Personal Data

Create Data Classification

Use this API to create new Data Mapping Automation-Data Classification.

post/api/inventory/v2/data-classifications

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/inventory/v2/data-classifications
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INVENTORY, INVENTORY_WRITE

Query parameters

generatorstring

Optional generator parameter

Request body

valuestring required

Name of the personal data entity

descriptionstring

Description of the personal data entity

status'Active' | 'Inactive' | 'Draft'

Status of the personal data entity

termIdstring uuid

ID of the associated term

tagIdstring uuid

ID of the associated tag

Example request

{
  "value": "Sensitive",
  "description": "Classification for sensitive information",
  "status": "Active"
}

Response

Created

idstring uuid required

Unique identifier of the entity

namestring required

Name of the entity

nameKeystring required

Translation key for the entity name

descriptionstring

Description of the entity

descriptionKeystring

Translation key for the entity description

source'SYSTEM' | 'USER' | 'IMPORTED'

Source of the data classification

Example response

{
  "id": "43fd3a8d-3f6b-464e-bf43-3f0c6c592442",
  "name": "Financial Data",
  "nameKey": "financial_data_name",
  "description": "Contains financial information of customers",
  "descriptionKey": "financial_data_description",
  "source": "SYSTEM"
}

Changes

No recorded changes to this operation across all 1 revision of this API.