获取工艺设计下的指定步骤

路径 /industry/modelling/step/info/get
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
id Long {"id":123} 指定步骤id(调用时code、id二选一)
code String {"code":"code123"} 指定步骤编码(调用时code、id二选一)
appId String {"appId":"xxxxxx"} 应用id
employeeId String 用户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/step/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": "code1",
    "modifyTime": "2019-04-09 17:13:11",
    "createTime": "2019-04-09 17:13:11",
    "name": "加工步骤1",
    "id": 8486,
    "parentId": 7454,
    "parentType": "process",
    "desc": "加工步骤描述",
    "attrs": [
      {
        "modifyTime": "2019-04-09 17:13:32",
        "createTime": "2019-04-09 17:13:32",
        "name": "属性名称1",
        "enName": "code1",
        "id": 34765,
        "value": "属性值"
      }
    ]
  },
  "id": "897faaedcb0c40c499e4e099c783d373"
}

异常返回示例

JSON 格式

{
  "code": 600410,
  "id": "61577883f9a044c797eb841df1d6fd85",
  "localizedMsg": "步骤不存在 traceId 6a0b1fd515548011057487279e",
  "message": "step does not exist traceId 6a0b1fd515548011057487279e"
}

错误码

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 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 执行出错