Updated on 2022-09-15 GMT+08:00

Processing Approvals

Function

This API is used to process an approval, including accepting and rejecting it.

URI

PUT /v2/{project_id}/design/approvals/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action-id

Yes

String

Approval processing result type

Enumeration values:

  • reject

  • resolve

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of integers

List of approval IDs

msg

Yes

String

Approval information

Maximum: 500

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Object

Returned data

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Example Requests

{
  "ids" : [ "885830700668964864" ],
  "msg" : "ok"
}

Example Responses

Status code: 200

The operation succeeds. The execution result is returned.

{
  "data" : {
    "value" : {
      "SUCCESS" : 1,
      "FAILURE" : 0
    }
  }
}

Status Codes

Status Code

Description

200

The operation succeeds. The execution result is returned.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found