Updating a Playbook Workflow

Function

This API is used to update a playbook workflow.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/actions/{action_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID.
version_id	Yes	String	Playbook version ID.
action_id	Yes	String	Playbook workflow 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
name	No	String	Name.
description	No	String	Description.
action_type	No	String	Type. The default value is AOP_WORKFLOW.
action_id	No	String	Playbook workflow ID.
sort_order	No	String	Sorting method.

Response Parameters

Status code: 200

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

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Error message
data	ActionInfo object	Playbook workflow information.

**Table 6** 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.

Status code: 400

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

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

Example Requests

Update a playbook workflow. Workflow name: MyXXX; Description: This my XXXX; Workflow type: aopworkflow; Workflow ID: 909494e3-558e-46b6-a9eb-07a8e18ca62f; Sorted by: string.

{
  "name" : "MyXXX",
  "description" : "This my XXXX",
  "action_type" : "aopworkflow",
  "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "sort_order" : "string"
}

Example Responses

Status code: 200

Response parameters for a successful request.

{
  "code" : 0,
  "message" : "Error message",
  "data" : {
    "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"
  }
}