Manipulation des données
All exposed dataclasses, attributes and functions can be accessed through REST. Les noms de dataclass, d'attributs et de fonctions sont sensibles à la casse; contrairement aux données des requêtes.
Rechercher des données
To query data directly, you can do so using the $filter function. Par exemple, pour trouver une personne nommée "Smith", vous pouvez écrire :
http://127.0.0.1:8081/rest/Person/?$filter="lastName=Smith"
Ajouter, modifier et supprimer des entités
Avec l'API REST, vous pouvez effectuer toutes les manipulations de données souhaitées dans 4D.
To add and modify entities, you can call $method=update. If you want to delete one or more entities, you can use $method=delete.
Besides retrieving a single entity in a dataclass using {dataClass}({key}), you can also write a class function that returns an entity selection (or a collection).
Before returning a selection, you can also sort it by using $orderby one one or more attributes (even relation attributes).
Parcourir les données
Add the $skip (to define with which entity to start) and $top/$limit (to define how many entities to return) REST requests to your queries or entity selections to navigate the collection of entities.
Créer et gérer un entity set
An entity set (aka entity selection) is a collection of entities obtained through a REST request that is stored in 4D Server's cache. L'utilisation d'un entity set vous empêche de lancer continuellement des requêtes à votre application pour obtenir les mêmes résultats. L'accès à un entity set est beaucoup plus rapide et peut améliorer la vitesse de votre application.
To create an entity set, call $method=entityset in your REST request. As a measure of security, you can also use $savedfilter and/or $savedorderby when you call $filter and/or $orderby so that if ever the entity set timed out or was removed from the server, it can be quickly retrieved with the same ID as before.
To access the entity set, you must use $entityset/{entitySetID}, for example:
/rest/People/$entityset/0AF4679A5C394746BFEB68D2162A19FF
By default, an entity set is stored for two hours; however, you can change the timeout by passing a new value to $timeout. Le timeout est continuellement réinitialisé à la valeur définie (soit par défaut soit à celle que vous définissez) chaque fois que vous l'utilisez.
If you want to remove an entity set from 4D Server's cache, you can use $method=release.
Si vous modifiez l'un des attributs de l'entité dans l'entity set, les valeurs seront mises à jour. Toutefois, si vous modifiez une valeur qui faisait partie de la requête exécutée pour créer l'entity set, elle ne sera pas supprimée de l'entity set même si elle ne correspond plus aux critères de recherche. Bien entendu, les entités que vous supprimez ne feront plus partie de l'entity set.
Si l'entity set ne se trouve plus dans le cache de 4D Server, il sera recréé avec un nouveau timeout de 10 minutes. L'ensemble d'entités sera actualisé (certaines entités peuvent être incluses tandis que d'autres peuvent être supprimées) depuis la dernière fois qu'il a été créé, s'il n'existait plus avant de le recréer.
Using $entityset/{entitySetID}?$logicOperator... &$otherCollection, you can combine two entity sets that you previously created. Vous pouvez combiner les résultats dans les deux, retourner uniquement ce qui est commun aux deux, ou renvoyer ce qui n'est pas commun aux deux.
A new selection of entities is returned; however, you can also create a new entity set by calling $method=entityset at the end of the REST request.
Calcul des données
By using $compute, you can compute the average, count, min, max, or sum for a specific attribute in a dataclass. Vous pouvez également calculer toutes les valeurs avec le mot clé $all.
Par exemple, pour obtenir le salaire le plus élevé :
/rest/Employee/salary/?$compute=max
Pour calculer toutes les valeurs et retourner un objet JSON :
/rest/Employee/salary/?$compute=$all
Appeler les fonctions de classe du modèle de données
You can call ORDA Data Model user class functions through POST requests, so that you can benefit from the exposed API of the targeted application. For example, if you have defined a getCity() function in the City dataclass class, you could call it using the following request:
/rest/City/getCity
with data in the body of the request: ["Paris"]
Les appels aux méthodes projet 4D exposées en tant que service REST sont toujours pris en charge mais sont obsolètes.
Selecting Attributes to get
You can always define which attributes to return in the REST response after an initial request by passing their path in the request (e.g., Company(1)/name,revenues/)
Vous pouvez appliquer ce filtre comme suit :
| Object | Syntaxe | Exemple |
|---|---|---|
| Dataclass | {dataClass}/{att1,att2...} | /People/firstName,lastName |
| Collection d'entités | {dataClass}/{att1,att2...}/?$filter="{filter}" | /People/firstName,lastName/?$filter="lastName='a@'" |
| Entité spécifique | {dataClass}({ID})/{att1,att2...} | /People(1)/firstName,lastName |
| {dataClass}:{attribute}(value)/{att1,att2...}/ | /People:firstName(Larry)/firstName,lastName/ | |
| Entity selection | {dataClass}/{att1,att2...}/$entityset/{entitySetID} | /People/firstName/$entityset/528BF90F10894915A4290158B4281E61 |
The attributes must be delimited by a comma, i.e., /Employee/firstName,lastName,salary. Des attributs de stockage ou des attributs relationnels peuvent être transmis.
Exemples
Voici quelques exemples vous permettant d'indiquer les attributs à retourner en fonction de la méthode employée pour récupérer les entités.
Vous pouvez appliquer cette méthode à :
- Dataclass (tout ou une collection d'entités dans une dataclass)
- Entités spécifiques
- Entity sets
Exemple avec une dataclass
The following requests returns only the first name and last name from the People dataclass (either the entire dataclass or a selection of entities based on the search defined in $filter).
GET /rest/People/firstName,lastName/
Result:
{
__entityModel: "People",
__COUNT: 4,
__SENT: 4,
__FIRST: 0,
__ENTITIES: [
{
__KEY: "1",
__STAMP: 1,
firstName: "John",
lastName: "Smith"
},
{
__KEY: "2",
__STAMP: 2,
firstName: "Susan",
lastName: "O'Leary"
},
{
__KEY: "3",
__STAMP: 2,
firstName: "Pete",
lastName: "Marley"
},
{
__KEY: "4",
__STAMP: 1,
firstName: "Beth",
lastName: "Adams"
}
]
}
GET /rest/People/firstName,lastName/?$filter="lastName='A@'"/
Result:
{
__entityModel: "People",
__COUNT: 1,
__SENT: 1,
__FIRST: 0,
__ENTITIES: [
{
__KEY: "4",
__STAMP: 4,
firstName: "Beth",
lastName: "Adams"
}
]
}
Exemple d'entité
La requête suivante retourne uniquement les attributs de prénom et nom à partir d'une entité spécifique de la dataclass People :
GET /rest/People(3)/firstName,lastName/
Result:
{
__entityModel: "People",
__KEY: "3",
__STAMP: 2,
firstName: "Pete",
lastName: "Marley"
}
GET /rest/People(3)/
Result:
{
__entityModel: "People",
__KEY: "3",
__STAMP: 2,
ID: 3,
firstName: "Pete",
lastName: "Marley",
salary: 30000,
employer: {
__deferred: {
uri: "http://127.0.0.1:8081/rest/Company(3)",
__KEY: "3"
}
},
fullName: "Pete Marley",
employerName: "microsoft"
}
Exemple d'ensemble d'entités
Once you have created an entity set, you can filter the information in it by defining which attributes to return:
GET /rest/People/firstName,employer.name/$entityset/BDCD8AABE13144118A4CF8641D5883F5?$expand=employer
Affichage d'un attribut d'image
Si vous souhaitez afficher intégralement un attribut d'image, saisissez ce qui suit :
GET /rest/Employee(1)/photo?$imageformat=best&$version=1&$expand=photo
For more information about the image formats, refer to $imageformat. For more information about the version parameter, refer to $version.
Enregistrement d'un attribut BLOB sur le disque
Si vous souhaitez enregistrer un BLOB stocké dans votre dataclass, vous pouvez écrire ce qui suit :
GET /rest/Company(11)/blobAtt?$binary=true&$expand=blobAtt
Récupérer une seule entité
You can use the {dataClass}:{attribute}(value) syntax when you want to retrieve only one entity. C'est particulièrement utile lorsque vous souhaitez lancer une recherche associée qui n'est pas créée sur la clé primaire de la dataclass. Par exemple, vous pouvez écrire :
GET /rest/Company:companyCode("Acme001")