版权所有©，上海海鼎信息工程股份有限公司，2016-2026，保留所有权利。

接口

1. 接口定义

1.1. 业务对象属性服务

1.1.1. 删除业务对象属性

POST /{tenant_id}/soms/bizObjPropertyService/delete/byParam
1.1.1.1. 说明

删除业务对象属性

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

param
必填

删除参数

业务对象属性删除参数
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

soms标准响应Void
1.1.1.4. HTTP请求示例
请求 path
/string/soms/bizObjPropertyService/delete/byParam
请求 body
{
  "biz_type_eq" : "string",
  "biz_key_eq" : "string"
}
1.1.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.1.2. 取指定的业务对象属性

POST /{tenant_id}/soms/bizObjPropertyService/get/byParam
1.1.2.1. 说明

取指定的业务对象属性

1.1.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

param
必填

获取参数

BizObjPropertyGetParam
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

soms标准响应ListBizObjProperties
1.1.2.4. HTTP请求示例
请求 path
/string/soms/bizObjPropertyService/get/byParam
请求 body
{
  "biz_type_eq" : "string",
  "biz_key_eq" : "string",
  "obj_type_eq" : "string",
  "obj_key_eq" : "string",
  "biz_obj_in" : [ {
    "biz_type" : "string",
    "biz_key" : "string",
    "obj_type" : "string",
    "obj_key" : "string"
  } ],
  "prop_type_eq" : "string",
  "prop_id_in" : [ "string" ],
  "fetch_values" : true,
  "return_forest" : true
}
1.1.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : [ {
    "properties" : [ {
      "maintainer" : "string",
      "required" : true,
      "parameters" : [ {
        "name" : "string",
        "value" : "string"
      } ],
      "prop_id" : "string",
      "prop_name" : "string",
      "prop_desc" : "string",
      "upper_id" : "string",
      "value_type" : "string",
      "value_max_size" : 0,
      "value_example" : "string",
      "sub_properties" : [ {
        "maintainer" : "string",
        "required" : true,
        "parameters" : [ {
          "name" : "string",
          "value" : "string"
        } ],
        "prop_id" : "string",
        "prop_name" : "string",
        "prop_desc" : "string",
        "upper_id" : "string",
        "value_type" : "string",
        "value_max_size" : 0,
        "value_example" : "string",
        "sub_properties" : [ "..." ],
        "values" : [ {
          "sort" : 0,
          "state" : "string",
          "exception" : true,
          "value_id" : "string",
          "value_text" : "string",
          "exception_reason" : "string"
        } ]
      } ],
      "values" : [ {
        "sort" : 0,
        "state" : "string",
        "exception" : true,
        "value_id" : "string",
        "value_text" : "string",
        "exception_reason" : "string"
      } ]
    } ],
    "biz_obj" : {
      "biz_type" : "string",
      "biz_key" : "string",
      "obj_type" : "string",
      "obj_key" : "string"
    },
    "prop_type" : "string"
  } ]
}

1.1.3. 取指定的业务对象属性值

POST /{tenant_id}/soms/bizObjPropertyService/get/values/byParam
1.1.3.1. 说明

取指定的业务对象属性值

1.1.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

param
必填

获取参数

BizObjPropertyValuesGetParam
1.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

soms标准响应ListBizObjPropertyValues
1.1.3.4. HTTP请求示例
请求 path
/string/soms/bizObjPropertyService/get/values/byParam
请求 body
{
  "biz_type_eq" : "string",
  "biz_key_eq" : "string",
  "obj_type_eq" : "string",
  "obj_key_eq" : "string",
  "biz_obj_in" : [ {
    "biz_type" : "string",
    "biz_key" : "string",
    "obj_type" : "string",
    "obj_key" : "string"
  } ],
  "prop_type_eq" : "string",
  "prop_id_in" : [ "string" ]
}
1.1.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : [ {
    "biz_obj" : {
      "biz_type" : "string",
      "biz_key" : "string",
      "obj_type" : "string",
      "obj_key" : "string"
    },
    "property_values" : [ {
      "values" : [ {
        "sort" : 0,
        "state" : "string",
        "exception" : true,
        "value_id" : "string",
        "value_text" : "string",
        "exception_reason" : "string"
      } ],
      "prop_id" : "string",
      "prop_type" : "string"
    } ]
  } ]
}

1.1.4. 保存业务对象属性

POST /{tenant_id}/soms/bizObjPropertyService/save
1.1.4.1. 说明

