Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Personal Data

Create Data Element

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

post/api/inventory/v2/data-elements

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

descriptionstring

Description of the Data Element.

descriptionKeystring

Unique key for description of the Data Element.

idstring

Unique Id of the Data Element.

namestring

Name of the Data Element.

nameKeystring

Unique key for the name of the Data Element.

Example response

{
  "categories": [
    {
      "description": "Academic Background",
      "descriptionKey": "DataCategoriesAcademicBackgroundDesc",
      "id": "43fd3a8d-3f6b-464e-bf43-3f0c6c592442",
      "name": "Academic Background",
      "nameKey": "DataCategoriesAcademicBackground"
    }
  ],
  "classifications": [
    {
      "description": "Personal Data",
      "descriptionKey": "DataClassificationsPersonalDataDesc",
      "id": "9fad637c-8548-438e-9a6f-6e38eb2692de",
      "name": "Personal Data",
      "nameKey": "DataClassificationsPersonalData"
    }
  ],
  "description": "Age",
  "descriptionKey": "DataElementsAgeDesc",
  "id": "54432905-eac2-4088-a48e-c02b0d66359b",
  "name": "Age",
  "nameKey": "DataElementsAge"
}