Automation 360

API タスクオンデマンドエンドポイント

PDF としてダウンロード

コンテンツ

API タスクオンデマンドエンドポイント

PDF としてダウンロード

最終更新日2024/10/31

API タスクオンデマンドエンドポイント

API タスクをエンドポイントで即座に呼び出します。オンデマンドリクエストと連動して、デプロイ API を使って API タスクをオンデマンドで動的に起動し、実行します。このアプローチによってワークフローは合理化され、従来の静的なデプロイに比べてリソース効率が向上します。

主なメリット

プログラム的デプロイ: お好みの API クライアントを使用して、オンデマンドでどこからでも API タスクをデプロイします。
処理:
- オートメーションは必要なときだけ有効になり、リソースの最適利用が保証されます。つまり、常にクラウド上に配置されることはなく、リソースが節約されます。その代わり、リクエストごとにロードされて実行されます。
- 高負荷時には、オートメーションはキューに入り、デバイスが利用可能になるとすぐに実行されるため、高負荷時でも円滑なオペレーションが保証されます。オートメーションの進行状況は、アクティビティページで確認できます。
- プレミアムライセンスではオートメーションが拡張され、クラウドリソースの大規模なプールにアクセスして API タスクの複数のインスタンスを実行できるため、並行性が高まり、より多くの API タスクリクエストを同時に処理できるようになります。
理想的な事例:
- バッチ処理ジョブ (販売データの分析、レポートの作成など)
- スケジュールを設定したタスク
- 即答が重要でない状況

注: プロセス内でオンデマンド API タスクデプロイを有効にするには、[管理] > [設定] > [Bot エージェントの一括インストール] > [新しいキーの生成] で登録キーを生成し、[変更を保存] をクリックします。

認証

デプロイ API とのやり取りのために必要な認証資格情報を取得します。一般的には、アクセストークンや API キーが含まれます。次のサンプルでは、API タスクがクラウドデバイスにオンデマンドでデプロイされます。また、変数は、デプロイされたときに Bot に渡すこともできます。

POST https://{{ControlRoomURL}}/v4/automations/deploy

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

すべての API 呼び出しには、認証 API による認証トークン (JSON Web トークンを生成)、または OAuth サービスによるベアラートークンのいずれかが必要です。API で両方を同時に使用することはできません。

オンデマンドリクエストの作成

リクエスト

{
  "botId": 121,
  "automationName": "SAMPLE_APITASK",
  "description": "My first API Task deploy using api",
  "botLabel": "string",
  "executionType": "RUN_NOW",
  "automationPriority": "PRIORITY_MEDIUM",
  "headlessRequest": {
    "numberOfExecutions": 1,
    "queueOnSlotsExhaustion": false,
    "sharedRunAsUserId": 12
  },
  "botInput": {
    "inputVar": {
      "type": "STRING",
      "string": "PassingString"
    }
  }
}

注:

オートメーションのデプロイリクエストは、入力フィールドなしでも可能です。入力を指定する場合、API タスクがこれらのマッピングされた値を正常に受信することを確認します。そのオートメーション用の変数は入力としてマークされている必要があります。さらに、API タスクの変数名は、リクエスト本文にマッピングされる値と一致しなければなりません。

リクエストパラメーター


パラメーター	タイプ	必須	説明
botId	Integer	はい	デプロイされるオートメーションの ID。
automationName	文字列	いいえ	デプロイされるオートメーションの名前。オートメーションを簡単に識別するために、名前を入力できます。`SAMPLE_APITASK`、 `FIRST_API_TASK`、`apitask-on-demand` のように入力してください。
description	文字列	いいえ	デプロイされたオートメーションの説明。例: `My first API Task deploy using api`
botLabel	文字列	いいえ	デプロイされたオートメーションのラベル。
executionType	文字列	いいえ	Bot に関連する実行タイプ。
automationPriority	文字列	いいえ	自動化の優先度。これはデフォルトでは `PRIORITY_MEDIUM` に設定されています。automationPriority に指定できる値には、以下のようなものがあります。`PRIORITY_MEDIUM`、`PRIORITY_HIGH`、`PRIORITY_LOW`。
headlessRequest オブジェクト。
numberOfExecutions	Integer	いいえ	指定されたオンデマンド (ヘッドレス) リクエストの実行回数。
queueOnSlotsExhaustion	ブール型	いいえ	デプロイをキューに入れるかどうかを指定します。
sharedRunAsUserId	Integer	いいえ	API タスクの RunAsUser コンテキストを確立する apitaskrunner。apitaskrunner の詳細については、「API タスクの実行ユーザー (apitaskrunner)」を参照してください。注: この RunAsUser には、Bot Runner ライセンスは不要です。
botInput オブジェクト
タイプ	任意	いいえ	デフォルトでは `STRING` です。タイプに指定できる値は次のとおりです。`STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY, and WORKITEM.`

レスポンス

{
  "deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
  "automationName": "SAMPLE_APITASK"
}

レスポンスパラメーター


パラメーター	タイプ	説明
deploymentId	文字列	作成されたデプロイ ID。
automationName	文字列	デプロイされたオートメーションの名前。この名前がリクエストで提供されない場合、デプロイされたオートメーションにはランダムな名前が割り当てられます。