保存业务对象属性

1.1.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

param
必填

保存参数

BizObjPropertySaveParam
1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

soms标准响应Void
1.1.4.4. HTTP请求示例
请求 path
/string/soms/bizObjPropertyService/save
请求 body
{
  "operator" : "string",
  "biz_obj_properties_list" : [ {
    "properties" : [ {
      "maintainer" : "string",
      "required" : true,
      "parameters" : [ {
        "name" : "string",
        "value" : "string"
      } ],
      "prop_id" : "string",
      "prop_name" : "string",
      "prop_desc" : "string",
      "upper_id" : "string",
      "value_type" : "string",
      "value_max_size" : 0,
      "value_example" : "string",
      "sub_properties" : [ {
        "maintainer" : "string",
        "required" : true,
        "parameters" : [ {
          "name" : "string",
          "value" : "string"
        } ],
        "prop_id" : "string",
        "prop_name" : "string",
        "prop_desc" : "string",
        "upper_id" : "string",
        "value_type" : "string",
        "value_max_size" : 0,
        "value_example" : "string",
        "sub_properties" : [ "..." ],
        "values" : [ {
          "sort" : 0,
          "state" : "string",
          "exception" : true,
          "value_id" : "string",
          "value_text" : "string",
          "exception_reason" : "string"
        } ]
      } ],
      "values" : [ {
        "sort" : 0,
        "state" : "string",
        "exception" : true,
        "value_id" : "string",
        "value_text" : "string",
        "exception_reason" : "string"
      } ]
    } ],
    "biz_obj" : {
      "biz_type" : "string",
      "biz_key" : "string",
      "obj_type" : "string",
      "obj_key" : "string"
    },
    "prop_type" : "string"
  } ],
  "delete_same_type_before_save" : true,
  "clean_values_before_save" : true
}
1.1.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.1.5. 保存业务对象属性值

POST /{tenant_id}/soms/bizObjPropertyService/save/values
1.1.5.1. 说明

保存业务对象属性值

1.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

param
必填

保存参数

BizObjPropertyValuesSaveParam
1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

soms标准响应Void
1.1.5.4. HTTP请求示例
请求 path
/string/soms/bizObjPropertyService/save/values
请求 body
{
  "operator" : "string",
  "biz_obj_property_values" : [ {
    "biz_obj" : {
      "biz_type" : "string",
      "biz_key" : "string",
      "obj_type" : "string",
      "obj_key" : "string"
    },
    "property_values" : [ {
      "values" : [ {
        "sort" : 0,
        "state" : "string",
        "exception" : true,
        "value_id" : "string",
        "value_text" : "string",
        "exception_reason" : "string"
      } ],
      "prop_id" : "string",
      "prop_type" : "string"
    } ]
  } ]
}
1.1.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

2. 定义

2.1. BizObj

业务对象

名称 说明 类型

biz_key
必填

业务key
样例 : "string"

string

biz_type
必填

业务类型
样例 : "string"

string

obj_key
必填

对象key
样例 : "string"

string

obj_type
必填

对象类型
样例 : "string"

string

2.2. BizObjProperties

业务对象属性

名称 说明 类型

biz_obj
必填

业务对象
样例 : BizObj

BizObj

prop_type
必填

属性类型
样例 : "string"

string

properties
必填

业务属性
样例 : [ "BizProperty" ]

< BizProperty > array

2.3. BizObjPropertyGetParam

业务对象属性获取参数

名称 说明 类型

biz_key_eq
可选

业务key等于，该字段和biz_obj_in必传其一
样例 : "string"

string

biz_obj_in
可选

业务对象in
样例 : [ "BizObj" ]

< BizObj > array

biz_type_eq
可选

业务类型等于，该字段和biz_obj_in必传其一
样例 : "string"

string

fetch_values
可选

是否级联获取属性值
默认值 : false
样例 : true

boolean

obj_key_eq
可选

对象key等于
样例 : "string"

string

obj_type_eq
可选

对象类型等于
样例 : "string"

string

prop_id_in
可选

属性Id in
样例 : [ "string" ]

< string > array

prop_type_eq
可选

属性类型等于
样例 : "string"

string

return_forest
可选

以森林结构返回
默认值 : false
样例 : true

boolean

2.4. BizObjPropertySaveParam

业务对象属性保存参数

名称 说明 类型

biz_obj_properties_list
必填

业务对象属性列表
样例 : [ "BizObjProperties" ]

