同步操作将从 WeBank/we-cmdb 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
提供统一接口定义,为使用者提供清晰明了的使用方法
枚举
配置
权限
其他
新增枚举类别
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of EnumCatTypeDto | 是 | 枚举类别实体列表,不包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of EnumCatTypeDto | 枚举类别实体列表,包含资源唯一ID |
正常输入:
[
{
"callbackId":"123456",
"catTypeName": "system_design",
"ciTypeId": 1,
"description": "系统设计私有枚举类别",
"type": 3
}
]
正常输出:
{
"statusCode": "OK",
"data": [
{
"callbackId": "123456",
"catTypeName": "system_design",
"ciTypeId": 1,
"description": "系统设计私有枚举类别",
"type": 3,
"catTypeId": 47
}
]
}
无效输入:
[
{
"callbackId":"123456",
"catTypeName": "system_design",
"ciTypeId": 1,
"description": "系统设计私有枚举类别",
"type": 3
}
]
异常输出:
{
"statusCode": "ERR_BATCH_CHANGE",
"statusMessage": "Fail to create [1] records, detail error in the data block",
"data": [
{
"callbackId": "123456",
"errorMessage": "Fail to create record with callbackId = [123456], error = [Duplicate cat type name [system_design] found, not allow to add/update.]"
}
]
}
查询枚举类别
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of catTypeDto | 枚举类别实体列表 |
正常输入:
{
"filterRs": "and",
"filters": [
{
"name": "catTypeName",
"operator": "eq",
"value": "sys"
}
]
}
正常输出:
{
"statusCode": "OK",
"data": {
"pageInfo": {
"startIndex": 0,
"pageSize": 10000,
"totalRows": 1
},
"contents": [
{
"catTypeId": 1,
"catTypeName": "sys",
"type": 1,
"cats": []
}
]
}
}
无效输入:
{
"filterRs": "and",
"filters": [
{
"name": "invalidFilterName",
"operator": "eq",
"value": "sys"
}
]
}
异常输出:
{
"statusCode": "ERR_INVALID_ARGUMENT",
"statusMessage": "Can not find out field [invalidFilterName] for domain ."
}
更新枚举类别
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of EnumCatTypeDto | 否 | 枚举类别实体列表,必须包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of EnumCatTypeDto | 枚举类别实体列表 |
正常输入:
[
{
"callbackId":"123456",
"catTypeId": 47,
"catTypeName": "system_design",
"ciTypeId": 1,
"description": "系统设计私有枚举类别",
"type": 3
}
]
正常输出:
{
"statusCode": "OK",
"data": [
{
"callbackId": "123456",
"catTypeName": "system_design",
"ciTypeId": 1,
"description": "系统设计私有枚举类别",
"type": 3,
"catTypeId": 47,
"cats":[]
}
]
}
无效输入:
[
{
"callbackId":"123456",
"catTypeName": "system_design",
"ciTypeId": 1,
"description": "系统设计私有枚举类别",
"type": 3
}
]
异常输出:
{
"statusCode": "ERR_BATCH_CHANGE",
"statusMessage": "Fail to update [1] records, detail error in the data block",
"data": [
{
"callbackId": "123456",
"errorMessage": "Fail to update record with callbackId = [123456], error = [Field 'catTypeId' is required.]"
}
]
}
删除枚举类别
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 资源唯一ID列表 |
参数名称 | 类型 | 描述 |
---|---|---|
data | string | 成功信息"Success" |
statusMessage | string | 异常信息,无异常则不返回该属性 |
正常输入:
[
47
]
正常输出:
{
"statusCode": "OK",
"data": "Success"
}
无效输入:
[
9999
]
异常输出:
{
"statusCode": "ERROR",
"statusMessage": "Unable to find com.webank.cmdb.domain.AdmBasekeyCatType with id 9999"
}
新增枚举目录
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of EnumCatDto | 是 | 枚举目录实体列表,不包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of EnumCatDto | 枚举目录实体列表,包含资源唯一ID |
查询枚举目录
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of EnumCatDto | 枚举目录实体列表 |
更新枚举目录
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of EnumCatDto | 否 | 枚举目录实体列表,必须包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of EnumCatDto | 枚举目录实体列表 |
删除枚举目录
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 资源唯一ID列表 |
参数名称 | 类型 | 描述 |
---|---|---|
data | string | 成功信息"Success" |
statusMessage | string | 异常信息,无异常则不返回该属性 |
新增枚举名称/值
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of EnumCodeDto | 是 | 枚举名称/值实体列表,不包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of EnumCodeDto | 枚举名称/值实体列表,包含资源唯一ID |
查询枚举名称/值
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of EnumCodeDto | 枚举名称/值实体列表 |
更新枚举名称/值
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of EnumCodeDto | 否 | 枚举名称/值实体列表,必须包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of EnumCodeDto | 枚举名称/值实体列表 |
删除枚举名称/值
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 资源唯一ID列表 |
参数名称 | 类型 | 描述 |
---|---|---|
data | string | 成功信息"Success" |
statusMessage | string | 异常信息,无异常则不返回该属性 |
新增配置项类型
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of CiTypeDto | 是 | 配置项类型实体列表,不包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of CiTypeDto | 配置项类型实体列表,包含资源唯一ID |
查询配置项类型
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of CiTypeDto | 配置项类型实体列表 |
更新配置项类型
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of CiTypeDto | 否 | 配置项类型实体列表,必须包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of CiTypeDto | 配置项类型实体列表 |
删除配置项类型
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 资源唯一ID列表 |
参数名称 | 类型 | 描述 |
---|---|---|
data | string | 成功信息"Success" |
statusMessage | string | 异常信息,无异常则不返回该属性 |
新增配置项类型属性
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of CiTypeAttrDto | 是 | 配置项类型属性实体列表,不包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of CiTypeAttrDto | 配置项类型属性实体列表,包含资源唯一ID |
查询配置项类型属性
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of CiTypeAttrDto | 配置项类型属性实体列表 |
更新配置项类型属性
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of CiTypeAttrDto | 否 | 配置项类型属性实体列表,必须包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of CiTypeAttrDto | 配置项类型属性实体列表 |
删除配置项类型属性
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 资源唯一ID列表 |
参数名称 | 类型 | 描述 |
---|---|---|
data | string | 成功信息"Success" |
statusMessage | string | 异常信息,无异常则不返回该属性 |
新增配置项
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ciTypeId | integer | 是 | URL path里的ciTypeId为配置项类型ID, 即为该配置项类型新增一个或多个配置项 |
Array | Array of Map<key,value> | 是 | 配置项实体列表,不包含资源唯一ID. |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of Map<key,value> | 配置项实体列表,包含资源唯一ID |
查询配置项
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ciTypeId | integer | 是 | URL path里的ciTypeId为配置项类型ID, 即为该配置项类型新增一个或多个配置项 |
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of Map<key,value>) | 配置项实体列表 |
更新配置项
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ciTypeId | integer | 是 | URL path里的ciTypeId为配置项类型ID, 即为该配置项类型新增一个或多个配置项 |
Array | Array of Map<key,value> | 否 | 配置项实体列表,必须包含资源唯一ID |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of Map<key,value> | 配置项实体列表 |
删除配置项
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ciTypeId | integer | 是 | URL path里的ciTypeId为配置项类型ID, 即为该配置项类型新增一个或多个配置项 |
Array | Array of integer | 是 | 资源唯一ID列表 |
参数名称 | 类型 | 描述 |
---|---|---|
data | string | 成功信息"Success" |
statusMessage | string | 异常信息,无异常则不返回该属性 |
根据条件查询用户
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
request | QueryRequest | 否 | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of UserDto | 配置项类型属性实体列表 |
新增用户
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
userDtos | Array of UserDto | 否 | 用户信息 |
参数名称 | 类型 | 描述 |
---|---|---|
userDtos | Array of UserDto | 用户信息 |
查询所有权限
参数名称 | 类型 | 描述 |
---|---|---|
request | QueryRequest | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of RoleDto | 角色信息 |
新建角色
参数名称 | 类型 | 描述 |
---|---|---|
roleDtos | Array of RoleDto | 角色信息 |
参数名称 | 类型 | 描述 |
---|---|---|
contents | Array of RoleDto | 角色信息 |
根据角色id删除角色
参数名称 | 类型 | 描述 |
---|---|---|
requestIds | Array of Integer | 角色id |
修改角色信息
参数名称 | 类型 | 描述 |
---|---|---|
roleDtos | Array of Map<key,value> | 角色信息 |
参数名称 | 类型 | 描述 |
---|---|---|
contents | Array of RoleDto | 角色信息 |
查询用户角色
参数名称 | 类型 | 描述 |
---|---|---|
request | QueryRequest | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of RoleUserDto | 角色信息 |
将角色授予用户
参数名称 | 类型 | 描述 |
---|---|---|
roleUsers | Array of RoleUserDto | 角色信息 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleUserDto | 角色信息 |
删除角色
参数名称 | 类型 | 描述 |
---|---|---|
requestIds | Array of Integer | 用户角色id |
查询角色的配置项权限信息
参数名称 | 类型 | 描述 |
---|---|---|
request | QueryRequest | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of RoleCiTypeDto | 角色配置项权限信息 |
给角色授予配置项权限
参数名称 | 类型 | 描述 |
---|---|---|
roleCiTypes | Array of RoleCiTypeDto | 角色配置项权限信息 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleCiTypeDto | 角色配置项权限信息 |
修改角色的授予配置项权限
参数名称 | 类型 | 描述 |
---|---|---|
request | Array of Map<key,value> | 角色配置项权限信息 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleCiTypeDto | 角色配置项权限信息 |
删除角色的配置项权限
参数名称 | 类型 | 描述 |
---|---|---|
requestIds | Array of Integer | 配置项权限id |
查询配置项属性权限信息
参数名称 | 类型 | 描述 |
---|---|---|
request | QueryRequest | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of RoleCiTypeCtrlAttrDto | 角色配置项属性权限信息 |
新增配置项属性权限
参数名称 | 类型 | 描述 |
---|---|---|
roleCiTypeCtrlAttrs | Array of RoleCiTypeCtrlAttrDto | 配置项属性权限信息 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleCiTypeCtrlAttrDto | 配置项属性权限信息 |
修改配置项属性权限
参数名称 | 类型 | 描述 |
---|---|---|
request | Array of Map<key,value> | 配置项属性权限信息 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleCiTypeDto | 配置项属性权限信息 |
删除角色的配置项权限
参数名称 | 类型 | 描述 |
---|---|---|
requestIds | Array of Integer | 配置项属性id |
查询配置项属性权限生效条件信息
参数名称 | 类型 | 描述 |
---|---|---|
request | QueryRequest | 请求参数对象 |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of RoleCiTypeCtrlAttrConditionDto | 配置项属性权限生效条件信息 |
新增配置项属性权限生效条件
参数名称 | 类型 | 描述 |
---|---|---|
roleCiTypeCtrlAttrConditions | Array of RoleCiTypeCtrlAttrConditionDto | 配置项属性权限生效条件 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleCiTypeCtrlAttrConditionDto | 配置项属性权限生效条件信息 |
修改配置项属性权限生效条件
参数名称 | 类型 | 描述 |
---|---|---|
request | Array of Map<key,value> | 配置项属性权限生效条件信息 |
参数名称 | 类型 | 描述 |
---|---|---|
Array | Array of RoleCiTypeCtrlAttrConditionDto | 配置项属性权限信息 |
删除配置项属性权限生效条件
参数名称 | 类型 | 描述 |
---|---|---|
requestIds | Array of Integer | 配置项属性生效条件id |
根据查询id查询综合查询
参数名称 | 类型 | 描述 |
---|---|---|
queryId | Integer | 综合查询id |
参数名称 | 类型 | 描述 |
---|---|---|
response | IntegrationQueryDto | 综合查询 |
保存综合查询
参数名称 | 类型 | 描述 |
---|---|---|
ciTypeId | Integer | 配置项id |
queryName | String | 综合查询名称 |
intQueryDto | IntegrationQueryDto | 综合查询 |
参数名称 | 类型 | 描述 |
---|---|---|
int | int | 新增综合查询结果 |
修改综合查询
参数名称 | 类型 | 描述 |
---|---|---|
queryId | int | 综合查询id |
intQueryDto | IntegrationQueryDto | 综合查询 |
删除综合查询
参数名称 | 类型 | 描述 |
---|---|---|
queryId | int | 综合查询id |
ciTypeId | Integer | 配置项id |
执行综合查询
参数名称 | 类型 | 描述 |
---|---|---|
queryId | Integer | 综合查询id |
参数名称 | 类型 | 描述 |
---|---|---|
data | PageInfo | 分页信息 |
contents | Array of Map<key,value> | 综合查询的查询结果 |
根据图标id查询图标
参数名称 | 类型 | 描述 |
---|---|---|
imageId | int | 图标id |
response | HttpServletResponse | 输出流 |
上传图标
参数名称 | 类型 | 描述 |
---|---|---|
file | MultipartFile | 图标文件 |
查询配置项状态常量
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | String | 查询结果 |
Array | Array of String | 配置项状态常量 |
正常返回:
{
"statusCode": "OK",
-"data": [
"notCreated",
"created",
"dirty",
"decommissioned"
]
}
查询引用类型常量
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | String | 查询结果 |
Array | Array of String | 引用类型常量 |
正常返回:
{
"statusCode": "OK",
-"data": [
"association",
"composition",
"aggregation",
"dependence"
]
}
查询输入类型常量
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | String | 查询结果 |
Array | Array of String | 输入类型常量 |
正常返回:
{
"statusCode": "OK",
-"data":[
"text",
"date",
"textArea",
"select",
"multiSelect",
"ref",
"multiRef",
"number",
"orchestration_multi_ref",
"orchestration_ref"
]
}
获取有效状态常量
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | String | 查询结果 |
data | Array of String | 有效状态常量 |
正常返回:
{
"statusCode": "OK",
-"data": [
"active",
"inactive"
]
}
创建所有待创建(状态为:notCreated)的配置项类型及其属性所对应的物理表及属性列
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
statusMessage | string | 异常信息,无异常则不返回该属性 |
创建指定的配置项类型及其属性所对应的物理表及属性列
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 配置项类型ID列表,见CiTypeDto.ciTypeId |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
statusMessage | string | 异常信息,无异常则不返回该属性 |
创建指定的配置项类型属性所对应的物理表的属性列
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 配置项类型属性ID列表,见CiTypeAttrDto.ciTypeAttrId |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
statusMessage | string | 异常信息,无异常则不返回该属性 |
配置项状态变化操作,根据配置项类型所对应的状态机允许的状态进行变化操作
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Array | Array of integer | 是 | 配置项类型ID列表,见CiTypeDto.ciTypeId |
operation | string | 是 | 操作名称 - insert: 插入, delete: 删除, update: 更新,discard: 废弃, confirm: 确认, startup: 启动, stop: 停止 注:状态机不同,所对应的操作集合会不同 |
参数名称 | 类型 | 描述 |
---|---|---|
statusCode | string | 状态码 - OK: 成功, ERROR: 失败,ERR_INVALID_ARGUMENT: 无效参数错误,ERR_BATCH_CHANGE: 批量处理错误 |
data | Array of Map<key,value> | 配置项实体列表 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
dialect/data | object | 否 | 方言数据,也称为额外数据 |
dialect/showCiHistory | boolean | 否 | 是否请求历史数据, 默认:false |
filterRs | string | 否 | 默认:and 过滤器的关系 -- and: 与关系, or: 或关系 |
filters | Array of Filter | 否 | 过滤器 |
groupsBys | Array of string | 否 | 分组查询 |
Pageable | Pageable | 否 | 每页信息 |
paging | boolean | 否 | 请求结果是否要分页 |
refResources | Array of string | 否 | 跨资源名称列表,为跨资源查询之用 |
resultsColumns | Array of string | 否 | 请求结果属性列表 |
sorting/asc | boolean | 否 | 是否升序排列,默认:true |
sorting/field | string | 否 | 排序属性名 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
name | string | 是 | 资源属性名 |
operator | string | 是 | 过滤操作符,目前支持:in/contains/eq/gt/lt/ne/notNull/null |
value | object | 否 | 根据操作符变化,如operator为eq, value即要求是对象, 如operator为contains, value即要求为列表 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
pageSize | integer | 否 | 每页显示记录行数 |
startIndex | integer | 否 | 开始页码索引 |
totalRows | integer | 否 | 总共记录数 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
pageSize | integer | 否 | 每页显示记录行数 |
startIndex | integer | 否 | 开始页码索引 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
callbackId | string | 否 | 入参唯一索引ID, 作为出参提取对应数据的依据 |
errorMessage | string | 否 | 出参异常信息,无异常则不返回该属性 |
catTypeId | integer | 是 | 实体ID, 新增时由系统产生,更新和删除时必选 |
catTypeName | string | 是 | 枚举类别名称 |
ciTypeId | integer | 否 | 所属配置项ID, 即该配置项的私有枚举类别 |
type | integer | 否 | 枚举类别的类型 - 1:系统枚举 2:公共枚举 3:私有枚举 |
description | string | 否 | 枚举类别的描述 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
callbackId | string | 否 | 入参唯一索引ID, 作为出参提取对应数据的依据 |
errorMessage | string | 否 | 出参异常信息,无异常则不返回该属性 |
catId | integer | 是 | 实体ID, 新增时由系统产生,更新和删除时必选 |
catName | string | 是 | 枚举目录名称 |
catTypeId | integer | 是 | 所属枚举类别ID, 见EnumCatTypeDto |
groupTypeId | integer | 否 | 枚举目录组,也称父枚举目录ID |
description | string | 否 | 枚举目录的描述 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
callbackId | string | 否 | 入参唯一索引ID, 作为出参提取对应数据的依据 |
errorMessage | string | 否 | 出参异常信息,无异常则不返回该属性 |
codeId | integer | 是 | 实体ID, 新增时由系统产生,更新和删除时必选 |
catId | integer | 是 | 所属枚举目录ID, 见EnumCatDto |
code | string | 是 | 枚举名称 |
value | string | 是 | 枚举值 |
groupCodeId | integer | 否 | 枚举组,也称父枚举ID |
codeDescription | string | 否 | 枚举的描述 |
seqNo | integer | 否 | 系统产生并维护 |
status | string | 否 | 默认:active, 枚举状态 - active: 可用, inactive: 不可用 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
callbackId | string | 否 | 入参唯一索引ID, 作为出参提取对应数据的依据 |
errorMessage | string | 否 | 出参异常信息,无异常则不返回该属性 |
ciTypeId | integer | 是 | 实体ID, 新增时由系统产生,更新和删除时必选 |
name | string | 是 | 名称 |
tableName | string | 是 | 对应的数据库表名 |
status | string | 否 | 默认:notCreated, 配置项状态 - notCreated: 待创建,created: 已创建, dirty: 已创建后更改, decommissioned: 丢弃 |
catalogId | integer | 否 | 目录ID |
seqNo | integer | 否 | 系统产生及维护, 同一层上的排序序列号 |
layerId | integer | 否 | Y轴的层级序列号 |
zoomLevelId | integer | 否 | Z轴的层级序列号 |
imageFileId | integer | 否 | 显示图片ID |
description | string | 否 | 描述 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
callbackId | string | 否 | 入参唯一索引ID, 作为出参提取对应数据的依据 |
errorMessage | string | 否 | 出参异常信息,无异常则不返回该属性 |
ciTypeAttrId | integer | 是 | 实体ID, 新增时由系统产生,更新和删除时必选 |
ciTypeId | integer | 是 | 属性所属配置项类型ID,见CiTypeDto |
name | string | 是 | 属性名称 |
inputType | string | 是 | 属性可接受输入数据类型 - text, date, textArea, select, multiSelect, ref, multiRef, number, orchestration_multi_ref, orchestration_ref |
propertyName | string | 是 | 属性对应的数据库表列名称, 只支持大小写字母,数据和下划线,而且以必须小写开头 |
propertyType | string | 是 | 属性对应的数据库表列数据类型 |
length | string | 否 | 属性对应的数据库表列数据允许的长度 |
referenceId | integer | 否 | 属性所引用的配置项类型ID, 见CiTypeDto 或 枚举目录ID, 见EnumCatDto |
referenceName | string | 否 | 引用关系命名 |
referenceType | integer | 否 | 引用关系的类型,即对应的枚举目录ID |
filterRule | string | 否 | 过滤规则,即当该属性为引用或枚举的时候,使用该设定的规则过滤所引用的数据 |
searchSeqno | integer | 否 | 搜索排序序列号 |
displaySeqNo | integer | 否 | 展示排序 |
autoFillRule | string | 否 | 自动填充规则 |
status | string | 否 | 默认:notCreated, 配置项状态 - notCreated: 待创建,created: 已创建, dirty: 已创建后更改, decommissioned: 丢弃 |
isDisplayed | boolean | 否 | 是否展示 |
isEditable | boolean | 否 | 是否可编辑 |
isHidden | boolean | 否 | 是否隐藏 |
isNullable | boolean | 否 | 是否允许保存空值 |
isRefreshable | boolean | 否 | 是否允许刷新 |
isSystem | boolean | 否 | 是否系统属性 |
isUnique | boolean | 否 | 是否唯一,即该属性值不允许保存重复值 |
isAccessControlled | boolean | 否 | 是否启用权限控制 |
isAuto | boolean | 否 | 是否自动填充该属性值,即根据autoFillRule属性所设定的规则进行填充 |
description | string | 否 | 配置项类型属性的描述 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
userId | integer | 否 | 实体ID, 新增时由系统产生,更新和删除时必选 |
username | String | 是 | 用户名 |
password | String | 否 | 密码 |
fullName | String | 否 | 名称 |
description | String | 否 | 描述 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
roleId | integer | 否 | 实体ID, 新增时由系统产生,更新和删除时必选 |
roleName | String | 是 | 角色名 |
roleType | String | 否 | 角色类型 |
isSystem | String | 否 | 是否系统角色 |
description | String | 否 | 描述 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
roleUserId | integer | 否 | 实体ID, 新增时由系统产生,更新和删除时必选 |
roleId | integer | 是 | 角色名 |
userId | integer | 否 | 角色类型 |
isSystem | String | 否 | 是否系统属性 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
roleCiTypeId | integer | 否 | 实体ID, 新增时由系统产生,更新和删除时必选 |
ciTypeId | integer | 是 | 配置项id |
roleId | integer | 否 | 角色id |
ciTypeName | String | 否 | 角色名称 |
creationPermission | String | 否 | 是否具有创建的权限 |
removalPermission | String | 否 | 是否具有删除的权限 |
modificationPermission | String | 否 | 是否具有修改的权限 |
enquiryPermission | String | 否 | 是否具有查询的权限 |
executionPermission | String | 否 | 是否具有执行的权限 |
grantPermission | String | 否 | 是否具有授权的权限 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
roleCiTypeCtrlAttrId | integer | 否 | 实体ID, 新增时由系统产生,更新和删除时必选 |
roleCiTypeId | integer | 是 | 角色配置项权限id |
creationPermission | String | 否 | 是否具有创建的权限 |
removalPermission | String | 否 | 是否具有删除的权限 |
modificationPermission | String | 否 | 是否具有修改的权限 |
enquiryPermission | String | 否 | 是否具有查询的权限 |
executionPermission | String | 否 | 是否具有执行的权限 |
grantPermission | String | 否 | 是否具有授权的权限 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
conditionId | integer | 否 | 实体ID, 新增时由系统产生,更新和删除时必选 |
roleCiTypeCtrlAttrId | integer | 是 | 角色配置项属性权限id |
ciTypeAttrId | integer | 否 | 配置项属性id |
ciTypeAttrName | String | 否 | 配置项属性名称 |
conditionValue | String | 否 | 条件 |
conditionValueType | String | 否 | 条件类型 |
conditionValueObject | Object | 否 | 条件对象 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
name | String | 否 | 综合查询名称 |
ciTypeId | integer | 是 | 配置项id |
attrs | Array of Integer | 否 | 配置项属性id |
attrAliases | String | 否 | 配置项属性别名 |
attrKeyNames | String | 否 | 配置项属性名称 |
conditionValueType | String | 否 | 条件类型 |
parentRs | Relationship(#Relationship) | 否 | 父节点信息 |
children | IntegrationQueryDto(#IntegrationQueryDto) | 否 | 子节点 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
attrId | Integer | 否 | 配置项属性id |
isReferedFromParent | Boolean | 否 | 是否存在父节点 |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。