Creating a Playbook Version

Function

This API is used to create a playbook version.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID.
playbook_id	Yes	String	Playbook ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
content-type	Yes	String	application/json;charset=UTF-8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Description.
workspace_id	No	String	Workspace ID.
playbook_id	No	String	Playbook ID.
actions	No	Array of ActionInfo objects	The list of the associated workflows.
dataclass_id	No	String	Data class ID.
rule_enable	No	Boolean	Whether the filter rule is enabled.
rule_id	No	String	Filter rule ID.
trigger_type	No	String	Trigger method. EVENT: Triggered by incidents; TIMER: Triggered as scheduled.
dataobject_create	No	Boolean	Whether to trigger a playbook when a data object is created.
dataobject_update	No	Boolean	Whether to trigger a playbook when a data object is updated.
dataobject_delete	No	Boolean	Whether to trigger a playbook when a data object is deleted.
action_strategy	No	String	Execution policy. Currently, only asynchronous concurrent execution is supported. The corresponding value is ASYNC.

**Table 4** ActionInfo
Parameter	Mandatory	Type	Description
id	No	String	Playbook workflow ID.
name	No	String	Workflow name.
description	No	String	Description.
action_type	No	String	Workflow type.
action_id	No	String	Workflow ID.
playbook_id	No	String	Playbook ID.
playbook_version_id	No	String	Playbook version ID.
project_id	No	String	Project ID.

Response Parameters

Status code: 200

**Table 5** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Error code.
message	String	Error message
data	PlaybookVersionInfo object	Playbook version details.

**Table 7** PlaybookVersionInfo
Parameter	Type	Description
id	String	Playbook version ID.
description	String	Description.
create_time	String	Creation time.
update_time	String	Update time.
project_id	String	Project ID.
creator_id	String	Creator ID.
modifier_id	String	ID of the editor.
playbook_id	String	Playbook ID.
version	String	Version No.
enabled	Boolean	Enable or not. true: Enabled false: Disabled
status	String	Playbook version status. Options: Editing, APPROVING, UNPASSED, and PUBLISHED
action_strategy	String	Execution policy. Currently, only asynchronous concurrent execution is supported. The corresponding value is ASYNC.
actions	Array of ActionInfo objects	The list of workflows associated with the playbook.
rule_enable	Boolean	Whether to enable the trigger condition filter.
rules	RuleInfo object	Playbook trigger information.
dataclass_id	String	Data class ID.
trigger_type	String	How the playbook is triggered. Options: EVENT and TIMER
dataobject_create	Boolean	Whether to trigger a playbook when a data object is created.
dataobject_update	Boolean	Whether to trigger a playbook when a data object is updated.
dataobject_delete	Boolean	Whether to trigger a playbook when a data object is deleted.
version_type	Integer	Version type (0: Draft; 1: Released).
rule_id	String	Filter rule ID.
dataclass_name	String	Data class name.
approve_name	String	Reviewer.

**Table 8** ActionInfo
Parameter	Type	Description
id	String	Playbook workflow ID.
name	String	Workflow name.
description	String	Description.
action_type	String	Workflow type.
action_id	String	Workflow ID.
playbook_id	String	Playbook ID.
playbook_version_id	String	Playbook version ID.
project_id	String	Project ID.

**Table 9** RuleInfo
Parameter	Type	Description
id	String	Rule ID.
project_id	String	Project ID.
rule	String	Trigger rules.

Status code: 400

**Table 10** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 11** Response body parameters
Parameter	Type	Description
code	String	Error code.
message	String	Error description.

Example Requests

Create a playbook version. Set the workspace ID to string, playbook ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, data class ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, and rule to Enabled.

{
  "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"
}

Example Responses

Status code: 200

Response to a successful request.

{
  "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"
  }
}