Liste des tâches
La syntaxe permettant de récupérer la liste des tâches disponibles à travers l’API est la suivante:
curl --insecure --silent \
-H "Authorization: Bearer <bearer_token>" \
'https://<host>/api/v1/tasks'
Si le code de retour HTTP est 200, la réponse sera structurée comme ceci:
{
"tasks": [
{
"id": "ADR02",
"label": "Saisie des dossiers",
"type": "R",
"path": "/api/v1/ADR02",
"spec": "/api/v1/ADR02/$openapi?domainId=ORT"
},
{
"id": "SYS02",
"label": "Saisie des utilisateurs",
"type": "B",
"path": "/api/v1/SYS02",
"spec": "/api/v1/SYS02/$openapi?domainId=ORT"
},
{
"id": "SYUS",
"label": "Vue des utilisateurs",
"type": "V",
"path": "/api/v1/SYUS",
"spec": "/api/v1/SYUS/$openapi?domainId=ORT"
}
]
}
Note:
Seules les tâches sur lesquelles l’utilisateur authentifié dispose du droit de lecture sont renvoyées. Deux utilisateurs différents peuvent donc obtenir des listes différentes.
| Clé | Description |
|---|---|
id |
Identifiant de la tâche. Cet identifiant est celui à utiliser pour y accéder à travers l’API. |
label |
Libellé de la tâche. |
type |
Type de la tâche. |
path |
Chemin d’accès à la tâche à travers l’API. |
spec |
Chemin du descripteur OpenAPI de la tâche, pour le domaine courant. |
Les types de tâches sont les suivants:
| Type | Description |
|---|---|
B |
Tâche de saisie de type sipmle. Ce sont des enregistrements basiques (voir ici). |
R |
Tâche de saisie de type dossier. Ce sont des enregistrements complexes, composés de différentes pages (voir ici). |
F |
Tâche de saisie à double niveau. Ce sont des enregistrements complexes, composés d’un en-tête et de lignes (voir ici). |
V/W |
Tâche de vue (courte / longue. Ces tâches permettent d’afficher différentes données sous forme de liste. |
T/U |
Tâche de traitement (court / long). Ces tâches effectuent des traitements sur les données. |
L/M |
Tâche de liste (courte / longue). Ces tâches effectuent potentiellement des traitements sur les données et retournent un résultat sous forme de document (PDF). |
Le listing des tâches dispose lui-même de son propre descripteur OpenAPI, accessible selon la même convention <resource>/$openapi?domainId=<domain> que celle utilisée pour les tâches:
curl --insecure --silent \
-H "Sai-Login: <username>" -H "Sai-Password: <password>" \
'https://<host>/api/v1/tasks/$openapi?domainId=<domain>'