Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Approval Management/ Application Processing
Updated on 2025-11-17 GMT+08:00
View PDF

Application Processing

Function

Reject/Approve one or more action-id=reject/resolve.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action-id

Yes

String

Application processing result type.

Options:

  • reject: rejected

  • resolve: approved

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

Application ID list, which is a string

msg

Yes

String

Approval order information, which is the approval opinion entered by the approver.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

data object

Number of applications that are successfully withdrawn.
Table 6 data

Parameter

Type

Description

value

BatchOperationVO object

Result of the approval operation.
Table 7 BatchOperationVO

Parameter

Type

Description

id

String

Batch approval ID, which is a string

tenant_id

String

Project ID.

group_id

String

Group ID, which is a string

biz_name

String

Service name.

biz_id

String

Business ID, which is a string

operation_status

String

Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed).

Options:

  • RUNNING: The task is running.

  • SUCCESS: The operation is successful.

  • FAILED: The operation fails.

operation_type

String

Indicates the type.

biz_info

String

Service details.

create_by

String

Creator.

remark

String

Indicates the remark information.

total

Integer

Total number.

success

Integer

Number of successful operations.

failed

Integer

Indicates the number of failed operations.

rate

String

Indicates the current progress.

logs

String

Logs.

groups

Array of BatchOperationVO objects

Group information.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

Approve the physical table release.

PUT https://{endpoint}/v2/{project_id}/design/approvals/action?action-id=resolve&from=standard

{
  "ids" : [ "1214980984198561792" ],
  "msg" : "Agree!"
}

Example Responses

Status code: 200

Success: The returned data is the execution result.

{
  "data" : {
    "value" : {
      "id" : null,
      "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
      "group_id" : "1230932891752615936",
      "biz_name" : null,
      "biz_id" : null,
      "operation_status" : "SUCCESS",
      "operation_type" : "APPROVAL",
      "biz_info" : null,
      "create_by" : "test_uesr",
      "remark" : null,
      "total" : 1,
      "success" : 1,
      "failed" : 0,
      "rate" : "1.00",
      "logs" : null,
      "groups" : [ {
        "id" : "1230932895607181312",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "group_id" : "1230932891752615936",
        "biz_name" : "test_czh_0305_003",
        "biz_id" : "1214580364266340352",
        "operation_status" : "SUCCESS",
        "operation_type" : "APPROVAL",
        "biz_info" : "{}",
        "create_by" : "test_uesr",
        "remark" : "PASSED",
        "total" : 0,
        "success" : 0,
        "failed" : 0,
        "rate" : null,
        "logs" : null,
        "groups" : null
      } ]
    }
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status code: 404

Not Found

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

Status Codes

Status Code

Description

200

Success: The returned data is the execution result.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
Parent Topic: Approval Management