Reviewing a Playbook

For details, see Calling APIs.

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/approval

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

**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 a token.
content-type	Yes	String	application/json;charset=UTF-8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
result	No	String	PASS or UN_PASS
content	No	String	Review Comments

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Response message.
data	ApproveOpinionDetail object	Review details.

**Table 6** ApproveOpinionDetail
Parameter	Type	Description
result	String	Review result.
content	String	Review content.

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

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

Review a playbook. The review result is PASS and the review comments are xxxxx.

{
  "result" : "PASS",
  "content" : "xxxxx"
}

Status code: 200

Response when the request is successful.

{
  "code" : 0,
  "message" : "Error message",
  "data" : {
    "result" : "PASS",
    "content" : "need modify"
  }
}

Status Code	Description
200	Response when the request is successful.
400	Response when the request failed.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.