Rechercher des enregistrements d’entités

Interroge les enregistrements d'entité.

Point de terminaison de l’API

BaseURL/EntityService/<Entity>/query

• URL de base : https://{yourDomain}/{organizationName}/{tenantName}/dataservice_

En-têtes de requête.

En-tête	Valeur (Value)
Autorisation	Porteur <access_token>
Type de contenu	application/json

Remarque :

Remplacez toutes les valeurs entre les chevrons <...> par leurs valeurs de cas d’utilisation correspondantes.

Le <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ètres de requête

Paramètre de requête	Type de données	Description	Valeur par défaut
NiveauDéveloppement (Facultatif)	int32	Spécifie la profondeur des enregistrements associés à récupérer. La valeur de ce paramètre peut être 1, 2 ou 3.	2

Corps de la requête (obligatoire)

{
  "selectedFields": [
    "string"
  ],
  "filterGroup": {
    "logicalOperator": 0,
    "queryFilters": [
      {
        "fieldName": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "filterGroups": [
      null
    ]
  },
  "start": 0,
  "limit": 0,
  "sortOptions": [
    {
      "fieldName": "string",
      "isDescending": true
    }
  ]
}

Schémas du corps de la requête

Le corps de la demande de point de terminaison query comporte les composants suivants :

selectedFields

Il s'agit d'un composant facultatif, de type 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érateur logique - Il s'agit d'une propriété facultative filterGroup de type int32. Il spécifie si tous les filtres et groupes de filtres s'appliquent à la requête. Utilisez 0 pour appliquer tous les filtres et groupes de filtres. Utilisez 1 pour appliquer l'un des filtres et groupes de filtres. La valeur par défaut est 0.

• RequêteFiltre - 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é facultative filterGroup , au cas où vous devriez définir une autre option de filtrage sur la requête. Il contient toutes les propriétés FilterGroup répertoriées ci-dessus.

Démarrer (Start)

Il s'agit d'un composant facultatif, de type 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é limite pour implémenter la pagination. Les enregistrements sont triés par ordre croissant par leurs ID. Pour modifier l'ordre de tri, utilisez la propriété triOptions . La valeur par défaut est 0.

limit

Il s'agit d'un composant facultatif, de type int32. Spécifie le nombre maximal d’enregistrements à lire à partir de l’entité. Peut être utilisé avec la propriété de début 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. Spécifie le nom du champ utilisé pour trier les enregistrements. Le nom doit correspondre à un champ valide et est sensible à la casse.
• EstDécroissant : il s'agit d'une propriété SortOptions facultative, de type boolean. Définissez ce paramètre sur true si vous souhaitez trier les enregistrements par ordre décroissant. La valeur par défaut est false.

Réponses

200 OK

{
  "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"
    }
  ]
}

Schéma du corps de la réponse

Le corps de la réponse du point de terminaison query comporte les composants suivants :

• totalRecordCount : le nombre total d'enregistrements correspondant aux filtres de requête spécifiés.
• value : Tableau d'enregistrements d'entités correspondant aux filtres de requête spécifiés, limité par propriété limit .

401 Non autorisé

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.

403 Forbidden

Vous n’êtes pas autorisé à accéder à l’entité, au champ, ni à l’enregistrement, ou utilisez un type de robot non pris en charge. Contactez votre administrateur afin d’obtenir les autorisations requises.