Custom Personal data elements Tag Details Retrieval

This endpoint facilitates retrieving custom personal data elements/entity tag details. It requires a PUT request with the specified query parameters.

Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token

Route: /metadata/custom-tag/details.

Request Type: PUT.

Input Structure:

The input structure consists of a JSON object with a data field containing:

• tag_type: The type of the custom tag
•  policy_name:Name of the Policy.(Prerequisite: Create the Policy )

.

{
   "data":{
    "policy_name":"Testing_Default_Policy"
     "tag_type":"CUSTOMER_ID"
   }
}

Response:

{
    "data": {
        "policy_name":"Testing_Default_Policy"
        "token_name": "Default Token",
        "format_name": "Default Format",
        "tag_type": "CUSTOMER_ID",
        "prefix": "<CUSTOMER_ID>",
        "suffix": "</CUSTOMER_ID>",
        "description": "CUSTOMER_ID",
        "pi_elements_list_endpoint_details": {
            "headers": {
                "Authorization": "<AUTH TOKEN>"
            },
            "method": "GET",
            "url": "<url>"
        }
    },
    "success": true,
    "error": {
        "message": ""
    }
}
    "success": true,
    "error": {
        "message": ""
    }
}

The response contains a JSON object with:

• A data field containing details of the custom tag specified by the tag_type.
  • tag_type: The type of the custom tag.
  • prefix: The prefix associated with the custom tag.
  • suffix: The suffix associated with the custom tag.
  • token_name: The name of the text token.
  • format_name: The format of the custom tag.
  • identification_endpoint_details: Details of the identification endpoint associated with the custom tag, including URL, method, and headers.
  • pi_elements_list_endpoint_details: Details of the PI elements list endpoint associated with the custom tag (if available).
  • policy_name”:Name of the Policy