Help Center/ SecMaster/ API Reference/ API/ Playbook Approval Management/ Querying Playbook Review Result
Updated on 2024-12-25 GMT+08:00

Querying Playbook Review Result

Function

Querying Playbook Review Result

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/approval

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

resource_id

No

String

Resource ID.

approve_type

No

String

Review type. (PLAYBOOK or AOP_WORKFLOW)

Request Parameters

Table 3 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

Response Parameters

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

Array of ApproveOpinionDetail objects

Playbook 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

Example Requests

None

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.