OC获取产品信息接口
路径 | /industry/product/info/get |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
productId | Long | 是 | 123456789 | 产品id |
corpId | String | 否 | 987656 | 企业唯一标识:如钉钉里的corpId,LH里的appId |
userId | String | 否 | 87656789 | 员工唯一标识:钉钉的userId、IOT的employeeId |
source | String | 否 | DINGDING | 钉钉填写DINGDING,多租户saas填写SAAS |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
productId | Long |
产品id |
|
productCode | String |
产品编码 |
|
productName | String |
产品名称 |
|
productModel | String |
产品型号 |
|
materialType | String |
物料类型 |
|
materialTypeName | String |
物料类型名称 |
|
measureUnit | String |
计量单位 |
|
processFlow | String |
工艺路径 |
|
processFlowName | String |
工艺路径名称 |
|
productDesc | String |
产品描述 |
|
productStatus | Int |
产品状态 |
|
version | Int |
产品版本 |
|
versionStatus | Int |
版本状态 |
|
source | String |
数据来源 |
|
picturesJson | String |
图片列表 |
|
annexesJson | String |
文件列表 |
|
customPropertiesJson | String |
产品扩展属性 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1"
},
"params":{
"productId":123456789,
"corpId": "987656",
"userId": "87656789",
"source": "DINGDING"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"customProperties":{
"自定义KEY_1":"自定义属性_1",
"自定义KEY_2":"自定义属性_2"
},
"files":[
"http://file.com/456789",
"http://file.com/456789"
],
"materialType":"男装编码",
"materialTypeName":"男装",
"measureUnit":"件",
"pictures":[
"http://pic.com/123456",
"http://pic.com/456789"
],
"processFlow":"工艺路径编码",
"processFlowName":"工艺路径名称",
"productCode":"产品编码",
"productDesc":"产品描述",
"productId":123456789,
"productModel":"产品型号",
"productName":"产品名称",
"productStatus":1,
"version":1,
"versionStatus":1
}
}
异常返回示例
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 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
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 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 460 | request forbidden | 请求被禁止 |
200 | 1009 | SQL invoke error | SQL 执行出错 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |