- OpenAPI Data Service
- Obtenir un enregistrement d’entité à partir d’un identifiant
- Obtenir des enregistrements d’entités
- Rechercher des enregistrements d’entités
- Supprimer un enregistrement d’entité par ID
- Mettre à jour un enregistrement d’entité par ID
- Créer un enregistrement d’entité
- Créer plusieurs enregistrements d’entités
- Mettre à jour plusieurs enregistrements d’entités
- Supprimer plusieurs enregistrements d’entités
- Télécharger le fichier à partir du champ d'enregistrement
- Télécharger le fichier vers le champ d’enregistrement
- Supprimer le fichier à partir du champ d’enregistrement
Rechercher des enregistrements d’entités
Interroge les enregistrements de l'entité.
En-tête |
Valeur (Value) |
---|---|
Autorisation |
Bearer
<access_token> |
Type de contenu |
application/json |
<...>
par leurs valeurs de cas d’utilisation correspondantes.
<access_token>
est celui que vous avez reçu lorsque vous avez autorisé l’application externe. Il est disponible pendant 1 heure, puis vous devez en générer un nouveau ou demander un jeton d'actualisation.
Paramètre de requête |
Type de données |
Description |
Valeur par défaut |
---|---|---|---|
expansionLevel (facultatif) |
|
Spécifie la profondeur des enregistrements associés à récupérer. La valeur de ce paramètre peut être 1, 2 ou 3. |
2 |
{
"selectedFields": [
"string"
],
"filterGroup": {
"logicalOperator": 0,
"queryFilters": [
{
"fieldName": "string",
"operator": "string",
"value": "string"
}
],
"filterGroups": [
null
]
},
"start": 0,
"limit": 0,
"sortOptions": [
{
"fieldName": "string",
"isDescending": true
}
]
}
{
"selectedFields": [
"string"
],
"filterGroup": {
"logicalOperator": 0,
"queryFilters": [
{
"fieldName": "string",
"operator": "string",
"value": "string"
}
],
"filterGroups": [
null
]
},
"start": 0,
"limit": 0,
"sortOptions": [
{
"fieldName": "string",
"isDescending": true
}
]
}
query
comporte les composants suivants :
selectedFields
string
. Il spécifie la liste des champs à renvoyer pour chaque enregistrement de la requête. Si elle est laissée vide, ou si la liste de requêtes est vide, tous les champs d'enregistrement sont renvoyés. La valeur par défaut est null
.
Groupefiltre
Il s'agit d'un composant requis qui vous aide à définir les propriétés de filtrage de la requête. Il combine les propriétés suivantes :
- OpérateurLogique : il s'agit d'une propriété filterGroup facultative, de type
int32
. Il spécifie si tous les filtres et groupes de filtres s'appliquent à la requête. Utilisez0
pour appliquer tous les filtres et groupes de filtres. Utilisez1
pour appliquer l'un des filtres et groupes de filtres. La valeur par défaut est0
. -
queryFilter : il s'agit d'une propriété filterGroup requise, qui vous aide à définir l'expression de filtrage. Il possède les propriétés suivantes :
Propriété queryFilter
Type de données
Description
fieldName
string
Spécifie le nom du champ à filtrer.
operator
string
Spécifie l'opérateur de filtre. Prend en charge les éléments suivants :
contains
,not contains
,startswith
,endswith
,=
,!=
,>
,<
,>=
,<=
,in
,not in
. Utilisez l'opérateur adéquat pour le type de champ correspondant.valeur
string
Spécifie la valeur de filtrage.
- filterGroups : il s'agit d'une propriété filterGroup facultative, au cas où vous devriez définir une autre option de filtrage pour la requête. Il contient toutes les propriétés filterGroup répertoriées ci-dessus.
Démarrer (Start)
int32
. Spécifie le nombre d'enregistrements à ignorer avant de récupérer les enregistrements de la requête. Peut être utilisé avec la propriété limit pour implémenter la pagination. Les enregistrements sont triés par ordre croissant de leurs ID. Pour modifier l'ordre de tri, utilisez la propriété sortOptions . La valeur par défaut est 0
.
limit
int32
. Il spécifie le nombre maximal d'enregistrements à lire à partir de l'entité. Peut être utilisé avec la propriété start pour implémenter la pagination. La valeur par défaut est 100
et la valeur maximale est 1000
.
sortOptions
Il s'agit d'un composant facultatif qui vous aide à trier les enregistrements interrogés en fonction d'une liste de champs. Si ce champ est laissé vide, les enregistrements sont triés par ordre croissant d'ID. Il combine les propriétés suivantes :
- fieldName : il s'agit d'une propriété sortOptions requise, de type
string
. Il spécifie le nom du champ utilisé pour trier les enregistrements. Le nom doit correspondre à un champ valide et est sensible à la casse. - isDescending : il s'agit d'une propriété optionnelle sortOptions , de type
boolean
. Définissez-le surtrue
si vous souhaitez trier les enregistrements par ordre décroissant. La valeur par défaut estfalse
.
{
"TotalRecordCount": 0,
"Value": [
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:21:22.771Z",
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Logo": {
"Name": "string",
"Path": "string",
"Size": 0,
"Type": "string"
},
"Name": "string",
"Nations": 0,
"OlymipcsVersion": 0,
"OpeningDate": "2021-03-04",
"UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"UpdateTime": "2021-03-04T10:21:22.771Z"
}
]
}
{
"TotalRecordCount": 0,
"Value": [
{
"ClosingDate": "2021-03-04",
"CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreateTime": "2021-03-04T10:21:22.771Z",
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Logo": {
"Name": "string",
"Path": "string",
"Size": 0,
"Type": "string"
},
"Name": "string",
"Nations": 0,
"OlymipcsVersion": 0,
"OpeningDate": "2021-03-04",
"UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"UpdateTime": "2021-03-04T10:21:22.771Z"
}
]
}
query
comporte les composants suivants :
- totalRecordCount : le nombre total d'enregistrements correspondant aux filtres de requête spécifiés.
- value - Un tableau d'enregistrements d'entité correspondant aux filtres de requête spécifiés, limité par la propriété limit .
Votre authentification ne vous permet pas d’accéder à Data Service. Assurez-vous que votre assistant ou votre robot est connecté à un dossier moderne de votre compte.