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

Downloading a Resource File

Function

This API is used to download a resource file.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/quality/resource/download

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

resource_id

Yes

String

ID of the resource export/import task. It can be obtained from the return of the API for exporting resources or importing resources.

obs_type

No

String

Export type. The options are technology (technical report) and business (business report). When a quality report is exported, this field is mandatory.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

File

Downloaded resource file.

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

Downloaded resource file

500

INTERNAL SERVER ERROR