帮助中心
帮助中心主页
安装与部署
开发与集成
RDS脚本方法字典
分页查询天风任务实例列表

接口介绍

API可以分页查询天风任务实例列表

请求

  • 功能:分页查询天风任务实例列表
  • 方法:POST
  • 接口说明:/api/queryWindTask
json
POST "http://host:8080/api/queryWindTask"
1

请求头

NameTypeDescriptionRequired
languageString表示语言,不传则默认使用中文。(zh:中文,en:英文,ja-jp:日文)

请求参数

NameTypeDescriptionRequired
currentPageint查询页数
pageSizeint查询条数
queryParamObject查询参数对象
taskIdString天风任务id
defLabelString天风任务名称
taskRecordIdString天风任务实例id(运输任务id)
statusint任务状态(1000:运行中;1001:终止;1002:暂停;1003:结束;1004:异常结束)
agvIdString机器人id
startDateString任务开始时间(格式:yyyy-MM-dd HH:mm:ss)
endDateString任务结束时间(格式:yyyy-MM-dd HH:mm:ss)
isOrderDescBoolean是否以开始时间进行排序(默认false;false/true:倒叙/正序)

请求示例

查询英文环境下,任务状态为结束的任务,以时间倒序排序,按照每页2条记录进行分页,当前查询第2页的结果

请求头

keyvalue
languageen

Body参数

json
{
    "currentPage":2,
    "pageSize":2,
    "queryParam": {
        "taskId":"",
        "taskRecordId":"",
        "status":1003,
        "agvId":"",
        "startDate":"",
        "endDate":"",
        "isOrderDesc":true
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

响应

NameTypeDescription
codeintAPI 错误码,详情见 API 错误码
msgStringAPI 错误码信息
dataObject返回的数据对象
totalCountint表示查询到的任务的总数
currentPageint表示当前结果的页码,如果参数currentPage为null,此返回值就为null
pageSizeint表示当前页可记录的任务的最大数量
taskRecordIdString实例ID
statusString任务实例的状态
agvIdString执行任务的agvId
taskLabelString天风任务的名称
createDateString实例创建时间
endDateString实例运行结束时间
firstExecutorTimeString机器人开始执行时间
executorTimeString机器人总共耗费时间
taskLabelVersionString任务类型
descriptionString运行描述

响应数据示例

Responses Code 200

json
{
    "code": 200,
    "msg": "Success",
    "data": {
        "totalCount": 24,
        "currentPage": 2,
        "pageSize": 2,
        "totalPage": 12,
        "pageList": [
            {
                "taskRecordId": "d08e7710-0237-425b-bb0a-f07caf96e6b2",
                "status": "Finished",
                "agvId": "sim_01",
                "taskLabel": "A2B",
                "createDate": "2022-05-06 14:49:32",
                "endDate": "2022-05-06 14:50:09",
                "firstExecutorTime": "2022-05-06 14:50:09",
                "executorTime": 32,
                "taskLabelVersion": "A2B[v2]",
                "description": "[RootBp]End Of Task"
            },
            {
                "taskRecordId": "9687262c-2433-4415-954c-ae8b932e4159",
                "status": "Finished",
                "agvId": null,
                "taskLabel": "cacheTest",
                "createDate": "2022-05-06 15:16:30",
                "endDate": "2022-05-06 15:16:30",
                "firstExecutorTime": "",
                "executorTime": 0,
                "taskLabelVersion": "cacheTest[v4]",
                "description": "[RootBp]End Of Task"
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
最近更新 2022/11/28
文章内容

接口介绍

请求

请求头

请求参数

请求示例

查询英文环境下,任务状态为结束的任务,以时间倒序排序,按照每页2条记录进行分页,当前查询第2页的结果

响应

响应数据示例

Responses Code 200