Help Center> DataArts Studio> API Reference> DataArts Factory APIs> Job Development APIs> Querying Release Packages
Updated on 2024-04-29 GMT+08:00
View PDF

Querying Release Packages

Function

This API is used to query release packages.

URI

  • URI format

    POST /v2/{project_id}/factory/release-packages

  • Parameter description
    Table 1 URI 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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

X-Auth-Token

No

String

This parameter is mandatory for token authentication. The length of a user token must meet the following requirements:

Minimum length: 0

Maximum length: 4096

Content-Type

No

String

This parameter is mandatory if the body is available. If the body is unavailable, you do not need to set and verify this parameter.

Example: Content-Type: application/json;charset=UTF-8

Authorization

No

String

This field is mandatory for AK/SK authentication.

Host

No

String

This field is mandatory for AK/SK authentication.
Table 3 Body parameters

Parameter

Mandatory

Type

Description

key_word

No

String

Keyword of the package name

apply_user_name

No

String

Applicant name

deploy_user_name

No

String

Deployer name

apply_begin_time

No

Long

Start time of the application. Its value is a 13-digit timestamp.

apply_end_time

No

Long

End time of the application. Its value is a 13-digit timestamp.

deploy_begin_time

No

Long

Start time of the release. Its value is a 13-digit timestamp.

deploy_end_time

No

Long

End time of the release. Its value is a 13-digit timestamp.

apply_user_name_filter

No

array[string]

Array of applicant names used to filter applicants. If apply_user_name is set, it must be contained in the array.

deploy_user_name_filter

No

array[string]

Array of deployer names used to filter deployers. If deploy_user_name is set, it must be contained in the array.

deploy_status_filter

No

array[integer]

Release status array

1: to be reviewed

2: successful

3: failed

5: being released

sorted_direction

No

String

Sorting direction. The default value is desc.

order_column

No

String

Sorting field. The default value is apply_timestamp.

limit

No

Integer

Number of results returned for each page. The default value is 10.

offset

No

Integer

Start page. The value must be greater than or equal to 0. The default value is 0.

Response Parameters

Table 4 Parameter description

Parameter

Mandatory

Type

Description

data

Yes

array[object]

Release package information. For details, see Table 5.

total

Yes

Integer

Number of release packages
Table 5 Release package parameters

Parameter

Mandatory

Type

Description

apply_timestamp

No

Long

Application time. The value is a 13-digit timestamp.

apply_user_id

No

String

Applicant ID

apply_user_name

No

String

Applicant name

delete_flag

No

integer

Whether to delete the package

0: It will not be deleted.

1: It will be deleted.

deploy_status

No

integer

Release status

1: to be reviewed

2: successful

3: failed

5: being released

deploy_timestamp

No

Long

Release time. Its value is a 13-digit timestamp.

deploy_user_id

No

String

Deployer ID

deploy_user_name

No

String

Deployer name

package_approvers

No

array[object]

Release package review information. For details, see Table 6.

package_id

No

String

Release package ID

package_name

No

String

Release package name

project_id

No

String

Project ID and workspace information in the following format: Project ID-workspace-Workspace ID

workspace_id

No

String

ID of the workspace where the release package is located
Table 6 Release package review parameters

Parameter

Mandatory

Type

Description

user_id

No

String

ID of the release package reviewer

user_name

No

String

Name of the release package reviewer

Example Request

POST /v2/62099355b894428e8916573ae635f1f9/factory/packages
{
	"key_word": "",
	"apply_user_name": "",
	"deploy_user_name": "",
        "apply_begin_time": 1699113600999,
	"apply_end_time": 1700323199999,
	"deploy_begin_time": "",
	"deploy_end_time": "",
	"apply_user_name_filter": "",
	"deploy_user_name_filter": "",
	"deploy_status_filter": "",
	"sorted_direction": "desc",
	"order_column": "apply_timestamp",
	"limit": 10,
	"offset": 0
}

Example Response

  • Success response

    HTTP status code 200

    {
    "data": [
        {
            "apply_timestamp": 1700288912934,
            "apply_user_id": "7b71e498e75d44048c9a22dd3c54f978",
            "apply_user_name": "ei_dlf_l00341563",
            "delete_flag": 0,
            "deploy_status": 3,
            "deploy_timestamp": 1700289155129,
            "deploy_user_id": "7b71e498e75d44048c9a22dd3c54f978",
            "deploy_user_name": "ei_dlf_l00341563",
            "package_approvers": [
                {
                    "user_id": "7b71e498e75d44048c9a22dd3c54f978",
                    "user_name": "ei_dlf_l00341563"
                }
            ],
            "package_id": "4",
            "package_name": "ads_supplier_inventory_info__ads_supplier_inventory_info_20231118143537",
            "project_id": "62099355b894428e8916573ae635f1f9-workspace-45be704b28cb4f25a39221169fd3e27e",
            "workspace_id": "45be704b28cb4f25a39221169fd3e27e"
        },
        {
            "apply_timestamp": 1700288777664,
            "apply_user_id": "7b71e498e75d44048c9a22dd3c54f978",
            "apply_user_name": "ei_dlf_l00341563",
            "delete_flag": 0,
            "deploy_status": 2,
            "deploy_timestamp": 1700289161361,
            "deploy_user_id": "7b71e498e75d44048c9a22dd3c54f978",
            "deploy_user_name": "ei_dlf_l00341563",
            "package_approvers": [
                {
                    "user_id": "7b71e498e75d44048c9a22dd3c54f978",
                    "user_name": "ei_dlf_l00341563"
                }
            ],
            "package_id": "3",
            "package_name": "aa_20231118143318",
            "project_id": "62099355b894428e8916573ae635f1f9-workspace-45be704b28cb4f25a39221169fd3e27e",
            "workspace_id": "45be704b28cb4f25a39221169fd3e27e"
        }
    ],
    "total": 2
}
  • Failure response

    HTTP status code 400

    {
    "error_code": "DLF.3051",
    "error_msg": "The request parameter is invalid.  "
}
Parent topic: Job Development APIs