Querying the Workflow List

Function

This API is used to query the workflow list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows

**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
offset	No	Integer	Offset.
limit	No	Integer	Data volume.
order	No	String	Sorting order. Options: asc: Ascending order; desc: Descending order.
sortby	No	String	Sorting field. create_time: creation time; category: category name.
enabled	No	Boolean	Whether to enable this feature.
last_version	No	Boolean	Latest version number.
name	No	String	Workflow name.
description	No	String	Workflow description.
dataclass_id	No	String	Data class ID.
dataclass_name	No	String	Data class name.
aop_type	No	String	Workflow type.

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 the user token.
content-type	Yes	String	Content type.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Response code.
total	Integer	Total data records.
offset	Integer	Current page size.
limit	Integer	Current page number.
message	String	The request ID.
success	Boolean	Successful or not.
data	Array of AopWorkflowInfo objects	Workflow list.

**Table 6** AopWorkflowInfo
Parameter	Type	Description
id	String	Workflow ID.
name	String	Workflow name.
description	String	Description.
project_id	String	Account ID.
owner_id	String	Owner ID.
creator_id	String	Creator ID.
edit_role	String	Role of the editor.
use_role	String	Applicable role.
approve_role	String	Reviewer.
enabled	Boolean	Enabled or not.
workspace_id	String	Workspace ID.
version_id	String	Workflow version ID.
current_approval_version_id	String	Current version number to be reviewed.
current_rejected_versoin_id	String	Current version number that has been rejected.
aop_type	String	AOP type. The options are as follows: NORMAL: General SURVEY: Investigation HEMOSTASIS: Prevention EASE: Mitigation
engine_type	String	Engine type. Shared and dedicated engines are available.
dataclass_id	String	Data class ID.

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Error code.
message	String	Error description.

Example Requests

Query the workflow list. Offset: 10. Quantity: 3.

{
  "limit" : 3,
  "offset" : 10
}

Example Responses

Status code: 200

Request succeeded.

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "total" : 41,
  "limit" : 2,
  "offset" : 1,
  "success" : true,
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "Workflow name.",
    "description" : "Description.",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "edit_role" : "Editor.",
    "use_role" : "User.",
    "approve_role" : "Approver.",
    "enabled" : true,
    "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "current_approval_version_id" : "v2",
    "current_rejected_versoin_id" : "v1",
    "aop_type" : "**EASE**: Mitigation",
    "engine_type" : "public_engine",
    "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
  } ]
}