タスクの起動
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
認証APIを使用してaccessTokenを取得し、対応するヘッダーに設定する必要があります。
説明:このAPIを使用するには、コンソールでタスクを新規作成し、ロボットと実行ロボットの構成を設定する必要があります。より複雑なスケジューリングに適しています。このAPIは、外部からロボットの実行パラメータを渡すことにも対応しています。ロボットが複数ある場合は、各ロボットの実行パラメータを設定する必要があります。サービス内部のロジックは、robotUuidに基づいて渡されたロボットの実行パラメータを取り出し、そのままクライアントに渡します。
重要な説明
Dr.Roboでは、入力パラメータのサイズに制限があります。通常、すべての入力パラメータの合計が8000を超えないことを推奨します。入力パラメータがしきい値を超える場合は、次の2つの方法で解決できます。
方法1: 入力パラメータを分割できます。例えば、EC業務で1000件の注文番号を渡して1回で呼び出す場合、100件の注文番号ごとに分割して呼び出し、1回のリクエストを10回に分けることができます。
方法2: 長文をファイル形式に変換して渡すことができます。
手順1:クライアントを開き、RPAフローを変更して、文字列タイプのパラメータをファイルパスタイプのパラメータに変更します。
手順2:ロボットを保存してバージョンをリリースします。
手順3:テキストパラメータをファイルに変換し、Dr.Roboのファイルサーバーにアップロードすると(ファイルをアップロード)、ファイルのkey値が返されます。
手順3:APIの呼び出し時に、パラメータタイプ(type)をfileタイプに変更し、手順3で取得したファイルのkey値を渡します。
テンプレート
postManテンプレート
apiタスクの起動.json(右クリックして「名前を付けて保存」)
Javaテンプレート
リクエストモデル:TaskStartReq.java(右クリックして「名前を付けて保存」)
レスポンスモデル:TaskStartRep.java(右クリックして「名前を付けて保存」)空
ロボットに関連付けられた実行パラメータのモデル:RobotRelaParam.java(右クリックして「名前を付けて保存」)
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/task/start | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください。 |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | accessToken変数は、認証APIから返されたaccessTokenに置き換える必要があります。 |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須かどうか | 説明 |
|---|---|---|---|---|
| scheduleUuid | string | タスクのuuid | はい | 起動するタスクのuuidです。コンソールの「タスク管理」で右クリックして取得できます。 |
| idempotentUuid | string | 冪等性uuid | いいえ | 今回のリクエストの冪等性uuidです。ネットワークの再試行によってタスクの実行が複数回トリガーされることを防ぐため、uuidの使用を推奨します。Dr.Roboが2回のリクエストで同じ冪等性idを検出した場合、実行は1回のみとなり、2回目には前回のtaskUuidが返されます。 |
| scheduleRelaParams | array | タスク実行に関連付けられたロボットのパラメータ | いいえ | タスクには複数のロボットの実行パラメータを設定できます。配列構造で、robotUuidと対応するロボットのパラメータを指定する必要があります。指定しない場合は、デフォルトのロボット実行パラメータが使用されます。 |
| ∟ robotUuid | string | ロボットのuuid | いいえ | 実行パラメータを持つロボットのuuidです。 |
| ∟ runTimeout | number | ロボットの実行タイムアウト | いいえ | ロボットの実行開始から自動停止するまでの時間を指定できます。通常、ロボットの実行時間を制御できなくなったり、フリーズしたりして、待機中のタスクの実行に影響することを防ぐために使用します。設定可能な最小値は60、最大値は950400で、単位は秒です。クライアントのバージョン5.10以降と組み合わせて使用する必要があります。 |
| ∟ params | array | ロボットの実行パラメータ | いいえ | このロボットに関連付けられたロボットの実行パラメータです。長さは最大8000を超えることはできません。 |
| ∟ name | string | パラメータ名 | いいえ | パラメータ名です。 |
| ∟ value | string | パラメータ値 | いいえ | パラメータ値です。ファイルタイプの場合は、ファイルアップロードAPIというファイルアップロードAPIを使用して先にファイルをアップロードし、レスポンスのfileKeyをパラメータ値として渡すことができます。 |
| ∟ type | string | パラメータタイプ | いいえ | パラメータタイプです。ロボット実行パラメータの列挙値の説明を参照してください。 |
実行パラメータを指定する場合は、robotUuidを必ず指定する必要があります。
リクエスト例
// APIでタスクを呼び出します
{
"scheduleUuid": "79985266-f37a-4bb1-b456-b928914d3437",
"idempotentUuid":"adss82cb-3333-111-1112-asdsad",
"scheduleRelaParams": [
{
"robotUuid": "8ccc82cb-3945-4c7e-bb02-ab4ba4b183fd",
"runTimeout":456,
"params": [
{
"name": "str1",
"value": "测试1",
"type": "str"
}
]
}
]
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須かどうか | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。ステータスコードの説明を参照してください。 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドに基づいて、APIの呼び出しが成功したかどうかを判断できます。 |
| msg | string | はい | ステータスコードの説明です。 |
| data | object | はい | レスポンスデータです。 |
| ∟ taskUuid | string | はい | タスク実行のuuidです。 |
| ∟ jobUuidList | array | はい | タスク内の各ロボットの実行記録のuuidの集合です。 |
| ∟ idempotentFlag | boolean | はい | 冪等性による作成かどうかを示すフラグです。trueの場合は重複作成を示します。入力パラメータのidempotentUuidと組み合わせて使用します。 |
レスポンスボディの例
{
"data": {
"taskUuid": "fc38fbsa-8333-1111-83f8-3292aaaaaa",
"jobUuidList": ["fd57564f-11f5-4035-a20f-b2838fcc0b05", "d64b1246-f0ef-436e-a948-01c325614e16"],
"idempotentFlag": false
},
"code": 200,
"success": true
}
エラーが発生した場合は、ステータスコードの説明に移動してください。