ロボットグループ一覧を取得
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/group/list |
専用クラウドを利用する企業は、専用クラウドのアドレスを使用してください |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | 説明 | |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証APIが返すaccess Tokenに置き換える必要があります |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須 | 説明 |
|---|---|---|---|---|
| key | string | キーワードによるあいまい検索です。like "xx%"と同じ動作で、現在はロボットグループの名称にのみ有効です | いいえ | キーワードによるあいまい検索です。like "xx%"のように、右側を任意とする前方一致検索に対応しています |
| page | Integer | ページ分割パラメータです。最初のページを指定します | いいえ | デフォルトは1で、最初のページから始まります |
| size | Integer | ページ分割パラメータです。1ページあたりの件数を指定します | いいえ | デフォルトは20で、1ページあたり20件です |
リクエスト例
ロボットのuuidを指定して取得する例:
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| msg | string | はい | ステータスコードの説明 |
| data | array | はい | レスポンスデータ |
| ∟ robotClientGroupUuid | string | はい | ロボットグループのuuid |
| ∟ robotClientGroupName | string | はい | ロボットグループの名称 |
| page | objects | はい | ページ分割情報 |
| ∟ total | int | はい | ページ分割対象の総件数 |
| ∟ size | int | はい | 1ページあたりの件数 |
| ∟ page | int | はい | ページ番号 |
| ∟ pages | int | はい | 分割後のページ数 |
| ∟ offset | int | はい | ページ分割のオフセット |
レスポンスボディの例
{
"data": [
{
"uuid": "a3d67252-6795-4a69-99ef-bce60e67xxxd",
"name": "double11",
}
],
"page": {
"total": 5,
"size": 20,
"page": 1,
"pages": 1,
"offset": 0,
"order": "desc"
},
"code": 200,
"success": true
}
エラーが発生した場合は、次のリンクに移動してください:ステータスコードの説明