Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V2)/ Approval Management/ Querying the Application List in Review Center
Updated on 2026-03-20 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Application List in Review Center

Function

This API is used to query the application list in Review Center.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/factory/workspaces/approval

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Parameter

Mandatory

Type

Description

begin_time

No

Long

Application start time, which is a 13-digit timestamp

end_time

No

Long

Application end time, which is a 13-digit timestamp If neither the start time nor the end time is transferred, data of the last seven days and the current day is queried by default.

status

No

String

Review status. The options are as follows:

  • DEVELOPING: pending review

  • APPROVED: approved

  • REJECT: rejected

By default, applications in all statuses are queried.

type

No

String

Review type. The options are as follows:

  • DEVELOPING: applications on the Pending Review page

  • FINISHED: applications on the Reviewed page

  • APPLY: applications on the My Applications page

The default value is APPLY.

apply_id

No

String

Application ID

approver_name

No

String

Reviewer

create_user

No

String

Applicant. This parameter can be used only on the Pending Review and Reviewed pages.

object_name

No

String

Object name

object_type

No

String

Type of the objects to be reviewed. The options are as follows:

  • JOB

  • SCRIPT

By default, all objects are reviewed.

offset

No

Integer

Start page. The value must be greater than or equal to 0. Example: offset=0.

The default value is 0.

limit

No

Integer

Maximum number of records on each page. The value ranges from 1 to 100. Example: limit=10.

The default value is 10.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

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

X-Auth-Token

No

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 parameter is mandatory when token authentication is used. The value contains 0 to 4096 characters.

X-Project-Id

No

String

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

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

Content-Type

Yes

String

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

Optional. This parameter is mandatory if a body is available. If no body is available, you do not need to set or verify this parameter.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_apply_search_list

Array of job_apply_search_list objects

Approval details

total

Integer

Total number of approvals
Table 5 job_apply_search_list

Parameter

Type

Description

actual_approver

String

Current approver

apply_id

String

Application ID

approval_msg

String

Approval message

approval_time

Integer

Approval time

approver_name

String

Approver

change_type

String

Job or script change type, which can be modification or deletion

create_user

String

Applicant

object_id

String

Approval object ID

object_name

String

Job or script name

object_type

String

Type of the object to be approved, which can be job or script

status

String

Approval status

submit_time

Long

Approval submission time

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET /v2/62099355b894428e8916573ae635f1f9/factory/workspaces/approval

Example Responses

Status code: 200

Response message body of a successful call

{
  "job_apply_search_list" : [ {
    "actual_approver" : "ei_dlf_l00341563",
    "apply_id" : "1453353598867083264",
    "approval_msg" : "ok",
    "approval_time" : 1766548111000,
    "approver_name" : "ei_dlf_l00341563",
    "change_type" : "MODIFY",
    "create_user" : "ei_dlf_l00341563",
    "object_id" : "935353",
    "object_name" : "job_6204",
    "object_type" : "JOB",
    "status" : "APPROVED",
    "submit_time" : 1766548100000
  } ],
  "total" : 1
}

Status code: 400

The operation fails, and an error message is returned.

{
  "error_code" : "DLF.5013",
  "error_msg" : "The request param is invalid."
}

Status Codes

Status Code

Description

200

Response message body of a successful call

400

The operation fails, and an error message is returned.
Parent Topic: Approval Management