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 :

• logicalOperator - This is an optional filterGroup property, of type int32. It specifies if all the filters and filter groups apply to the query. Use 0 to apply all the filters and filter groups. Use 1 to apply any of the filters and filter groups. Default value is 0.

• queryFilter - This is a required filterGroup property, that helps you define the filtering expression. It has the following properties:

  Propriété queryFilter	Type de données	Description
  fieldName	string	Spécifie le nom du champ à filtrer.
  operator	string	Specifies the filter operator. Supports the following: contains, not contains, startswith, endswith, =, !=, >, <,>=, <=, in, not in. Use the adequate operator for the corresponding field type.
  valeur	string	Spécifie la valeur de filtrage.

• filterGroups - This is an optional filterGroup property, in case you need to set another filtering option to the query. It contains all the filterGroup properties listed above.

Démarrer (Start)

This is an optional component, of type int32. Specifies the number of records to skip before retrieving the records from the query. Can be used together with the limit property to implement pagination. The records are ordered ascendingly by their IDs. To modify the sort order, use the sortOptions property. Default value is 0.

limit

This is an optional component, of type int32. It specifies the maximum number of records to be read from the entity. Can be used together with the start property to implement pagination. The default value is 100, and the maximum value is 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 - This is a required sortOptions property, of type string. It specifies the name of the field used to sort the records. The name must correspond to a valid field, and it is case-sensitive.
• isDescending - This is an optional sortOptions property, of type boolean. Set it to true if you want to sort the records descendingly. The default value is 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 - The total number of records matching the specified query filters.
• value - An array of entity records matching the specified query filters, limited by limit property.

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.