ONonetrust
Personal Data

Get Data Element

Use this API to retrieve the details of a single Data Element by ID.

get/api/inventory/v2/data-elements/{id}

Request

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

Path parameters

idstring uuid required

The ID of the data element to retrieve

Response

OK

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.