Personal Data

Create Data Element

Use this API to create new Data Elements in Data Mapping Automation module.

post/api/inventory/v2/data-elements

Request

Base URL
https://hostname
URL
https://hostname/api/inventory/v2/data-elements
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

assignToAllSubjectsboolean

Flag indicating whether to assign the data element to all subjects

Example request

{
  "value": "Email Address",
  "description": "Customer email address",
  "categories": [
    {
      "id": "43fd3a8d-3f6b-464e-bf43-3f0c6c592442"
    }
  ]
}

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 element

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

Status of the data element

visibleboolean

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",
  "status": "Active",
  "dataSubjectTypes": [
    {
      "id": "43fd3a8d-3f6b-464e-bf43-3f0c6c592442",
      "name": "Financial Data",
      "nameKey": "financial_data_name",
      "description": "Contains financial information of customers",
      "descriptionKey": "financial_data_description"
    }
  ],
  "categories": [
    {
      "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"
    }
  ],
  "classifications": [
    {
      "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.