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

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 sequence, including asc for ascending order and desc for descending order.

sortby

No

String

Sorting fields, including create_time for creation time and category for classification name.

enabled

No

Boolean

Whether to enable.

last_version

No

Boolean

Latest version.

name

No

String

Workflow name.

description

No

String

Description

dataclass_id

No

String

Data class ID.

dataclass_name

No

String

Data class name.

aop_type

No

String

Process 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 a 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, in the format request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

code

String

Return code.

total

Integer

Total records.

offset

Integer

Current page size.

limit

Integer

Current page.

message

String

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

Tenant ID.

owner_id

String

Owner ID.

creator_id

String

Creator ID.

edit_role

String

Edit

use_role

String

User 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

Version to be viewed currently.

current_rejected_versoin_id

String

Version that has been rejected currently.

aop_type

String

AOP types.

- NORMAL: General

- SURVEY: Investigation

- HEMOSTASIS: Prevention

- EASE: Mitigation

engine_type

String

There are two types of engine, shared and dedicated.

dataclass_id

String

ID of the data class.

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

Query the workflow list. The offset is 10, and three alerts are queried.

{
  "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" : "Mitigation (ease).",
    "engine_type" : "public_engine",
    "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Response body of the failed requests for querying the data class list.

Error Codes

See Error Codes.

Parent Topic: Workflow Management