Automation Anywhere ドキュメントを読んで確認する

Automation Anywhere Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

API の実行botスケジュール

  • 更新済み: 1/28/2021
    • Automation 360 v.x
    • 最新情報
    • RPA Workspace

API の実行botスケジュール

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

前提条件

注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
  • 認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
  • 次のリソースが割り当てられていることを確認します。
    • [マイ Bot の表示と実行] 機能権限
    • bots を含むフォルダーの [実行とスケジュール] 権限
    • Bot Runner のライセンスを付与されたユーザーへのアクセス。
    • デフォルト デバイスまたはデバイス プールへのアクセス
      注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、bot はそのデバイスにデプロイされます。デフォルト デバイスが割り当てられていない場合、または別のデバイスを選択する場合、デバイス プールを指定する必要があります。

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

パラメーター 必須 タイプ 説明
fileId はい Number bot の識別子。 ワークスペース API 別にファイルとフォルダーを一覧表示
runAsUserIds はい Number Control RoomUnattended Bot Runner として登録されているユーザーの識別子
poolIds いいえ 数値 少なくとも 1 つのアクティブなデバイスを持つデバイス プールの識別子。
注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、bot はそのデバイスにデプロイされます。デフォルト デバイスが割り当てられていない場合、または別のデバイスを選択する場合、デバイス プールを指定する必要があります。
デバイス プール API の一覧表示

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
  2. 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"
       }
    このリクエスト本文の例には、 が繰り返し実行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"
    }
  3. リクエストを送信します。
    レスポンス本文: 2 つのレスポンスの例には、オートメーションについての以下の情報が含まれています。
    • id: オートメーションを識別する数値。このパラメーターは、オートメーションの更新またはオートメーションの削除 API で使用します。
    • zandedNextRunDateTime: 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",
        "updatedOn": "2021-01-11T18:57:18.932422Z",
        "tenantId": "1",
        "fileName": "appsheet",
        "filePath": "Automation Anywhere\\Bots\\appsheet",
        "runAsUserIds": [
            "480",
            "80",
            "472"
        ],
        "botInput": {},
        "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
        "poolId": [
            "11"
        ],
        "overrideDefaultDevice": false,
        "runElevated": false
    }
    これは、bot を繰り返し実行されるようにスケジュールするレスポンスの例です。
    {
        "id": "990",
        "name": "UpdateInventory.20.12.16.10.40.48",
        "fileId": "14277",
        "status": "ACTIVE",
        "deviceIds": [],
        "description": "",
        "rdpEnabled": false,
        "scheduleType": "WEEKLY",
        "weeklyRecurrence": {
            "interval": 1,
            "daysOfWeek": [
                "TUE",
                "THU",
                "FRI"
            ]
        },
        "timeZone": "Australia/Melbourne",
        "startDate": "2021-01-16",
        "endDate": "2021-12-24",
        "startTime": "20:45",
        "repeatEnabled": true,
        "repeatOccurrence": {
            "runEvery": "1",
            "timeUnit": "HOURS",
            "endTime": "23:59"
        },
        "zonedNextRunDateTime": "2021-01-19T09:45:00Z",
        "createdBy": "1103",
        "createdOn": "2021-01-11T18:59:31.182663Z",
        "updatedBy": "1103",
        "updatedOn": "2021-01-11T18:59:31.182669Z",
        "tenantId": "1",
        "fileName": "a_trigger",
        "filePath": "Automation Anywhere\\Bots\\a_trigger",
        "runAsUserIds": [
            "80",
            "36",
            "1103"
        ],
        "botInput": {},
        "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
        "poolId": [
            "7"
        ],
        "overrideDefaultDevice": false,
        "runElevated": false
    } 
    REST API は、HTTP レスポンス コードで各リクエストに応答します。 レスポンス コードについては、API レスポンス コード を参照してください。

次のステップ

自動化スケジュール API のリスト を使用して、スケジュールされたすべてのオートメーションの詳細を取得します。
フィードバックを送る