dataClass
Les noms de dataclass peuvent être utilisés directement dans les requêtes REST pour opérer avec des entités, des sélections d'entités (entity selections) ou des fonctions de classe (class functions) de la dataclass.
Syntaxe
Syntaxe | Exemple | Description |
---|---|---|
{dataClass} | /Employee | Renvoie toutes les données (par défaut les 100 premières entités) de la dataclass |
{dataClass}[{key}] | /Employee[22] | Renvoie les données de l'entité spécifique définie par la clé primaire de la dataclass |
{dataClass}:{attribute}(value) | /Employee:firstName(John) | Renvoie les données d'une entité dans laquelle la valeur de l'attribut est définie |
{dataClass}/{DataClassClassFunction} | /City/getCity | Exécute une fonction de classe d'une dataclass |
{dataClass}/{EntitySelectionClassFunction} | /City/getPopulation/?$filter="ID<3" | Exécute une fonction de classe d'une sélection d'entité |
{dataClass}[{key}]/{EntityClassFunction} | City(2)/getPopulation | Exécute une fonction de classe d'une entité |
Les appels de fonction sont détailles dans la section Appeler des fonctions de classe ORDA.
{dataClass}
Renvoie toutes les données (par défaut, les 100 premières entités) pour une dataclass spécifique (par exemple, Société
)
Description
When you call this parameter in your REST request, the first 100 entities are returned unless you have specified a value using $top/$limit
.
Voici une description des données retournées :
Propriété | Type | Description |
---|---|---|
__entityModel | String | Nom de la dataclass. |
__COUNT | Number | Nombre d'entités dans la dataclass. |
__SENT | Number | Nombre d'entités envoyées par la requête REST. Ce nombre peut être le nombre total d'entités s'il est inférieur à la valeur définie par $top/$limit . |
__FIRST | Number | Numéro d'entité à partir duquel la sélection commence. Soit 0 par défaut soit la valeur définie par $skip . |
__ENTITIES | Collection | Cette collection d'objets contient un objet pour chaque entité avec tous ses attributs. Tous les attributs relationnels sont renvoyés en tant qu'objets avec un URI pour obtenir des informations concernant le parent. |
Chaque entité contient les propriétés suivantes :
Propriété | Type | Description |
---|---|---|
__KEY | String | Valeur de la clé primaire définie pour la dataclass. |
__TIMESTAMP | Date | Horodatage de la dernière modification de l'entité |
__STAMP | Number | Tampon interne qui est nécessaire lors de la modification des valeurs de l'entité lors de l'utilisation de $method=update . |
If you want to specify which attributes you want to return, define them using the following syntax {attribute1, attribute2, ...}. Par exemple :
GET /rest/Company/name,address
Exemple
Retourne toutes les données d'une dataclass spécifique.
GET /rest/Company
Résultat :
{
"__entityModel": "Company",
"__GlobalStamp": 51,
"__COUNT": 250,
"__SENT": 100,
"__FIRST": 0,
"__ENTITIES": [
{
"__KEY": "1",
"__TIMESTAMP": "2020-04-10T10:44:49.927Z",
"__STAMP": 1,
"ID": 1,
"name": "Adobe",
"address": null,
"city": "San Jose",
"country": "USA",
"revenues": 500000,
"staff": {
"__deferred": {
"uri": "http://127.0.0.1:8081/rest/Company(1)/staff?$expand=staff"
}
}
},
{
"__KEY": "2",
"__TIMESTAMP": "2018-04-25T14:42:18.351Z",
"__STAMP": 1,
"ID": 2,
"name": "Apple",
"address": null,
"city": "Cupertino",
"country": "USA",
"revenues": 890000,
"staff": {
"__deferred": {
"uri": "http://127.0.0.1:8081/rest/Company(2)/staff?$expand=staff"
}
}
},
{
"__KEY": "3",
"__TIMESTAMP": "2018-04-23T09:03:49.021Z",
"__STAMP": 2,
"ID": 3,
"name": "4D",
"address": null,
"city": "Clichy",
"country": "France",
"revenues": 700000,
"staff": {
"__deferred": {
"uri": "http://127.0.0.1:8081/rest/Company(3)/staff?$expand=staff"
}
}
},
{
"__KEY": "4",
"__TIMESTAMP": "2018-03-28T14:38:07.430Z",
"__STAMP": 1,
"ID": 4,
"name": "Microsoft",
"address": null,
"city": "Seattle",
"country": "USA",
"revenues": 650000,
"staff": {
"__deferred": {
"uri": "http://127.0.0.1:8081/rest/Company(4)/staff?$expand=staff"
}
}
}
.....//plus d'entités ici
]
}
{dataClass}[{key}]
Returns the data for the specific entity defined by the dataclass's primary key, e.g., Company[22]
or Company[IT0911AB2200]
Description
En passant la dataclass et une clé, vous pouvez récupérer toutes les informations publiques de cette entité. En passant la dataclass et une clé, vous pouvez récupérer toutes les informations publiques de cette entité. Pour plus d'informations sur la définition d'une clé primaire, reportez-vous à la section Modification de la clé primaire dans l'éditeur de modèle de données.
For more information about the data returned, refer to {dataClass}.
If you want to specify which attributes you want to return, define them using the following syntax {attribute1, attribute2, ...}. Par exemple :
GET /rest/Company(1)/name,address
Si vous souhaitez développer un attribut relationnel à l'aide de $expand
, vous devez l'indiquer comme suit :
GET /rest/Company(1)/name,address,staff?$expand=staff
Exemple
La requête suivante retourne toutes les données publiques de la dataclass Company dont la clé est 1.
GET /rest/Company[1]
Résultat :
{
"__entityModel": "Company",
"__KEY": "1",
"__TIMESTAMP": "2020-04-10T10:44:49.927Z",
"__STAMP": 2,
"ID": 1,
"name": "Apple",
"address": Infinite Loop,
"city": "Cupertino",
"country": "USA",
"url": http://www.apple.com,
"revenues": 500000,
"staff": {
"__deferred": {
"uri": "http://127.0.0.1:8081/rest/Company(1)/staff?$expand=staff"
}
}
}
{dataClass}:{attribute}(value)
Renvoie les données d'une entité dans laquelle la valeur de l'attribut est définie
Description
En passant la dataClass et un attribut avec une valeur, vous pouvez récupérer toutes les informations publiques de cette entité. La valeur est une valeur unique pour l'attribut, mais ce n'est pas la clé primaire.
GET /rest/Company:companyCode(Acme001)
If you want to specify which attributes you want to return, define them using the following syntax {attribute1, attribute2, ...}. Par exemple :
GET /rest/Company:companyCode(Acme001)/name,address
Si vous souhaitez utiliser un attribut relationnel à l'aide de $attributes, vous devez l'indiquer comme suit :
GET /rest/Company:companyCode(Acme001)?$attributes=name,address,staff.name
Exemple
La requête suivante retourne toutes les données publiques de l'employé nommé "Jones".
GET /rest/Employee:lastname(Jones)