- Démarrage
- Définition Swagger
- Lisez-moi
- Autorisation des appels d'API dans Swagger
- Gestion des ressources logiques
- API Orchestrator
- Demandes d'alertes
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches génériques
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes d'espaces de travail personnels
- Requêtes relatives aux processus
- Demandes d'éléments de la file d'attente
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
Guide de l'API Orchestrator
Gestion des ressources logiques
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.
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.
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.
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) |