ロボット実行の開始
この記事の内容
ロボットの起動
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
- 認証APIを使用してaccessTokenを取得し、対応するhearderに設定する必要があります。
- 新規作成したユーザーアカウントは、事前に一度スケジューリングモードに入っている必要があります。
説明:このAPIは、ロボットまたはロボットグループと、実行する単一のロボットを指定するもので、単純なスケジューリングのシナリオに適しています。複数のロボットで複数のロボットを実行するなど、複雑なシナリオでは、スケジュールタスクAPIの機能を使用することをお勧めします。また、ロボットの実行情報は、コンソールの「API実行」でコールバックAPIを設定するか、ロボット実行詳細の照会APIを使用して取得できます。
重要な説明
Dr.Roboでは、入力パラメータのサイズに制限があります。通常、すべての入力パラメータの合計を8000以下にすることをお勧めします。入力パラメータがしきい値を超える場合は、次の2つの方法で解決できます。
方法1: 入力パラメータを分割できます。例えば、ECのシナリオで1000件の注文番号を渡して1回で呼び出す場合、100件の注文番号ごとに分割して呼び出し、1回のリクエストを10回に分けることができます。
方法2: 長いテキストをファイルタイプに変換して渡すことができます。
ステップ1:クライアントを開き、RPAフローを編集して、文字列タイプのパラメータをファイルパスのパラメータタイプに変更します。
ステップ2:ロボットを保存し、バージョンをリリースします。
ステップ3:テキストパラメータをファイルに変換してDr.Roboのファイルサーバーにアップロードします(ファイルをアップロード)。このAPIはファイルのkey値を返します。
ステップ3:APIを呼び出す際に、パラメータタイプ(type)をfileタイプに変更し、ステップ3で取得したファイルのkey値を渡します。
テンプレート
postManテンプレート
APIによるロボットの起動.json(右クリックして「名前を付けて保存」)
Javaテンプレート
リクエストモデル:JobStartReq.java(右クリックして「名前を付けて保存」)
レスポンスモデル:JobStartRep.java(右クリックして「名前を付けて保存」)
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/job/start | 専有クラウドをご利用の企業は、専有クラウドのアドレスを使用してください。 |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証APIが返すaccessTokenに置き換える必要があります。 |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須 | 説明 |
|---|---|---|---|---|
| accountName | string | ロボットアカウント名 | いいえ | accountNameとrobotClientGroupUuidは排他的で、いずれか一方を指定します。accountNameは、コンソールの「ロボット管理」一覧で名称をコピーして取得できます。 |
| robotClientGroupUuid | string | ロボットグループ名 | いいえ | accountNameとrobotClientGroupUuidは排他的で、いずれか一方を指定します。robotClientGroupUuidは、コンソールの「ロボットグループ」一覧でUUIDをコピーして取得できます。 |
| robotUuid | string | ロボットuuid | はい | コンソールにログインし、「ロボット管理」でロボットの詳細を表示してuuidをコピーします。 |
| idempotentUuid | string | 冪等性uuid | いいえ | ネットワークリクエストのタイムアウトによってタスクが重複して起動されることを防ぐため、このリクエストの冪等性uuidを指定できます。Dr.Roboは、同じ冪等性uuidを持つリクエストが複数回送信された場合、作成に成功するのが1回だけになるように判定します。uuidの使用をお勧めします。また、長さは36文字を超えてはいけません。 |
| waitTimeout | string | 待機タイムアウト時間(近日廃止予定) | いいえ | 待機タイムアウトです。jobのキュー待機時間を指定できます。待機タイムアウトの説明 |
| waitTimeoutSeconds | number | 待機タイムアウト時間(秒単位) | いいえ | 待機タイムアウト時間です。単位は秒で、最小設定値は60(1分)、最大設定値は950400(11日)、デフォルト値は600(10分)です。 |
| runTimeout | number | ロボット実行タイムアウト | いいえ | ロボットの実行開始から自動停止までの時間を指定できます。通常、ロボットの実行時間が制御できなくなったり、フリーズしたりして、キュー内のタスクの実行に影響を与えることを防ぐために使用します。最小設定値は60、最大設定値は950400で、単位は秒です。クライアント5.10以降のバージョンと併用する必要があります。 |
| priority | string | キューの優先度 | いいえ | このパラメータで、待機キュー内のjobの優先度を指定できます。待機キューの優先度の説明を参照してください。デフォルトはmiddleです。 |
| executeScope | string | 実行範囲です。ロボットグループにのみ適用されます。 | いいえ | any:ロボットグループ内のランダムに選ばれた1つのロボットで実行します。 all:ロボットグループ内のすべてのロボットで実行します。 |
| params | object | ロボット実行パラメータ | いいえ | 合計5種類のロボットパラメータに対応しています。paramsの最大対応長は10000です。ロボット実行パラメータの説明を参照してください。専有クラウドの6.0.0より前のバージョンでは3000、それ以降のバージョンでは8000に対応しています。 |
| ∟ name | string | パラメータ名 | いいえ | パラメータ名です。 |
| ∟ value | string | パラメータ値 | いいえ | パラメータ値です。 |
| ∟ type | string | パラメータタイプ | いいえ | パラメータタイプです。ロボット実行パラメータの列挙値の説明を参照してください。 |
accountNameとrobotClientGroupUuidの両方が指定された場合は、ロボットグループが優先されます。
リクエスト例
{
"accountName": "admin@fckj",
"robotUuid": "73d9a119-7ec7-4226-b679-506afefae667",
"idempotentUuid":"69ba7c82-4087-42ca-b1ce-bd117bfea097",
"waitTimeout":"10m",
"executeScope":"any",
"priority": "middle",
"params":[
{
"name":"获取页数",
"value":"10",
"type":"str"
}
]
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を表します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを表します。このフィールドに基づいて、API呼び出しが成功したかどうかを判断できます。 |
| msg | string | はい | ステータスコードの説明です。 |
| data | object | はい | レスポンスデータです。 |
| ∟ jobUuid | string | はい | ロボット実行uuidです。後で実行を停止したり、実行ステータスを照会したりする際の入力パラメータとして使用します。 |
| ∟ idempotentFlag | boolean | はい | 冪等性による作成かどうかを表すフラグです。trueの場合は重複リクエストであることを表します。入力パラメータidempotentUuidと併用します。 |
レスポンスボディの例
{
"data": {
"jobUuid": "fc38f4f1-8444-475e-83f8-3292eeb1606b",
"idempotentFlag": true
},
"code": 200,
"success": true
}
エラーが発生した場合は、ステータスコードの説明を参照してください。