获取指定车间信息
路径 | /industry/modelling/workshop/info/get |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
id | Long | 否 | 车间id(code和id二选一) | |
code | String | 否 | 车间编码(code和id二选一) | |
appId | String | 否 | {"appId”:”xxxxx”} | 应用id |
employeeId | String | 否 | {"employeeId”:”xxxxx”} | 用户id,需要做用户级别鉴权时需要传入此参数 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
id | Long |
车间id |
|
name | String |
车间名称 |
|
code | String |
车间编码 |
|
desc | String |
车间描述 |
|
createTime | String |
创建时间 |
|
modifyTime | String |
更新时间 |
|
parentId | Long |
父亲节点id |
|
parentType | String |
父亲节点类型 |
|
attrs | JSON |
扩展属性 |
|
id | Long |
属性id |
|
name | String |
属性名称 |
|
enName | String |
属标识 |
|
value | String |
属性值 |
|
createTime | String |
创建时间 |
|
modifyTime | String |
更新时间 |
|
flag | String |
发布状态(unpublish-待发布,publish-已发布,archive-已归档) |
示例
请求示例
// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");
SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
IoTApiRequest request = new IoTApiRequest();
// 设置请求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 设置API版本号
request.setApiVer("1.0.1");
// 设置参数
request.putParam("id", "value0");
request.putParam("code", value1");
request.putParam("appId", value2");
request.putParam("employeeId", value3");
// 如果需要,设置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");
// 设置请求参数域名, path, request, isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/industry/modelling/workshop/info/get", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例
JSON
格式
{
"code": 200,
"data": {
"code": "newCJ0528",
"modifyTime": "2019-06-17 15:13:29",
"createTime": "2019-05-28 19:05:48",
"name": "新的车间0528",
"id": 135,
"parentId": 10731,
"parentType": "factory",
"desc": "ddassds",
"attrs": [
{
"modifyTime": "2019-08-07 14:51:16",
"createTime": "2019-08-07 14:51:16",
"name": "车间属性",
"enName": "code",
"id": 38091,
"value": "100"
}
]
},
"id": "2241eb15406345d7a9e4cdb32fa1fe96"
}
异常返回示例
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 | 28800 | The maximum number of resource that you can create is exceeded. | 已达创建资源的上限。 |
200 | 28804 | Duplicate name. | 该名称已经存在,请重新命名。 |
200 | 460 | request parameter error. | 参数错误。 |
200 | 28805 | Invalid name. | 仅支持大小写英文字母、汉字、数字和空格。 |
200 | 28805 | Invalid name. | 仅支持字母、数字和汉字 |
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 | 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 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
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 | 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 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 1009 | SQL invoke error | SQL 执行出错 |