创建元数据,带全量属性列表

路径 /industry/metadata/create
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
corpId String 企业标识,每个企业拥有唯一的CorpID,比如钉钉corpID、SaaS应用里面的appId,用参数source来区分参数含义
userId String 员工在当前企业内的唯一标识,比如钉钉userId或者IoT的employeeId
name String 元数据名称
description String 元数据描述
multiVersion Boolean 元数据是否支持多版本
prefixNested Boolean 是否开启前缀表示层级关系。如果开启,唯一键必须是字符串类型
properties List 元数据的属性列表。创建元数据时,必须指定唯一键
propertyCode String 属性标识
propertyDesc String 属性名称
propertyType String 属性类型。目前支持的类型:INTEGER/DOUBLE/STRING/ENUM/BOOLEAN/MASTERDATA/FACTORY/TECHNOLOGY/WAREHOUSE
isNull Boolean 该属性字段是否允许为空
display Boolean 该属性字段是否为显示属性。一个元数据必须有一个显示属性
isUnique Boolean 该属性是否唯一键
array Boolean 该属性是否为多值属性。
defaultValue String 该属性的默认值。无论属性是什么类型,defaultValue都是字符串格式。
propertyLimit Struct 属性的限制信息。比如字符串类型的属性,这里可以指定长度限制
len Int 如果属性是字符串类型,该字段限制字符串的最大长度
min Double 如果属性是数值类型的 INTEGER/DOUBLE,这个表示它的最小值
max Double 如果属性是数值类型的 INTEGER/DOUBLE,这个表示它的最大值
dataId Long 如果属性类型是MASTERDATA,这个表示关联的元数据id
factoryType String 如果属性类型是FACTORY,这个表示具体的工厂模型的类型,可选的值 FACTORY/WORKSHOP/BELTLINE/MACHINING_CENTER
technologyType String 如果属性类型为TECHNOLOGY,这个表示具体的工艺路径类型。可选的值TECHNOLOGY/PROCESS/STEP
warehouseType String 如果属性类型为WAREHOUSE,这个字段表示具体的存库模型,可选值 WAREHOUSE/AREA/LOCATION
enumValues List 枚举类型的值列表
remark String 枚举类型值的描述信息
value String 枚举类型的值
booleanValues List 布尔类型的值列表
remark String 布尔类型值的描述信息
value String 布尔类型的值
propertyIndex Int 属性的显示顺序
source String DINGDING, SAAS 参数来源源,枚举值,钉钉填写DINGDING,多租户saas应用填SAAS,source、corpId、userId配合使用
platform String 标识行业平台还是区域平台,INDUSTRY_PLATFORM_OPERATION表示行业平台,REGION_PLATFORM_OPERATION表示区域平台
platformControl Boolean 元数据是否由平台管控.

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data Long

元数据id

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1"
	},
	"params":{
		"corpId": "value0",
		"userId": "value1",
		"name": "value2",
		"description": "value3",
		"multiVersion": "value4",
		"prefixNested": "value5",
		"properties": "value6",
		"source": "DINGDING, SAAS",
		"platform": "value8",
		"platformControl": "value9"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": 1234
}

异常返回示例

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