手動の依存関係を追加および削除する API

リポジトリの My Docs、My Exes および My Scripts フォルダーの タスク Bot に対して、依存ファイルの追加や削除を手動で行うには、手動依存関係 API を使用します。

Control Room 管理者、または [スケジュール設定済みアクティビティを表示・管理] 権限を持つユーザーは、手動で依存関係を管理できます。手動依存関係 API では、次の操作を実行できます。

  1. 依存ファイルを親 タスク Bot に追加する
  2. 依存ファイルを親 タスク Bot から削除する
注: このトピックで示す例は、あくまでも参考用です。

依存関係 API にアクセスする前に、まず認証 API を使用し、これを特定の API を使用するためのトークンとして渡す必要があります。

  1. POST メソッドで、エンド ポイント http(s)://<hostname:port>/v1/authentication を使用してトークンを生成します。このために、Control Room インスタンスを、サーバー名/ホスト名/IP およびポート番号として指定します。

    例: https://crdevenv.com:81/v1/authentication

  2. 次の要求ペイロードをヘッダーに指定します。

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

  3. 次のリクエスト ペイロードを本文に指定します。

    {

    "username": "<Username>",

    "password": "<Password>"

    }

    例:

    {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

依存ファイルを追加する API

オートメーションの実行と導入を成功させるために、この API を使用して親 タスク Bot にファイルを追加します。

API エンド ポイント

次のエンド ポイントを使用して、API にアクセスします。

<Control Room URL>/v1/files/manualdependencies/add

例:

https://crdevenv.com:81/v1/files/manualdependencies/add

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. 導入 API を使用して、リポジトリに存在するファイルのリストを取得します。「Bot 実行オーケストレータ API」をご覧ください。
  3. POST メソッドを使用して、ファイル ID をリクエスト ペイロードとして本文に指定します。
     {
     "id": <parent file id>,
     "child_ids": [ <dependent file id 1>, <dependent file id 2> ]
     }
    次の例では、ID <..> の TaskBot に、ID <...> の依存ファイルを追加しています。
     {
     "id":10
     "child_ids":[18, 19]
     } 
  4. [送信] をクリックします。
  5. 応答ステータスが「200」であれば、アクションは正常に実行されています。
  6. 応答は本文データで確認できます。

パラメーターの説明

パラメーター 説明
id 親ファイルの ID
child_ids 子の手動依存関係 ID のコレクションです。

依存ファイルを削除する API

この API を使用して、依存ファイルを親 タスク Bot から削除します。

API エンド ポイント

次のエンド ポイントを使用して、API にアクセスします。

<Control Room URL>/v1/files/manualdependencies/remove

例: https://crdevenv.com:81/manualdependencies/remove

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. DELETE メソッドを使用して、次のリクエスト ペイロードを本文に指定します。
     {
     "id": 0,
     "child_ids": 0
     }

    次の例では、ID <..> の TaskBot から、ID <...> の依存ファイルを削除しています。

     {
     "id":
     "child_ids":
    }
  3. [送信] をクリックします。
  4. 応答ステータスが「200」であれば、アクションは正常に実行されています。
  5. 応答は本文データで確認できます。

パラメーターの説明

パラメーター 説明
id 親ファイルの ID
child_ids 子の手動依存関係 ID のコレクションです。