Querying the Playbook Version List
Function
This API is used to query the version list of a playbook.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
playbook_id |
Yes |
String |
Playbook ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status |
No |
String |
Playbook version status. Options: Editing, APPROVING, UNPASSED, and PUBLISHED |
enabled |
No |
Integer |
Enable/Disable |
version_type |
No |
Integer |
Version type. The options are as follows: 0: Draft version. 1: Formal version. |
offset |
No |
Integer |
Pagination query parameter. This parameter specifies the 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
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Error message. |
size |
Integer |
Records on each page. |
page |
Integer |
Current page number. |
total |
Integer |
Total number. |
data |
Array of PlaybookVersionListEntity objects |
Playbook version list. |
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 editor. |
playbook_id |
String |
Playbook ID. |
version |
String |
Version No. |
enabled |
Boolean |
Whether to activate. |
status |
String |
Status. (EDITING: Being edited; APPROVING: Being reviewed; UNPASSED: Rejected; 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 |
Trigger mode. EVENT: Triggered by incidents; TIMER: Triggered as 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 |
Version type. |
rule_id |
String |
Filter rule ID. |
dataclass_name |
String |
Data class name. |
approve_name |
String |
Reviewer. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
Response to a successful request.
{ "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 to a successful request. |
400 |
Response message for failed requests. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot