Help Center/ SecMaster/ API Reference/ API/ Playbook Version Management/ Querying the Playbook Version List
Updated on 2025-03-20 GMT+08:00
View PDF

Querying the Playbook Version List

Function

Querying the Playbook Version List

Calling Method

For details, see Calling APIs.

URI

GET /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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

status

No

String

Playbook version status. Options are Editing, APPROVING, UNPASSED, and PUBLISHED

enabled

No

Integer

enabled/disabled

version_type

No

Integer

Version type. The options are as follows 0 is draft version; 1 is official version.

offset

No

Integer

Indicates the page number. Start position of the query result. The value starts from 0.

limit

No

Integer

The maximum number of records can be returned on each page for a pagination query. The value starts from 1.

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

Error Message

size

Integer

Records on each page.

page

Integer

Current page.

total

Integer

Total

data

Array of PlaybookVersionListEntity objects

Playbook version list.
Table 6 PlaybookVersionListEntity

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 user who updated the information.

playbook_id

String

Playbook ID.

version

String

Version No.

enabled

Boolean

Activated

status

String

Status. (EDITING -- editing, APPROVING -- reviewing, UNPASSED -- not approved, Published -- approved)

action_strategy

String

Execution policy. Currently, only asynchronous concurrent execution is supported. The corresponding value is ASYNC.

rule_enable

Boolean

Whether the filtering rule is enabled.

dataclass_id

String

Data class ID.

trigger_type

String

Triggering mode. The options are as follows - EVENT -- event; TIMER -- scheduled.

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

Edition

rule_id

String

Filtering rule ID.

dataclass_name

String

Data class name.

approve_name

String

Reviewer.

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",
  "size" : 3,
  "page" : 10,
  "total" : 41,
  "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",
    "rule_enable" : true,
    "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"
  } ]
}

Status Codes

Status Code

Description

200

Response when the request is successful.

400

Response when the request failed.

Error Codes

See Error Codes.

Parent Topic: Playbook Version Management