Requêtes d’application de cas

API endpoints for triggering ad-hoc case tasks, closing case instances, and listing available ad-hoc tasks through the CaseApp v3 API.

Déclencher une tâche de cas ad hoc

Déclenche une tâche déclenchée manuellement, identifiée par son nom de plan de cas, sur une instance de Maestro Case en cours d'exécution.

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

Ferme une instance de Maestro Case en cours d'exécution.

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.

List the ad-hoc tasks you can run on a case

Lists the ad-hoc tasks a caller is permitted to trigger on a case instance, grouped by the stage that owns each task.

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

Returns the ad-hoc tasks the caller can trigger, grouped by the stage that owns them. Stages without a task the caller can trigger are omitted, so an empty stages list means the caller can't trigger any task on this case.

Champ	Saisie de texte	Description
stages	Tableau	The stages that contain at least one task the caller can trigger.
stages[].stageId	string	The stage's case plan node ID. Can be null.
stages[].stageLabel	string	The stage's label in the case plan.
stages[].tasks	Tableau	The stage's ad-hoc tasks, in case plan order.
stages[].tasks[].taskName	string	The task's name, to pass as taskName when calling Trigger an ad-hoc case task. Matching is case-sensitive.
stages[].tasks[].taskId	string	The task's case plan node ID. Can be null. The trigger endpoint doesn't accept it.

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

A listed task is one the caller is authorized to trigger, but the trigger can still fail. For example, triggering a task on a completed case returns 404.

Codes de réponse

Code	Signification
200	The list was returned. It can be empty.
400	The X-UIPATH-FolderKey header is missing or invalid.
401	L'appelant n'est pas authentifié.
403	The caller has no Cases.RunAdhocTasks grant related to this case.
404	The instance doesn't exist in the folder specified in X-UIPATH-FolderKey, or it isn't a case instance.
500	The case plan couldn't be read, or an unexpected server error occurred.

Autorisations

Requires the Cases.RunAdhocTasks permission, authorized at the scope of the stage that owns each listed task.