Querying Sensitive Data Classification Dimensions

Function

This API is used to query the details of the classification dimensions of sensitive data in an asset catalog. You can filter the sensitive data statistics of a classification dimension by group label ID and type ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/metadata/catalog/column-details/classification-dim

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
label_id	No	String	Group label ID, which is used to filter the classification dimension of a specific group.
type_id	No	String	Type ID, which is used to filter classification dimensions of a specific type.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
results	Array of TemplateDim objects	List of column label details by classification.

**Table 4** TemplateDim
Parameter	Type	Description
classifications	Array of ClassificationDim objects	Classification information list.
count	Integer	Matched items.
template_name	String	Template name.

**Table 5** ClassificationDim
Parameter	Type	Description
classification_name	String	Classification name.
columns	Array of ColumnInfoAndMatchInfo objects	List of column information and matching information.
count	Integer	Matched items.

**Table 6** ColumnInfoAndMatchInfo
Parameter	Type	Description
asset_id	String	Asset ID.
asset_name	String	Asset name.
column_fqn	String	Fully qualified name (FQN) of the column.
db_type	String	Database type.
match_infos	Array of ClassificationMatchInfo objects	List of matching information.

**Table 7** ClassificationMatchInfo
Parameter	Type	Description
classification_id	String	Classification ID.
classification_name	String	Classification name.
match_content_cnt	Integer	Number of matched content items.
match_rate	Double	Matching rate (%).
matched_detail	String	Matching details.
matched_examples	Array of MatchedExamples objects	List of matching examples.
rule_id	String	Rule ID.
rule_name	String	Rule name.
security_level_color	Integer	Security level color (RGB value).
security_level_id	String	Security level ID.
security_level_name	String	Security level name.
template_id	String	Template ID.
template_name	String	Template name.

**Table 8** MatchedExamples
Parameter	Type	Description
context	String	Matching context.
line_number	Long	Match line No.
matched_content	String	Matching content.
nlp_revised	Boolean	Revised by NLP.

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	Query result.
401	Unauthorized. The user is not logged in or the token is invalid.
403	Unauthorized to access the resource.
404	The specified project does not exist.