Obtenir des enregistrements d’entités

Répertorie tous les enregistrements d'entité.

Point de terminaison de l’API

BaseURL/EntityService/<Entity>/read

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

En-têtes de requête.

En-tête	Valeur (Value)
Autorisation	Porteur <access_token>

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
démarrer (facultatif)	int32	Spécifie le nombre d’enregistrements à ignorer avant de récupérer les enregistrements de la requête. Peut être utilisé conjointement avec le paramètre de limite pour implémenter la pagination. Les enregistrements sont triés par ordre croissant par leurs ID.	0
limite (facultatif)	int32	Spécifie le nombre maximal d’enregistrements à lire à partir de l’entité. Peut être utilisé avec le paramètre de début pour mettre en œuvre la pagination. La valeur maximale est 1 000.	100
NiveauExtension (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

Réponses

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:20:47.791Z",
      "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:20:47.791Z"
    }
  ]
}

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.