创建剧本版本
功能介绍
创建剧本版本
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
|
playbook_id |
是 |
String |
剧本ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
content-type |
是 |
String |
application/json;charset=UTF-8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
description |
否 |
String |
描述 |
|
workspace_id |
否 |
String |
工作空间ID |
|
playbook_id |
否 |
String |
剧本ID |
|
actions |
否 |
Array of ActionInfo objects |
关联流程列表 |
|
dataclass_id |
否 |
String |
数据类ID |
|
rule_enable |
否 |
Boolean |
过滤规则是否启用 |
|
rule_id |
否 |
String |
过滤规则ID |
|
trigger_type |
否 |
String |
触发方式. EVENT--事件触发, TIMER--定时触发 |
|
dataobject_create |
否 |
Boolean |
标识数据对象是否创建时触发剧本 |
|
dataobject_update |
否 |
Boolean |
标识数据对象是否更新时触发剧本 |
|
dataobject_delete |
否 |
Boolean |
标识数据对象是否删除时触发剧本 |
|
action_strategy |
否 |
String |
执行策略. 目前仅支持异步并发执行，对应值为ASYNC |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
Error message |
|
data |
PlaybookVersionInfo object |
剧本版本详情信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本版本ID |
|
description |
String |
描述 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
更新时间 |
|
project_id |
String |
项目ID |
|
creator_id |
String |
创建者ID |
|
modifier_id |
String |
修改者ID |
|
playbook_id |
String |
剧本ID |
|
version |
String |
版本号 |
|
enabled |
Boolean |
是否启用。（true--已启用，false-未启用） |
|
status |
String |
剧本版本状态，编辑中：EDITING 审核中：APPROVING 不通过：UNPASSED 已发布：PUBLISHED |
|
action_strategy |
String |
执行策略. 目前仅支持异步并发执行，对应值为ASYNC |
|
actions |
Array of ActionInfo objects |
剧本关联流程列表信息 |
|
rule_enable |
Boolean |
是否启用触发条件过滤器 |
|
rules |
RuleInfo object |
剧本触发规格信息 |
|
dataclass_id |
String |
数据类ID |
|
trigger_type |
String |
剧本触发方式(EVENT--事件触发，TIMER--定时触发) |
|
dataobject_create |
Boolean |
标识数据对象是否创建时触发剧本 |
|
dataobject_update |
Boolean |
标识数据对象是否更新时触发剧本 |
|
dataobject_delete |
Boolean |
标识数据对象是否删除时触发剧本 |
|
version_type |
Integer |
版本类型（0--草稿版本，1--正式版本) |
|
rule_id |
String |
过滤规则ID |
|
dataclass_name |
String |
数据类名称 |
|
approve_name |
String |
审核者 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本流程动作ID |
|
name |
String |
流程动作名称 |
|
description |
String |
描述 |
|
action_type |
String |
流程动作类型 |
|
action_id |
String |
流程ID |
|
playbook_id |
String |
剧本ID |
|
playbook_version_id |
String |
剧本版本ID |
|
project_id |
String |
项目ID |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
创建一个剧本版本，剧本版本所属工作空间ID为string，剧本ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，数据类ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，规则为启用。
{
"description" : "This my XXXX",
"workspace_id" : "string",
"playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"actions" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "MyXXX",
"description" : "This my XXXX",
"action_type" : "Workflow",
"action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"playbook_id" : "string",
"playbook_version_id" : "string",
"project_id" : "string"
} ],
"dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"rule_enable" : true,
"rule_id" : "4185bbd2-9d18-4362-92cb-46df0b24fe4e",
"trigger_type" : "event",
"dataobject_create" : true,
"dataobject_update" : true,
"dataobject_delete" : true,
"action_strategy" : "sync"
}响应示例
状态码： 200
请求成功响应信息
{
"code" : 0,
"message" : "Error message",
"data" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"description" : "This my XXXX",
"create_time" : "2021-01-30T23:00:00Z+0800",
"update_time" : "2021-01-30T23:00:00Z+0800",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version" : "v1.1.1",
"enabled" : true,
"status" : "editing",
"action_strategy" : "sync",
"actions" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "MyXXX",
"description" : "This my XXXX",
"action_type" : "Workflow",
"action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"playbook_id" : "string",
"playbook_version_id" : "string",
"project_id" : "string"
} ],
"rule_enable" : true,
"rules" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
},
"dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"trigger_type" : "event",
"dataobject_create" : true,
"dataobject_update" : true,
"dataobject_delete" : true,
"version_type" : 1,
"rule_id" : "string",
"dataclass_name" : "string",
"approve_name" : "string"
}
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功响应信息 |
|
400 |
请求失败响应信息 |
错误码
请参见错误码。