< BizObjProperties > array

clean_values_before_save
可选

保存前删除旧值
默认值 : false
样例 : true

boolean

delete_same_type_before_save
可选

删除同类型属性属性
默认值 : false
样例 : true

boolean

operator
必填

操作人
样例 : "string"

string

2.5. BizObjPropertyValues

业务对象属性值

名称 说明 类型

biz_obj
可选

业务对象
样例 : BizObj

BizObj

property_values
可选

属性值
样例 : [ "BizPropertyValues" ]

< BizPropertyValues > array

2.6. BizObjPropertyValuesGetParam

业务对象属性值获取参数

名称 说明 类型

biz_key_eq
可选

业务key等于，该字段和biz_obj_in必传其一
样例 : "string"

string

biz_obj_in
可选

业务对象in
样例 : [ "BizObj" ]

< BizObj > array

biz_type_eq
可选

业务类型等于，该字段和biz_obj_in必传其一
样例 : "string"

string

obj_key_eq
可选

对象key等于
样例 : "string"

string

obj_type_eq
可选

对象类型等于
样例 : "string"

string

prop_id_in
可选

属性Id in
样例 : [ "string" ]

< string > array

prop_type_eq
可选

属性类型等于
样例 : "string"

string

2.7. BizObjPropertyValuesSaveParam

业务对象属性值保存参数

名称 说明 类型

biz_obj_property_values
必填

业务对象属性值列表
样例 : [ "BizObjPropertyValues" ]

< BizObjPropertyValues > array

operator
必填

操作人
样例 : "string"

string

2.8. BizProperty

业务属性

名称 说明 类型

maintainer
可选

限定的维护方
样例 : "string"

string

parameters
可选

自定义参数
样例 : [ "自定义参数" ]

< 自定义参数 > array

prop_desc
可选

属性说明
样例 : "string"

string

prop_id
必填

属性Id
样例 : "string"

string

prop_name
可选

属性名称
样例 : "string"

string

required
可选

是否必填
默认值 : false
样例 : true

boolean

sub_properties
可选

子属性
样例 : [ "BizProperty" ]

< BizProperty > array

upper_id
可选

上级属性Id
样例 : "string"

string

value_example
可选

示例值
样例 : "string"

string

value_max_size
可选

最多维护几个值
样例 : 0

integer (int32)

value_type
可选

值类型
样例 : "string"

string

values
可选

维护过的值
样例 : [ "BizValue" ]

< BizValue > array

2.9. BizPropertyValues

业务属性值

名称 说明 类型

prop_id
可选

属性ID
样例 : "string"

string

prop_type
可选

属性类型
样例 : "string"

string

values
可选

值
样例 : [ "BizValue" ]

< BizValue > array

2.10. BizValue

业务值

名称 说明 类型

exception
可选

是否有异常
默认值 : false
样例 : true

boolean

exception_reason
可选

异常原因
样例 : "string"

string

sort
可选

排序值
样例 : 0

integer (int32)

state
可选

状态
样例 : "string"

string

value_id
可选

值Id
样例 : "string"

string

value_text
可选

值文本
样例 : "string"

string

2.11. soms标准响应ListBizObjProperties

名称 说明 类型

code
可选

错误码
样例 : "string"

string

data
可选

数据
样例 : [ "BizObjProperties" ]

< BizObjProperties > array

message
可选

失败信息
样例 : "string"

string

success
可选

请求是否处理成功
默认值 : false
样例 : true

boolean

2.12. soms标准响应ListBizObjPropertyValues

名称 说明 类型

code
可选

错误码
样例 : "string"

string

data
可选

数据
样例 : [ "BizObjPropertyValues" ]

< BizObjPropertyValues > array

message
可选

失败信息
样例 : "string"

string

success
可选

请求是否处理成功
默认值 : false
样例 : true

boolean

2.13. soms标准响应Void

名称 说明 类型

code
可选

错误码
样例 : "string"

string

data
可选

数据
样例 : [_void]

Void

message
可选

失败信息
样例 : "string"

string

success
可选

请求是否处理成功
默认值 : false
样例 : true

boolean

2.14. 业务对象属性删除参数

名称 说明 类型

biz_key_eq
可选

业务key等于
样例 : "string"

string

biz_type_eq
可选

业务类型等于
样例 : "string"

string

2.15. 自定义参数

名称 说明 类型

name
可选

名称
样例 : "string"

string

value
可选

值
样例 : "string"

string