分页查询工厂日历班次列表信息
路径 | /industry/factorycalendar/shift/query |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
pageNo | Int | 是 | 1 | 当前页码 |
pageSize | Int | 是 | 50 | 每页条数,最大200个 |
ftyModelValue | Int | 是 | 1 | 工厂模型层级值,工厂1,车间2,产线3,加工中心4,设备5 |
ftyModelId | Long | 是 | 1 | 工厂模型ID |
corpId | String | 否 | 企业标识,每个企业拥有唯一的CorpID | |
userId | String | 否 | 员工在当前企业内的唯一标识 | |
source | String | 否 | DINGDING | 源,枚举值,如DINGDING,SAAS等 |
agentId | String | 否 | 企业应用ID | |
platForm | String | 否 | 平台参数,包括手机型号信息,屏幕信息等 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
total | Long |
查询结果的记录总数 |
|
data | JSON |
符合条件的班次列表 |
|
id | Long |
班次ID |
|
beginEffectiveDate | String |
开始生效日期,格式为yyyy-MM-dd |
|
endEffectiveDate | String |
结束生效日期,格式为yyyy-MM-dd |
|
beginTime | String |
开始时间,格式为HH:mm:ss |
|
endTime | String |
结束时间,格式为HH:mm:ss |
|
description | String |
班次描述 |
|
ftyModelId | Long |
工厂模型ID |
|
ftyModelValue | Int |
工厂模型层级值,工厂1,车间2,产线3,加工中心4,设备5 |
|
ftyModelName | String |
工厂模型名称 |
|
name | String |
班次名称 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1"
},
"params":{
"pageNo":1,
"pageSize":50,
"ftyModelValue":1,
"ftyModelId":1,
"corpId": "value4",
"userId": "value5",
"source": "DINGDING",
"agentId": "value7",
"platForm": "value8"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"total": 1,
"data": [{
"id": 1,
"ftyModelId": 123,
"ftyModelValue": 1,
"ftyModelName": "测试的工厂",
"name": "日班",
"beginTime": "08:00:00",
"endTime": "16:00:00",
"beginEffectiveDate": "2019-10-01",
"description": "日班的备注"
}]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |