Retrieve Data Type List

Use this API to list sensitive data types that can be assigned to columns in NineData. The response includes each data type's default masking algorithm, sensitive level, and enabled status for preparing or validating sensitive-data configuration through automation.

Request URL: /openapi/v1/sensitiveData/dataType/list

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
dataTypeId	String	No	Data type ID.	scan-dhfzxatw8b4d
current	Integer	No	Current page number, starting from 1. Default value: 1.	1
pageSize	Integer	No	Page size. Default value: 10.	1

Request Example

For request headers, signatures, and GET query construction, see OpenAPI API Documentation.

{
  "current": 1,
  "pageSize": 1
}

Response Parameters

Parameter	Type	Description
success	Boolean	Indicates whether the API call is successful.
requestId	String	Request ID.
data	Array	Data type detail list.
current	Integer	Current page number.
pageSize	Integer	Page size.
total	Integer	Total number of records.

The fields of each data type detail are as follows:

Parameter	Type	Description
dataTypeId	String	Data type ID.
name	String	Data type name.
algorithmId	Integer	Default masking algorithm ID for the data type.
sensitiveLevel	Integer	Default sensitive level of the data type. Valid values: 0~5.
enable	Boolean	Indicates whether the data type is enabled.

Successful Response Example

{
  "success": true,
  "requestId": "Gp8t8TCI-JPQIcZFnMPLb5BLdORf9RCC",
  "data": [
    {
      "dataTypeId": "scan-dhfzxatw8b4d",
      "name": "SQLServer Amount",
      "sensitiveLevel": 5,
      "algorithmId": 1,
      "enable": true
    }
  ],
  "current": 1,
  "pageSize": 1,
  "total": 48
}

Result

A successful response returns a paginated list of data types. Use the returned dataTypeId when you set or update the sensitive data recognition result for a column.