Browse AI

Retrieve a robot's bulk runs list

开发环境

http://dev-cn.your-api-server.com

GET

/robots/{robotId}/bulk-runs

bulk runs

Retrieve a robot's bulk runs list.

请求示例

Java

Objective-C

Shell

curl --location --request GET 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e/bulk-runs' \
--header 'authorization: Bearer YOUR_SECRET_API_KEY'

响应示例

200 - 示例 1

{
    "statusCode": 200,
    "messageCode": "success",
    "result": {
        "totalCount": 20,
        "pageNumber": 1,
        "hasMore": true,
        "items": [
            {
                "id": "f6fb62b6-f06a-4bf7-a623-c6a35c2e70b0",
                "title": "Bulk Run Title",
                "tasksCount": 10,
                "robotId": "4f5cd7ff-6c98-4cac-8cf0-d7d0cb050b06",
                "createdAt": 1678795867879
            }
        ]
    }
}

请求参数

Path 参数

robotId

string

必需

Unique robot ID

You can find a robot's ID by opening it on the dashboard and copying its ID in the browser address bar.

示例值:

c3689adb-50aa-44af-b265-a7e0d4e5846e

Query 参数

page

integer

可选

Page number

Header 参数

authorization

string

必需

You can generate a new API key on your dashboard if you do not have one.

示例值:

Bearer YOUR_SECRET_API_KEY

返回响应

🟢200A JSON object containing the bulk runs list.

application/json

Body

statusCode

enum<number>

必需

枚举值:

200

messageCode

enum<string>

必需

枚举值:

success

result

object (BulkRuns)

必需

totalCount

integer

必需

Total number of bulk runs a robot has had.

示例值:

pageNumber

integer

必需

Current page number.

示例值:

hasMore

boolean

必需

Whether there are more bulk runs on the next page.

示例值:

true

items

array[object (BulkRun) {5}]

必需

🟠400A JSON containing error attributes. This will happen if any of the parameters are not valid.

🟠401The request is not authorized

🟠404The resource is not found

修改于 2024-02-20 02:11:12

Bulk run tasks

Retrieve a robot's bulk run