完全な割り当て API - Automate_Evolve - Automate_Studio_Manager - 20.3

API の概要

以下は、Start Process API の概要です。

1. 選択可能なすべてのオプション、承認/却下/完了でタスクを完了します。次のオプションを使用して、タスクの完了中にコメントを提供することもできます。

   • タスク ID によって。

   • processID とタスク名を提供して。このタスク名に対して複数の開いているタスクが見つかった場合、いずれか 1 つが完了します。

2. API は、ワークフロー タスク プロパティ「レビューが必要」をサポートしています。これは、対応するドキュメントがまだレビューされていない場合、タスクを完了できないことを意味します。

3. API からレビューするようにタスクを設定することはできません。

4. 「Excel ワークフロー」の場合、更新された Excel ファイルを提供できます。

   • API は、ワークフロー タスク「AllowReplacement」プロパティをサポートしています。例えば、このプロパティが true の場合のみ、Excel ファイルが受け入れられます。それ以外の場合、API はエラーをスローします。

   • Excel ファイルは、このタスク プロセス ソリューション、ライブラリ、およびアプリに属している必要があります。

5. フォーム ワークフローの場合、フォーム データを提供できます。

   • フォーム データは JSON 形式である必要があります。また、繰り返しのないフォーム フィールドの場合、API はフォームで提供されたフィールドのみを更新し (フィールドが提供されていない場合は、既存のフォーム値が保持される)、繰り返しのテーブル データが JSON で提供されている場合、既存のフォームのテーブル データは完全に新しいデータで上書きされます。

   • フォーム フィールド データを更新するときに、フィールド ルール、ビュー ルールなどはトリガーされません。したがって、呼び出し側システムは、有効なフォーム データを確実に送信する必要があります。

   • XML 形式のフォーム データはサポートされていません。

6. この API では、添付ファイルまたはサポート ドキュメントはサポートされていません。

7. Digital Access API に承認時のチャレンジは適用されません。ユーザーは資格情報を検証せずに Digital Access API からタスクを完了できます。API の使用例では「承認時のチャレンジ」プロパティを False に設定するか、そのようなソリューションの API アクセスを無効にすることをお勧めします。

リクエストとレスポンスの本文

この API は、要求と応答の次の形式で既存のオープン割り当てを完了するために使用されます。

リクエスト データ コントラクト:

レスポンス データ コントラクト:

リクエストとレスポンスのサンプル

次のサンプルは、API の使用を示しています。

サンプル 1

ルート: http://cha-en-vstwp418:8090/svr/api/v1/Processextn/CompleteAssignment

ペイロードのリクエスト

{   "FileContent" : null,   "Decision": "Approved",   "Note": "Completed through PE",   "AssignmentId": "07b25c54-d862-4270-af32-4654b321b3d7",   "Formfields":    {     "my:myFields":     {       "my:field_1": "test_new1",       "my:field_2": "test_new2",       "my:Repeating_Table_2":        {         "my:Repeating_Content":          {           "my:field_3": "R1_activity",           "my:field_4": "R2_activity"         }       }     }   } }

ペイロードのレスポンス

1. タスク アクション (すなわち、完了/承認/拒否) が正常に完了する時:

   True

2. すでに完了したタスクの場合:

   [{"ErrorCode":"Task Process Already Completed","Message":"Task Process Already Completed","errorPrameters":[]}]

3. 付与された割り当て ID が見つからない場合

   [{"ErrorCode":"InvalidAssignment_AssignmentReassigned","Message":"Invalid assignment id: 2ffdba51-2f93-4502-b07e-02972ec8d1fa","errorPrameters":[]}]

サンプル 2

ルート: http://cha-en-vstwp418:8090/svr/api/v1/Processextn/CompleteAssignment

ペイロードのリクエスト

{   "FileContent" : null,   "Decision": "Approved",   "Note": "Completed through PE",   "ProcessId": "07b25c54-d862-4270-af32-4654b321b3d7",   "AssignmentName": "Activity 3",   "Formfields":    {     "my:myFields":     {       "my:field_1": "test_new1",       "my:field_2": "test_new2",       "my:Repeating_Table_2":        {         "my:Repeating_Content":          {           "my:field_3": "R1_activity",           "my:field_4": "R2_activity"         }       }     }   } }

ユーザーが誤って POST 呼び出しではなく GET 呼び出しを行った場合のエラー サンプル:

{     "Message": "The requested resource does not support http method 'GET'." }

間違った割り当て ID が記載された場合のエラー サンプル:

[{"ErrorCode":"InvalidAssignment_AssignmentReassigned","Message":"Invalid assignment id: 07b25c54-d862-4270-af32-4654b321b3d7","errorPrameters":[]}]