API の実行 Bot スケジュール

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

PDF をダウンロード

API の実行 Bot スケジュール

Bot を Unattended Bot Runner で 1 回実行するか、繰り返し実行するかのスケジュールを設定します。

前提条件

注: Community Edition で Control Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。

すべての API 呼び出しは、リクエストヘッダーに認証トークンを含める必要があります。認証 API を使用して JSON Web トークンを生成します。「認証 API」を参照してください。
次のリソースが割り当てられていることを確認します。
- [マイ Bot の表示と実行] 機能権限
- Bot を含むフォルダーの [実行とスケジュール] 権限
- Bot Runner のライセンスを付与されたユーザーへのアクセス。
- デフォルトデバイスまたはデバイスプールへのアクセス
  注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、Bot はそのデバイスにデプロイされます。デフォルトデバイスが割り当てられていない場合、または別のデバイスを選択する場合、デバイスプールを指定する必要があります。

Bot をスケジュールするには、API に次の情報を提供します。


パラメーター	必須	タイプ	説明
fileId	はい	数字	Bot の識別子。ワークスペース API 別にファイルとフォルダーを一覧表示
runAsUserIds	はい	数字	Control Room に Unattended bot runner として登録されているユーザーの識別子。利用可能な Unattended Bot Runner API のリスト
status	はい	文字列	アクティブスケジュールとドラフトスケジュールのどちらを作成するかを指定します。`ACTIVE` または `DRAFT` のいずれかを入力します。
poolIds	いいえ	数字	少なくとも 1 つのアクティブなデバイスを持つデバイスプールの識別子。注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、Bot はそのデバイスにデプロイされます。デフォルトデバイスが割り当てられていない場合、または別のデバイスを選択する場合、デバイスプールを指定する必要があります。デバイスプール API のリスト
overrideDefaultDevice	いいえ	Boolean	Bot Runner ユーザーがデフォルトデバイスに割り当てられていて、デバイスプールを指定する場合、このパラメーターを `true` に設定します。デフォルトデバイスにデプロイする場合、このパラメーターを `false` に設定します。

手順

リクエストヘッダーに認証トークンを追加します。

POST メソッドとエンドポイント URL (<control_room_url>/v1/schedule/automations。

リクエスト本文:

このリクエスト本文の例には、Bot を 1 回実行するようにスケジュールするための必須パラメーターが含まれています。

{
   "name":"UpdateInventory.20.12.16.10.40.48",
   "fileId":14277,
   "poolIds":[
      "27"
   ],
   "timeZone":"Asia/Calcutta",
   "runAsUserIds":[
      "472",
      "480",
      "80"
   ],
   "startDate":"2020-12-16",
   "startTime":"15:00",
   "scheduleType":"NONE",
   "status":"ACTIVE"
   }

このリクエスト本文の例には、Bot が繰り返し実行するようにスケジュールするために必要なパラメーターが含まれています。

{
   "name":"UpdateInventory.20.12.16.10.40.48",
   "fileId":14277,
   "poolIds":[
      "27"
   ],
   "timeZone":"Australia/Melbourne",
   "runAsUserIds":[
      "1103",
      "36",
      "80"
   ],
   "startDate":"2020-12-16",
   "repeatOccurrence":{
      "endTime":"23:59",
      "runEvery":"1",
      "timeUnit":"HOURS"
   },
   "repeatEnabled":true,
   "endDate":"2020-12-24",
   "startTime":"20:45",
   "weeklyRecurrence":{
      "interval":"1",
      "daysOfWeek":[
         "TUE",
         "THU",
         "FRI"
      ]
   },
   "scheduleType":"WEEKLY",
   "status":"ACTIVE"
}

リクエストを送信します。

レスポンス本文: 2 つのレスポンスの例には、オートメーションについての以下の情報が含まれています。

id: オートメーションを識別する数値。このパラメーターは、Update automations または Delete automations API で使用します。
zonedNextRunDateTime: Bot が次に実行される予定の日時

これは、Bot を 1 回実行するようにスケジュールするレスポンスの例です。

{
    "id": "989",
    "name": "UpdateInventory.20.12.16.10.40.48",
    "fileId": 14277,
    "status": "ACTIVE",
    "deviceIds": [],
    "description": "",
    "rdpEnabled": false,
    "scheduleType": "NONE",
    "timeZone": "Asia/Calcutta",
    "startDate": "2021-12-16",
    "endDate": "",
    "startTime": "15:00",
    "repeatEnabled": false,
    "zonedNextRunDateTime": "2021-12-16T09:30:00Z",
    "createdBy": "1103",
    "createdOn": "2021-01-11T18:57:18.932407Z",
    "updatedBy": "1103",