Querying the Playbook Workflow
Function
Querying the Playbook Workflow List
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/actions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
version_id |
Yes |
String |
Playbook version ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
Yes |
Integer |
The maximum number of records can be returned on each page for a pagination query. The value starts from 1. |
offset |
Yes |
Integer |
Pagination query parameter. This parameter specifies the start position of the query result. The value starts from 0. |
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. |
total |
Integer |
Total number. |
size |
Integer |
The number of records on each page. |
page |
Integer |
Current page number. |
data |
Array of ActionInfo objects |
Playbook workflow list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook workflow ID. |
name |
String |
Workflow name. |
description |
String |
Description. |
action_type |
String |
Workflow type. |
action_id |
String |
Workflow ID. |
playbook_id |
String |
Playbook ID. |
playbook_version_id |
String |
Playbook version ID. |
project_id |
String |
Project ID. |
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 parameters for a successful request.
{ "code" : 0, "message" : "Error message", "total" : 41, "size" : 3, "page" : 10, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "description" : "This my XXXX", "action_type" : "Workflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "string", "playbook_version_id" : "string", "project_id" : "string" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Response parameters for a successful request. |
400 |
Response parameters 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