Reviewing a Playbook
Function
Reviewing a Playbook
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/approval
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
workspace_id |
Yes |
String |
Workspace ID |
|
version_id |
Yes |
String |
Version ID |
Request 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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
result |
No |
String |
PASS or UN_PASS |
|
content |
No |
String |
Review Comments |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code |
|
message |
String |
Response message. |
|
data |
ApproveOpinionDetail object |
Review details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
result |
String |
Review result. |
|
content |
String |
Review content. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error Code |
|
message |
String |
Error Description |
Example Requests
Review a playbook. The review result is PASS and the review comments are xxxxx.
{
"result" : "PASS",
"content" : "xxxxx"
}
Example Responses
Status code: 200
Response when the request is successful.
{
"code" : 0,
"message" : "Error message",
"data" : {
"result" : "PASS",
"content" : "need modify"
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response when the request is successful. |
|
400 |
Response when the request failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
