Help Center/ DataArts Studio/ API Reference/ DataArts Quality APIs/ Quality Reports/ Obtaining a Quality Report Scoring System
Updated on 2024-11-06 GMT+08:00

Obtaining a Quality Report Scoring System

Function

This API is used to obtain the scoring system for quality reports.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/quality/report/scoring

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

full_score

Integer

Full score

Status code: 400

Table 4 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

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

GET /v2/0833a5737480d53b2f25c010dc1a7b88/quality/report/scoring

Example Responses

Status code: 200

Success

{
  "full_score" : 100
}

Status Codes

Status Code

Description

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR