UiPath Documentation
maestro
latest
false
Maestro Orchestrate ユーザー ガイド
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

CaseApp の要求

アドホック・ケース・タスクのトリガー、ケース・インスタンスのクローズ、使用可能なアドホック・タスクのリスト、およびCaseApp v3 APIを介してケース・インスタンスとその状況の読み取りを行うためのAPIエンドポイント。

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

実行中のケース インスタンスに対して、ケース プラン名で識別される 1 つの手動トリガー (アドホック) タスクをトリガーします。

POST

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

要求ヘッダー​

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

要求本文​

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

応答コード​

200成功(空の本体)

エラー応答​

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

権限​

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

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

実行中のケース インスタンスを閉じます。

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[].stageIdstringステージのケース プラン ノード ID。nullできます。
stages[].stageLabelstringケースプランのステージのラベル。
stages[].tasks配列ケースプランの順序でのステージのアドホックタスク。
stages[].tasks[].taskNamestringアドホック ケース タスクのトリガーを呼び出すときにtaskNameとして渡すタスクの名前です。一致では大文字と小文字が区別されます。
stages[].tasks[].taskIdstringタスクのケース プラン ノード ID。nullできます。トリガー エンドポイントはそれを受け入れません。
{
  "stages": [
    {
      "stageId": "string",
      "stageLabel": "string",
      "tasks": [
        {
          "taskName": "string",
          "taskId": "string"
        }
      ]
    }
  ]
}
{
  "stages": [
    {
      "stageId": "string",
      "stageLabel": "string",
      "tasks": [
        {
          "taskName": "string",
          "taskId": "string"
        }
      ]
    }
  ]
}

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

応答コード​

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

権限​

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

ケース インスタンスを取得する​

単一のケース インスタンスをその ID で返します。応答のフィールドは v3 インスタンス リストと同じで、ケースの優先度、優先度の理由、調整のステートなどがあります。

GET

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

要求ヘッダー​

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

応答コード​

コード意味
200ケース インスタンスが返されました。
400X-UIPATH-FolderKey ヘッダーが見つからないか、無効です。
401呼び出し元は認証されていません。
403呼び出し元には、このケースに対する Cases.View 許可はありません。
404インスタンスが存在しないか、ケース インスタンスではありません。
424認可サービスにアクセスできませんでした。
500予期しないサーバー エラーが発生していました。

権限​

ケース プロセスまたはその任意のステージで付与される Cases.View 権限が必要です。v3 インスタンス リストに表示されるすべてのケースは、この要求で開くことができます。

ケースのステータスを取得する​

ケースの現在のステータス (ケースのステータスと SLA、ケースが到達したすべてのステージとタスクの現在の実行、再度実行されていない失敗したタスクの実行、オープン ステージの選択、タスクにアタッチされていない未解決のインシデント) を 1 回の呼び出しで返します。

GET

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/case-status

要求ヘッダー​

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

応答コード​

コード意味
200ケースのステータスが返されました。
400X-UIPATH-FolderKey ヘッダーが見つからないか、無効です。
401呼び出し元は認証されていません。
403この場合、呼び出し元には Cases.ViewSummary の付与がありません (CaseRbacAccessDenied)。
404インスタンスが存在しないか、ケース インスタンスではありません。
424認可サービスにアクセスできませんでした (CaseRbacAuthzUnavailable)。
500ケースの状態を読み取れなかったか、予期しないサーバー エラーが発生しました。

権限​

ケース プロセスに対する [ Cases.ViewSummary ] 権限が必要です。Orchestrator のフォルダー権限は不要です。

このページは役に立ちましたか?

接続

ヘルプ リソース サポート(opens in new window)

学習する UiPath アカデミー(opens in new window)

質問する UiPath フォーラム(opens in new window)

最新情報を取得