CaseApp の要求

CaseApp v3 API を介してアドホック ケース タスクをトリガーし、ケース インスタンスをクローズし、使用可能なアドホック タスクを一覧表示するための API エンドポイントです。

アドホック ケース タスクをトリガーする

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

POST

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

要求ヘッダー

キー	値 (Value)
認可	Bearer
X-UIPATH-FolderKey	ケース インスタンスのフォルダー キーです

要求本文

フィールド	入力	Required	説明
taskName	string	はい	トリガーするアドホック タスクの名前です。ケース プランで解決される名前とまったく同じです。一致では大文字と小文字が区別されます。
タスク入力	object	いいえ	自由形式の JSON オブジェクトが、入れ子になったペイロードとしてトリガーされたタスクに逐語的に転送されます。たとえば、承認の参照や意思決定データなどです。このペイロードは解釈もスキーマ検証も行わず、タスクの宣言された入力にバインドされません。

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

応答コード

200成功(空の本体)

エラー応答

コード	意味
400	要求本文が見つからないか、無効です。
401	呼び出し元は認証されていません。
403	呼び出し元には、このタスクに必要なアクセス許可がありません。
404	ケース インスタンスが存在しないか、同じ名前のアドホック タスクがケース プランに存在しません。エントリ条件が「アドホック」のタスクのみが対象となります。それ以外の名前では 404 が返されます。
500	予期しないサーバー エラーが発生していました。

権限

要求されたタスクを所有するステージの範囲で承認された Cases.RunAdhocTasks 権限が必要です。

ケース インスタンスを閉じる

Closes a running Case instance.

POST

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

要求ヘッダー

キー	値 (Value)
認可	Bearer
X-UIPATH-FolderKey	ケース インスタンスのフォルダー キーです

応答コード

コード	意味
200	インスタンスは Cancelingに移行します。作業者がシフトを完了して、非同期に Cancelled します。すでにターミナルにあるインスタンスは、現在のステータスを変更せずに返します。
400	インスタンスはすでに Completed に達しているため、キャンセルできません。
401	呼び出し元は認証されていません。
403	呼び出し元には、このインスタンスに必要な権限がありません。
404	インスタンス ID がケース インスタンスに解決されません。

権限

Cases.Close ペルソナの付与が必要です。

ケースで実行できるアドホック タスクを一覧表示する

呼び出し元がケース インスタンスに対してトリガーできるアドホック タスクを、各タスクを所有するステージごとにグループ化してリストします。

GET

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

要求ヘッダー

キー	値 (Value)
認可	Bearer
X-UIPATH-FolderKey	ケース インスタンスのフォルダー キーです

応答本文

呼び出し元がトリガーできるアドホック タスクを、そのタスクを所有するステージ別にグループ化して返します。呼び出し元がトリガーできるタスクがないステージは省略されるため、空の stages リストは、呼び出し元がこのケースに対してタスクをトリガーできないことを意味します。

フィールド	入力	説明
ステージ	配列	呼び出し元がトリガーできるタスクを少なくとも 1 つ含むステージ。
stages[].stageId	string	ステージのケース プラン ノード ID。nullできます。
stages[].stageLabel	string	ケースプランのステージのラベル。
stages[].tasks	配列	ケースプランの順序でのステージのアドホックタスク。
stages[].tasks[].taskName	string	アドホック ケース タスクのトリガーを呼び出すときにtaskNameとして渡すタスクの名前です。一致では大文字と小文字が区別されます。
stages[].tasks[].taskId	string	タスクのケース プラン ノード ID。nullできます。トリガー エンドポイントはそれを受け入れません。

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

一覧表示されているタスクとは、呼び出し元がトリガーする権限を与えられているが、トリガーが失敗する可能性があるタスクのものです。たとえば、完了したケースに対してタスクをトリガーすると、404 が返されます。

応答コード

コード	意味
200	リストが返されました。空でも構いません。
400	X-UIPATH-FolderKey ヘッダーが見つからないか、無効です。
401	呼び出し元は認証されていません。
403	発信者は、このケースに関連する Cases.RunAdhocTasks の付与権を持っていません。
404	インスタンスが X-UIPATH-FolderKeyで指定したフォルダーに存在しないか、ケース インスタンスではありません。
500	ケース計画を読み取れなかったか、予期しないサーバー エラーが発生しました。

権限

一覧表示された各タスクを所有するステージの範囲で承認された Cases.RunAdhocTasks 権限が必要です。