Updated on 2022-09-15 GMT+08:00

Associating a Classification with Assets

Function

This API is used to associate a classification with multiple assets, including columns in data tables and OBS objects.

URI

POST /v3/{project_id}/asset/entities/classification

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM Token

workspace

Yes

String

DGC workspace ID

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

guids

Yes

Array of strings

List of data assets

classification

Yes

OpenClassification object

Classification

Table 4 OpenClassification

Parameter

Mandatory

Type

Description

name

Yes

String

Classification name

description

No

String

Classification description

create_user

No

String

User who created the classification

create_time

No

Number

Classification creation time

update_time

No

Number

Classification update time

update_user

No

String

User who updated the classification

guid

No

String

Classification GUID

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

{
  "guids" : [ "0aa90b11-5064-4c6a-9c00-a35267a85aab", "348f0dc5-e03f-487e-a967-3e1abacccce8" ],
  "classification" : {
    "name" : "hive_common"
  }
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found