编码发生器API - Code Generator
功能介绍
调用编码生成器,生成编码。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /unidata/public/api/v1/geninfo/createExternalGen
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 通过基础服务接口获取到的Token |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| genCode | 是 | String | 生成器代码 |
| objJson | 否 | JSONObject | 编码生成器包含对象编码属性时使用,objJson里面的值是对象编码中定义的属性值,支持多个属性 "objJson": "{\"Category_Code\": \"0303\",\"Model_Number\": \"modelNumber\"}" |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 状态码 |
| message | String | 调用返回信息 |
| i18n | String | 国际化 |
| data | JSONObject | 接口返回结果,包含序号5到42内容 |
| ruleInfo | List<Map<String, Object>> | 规则集合信息 |
| headId | String | 首标识Id |
| expandRule | JSONObject | 规则,包含序号8到17内容 |
| idPrefix | String | Id标识前缀 |
| headerSequence | String | 首序列 |
| stepSize | Integer | 步长 |
| createNum | Integer | 生成数量 |
| tailSequence | String | 尾序列 |
| idSuffix | String | Id标识后缀 |
| numberRules | String | 进制规则 |
| characterSet | String | 进制字符集 |
| deHeaderSequence | Integer | 首序列十进制值 |
| deTailSequence | Integer | 尾序列十进制值 |
| traceKey | String | 追踪信息 |
| status | Integer | 生成器的状态:
|
| genId | String | 生成器Id |
| genCode | String | 生成器代码 |
| genName | String | 生成器名称 |
| genClassName | String | 生成器分类名称 |
| siteId | String | 工厂Id |
| objectAttrCode | String | 对象属性码 |
| objectAttrValue | String | 对象属性值 |
| createNum | Integer | 生成数量 |
| idList | List<String> | 生成编码集合 |
| code | String | 返回信息代码 |
| message | String | 信息 |
| seqLength | String | 流水长度 |
| lastIdValue | String | 最新Id标识码 |
| idGroupValue | String | 流水分组标示 |
| idSegmentValue | String | 流水分段标示 |
| tenantId | String | 租户Id |
| dataClass | String | 对象类 |
| barcode | String | Id条码 |
| parseInfo | List<String> | 条码解析后信息 |
| objJson | String | 对象JSON |
| genLabelCode | String | 标签Code |
| genClassCode | String | 生成器分类Code |
| iconId | String | 生成器iconId |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 结果 |
| data | String | 日期 |
| errors | List<String> | 错误信息包含“code”、“message”、“detailMessage”、“args” |
| code | String | 错误码 |
| message | String | 错误信息 |
| detailMessage | String | 详细信息 |
| args | String | - |
| pageInfo | Object | 分页信息 |
请求示例
{
"genCode": "GEN0005",
"objJson": "{\"Category_Code\": \"0807\"}"
} 响应示例
{
"status": "200",
"message": "success",
"i18n": null,
"data": {
"ruleInfo": null,
"headId": null,
"expandRule": {
"idPrefix": "0807",
"headerSequence": "0001",
"stepSize": 1,
"createNum": 1,
"tailSequence": "0001",
"idSuffix": "",
"numberRules": "10",
"characterSet": "0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F,G,H,J,K,L,M,N,P,Q,R,S,T,U,V,W,X,Y,Z",
"deHeaderSequence": 1,
"deTailSequence": 1
},
"traceKey": null,
"status": 30,
"genId": "1792828105460658176",
"genCode": "GEN0005",
"genName": "Part分类生成器",
"genClassName": null,
"siteId": "-1",
"objectAttrCode": null,
"objectAttrValue": null,
"createNum": null,
"idList": [
"08070001"
],
"code": null,
"message": "success",
"seqLength": null,
"lastIdValue": null,
"idGroupValue": null,
"idSegmentValue": null,
"tenantId": "PDM",
"dataClass": null,
"barcode": null,
"parseInfo": null,
"objJson": null,
"genLabelCode": null,
"genClassCode": null,
"iconId": "975cbf40-8eed-4287-92a1-5886737b24ed"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功返回SUCCESS |
| 400 | 参数校验错误返回ERROR消息 |
错误码
请参见错误码。