Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Workflow Version Management/ Reviewing the Workflow Version for Release
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Reviewing the Workflow Version for Release

Function

This API is used to review a workflow version.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/versions/{version_id}/approval

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Range

N/A

version_id

Yes

String

Definition

Workflow version ID.

Range

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

content

Yes

String

Definition

Workflow review comments.

Constraints

N/A

Range

N/A

Default Value

N/A

result

Yes

String

Definition

Workflow review result.

  • PASS: passed

  • UN_PASS rejected

Constraints

N/A

Range

  • PASS

  • UN_PASS

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Response message.

data

WorkflowApproveOpinionDetail object

Workflow review details.
Table 5 WorkflowApproveOpinionDetail

Parameter

Type

Description

result

String

Definition

Workflow review result.

  • PASS: passed

  • UN_PASS rejected

Constraints

N/A

Range

  • PASS

  • UN_PASS

Default Value

N/A

content

String

Definition

Workflow review comments.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

  • Example of an approved review

    {
  "result" : "PASS",
  "content" : "ok"
}

  • Example of a rejected review

    {
  "result" : "UN_PASS",
  "content" : "reject renson"
}

Example Responses

Status code: 200

Workflow version review result.

{
  "code" : "00000000",
  "message" : "",
  "data" : {
    "result" : "UN_PASS",
    "content" : "reject renson"
  }
}

Status Codes

Status Code

Description

200

Workflow version review result.

400

Error response

Error Codes

See Error Codes.