Automation 360

API Task オンデマンドエンドポイント

PDF としてダウンロード

コンテンツ

API Task オンデマンドエンドポイント

PDF としてダウンロード

最終更新日2025/07/01

API Task オンデマンドエンドポイント

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

注: API Tasks はインタラクティブフォームをサポートしていません。

主なメリット

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

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

認証

デプロイ API とのやり取りのために必要な認証資格情報を取得します。一般的には、アクセストークンや API キーが含まれます。次のサンプルでは、API Taskがクラウドデバイスにオンデマンドでデプロイされます。また、変数は、デプロイされたときに 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 Taskがこれらのマッピングされた値を正常に受信することを確認します。そのオートメーション用の変数は入力としてマークされている必要があります。さらに、API Taskの変数名は、リクエスト本文にマッピングされる値と一致しなければなりません。

リクエストパラメーター


パラメーター	タイプ	必須	説明
botId	Integer	はい	デプロイされるオートメーションの ID を入力してください。自動化をエディタで開くと、アドレスバーに ID が表示されます。
自動化名	文字列	いいえ	自動化を作成したときに使用した名前を入力してください。
description	文字列	いいえ	自動化を作成したときに使用した説明を入力してください。
botLabel	文字列	いいえ	自動化でチェックインした際に適用したラベルを入力してください。 `Production` または `N/A` を入力できます。
executionType	文字列	いいえ	Bot に関連付けられた実行タイプを入力します。次のいずれかの実行タイプを入力できます。 `RUN_NOW` `RUN_WITH_QUEUE` `RUN_WITH_EVENT_TRIGGERS`
automationPriority	文字列	いいえ	自動化実行の優先度を入力してください。次のいずれかの優先度を入力できます。 `PRIORITY_MEDIUM` `PRIORITY_HIGH` `PRIORITY_LOW` デフォルトの優先度は `PRIORITY_MEDIUM` に設定されています。
headlessRequest オブジェクト。
numberOfExecutions	Integer	いいえ	指定されたオンデマンド (ヘッドレス) リクエストの実行回数を入力してください。
queueOnSlotsExhaustion	ブール型	いいえ	デプロイメントをキューに入れる必要があるかどうかを指定するには、`True` または `False` を入力してください。
sharedRunAsUserId	Integer	いいえ	API Tasksの`RunAsUser`コンテキストを確立するために、`apitaskrunner`ユーザーのユーザー ID を入力してください。ユーザー詳細をユーザーを編集ページで編集すると、ユーザー ID がアドレスバーに表示されます。 apitaskrunner の詳細については、「API Task の実行ユーザー (apitaskrunner)」を参照してください。注: `RunAsUser` には Bot Runner ライセンスは必要ありません。
botInput オブジェクト
type	任意	いいえ	入力変数の種類を入力します。以下のいずれかの変数型を入力できます。 `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`、`WORKITEM` などがあります。
string	文字列	いいえ	`STRING` 変数の入力として使用する必要がある文字列を入力してください。

レスポンス

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

レスポンスパラメーター


パラメーター	タイプ	説明
deploymentId	文字列	Bot のデプロイ中に生成されるデプロイメント ID です。
自動化名	文字列	デプロイされたオートメーションの名前。リクエストにオートメーション名を含めない場合、デプロイされたオートメーションにはランダムな名前が割り当てられます。