Managing logical resources

About the response and request schema

Pour afficher le schéma de réponse et de requête, cliquez sur le bouton Développer les réponses (Expand Operations) en regard de la ressource qui vous intéresse.

Dans la section Classe de réponse (Response Class), vous pouvez afficher le modèle entier de la ressource avec les explications sur le mode de remplissage des paramètres, ou un exemple de l'apparence des informations que vous avez demandées.

La section Paramètres (Parameters) contient tous les paramètres disponibles pris en charge par la ressource sélectionnée, avec une brève explication. En outre, tous les paramètres pris en charge peuvent être renseignés avec des informations afin que vos puissiez réellement tester l'API Orchestrator tout en consultant la documentation.

Listing operations

Pour afficher toutes les opérations disponibles d'une ressource spécifique, cliquez sur le bouton Lister les opérations (List Operations) en regard de la ressource intéressante.

Using the response model to build request parameters

Le modèle de réponse des ressources permet de vous aider à comprendre sa structure et son mode d'utilisation dans les requêtes ultérieures. Il est constitué comme suit :

• L'entité principale ou l'objet de transfert de données (Dto, data transfer object) et ses propriétés. Pour chaque propriété, les informations suivantes s'affichent :

  • le type de valeur accepté, écrit entre parenthèses ;
  • requis ou facultatif : les paramètres facultatifs sont marqués comme tels ;
  • explication concernant le paramètre et les valeurs maximales acceptées.
• Entité de second niveau : s'affiche uniquement si l'entité principale contient une ressource en tant que paramètre. Notez qu'il peut y avoir plusieurs entités de second niveau, selon la ressource principale.

Le nombre total de niveaux de ressource dépend de l'entité principale. Par exemple, il y a trois niveaux pour RobotDto, et deux pour EnvironmentsDto.

API stricte

Vous pouvez alléger la charge potentielle générée par les requêtes d'API à l'aide du paramètre de locataire API stricte (Strict API), disponible dans la section Paramètres de l'API (API Settings) de l'onglet Général (General). Lorsque cette option est activée, les champs suivants deviennent non filtrables et/ou non triables :

Entité	Champ	Non-filterable	Non-sortable
Éléments de file d'attente	OutputData	Oui (Yes)	Oui (Yes)
	AnalyticsData	Oui (Yes)	Oui (Yes)
	ReviewerUserId	S/O	Oui (Yes)
	Key	Oui (Yes)	Oui (Yes)
	Reference	S/O	Oui (Yes)
	DueDate	Oui (Yes)	Oui (Yes)
	RiskSlaDate	Oui (Yes)	Oui (Yes)
	DeferDate	Oui (Yes)	Oui (Yes)
	StartProcessing	Oui (Yes)	S/O
	EndProcessing	Oui (Yes)	S/O
	SecondsInPreviousAttempts	Oui (Yes)	Oui (Yes)
	AncestorId	Oui (Yes)	Oui (Yes)
	RetryNumber	Oui (Yes)	Oui (Yes)
	SpecificData	Oui (Yes)	Oui (Yes)
	CreationTime	Oui (Yes)	Oui (Yes)
	Progress	Oui (Yes)	Oui (Yes)
	RowVersion	Oui (Yes)	Oui (Yes)
	OrganizationUnitId	Oui (Yes)	Oui (Yes)
	OrganizationUnitFullyQualifiedName	Oui (Yes)	Oui (Yes)

La liste ci-dessus sera étendue à l'avenir, en fonction des modèles d'utilisation que nous observons.