Sign in

v1

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

Create Data Subject

Use this API to create new Data Subject in the Data Mapping Automation Module.

post/api/inventory/v2/data-subjects

Query parameters

generatorstring

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": "Customer",
  "description": "End user of the service",
  "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 subject

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"
}