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

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

自動化スケジュール API のリスト

  • 更新済み: 2021/01/26

    自動化スケジュール API のリスト

    表示する権限があるオートメーション スケジュールの詳細を取得します。

    前提条件

    注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
    • 認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
    • すべてのスケジュール設定済みアクティビティを自分のフォルダーから表示および管理する」権限を含むロールが割り当てられている必要があります。

    この例では、スケジュールされたすべてのオートメーションを次の実行日時順に並べ替えてリストします。

    手順

    1. リクエスト ヘッダーに認証トークンを追加します。
    2. POST メソッドとエンドポイント URL: <control_room_url>/v1/schedule/automations/list を使用します。
      リクエスト本文:
      {
         "sort":[
            {
               "field":"zonedNextRunDateTime",
               "direction":"asc"
            }
         ]
      }
    3. リクエストを送信します。
      レスポンス本文: レスポンスには、各オートメーションに関する次のデータが含まれます。
      • id: オートメーションを識別する数値。このパラメーターは、オートメーションの更新またはオートメーションの削除 API で使用します。
      • status: スケジュールされたオートメーションが ACTIVE (アクティブ) か INACTIVE (非アクティブ) かを返します。
      {
          "page": {
              "offset": 0,
              "total": 3,
              "totalFilter": 3
          },
          "list": [
              {
                  "id": "661",
                  "name": "eodReport_28.20.10.12.23.02.48",
                  "fileId": "6598",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "DAILY",
                  "dailyRecurrence": {
                      "interval": 3
                  },
                  "timeZone": "America/Los_Angeles",
                  "startDate": "2020-10-12",
                  "endDate": "",
                  "startTime": "23:30",
                  "repeatEnabled": true,
                  "repeatOccurrence": {
                      "runEvery": "3",
                      "timeUnit": "HOURS",
                      "endTime": "23:59"
                  },
                  "zonedNextRunDateTime": "2021-01-14T07:30:00Z",
                  "createdBy": "251",
                  "createdOn": "2020-10-13T06:01:51.992433Z",
                  "updatedBy": "251",
                  "updatedOn": "2021-01-11T07:30:00.082057Z",
                  "tenantId": "1",
                  "fileName": "wlm_28",
                  "filePath": "Automation Anywhere\\Bots\\West Coast",
                  "runAsUserIds": [
                      "251"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "23"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              },
              {
                  "id": "990",
                  "name": "accounts.20.12.16.10.51.59",
                  "fileId": "12501",
                  "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\\APAC",
                  "runAsUserIds": [
                      "80",
                      "36",
                      "1103"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "7"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              },
              {
                  "id": "989",
                  "name": "UpdateInventory.20.12.16.10.40.48",
                  "fileId": "11201",
                  "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\\spreadsheets",
                  "runAsUserIds": [
                      "480",
                      "80",
                      "472"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "11"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              }
          ]
      }
      REST API は、HTTP レスポンス コードで各リクエストに応答します。 レスポンス コードについては、API レスポンス コード を参照してください。
    フィードバックを送る