Requêtes d’application de cas

Points de terminaison d'API pour déclencher des tâches de cas ad-hoc, fermer les instances de cas et répertorier les tâches ad-hoc disponibles via l'API CaseApp v3.

Déclencher une tâche de cas ad hoc

Triggers one manually-triggered (ad-hoc) task, identified by its case plan name, on a running Case instance.

Publier

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/trigger

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur
X-UIPATH-CléDossier	La clé de dossier de l’instance de cas

Corps de la requête

Champ	Saisie de texte	Requis	Description
taskName	string	Oui (Yes)	Le nom de la tâche ad-hoc à déclencher, exactement tel qu'il se résout dans le plan de cas. La correspondance est sensible à la casse.
EntréeTâche	object	Non (No)	Un objet JSON de forme libre transféré dans un élément textuel à la tâche déclenchée sous forme de charge utile imbriquée, par exemple des références d'approbation ou des données de décision. La plateforme n’interprète pas ou ne valide pas de schéma cette charge utile et elle n’est pas liée aux entrées déclarées de la tâche.

{
  "taskName": "string",
  "taskInput": {}
}

Codes de réponse

200 Success (corps vide)

Réponses d’erreur

Code	Signification
400	Le corps de la requête est manquant ou non valide.
401	L'appelant n'est pas authentifié.
403	L’appelant ne dispose pas de l’autorisation requise pour cette tâche.
404	L’instance de cas n’existe pas, ou aucune tâche ad hoc avec ce nom n’existe sur le plan de cas. Seules les tâches avec un point de terminaison « ad hoc »; les conditions d'entrée sont éligibles — les autres noms renvoient le code 404.
500	Une erreur de serveur inattendue s’est produite.

Autorisations

Nécessite l'autorisation Cases.RunAdhocTasks, autorisée au niveau de l'étendue de l'étape propriétaire de la tâche demandée.

Fermer une instance de cas

Closes a running Case instance.

Publier

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/close

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur
X-UIPATH-CléDossier	La clé de dossier de l’instance de cas

Codes de réponse

Code	Signification
200	L’instance est passée à Canceling. Le travailleur exécute le décalage vers Cancelled de manière asynchrone. Une instance déjà terminée renvoie son statut actuel inchangé.
400	L’instance a déjà atteint Completed et ne peut pas être annulée.
401	L'appelant n'est pas authentifié.
403	L’appelant ne dispose pas de l’autorisation requise pour cette instance.
404	L’ID d’instance ne se résout pas en une instance de cas.

Autorisations

Nécessite l'octroi de persona Cases.Close.

Répertorier les tâches ad hoc que vous pouvez exécuter sur un cas

Répertorie les tâches ad hoc qu'un appelant est autorisé à déclencher sur une instance de cas, regroupées par l'étape propriétaire de chaque tâche.

Obtenir

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/adhoc

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur
X-UIPATH-CléDossier	La clé de dossier de l’instance de cas

Corps de la réponse

Renvoie les tâches ad hoc que l'appelant peut déclencher, regroupées par l'étape qui les possède. Les étapes sans tâche que l'appelant peut déclencher sont omises, par conséquent, une liste stages vide signifie que l'appelant ne peut déclencher aucune tâche dans ce cas.

Champ	Saisie de texte	Description
Étapes	Tableau	Les étapes qui contiennent au moins une tâche que l'appelant peut déclencher.
étapes[].stageId	string	ID du nœud du plan de cas de l’étape. Il peut s'agir null.
étapes[].stageLabel	string	Le libellé de l’étape dans le plan de cas.
étapes[].tâches	Tableau	Les tâches ad hoc de l’étape, dans l’ordre du plan de cas.
étapes[].tasks[].taskName	string	Le nom de la tâche, à transmettre par taskName lors de l'appel de Déclencher une tâche de cas ad hoc. La correspondance est sensible à la casse.
étapes[].tasks[].taskId	string	ID du nœud du plan de cas de la tâche. Il peut s'agir null. Le point de terminaison du déclencheur ne l'accepte pas.

{
  "stages": [
    {
      "stageId": "string",
      "stageLabel": "string",
      "tasks": [
        {
          "taskName": "string",
          "taskId": "string"
        }
      ]
    }
  ]
}

Une tâche répertoriée est une tâche que l'appelant est autorisé à déclencher, mais le déclencheur peut toujours échouer. Par exemple, le déclenchement d'une tâche sur un cas terminé renvoie 404.

Codes de réponse

Code	Signification
200	La liste a été renvoyée. Peut être vide.
400	L’en-tête X-UIPATH-FolderKey est manquant ou non valide.
401	L'appelant n'est pas authentifié.
403	L'appelant ne dispose d'aucune autorisation Cases.RunAdhocTasks liée à ce cas.
404	L’instance n’existe pas dans le dossier spécifié dans X-UIPATH-FolderKey, ou il ne s’agit pas d’une instance de cas.
500	Le plan de cas n’a pas pu être lu, ou une erreur de serveur inattendue s’est produite.

Autorisations

Nécessite l'autorisation Cases.RunAdhocTasks , autorisée au niveau de l'étendue de l'étape propriétaire de chaque tâche répertoriée.