Liste des processus

Les tâches de vues, liste et traitement longues offrent un accès génériques aux processus qui ont été exécutés pour chacunes des tâches.

La liste des processus s’obtient avec la commande suivante:

curl --insecure --silent \
     -H "Authorization: Bearer <bearer_token>"  \
     'https://<host>/api/v1/<taskId>/processes'

Paramètres	Type	Description
status	string	Permet de filtrer la liste des processus ayant le même status (INIT,RUNNING,SUCCESS,FAILURE ou STOPPED, cette dernière valeur étant déclarée par l’API mais non émise actuellement). Si pas spécifié, aucun filtre n’est appliqué.

{
  "metadata": {
    "apiVersion": "1.0",
    "taskId": "<taskId>",
    "taskType": "<type>",
    "domainId": "<domainId>"
  },
  "data": [
    {
      "processId": "18B60ECA45E-3D-D05099-MX3E4M",
      "userId": "atalon",
      "startTime": "2021-02-05T08:03:23+0200",
      "stopTime": "2021-02-05T08:27:12+0200",
      "status": "SUCCESS"
    },
    {
      "processId": "18B60ED613A-3D-D05099-TP9L0A",
      "userId": "tcruise",
      "startTime": "2022-10-12T10:01:11+0200",
      "status": "RUNNING"
    },
    {
      "processId": "18B60ED99D3-3D-D05099-VZ5RU8",
      "userId": "slampion",
      "startTime": "2022-05-24T11:04:26+0200",
      "stopTime": "2022-05-24T11:04:26+0200",
      "status": "FAILURE"
    }
  ]
}

Clé	Description
processId	Identifiant du processus.
userId	Utilisateur ayant lancé le processus.
startTime	Date/heure de lancement.
stopTime	Date/heure lorsque le processus a terminé. Absent si le processus est en cours.
status	Status (INIT,RUNNING,SUCCESS,FAILURE ou STOPPED). STOPPED est déclarée par l’API mais non émise par l’implémentation actuelle : un arrêt aboutit à FAILURE.

Pour accéder à l’état d’avancement d’un processus:

curl --insecure --silent \
     -H "Authorization: Bearer <bearer_token>"  \
     'https://<host>/api/v1/<taskId>/processes/<processId>'

{
  "metadata": {
    "apiVersion": "1.0",
    "taskId": "<taskId>",
    "taskType": "<type>",
    "domainId": "<domainId>"
  },
  "data": {
    "processId": "18B60ED613A-3D-D05099-TP9L0A",
    "userId": "tcruise",
    "startTime": "2022-10-12T10:01:11+0200",
    "status": "RUNNING",
    "progression": {
      "value": 0.246,
      "labels": ["Initialisation","Assuré 542823","Assuré 585838"]
    }
  }
}

Lorsque l’état d’un processus est demandé, si celui-ci est en cours d’éxécution, une clé progression est retournée avec les informations permettant de suivre l’avancement.

Clé	Description
value	Nombre de 0 à 1, représentant l’avancement global
labels	Liste de libellés traités / en cours de traitement.

curl --insecure --silent \
     -H "Authorization: Bearer <bearer_token>"  \
     'https://<host>/api/v1/<taskId>/processes/<processId>/result'

Le résultat d’un processus dépend du type de la tâche associée:

• type W (vue longue): result contient gridViewId, columns et rows, mais ni processId ni screen.
• type M (impression longue): result contient fileName et fileId.
• type U (traitement long): result contient directement les champs de l’écran, à plat, sans sous-clé screen.

{
  "metadata": {
    "apiVersion": "1.0",
    "taskId": "<taskId>",
    "taskType": "<type>",
    "domainId": "<domainId>"
  },
  "data": {
    "processId": "18B60ED613A-3D-D05099-TP9L0A",
    "userId": "tcruise",
    "startTime": "2022-10-12T10:01:11+0200",
    "stopTime": "2022-10-12T10:05:18+0200",
    "status": "SUCCESS",
    "result": {
      ...
    }
  }
}

En cas d’erreur, un code standard est remonté lorsque le résultat est demandé.