Process Approvals

すべての承認プロセスのリストを返します。特定のレコードが承認プロセスをサポートしていて、承認プロセスがすでに定義されている場合、そのレコードを送信するためにも使用できます。現在のユーザが割り当てられた承認者である場合、レコードを承認および却下できます。POST 要求を使用して一括承認を行う場合、成功した要求はコミットされ、失敗した要求からはエラーが返されます。

構文

URI

承認のリストを返す場合の URI: /vXX.X/process/approvals/

適用開始バージョン

30.0

形式

JSON、XML

HTTP メソッド

GET、HEAD、POST

認証

Authorization: Bearer token

要求パラメータ

不要

リクエストボディ

リクエストボディには、次の情報を含むプロセス要求の配列が含まれます。

名前	データ型	説明
actionType	string	実行するアクション (Submit、Approve、または Reject) を表します。
contextActorId	ID	承認レコードを要求した申請者の ID。
contextId	ID	動作の対象となる項目の ID。
comments	string	この要求に関連付けられた履歴ステップに追加されるコメント。
nextApproverIds	ID[]	プロセスが引き続き承認の詳細を要求する場合、次の要求に割り当てられるユーザ ID。
processDefinitionNameOrId	string	プロセス定義の開発者名または ID。
skipEntryCriteria	boolean	プロセス定義名または ID が null ではない場合にプロセスの開始条件を評価するか (true)、否か (false) を決定します。プロセス定義名または ID が指定されていない場合、この引数は無視され、標準の評価がプロセスの順序に基づいて行われます。この要求で設定されていなければ、デフォルトでは開始条件はスキップされません。

レスポンスボディ

レスポンスボディには、次の情報を含むプロセス結果の配列が含まれます。

名前	データ型	説明
actorIds	ID[]	この承認ステップに現在割り当てられているユーザの ID。
entityId	ID	処理されているオブジェクト
errors	Error[]	要求が失敗した場合に返されるエラーのセット。
instanceId	ID	処理用に提出されるオブジェクトに関連付けられている ProcessInstance の ID。
instanceStatus	string	現在のプロセスインスタンスの状態 (個別のオブジェクトではな��、全体のプロセスインスタンス)。有効値は、「Approved」、「Rejected」、「Removed」、または「Pending」です。
newWorkItemIds	ID[]	ProcessInstanceWorkitem 項目を示す、大文字と小文字が区別されない ID (保留中の承認要求セット)。
success	boolean	処理または承認が正常に完了した場合、true。

例

• 「すべての承認プロセスのリストを取得する」を参照してください。
• 「承認を受けるレコードを送信する」を参照してください。
• 「レコードを承認する」を参照してください。
• 「レコードを却下する」を参照してください。
• 「一括承認」を参照してください。