Updated on 2024-11-06 GMT+08:00

Export Resources

Function

This API is used to export resources from DataArts Quality, such as quality jobs and comparison jobs.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/quality/resource/export

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

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

X-Auth-Token

Yes

String

IAM token. For details about how to obtain the token, see Authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Type of the resources to be exported in batches. rule-template indicates quality rule templates, quality-task indicates quality jobs, consistency-task indicates comparison jobs, and report indicates quality reports.

is_select_all

No

Boolean

Whether to export all jobs in the current workspace. Value true indicates that all jobs are to be exported, and value false indicates that not all jobs are to be exported. The default value is false.

resources

No

Array of longs

Resource ID array

export_mode

No

String

Export mode. null indicates that data is to be exported to a local file system, and obs indicates that data is to be exported to OBS. This parameter is available only for exporting quality reports.

obs_service_type

No

String

Service type. Value technology indicates a technical report, and value business indicates a business report. This parameter is available only for exporting quality reports.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

resource_id

String

Returned export task ID

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

500

INTERNAL SERVER ERROR