白皮书下载
中枢变量管理
一、中枢变量新增
接口说明
该接口是为了提供中枢变量管理功能，中枢变量新增所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/resource-variable/add
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)
"value": "100", // 变量值
"description": "测试描述", // 描述
"enable": 0 // 是否启用：0-禁用，1-启用
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableName |
String |
是 |
中枢变量名称（中枢变量名称长度最大30字符） |
|
type |
Integer |
是 |
变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符) |
|
value |
String |
是 |
变量值 |
|
description |
String |
否 |
描述 |
|
enable |
Integer |
是 |
是否启用：0-禁用，1-启用 |
响应样例
{
"msg": "success",
"code": 0,
"data": "e06c4f71a9831a5e149f7bf0c8d96686" // 中枢变量UUID
}
二、中枢变量更新
接口说明
该接口是为了提供中枢变量管理功能，中枢变量更新所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/resource-variable/update
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0 // 是否启用：0-禁用，1-启用
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableUUID |
String |
是 |
中枢变量UUID |
|
value |
String |
是 |
变量值 |
|
description |
String |
否 |
描述（描述最大长度为100字符） |
|
enable |
Integer |
是 |
是否启用：0-禁用，1-启用 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
三、根据中枢变量UUID精准查询中枢变量信息
接口说明
该接口是为了提供中枢变量管理功能，根据中枢变量UUID精准查询中枢变量信息所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/resource-variable/select-resource-variable-by-uuid
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686" // 中枢变量UUID，中枢变量新增时获取
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableUUID |
String |
是 |
中枢变量UUID |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0, // 是否启用，0-禁用，1-启用
"gmtCreated": "2021-07-07 15:56:45", // 创建时间
"gmtModified": "2021-07-07 16:02:10" // 修改时间
}
}
四、查询中枢变量列表
接口说明
该接口是为了提供中枢变量管理功能，查询中枢变量列表所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/resource-variable/select-resource-variable-list
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableName": "open", // 资源量变量名称，右模糊查询
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)
"enable": 1 // 是否启用，0-禁用，1-启用
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableName |
String |
否 |
中枢变量名称，右模糊查询 |
|
type |
Integer |
否 |
变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符) |
|
enable |
Integer |
否 |
是否启用，0-禁用，1-启用 |
响应样例
{
"msg": "success",
"code": 0,
"data": [
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0, // 是否启用，0-禁用，1-启用
"gmtCreated": "2021-07-07 15:56:45", // 创建时间
"gmtModified": "2021-07-07 16:02:10" // 修改时间
},
{
"resourceVariableUUID": "1057f2cf606f5c0e6358a4ef8a709c00",
"resourceVariableName": "openapi测试资源变量001",
"type": 0,
"value": "100",
"description": "测试描述",
"enable": 1,
"gmtCreated": "2021-07-05 11:08:44",
"gmtModified": "2021-07-06 11:57:18"
}
]
}
五、中枢变量删除
接口说明
该接口是为了提供中枢变量管理功能，中枢变量删除所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/resource-variable/delete
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableUUID |
String |
是 |
中枢变量UUID |
响应样例
{
"msg": "success",
"code": 0,
"data": true
}
六、根据名称右模糊查询资源变量数组（含变量组）
接口说明
该接口是根据名称右模糊查询资源变量数组的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/resource-variable/list/searchByName
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableName": "测试资源变量名", // 中枢变量名
"length": 100//返回数据长度，不传值时默认返回1000条
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableName |
String |
是 |
中枢变量名 |
|
length |
Integer |
否 |
返回数据长度，不传值时默认返回1000条 |
响应样例
{
"msg":"success",
"code":0,
"data":[
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，5 变量组(至少2个子变量)
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0, // 是否启用，0-禁用，1-启用
"gmtCreated": "2021-07-07 15:56:45", // 创建时间
"gmtModified": "2021-07-07 16:02:10" // 修改时间
"child":[]//type=5时，child返回子变量数组
},
{
"resourceVariableUUID": "1057f2cf606f5c0e6358a4ef8a709c00",
"resourceVariableName": "openapi测试资源变量组001",
"type": 5,
"value": "",
"description": "测试描述",
"enable": 1,
"gmtCreated": "2021-07-05 11:08:44",
"gmtModified": "2021-07-06 11:57:18"，
"child":[
{"resourceVariableUUID":"3f10b44d07e6e23fc0363c4d1aec69b3",
"resourceVariableName":"子变量名1",
"type":2,
"value":"1FF801D460DD60BA4B768C0CE40693D2",
"gmtCreated":"2021-08-10 11:05:46",
"gmtModified":"2021-08-12 14:22:59"},
{"resourceVariableUUID":"4454bb72fe77e3e3040e94b9fea77a95",
"resourceVariableName":"子变量名2",
"type":0,
"value":"子文本",
"gmtCreated":"2021-08-10 11:05:46",
"gmtModified":"2021-08-12 14:22:59"}
]
}
七、中枢变量新增（含变量组）
接口说明
该接口是为了提供中枢变量管理功能，中枢变量新增所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v2/resource-variable/add
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，5变量组
"value": "100", // 变量值，新增变量组时可不传
"description": "测试描述", // 描述
"enable": 0 // 是否启用：0-禁用，1-启用
"child": // 子资源变量数组[
{"resourceVariableName":"资源子变量名1"，"type":0，"value":"资源变量值"}，
{"resourceVariableName":"资源子变量名2"，"type":1，"value":"123"}，
]
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableName |
String |
是 |
中枢变量名称（中枢变量名称长度最大30字符） |
|
type |
Integer |
是 |
变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，5变量组 |
|
value |
String |
否 |
变量值。type=5时可不传，其他类型必填 |
|
description |
String |
否 |
描述 |
|
enable |
Integer |
是 |
是否启用：0-禁用，1-启用 |
|
child |
Object[] |
否 |
子变量数组，type=5时必填 |
|
-resourceVariableName |
String |
是 |
子中枢变量名称（中枢变量名称长度最大30字符） |
|
-type |
Integer |
是 |
子变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符) |
|
-value |
String |
是 |
子变量值 |
响应样例
{
"msg": "success",
"code": 0,
"data": "e06c4f71a9831a5e149f7bf0c8d96686" // 中枢变量UUID
}
八、中枢变量更新（含变量组）
接口说明
该接口是为了提供中枢变量管理功能，中枢变量更新所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v2/resource-variable/update
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0 // 是否启用：0-禁用，1-启用，
"child"://编辑子变量[
{"resourceVariableUUID":"53301c12f61aadc2b6dce3ea1eef0348"，"delete":1}，
//传入resourceVariableUUID，并且delete=1，删除子变量
{"resourceVariableUUID":"ffdc547c710c30a80e282637606c79e1"，"value":"1adf"}
//传入resourceVariableUUID，delete不等于1，编辑子变量
{"resourceVariableName":"资源子变量名2"，"type":1，"value":"123"}，
//不传入resourceVariableUUID，delete不等于1，传入resourceVariableName、type、value，新增子变量
]
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableUUID |
String |
是 |
中枢变量UUID |
|
value |
String |
是 |
变量值 |
|
description |
String |
否 |
描述（描述最大长度为100字符） |
|
enable |
Integer |
是 |
是否启用：0-禁用，1-启用 |
|
child |
Object[] |
否 |
子变量组 |
|
-resourceVariableUUID |
String |
否 |
中枢子变量UUID，编辑、删除子变量时传入 |
|
-resourceVariableName |
String |
否 |
中枢子变量名，新增子变量时传入 |
|
-type |
Integer |
否 |
子变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，新增子变量时传入 |
|
-value |
String |
否 |
子变量值，新增、编辑子变量时传入 |
|
-delete |
Integer |
否 |
如果进行删除，则传值为1 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
九、根据中枢变量UUID精准查询中枢变量信息（含变量组）
接口说明
该接口是为了提供中枢变量管理功能，根据中枢变量UUID精准查询中枢变量信息所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v2/resource-variable/select-resource-variable-by-uuid
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686" // 中枢变量UUID，中枢变量新增时获取
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableUUID |
String |
是 |
中枢变量UUID |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0, // 是否启用，0-禁用，1-启用
"gmtCreated": "2021-07-07 15:56:45", // 创建时间
"gmtModified": "2021-07-07 16:02:10", // 修改时间
"child": // 子资源变量数组[
{"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686","resourceVariableName":"资源子变量名1"，"type":0，"value":"资源变量值", "gmtCreated": "2021-07-07 15:56:45", "gmtModified": "2021-07-07 16:02:10"}，
{"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686","resourceVariableName":"资源子变量名2"，"type":0，"value":"资源变量值", "gmtCreated": "2021-08-07 15:56:45", "gmtModified": "2021-07-08 17:03:00"}
]
}
}
十、查询中枢变量列表（含变量组）
接口说明
该接口是为了提供中枢变量管理功能，查询中枢变量列表所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v2/resource-variable/select-resource-variable-list
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableName": "open", // 资源量变量名称，右模糊查询
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，5变量组
"enable": 1 // 是否启用，0-禁用，1-启用
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableName |
String |
否 |
中枢变量名称，右模糊查询 |
|
type |
Integer |
否 |
变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，5变量组 |
|
enable |
Integer |
否 |
是否启用，0-禁用，1-启用 |
响应样例
{
"msg":"success",
"code":0,
"data":[
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
"resourceVariableName": "openapi测试资源变量005", // 中枢变量名称
"type": 0, // 变量类型：0 文本(限10240字符)，1 数值(限30字符)，2 密码(限30字符)，3 布尔(0/1)，4 json(限10240字符)，5 变量组(至少2个子变量)
"value": "333", // 变量值
"description": "33", // 描述
"enable": 0, // 是否启用，0-禁用，1-启用
"gmtCreated": "2021-07-07 15:56:45", // 创建时间
"gmtModified": "2021-07-07 16:02:10" // 修改时间
"child":[]//type=5时，child返回子变量数组
},
{
"resourceVariableUUID": "1057f2cf606f5c0e6358a4ef8a709c00",
"resourceVariableName": "openapi测试资源变量组001",
"type": 5,
"value": "",
"description": "测试描述",
"enable": 1,
"gmtCreated": "2021-07-05 11:08:44",
"gmtModified": "2021-07-06 11:57:18"，
"child":[
{"resourceVariableUUID":"3f10b44d07e6e23fc0363c4d1aec69b3",
"resourceVariableName":"子变量名1",
"type":2,
"value":"1FF801D460DD60BA4B768C0CE40693D2",
"gmtCreated":"2021-08-10 11:05:46",
"gmtModified":"2021-08-12 14:22:59"},
{"resourceVariableUUID":"4454bb72fe77e3e3040e94b9fea77a95",
"resourceVariableName":"子变量名2",
"type":0,
"value":"子文本",
"gmtCreated":"2021-08-10 11:05:46",
"gmtModified":"2021-08-12 14:22:59"}]
}
]
}
十一、中枢变量删除（含变量组）
接口说明
该接口是为了提供中枢变量管理功能，中枢变量删除所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v2/resource-variable/delete
HTTP method: POST
Content-Type: application/json
请求样例
{
"resourceVariableUUID": "e06c4f71a9831a5e149f7bf0c8d96686", // 中枢变量UUID
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
resourceVariableUUID |
String |
是 |
中枢变量UUID |
响应样例
{
"msg": "success",
"code": 0,
"data": true
}
