ロボット一覧を取得

この記事の内容
  1. 事前操作
  2. テンプレート
  3. postManテンプレート
  4. Javaテンプレート
  5. リクエスト
  6. リクエストヘッダー
  7. リクエストボディ
  8. リクエスト例
  9. レスポンス
  10. レスポンスボディ
  11. レスポンスボディの例

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

事前操作

​ 認証APIを使用してaccessTokenを取得し、対応するヘッダーに入力する必要があります。

説明: このAPIは、パラメータを指定して、自社内のすべてのロボットを絞り込んで取得できます。返されるフィールドには、状態、名称、およびロボットが存在する端末の情報が含まれます。ロボット管理モジュールの構築に使用できるほか、アイドル状態のロボットを絞り込んでタスクを割り当てるためにも使用できます。

テンプレート

postManテンプレート

Javaテンプレート

​ リクエストモデル:

​ レスポンスモデル:

リクエスト

基本 説明
HTTP URL https://api.example.com/oapi/dispatch/v2/client/list 専用クラウドを利用する企業は、専用クラウドのアドレスを使用してください
HTTP Method POST

リクエストヘッダー

基本 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証APIが返すaccess Tokenに置き換える必要があります
Content-Type application/json

リクエストボディ

名称 タイプ 説明 必須 説明
status string ロボットの状態 いいえ ロボットの状態です。ロボットの状態の列挙値の説明を参照してください
key string キーワードによるあいまい検索です。現在はロボットの名称にのみ有効です いいえ キーワードによるあいまい検索です。現在はロボットの名称にのみ有効で、robotClientNameと同じです
robotClientGroupUuid string ロボットグループのuuid いいえ ロボットグループのuuid
page Integer ページ分割パラメータです。最初のページを指定します はい ページ番号
size Integer ページ分割パラメータです。1ページあたりの件数を指定します はい 1ページあたりの件数

リクエスト例

{
  "page":1,
  "size": 10
}

レスポンス

レスポンスボディ

名称 タイプ 必須 説明
code int はい ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明
success boolean はい 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます
msg string はい ステータスコードの説明
data array はい レスポンスデータ
∟ robotClientUuid string はい ロボットのuuid
∟ robotClientName string はい ロボットの名称です。accountNameと同じです
∟ status string はい ロボットの状態です。ロボットの状態の列挙値の説明を参照してください
∟ description string いいえ ロボットの備考説明
object いいえ クライアント端末の情報
∟ windowsAccount string いいえ クライアントのシステムアカウント
∟ clientIp string いいえ クライアントのシステムip
∟ machineName string いいえ クライアントのシステムのhost名称

レスポンスボディの例

{
  "data": [{
    "robotClientUuid": "xxx",
    "robotClientName": "admin@ydsc",
    "status": "idle",
    "description": "rpa001",
    "windowsUserName": "by",
    "clientIp": "127.0.0.1",
    "machineName": "RPA-PC"
  }],
  "page": {
    "total": 100,
    "size": 10,
    "page": 1,
    "pages": 10
  },
  "code": 0,
  "success": true,
  "msg": "success"
}

エラーが発生した場合は、次のリンクに移動してください:ステータスコードの説明

OpenAPIの記事一覧ページの先頭へ ↑