onetrust-data-mapping

OneTrust Data Mapping - Manage data inventories, categories, classifications, data elements, and data subject types

Server path: /onetrust-data-mapping | Type: Application | PCID required: Yes

Tools

Tool	Description
onetrust_data_mapping_add_controls_to_inventory_using_post	Create Control Implementation
onetrust_data_mapping_copy_inventory_using_post	Copy Inventory
onetrust_data_mapping_create_data_category_using_post	Create Data Category
onetrust_data_mapping_create_data_classification_using_post	Create Data Classification
onetrust_data_mapping_create_data_element_using_post	Create Data Element
onetrust_data_mapping_create_data_subject_using_post	Create Data Subject
onetrust_data_mapping_create_inventory_using_post	Create Inventory
onetrust_data_mapping_create_relations_using_post	Link Inventory
onetrust_data_mapping_delete_category_using_delete	Delete Data Category
onetrust_data_mapping_delete_classification_using_delete	Delete Data Classification
onetrust_data_mapping_delete_element_using_delete	Delete Data Element
onetrust_data_mapping_delete_inventory_using_delete	Delete Inventory
onetrust_data_mapping_delete_relations_using_delete	Delete Inventory Link
onetrust_data_mapping_delete_subject_using_delete	Delete Data Subject
onetrust_data_mapping_get_all_schemas_using_get	Get List of Inventory Schemas
onetrust_data_mapping_get_categories_by_partial_name_using_get	Get List of Data Categories
onetrust_data_mapping_get_category_using_get	Get Data Category
onetrust_data_mapping_get_classification_using_get	Get Data Classification
onetrust_data_mapping_get_element_using_get	Get Data Element
onetrust_data_mapping_get_hierarchy_for_inventory_id_using_get	Get List of Child Inventories by Root Inventory
onetrust_data_mapping_get_inventory_by_external_id_using_get	Get Inventory by External ID
onetrust_data_mapping_get_inventory_by_id_using_get	Get Inventory by ID
onetrust_data_mapping_get_inventory_relations_by_id_using_get	Get Inventory Links
onetrust_data_mapping_get_list_of_inventories_by_filter_criteria_using_post	Get List of Inventories by Criteria
onetrust_data_mapping_get_list_of_inventories_using_get	Get List of Inventories
onetrust_data_mapping_get_schema_details_using_field_name	Get Inventory Schema Details
onetrust_data_mapping_get_subject_using_get	Get Data Subject
onetrust_data_mapping_get_subjects_by_partial_name_using_get	Get List of Data Subjects
onetrust_data_mapping_link_asset_inventory_to_parent_asset_id_using_post	Add Asset Inventory as Child to Parent Inventory
onetrust_data_mapping_link_legal_entity_inventory_to_parent_legal_entity_id_using_post	Add Legal Entity Inventory as Child to Parent Inventory
onetrust_data_mapping_link_processing_activity_inventory_to_parent_processing_activity_id_using_post	Add Processing Activity Inventory as Child to Parent Inventory
onetrust_data_mapping_link_vendor_inventory_to_parent_vendor_id_using_post	Add Vendor Inventory as Child to Parent Inventory
onetrust_data_mapping_set_inventory_as_parent_inventory_using_put	Set Inventory as Parent
onetrust_data_mapping_unlink_child_inventory_from_hierarchy_using_delete	Remove Child Inventory from Root Inventory
onetrust_data_mapping_unset_inventory_as_parent_inventory_using_put	Unset Inventory as Parent
onetrust_data_mapping_update_advanced_attributes_for_personal_data_association_using_put	Update Advanced Attributes for Personal Data Association
onetrust_data_mapping_update_inventory_association_using_put	Update Inventory Link
onetrust_data_mapping_update_inventory_status_by_id_using_put	Update Inventory Status
onetrust_data_mapping_update_inventory_using_put	Update Inventory by ID
onetrust_data_mapping_update_relations_using_put	Link Inventory
onetrust_data_mapping_upsert_inventory_using_put	Update Inventory by External ID

---

onetrust_data_mapping_add_controls_to_inventory_using_post

Create Control Implementation

Parameters:

Parameter	Type	Required	Default	Description
type	string	Yes	—	The type of inventory to add controls to
inventoryId	string	Yes	—	The unique identifier of an inventory record. This value can be obtained using the Get List of Inventories API.
controlIds	string[]	Yes	—	Set of control IDs to be implemented for the given inventory entity
status	string	No	—	Implementation status of the controls being added to the inventory. If not provided, defaults to ‘Pending’

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "type": {
      "type": "string",
      "description": "The type of inventory to add controls to",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "inventoryId": {
      "type": "string",
      "description": "The unique identifier of an inventory record. This value can be obtained using the [Get List of Inventories](/onetrust/reference/getinventorylist) API."
    },
    "controlIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Set of control IDs to be implemented for the given inventory entity"
    },
    "status": {
      "type": "string",
      "description": "Implementation status of the controls being added to the inventory. If not provided, defaults to 'Pending'",
      "enum": [
        "Implemented",
        "Not Implemented",
        "Partially Implemented",
        "Not Applicable",
        "Pending"
      ]
    }
  },
  "required": [
    "PCID",
    "type",
    "inventoryId",
    "controlIds"
  ]
}

---

onetrust_data_mapping_copy_inventory_using_post

Copy Inventory

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
id	string	Yes	—	The unique identifier of the inventory record to copy.
inheritFromMaster	boolean	No	—	Flag to indicate if the copy should inherit attributes from the master inventory.
copyRelated	boolean	No	—	Flag to indicate if related records should also be copied.
copyAsChild	boolean	No	—	Flag to indicate if the copy should be created as a child of the original inventory.
canViewDetails	boolean	No	—	Flag indicating if the current user can view inventory details
createdBy	object	No	—	Created By
createdDate	string	No	—	Date and time when the inventory was created
deletable	boolean	No	—	The deletable value
deletedBy	string	No	—	ID of the user who deleted the inventory
deletedDate	string	No	—	Date and time when the inventory was deleted
deletedReason	string	No	—	Reason for deletion of the inventory
editable	boolean	No	—	The editable value
externalId	string	No	—	External identifier of the inventory
inherentRiskLevel	string	No	—	Inherent risk level of the inventory
inherentRiskScore	number	No	—	Inherent risk score of the inventory
integrationWorkflowId	string	No	—	ID of the integration workflow
inventoryDeleteType	string	No	—	Type of deletion for the inventory
isGlobalAttributeConfigurationEnabled	boolean	No	—	Flag indicating if global attribute configuration is enabled
isParent	boolean	No	—	Flag indicating if this inventory is a parent
masterRecord	string	No	—	Reference to the master record
name	string	No	—	Name of the inventory
number	integer	No	—	Sequence number of the inventory
organization	object	No	—	The organization value
parentInventoryId	string	No	—	ID of the parent inventory
reviewType	string	No	—	Type of review for the inventory
riskLevel	string	No	—	Risk level of the inventory
riskScore	number	No	—	Risk score of the inventory
selectFields	object	No	—	Map of select fields with their values
similarRecord	object	No	—	Similar Record
sourceId	string	No	—	ID of the source inventory
sourceType	string	No	—	Type of the source inventory
status	object	No	—	The status value
targetRiskLevel	string	No	—	Target risk level of the inventory
targetRiskScore	number	No	—	Target risk score of the inventory
textFields	object	No	—	Map of text fields with their values
totalHierarchyInherentRiskLevel	string	No	—	Total hierarchy inherent risk level of the inventory
totalHierarchyInherentRiskScore	number	No	—	Total hierarchy inherent risk score of the inventory
totalHierarchyRiskLevel	string	No	—	Total hierarchy risk level of the inventory
totalHierarchyRiskScore	number	No	—	Total hierarchy risk score of the inventory
totalHierarchyTargetRiskLevel	string	No	—	Total hierarchy target risk level of the inventory
totalHierarchyTargetRiskScore	number	No	—	Total hierarchy target risk score of the inventory
updatedBy	object	No	—	Updated By
updatedDate	string	No	—	Date and time when the inventory was last updated
workflow	object	No	—	The workflow value
workflowStage	object	No	—	Workflow Stage

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of the inventory record to copy."
    },
    "inheritFromMaster": {
      "type": "boolean",
      "description": "Flag to indicate if the copy should inherit attributes from the master inventory."
    },
    "copyRelated": {
      "type": "boolean",
      "description": "Flag to indicate if related records should also be copied."
    },
    "copyAsChild": {
      "type": "boolean",
      "description": "Flag to indicate if the copy should be created as a child of the original inventory."
    },
    "canViewDetails": {
      "type": "boolean",
      "description": "Flag indicating if the current user can view inventory details"
    },
    "createdBy": {
      "type": "object",
      "description": "Created By",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "value": {
          "type": "string",
          "description": "The value value"
        },
        "valueKey": {
          "type": "string",
          "description": "Value Key"
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Date and time when the inventory was created"
    },
    "deletable": {
      "type": "boolean",
      "description": "The deletable value"
    },
    "deletedBy": {
      "type": "string",
      "description": "ID of the user who deleted the inventory"
    },
    "deletedDate": {
      "type": "string",
      "description": "Date and time when the inventory was deleted"
    },
    "deletedReason": {
      "type": "string",
      "description": "Reason for deletion of the inventory"
    },
    "editable": {
      "type": "boolean",
      "description": "The editable value"
    },
    "externalId": {
      "type": "string",
      "description": "External identifier of the inventory"
    },
    "inherentRiskLevel": {
      "type": "string",
      "description": "Inherent risk level of the inventory",
      "enum": [
        "ZERO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "VERY_HIGH"
      ]
    },
    "inherentRiskScore": {
      "type": "number",
      "description": "Inherent risk score of the inventory"
    },
    "integrationWorkflowId": {
      "type": "string",
      "description": "ID of the integration workflow"
    },
    "inventoryDeleteType": {
      "type": "string",
      "description": "Type of deletion for the inventory",
      "enum": [
        "HARD",
        "SOFT",
        "NONE"
      ]
    },
    "isGlobalAttributeConfigurationEnabled": {
      "type": "boolean",
      "description": "Flag indicating if global attribute configuration is enabled"
    },
    "isParent": {
      "type": "boolean",
      "description": "Flag indicating if this inventory is a parent"
    },
    "masterRecord": {
      "type": "string",
      "description": "Reference to the master record"
    },
    "name": {
      "type": "string",
      "description": "Name of the inventory"
    },
    "number": {
      "type": "integer",
      "description": "Sequence number of the inventory"
    },
    "organization": {
      "type": "object",
      "description": "The organization value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "value": {
          "type": "string",
          "description": "The value value"
        },
        "valueKey": {
          "type": "string",
          "description": "Value Key"
        }
      }
    },
    "parentInventoryId": {
      "type": "string",
      "description": "ID of the parent inventory"
    },
    "reviewType": {
      "type": "string",
      "description": "Type of review for the inventory"
    },
    "riskLevel": {
      "type": "string",
      "description": "Risk level of the inventory",
      "enum": [
        "ZERO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "VERY_HIGH"
      ]
    },
    "riskScore": {
      "type": "number",
      "description": "Risk score of the inventory"
    },
    "selectFields": {
      "type": "object",
      "description": "Map of select fields with their values"
    },
    "similarRecord": {
      "type": "object",
      "description": "Similar Record",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "organization": {
          "type": "object",
          "description": "The organization value"
        },
        "location": {
          "type": "object",
          "description": "The location value"
        },
        "hasAccessToSimilarRecord": {
          "type": "boolean",
          "description": "Has Access To Similar Record"
        }
      }
    },
    "sourceId": {
      "type": "string",
      "description": "ID of the source inventory"
    },
    "sourceType": {
      "type": "string",
      "description": "Type of the source inventory"
    },
    "status": {
      "type": "object",
      "description": "The status value",
      "properties": {
        "key": {
          "type": "string",
          "description": "The key identifier"
        },
        "name": {
          "type": "string",
          "description": "The display name associated with the key"
        }
      },
      "required": [
        "key"
      ]
    },
    "targetRiskLevel": {
      "type": "string",
      "description": "Target risk level of the inventory",
      "enum": [
        "ZERO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "VERY_HIGH"
      ]
    },
    "targetRiskScore": {
      "type": "number",
      "description": "Target risk score of the inventory"
    },
    "textFields": {
      "type": "object",
      "description": "Map of text fields with their values"
    },
    "totalHierarchyInherentRiskLevel": {
      "type": "string",
      "description": "Total hierarchy inherent risk level of the inventory",
      "enum": [
        "ZERO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "VERY_HIGH"
      ]
    },
    "totalHierarchyInherentRiskScore": {
      "type": "number",
      "description": "Total hierarchy inherent risk score of the inventory"
    },
    "totalHierarchyRiskLevel": {
      "type": "string",
      "description": "Total hierarchy risk level of the inventory",
      "enum": [
        "ZERO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "VERY_HIGH"
      ]
    },
    "totalHierarchyRiskScore": {
      "type": "number",
      "description": "Total hierarchy risk score of the inventory"
    },
    "totalHierarchyTargetRiskLevel": {
      "type": "string",
      "description": "Total hierarchy target risk level of the inventory",
      "enum": [
        "ZERO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "VERY_HIGH"
      ]
    },
    "totalHierarchyTargetRiskScore": {
      "type": "number",
      "description": "Total hierarchy target risk score of the inventory"
    },
    "updatedBy": {
      "type": "object",
      "description": "Updated By",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "value": {
          "type": "string",
          "description": "The value value"
        },
        "valueKey": {
          "type": "string",
          "description": "Value Key"
        }
      }
    },
    "updatedDate": {
      "type": "string",
      "description": "Date and time when the inventory was last updated"
    },
    "workflow": {
      "type": "object",
      "description": "The workflow value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "value": {
          "type": "string",
          "description": "The value value"
        },
        "valueKey": {
          "type": "string",
          "description": "Value Key"
        }
      }
    },
    "workflowStage": {
      "type": "object",
      "description": "Workflow Stage",
      "properties": {
        "stage": {
          "type": "object",
          "description": "The stage value"
        },
        "badgeColor": {
          "type": "string",
          "description": "Color code for the workflow stage badge"
        }
      }
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "id"
  ]
}

---

onetrust_data_mapping_create_data_category_using_post

Create Data Category

Parameters:

Parameter	Type	Required	Default	Description
generator	string	No	—	Optional generator parameter
description	string	No	—	Description of the personal data entity
status	string	No	—	Status of the personal data entity
tagId	string	No	—	ID of the associated tag
termId	string	No	—	ID of the associated term
value	string	Yes	—	Name of the personal data entity

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "generator": {
      "type": "string",
      "description": "Optional generator parameter"
    },
    "description": {
      "type": "string",
      "description": "Description of the personal data entity"
    },
    "status": {
      "type": "string",
      "description": "Status of the personal data entity",
      "enum": [
        "Active",
        "Inactive",
        "Draft"
      ]
    },
    "tagId": {
      "type": "string",
      "description": "ID of the associated tag"
    },
    "termId": {
      "type": "string",
      "description": "ID of the associated term"
    },
    "value": {
      "type": "string",
      "description": "Name of the personal data entity"
    }
  },
  "required": [
    "PCID",
    "value"
  ]
}

---

onetrust_data_mapping_create_data_classification_using_post

Create Data Classification

Parameters:

Parameter	Type	Required	Default	Description
generator	string	No	—	Optional generator parameter
description	string	No	—	Description of the personal data entity
status	string	No	—	Status of the personal data entity
tagId	string	No	—	ID of the associated tag
termId	string	No	—	ID of the associated term
value	string	Yes	—	Name of the personal data entity

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "generator": {
      "type": "string",
      "description": "Optional generator parameter"
    },
    "description": {
      "type": "string",
      "description": "Description of the personal data entity"
    },
    "status": {
      "type": "string",
      "description": "Status of the personal data entity",
      "enum": [
        "Active",
        "Inactive",
        "Draft"
      ]
    },
    "tagId": {
      "type": "string",
      "description": "ID of the associated tag"
    },
    "termId": {
      "type": "string",
      "description": "ID of the associated term"
    },
    "value": {
      "type": "string",
      "description": "Name of the personal data entity"
    }
  },
  "required": [
    "PCID",
    "value"
  ]
}

---

onetrust_data_mapping_create_data_element_using_post

Create Data Element

Parameters:

Parameter	Type	Required	Default	Description
generator	string	No	—	Optional generator parameter
assignToAllSubjects	boolean	No	—	Flag indicating whether to assign the data element to all subjects
categories	object[]	Yes	—	List of data categories to associate with the data element
classifications	object[]	No	—	List of data classifications to associate with the data element
description	string	No	—	Description of the personal data entity
status	string	No	—	Status of the personal data entity
subjects	object[]	No	—	List of data subjects to associate with the data element
tagId	string	No	—	ID of the associated tag
termId	string	No	—	ID of the associated term
value	string	Yes	—	Name of the personal data entity

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "generator": {
      "type": "string",
      "description": "Optional generator parameter"
    },
    "assignToAllSubjects": {
      "type": "boolean",
      "description": "Flag indicating whether to assign the data element to all subjects"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The id value"
          },
          "value": {
            "type": "string",
            "description": "The value value"
          },
          "valueKey": {
            "type": "string",
            "description": "Value Key"
          }
        }
      },
      "description": "List of data categories to associate with the data element"
    },
    "classifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The id value"
          },
          "value": {
            "type": "string",
            "description": "The value value"
          },
          "valueKey": {
            "type": "string",
            "description": "Value Key"
          }
        }
      },
      "description": "List of data classifications to associate with the data element"
    },
    "description": {
      "type": "string",
      "description": "Description of the personal data entity"
    },
    "status": {
      "type": "string",
      "description": "Status of the personal data entity",
      "enum": [
        "Active",
        "Inactive",
        "Draft"
      ]
    },
    "subjects": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The id value"
          },
          "value": {
            "type": "string",
            "description": "The value value"
          },
          "valueKey": {
            "type": "string",
            "description": "Value Key"
          }
        }
      },
      "description": "List of data subjects to associate with the data element"
    },
    "tagId": {
      "type": "string",
      "description": "ID of the associated tag"
    },
    "termId": {
      "type": "string",
      "description": "ID of the associated term"
    },
    "value": {
      "type": "string",
      "description": "Name of the personal data entity"
    }
  },
  "required": [
    "PCID",
    "categories",
    "value"
  ]
}

---

onetrust_data_mapping_create_data_subject_using_post

Create Data Subject

Parameters:

Parameter	Type	Required	Default	Description
generator	string	No	—	The generator value
description	string	No	—	Description of the personal data entity
status	string	No	—	Status of the personal data entity
tagId	string	No	—	ID of the associated tag
termId	string	No	—	ID of the associated term
value	string	Yes	—	Name of the personal data entity

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "generator": {
      "type": "string",
      "description": "The generator value"
    },
    "description": {
      "type": "string",
      "description": "Description of the personal data entity"
    },
    "status": {
      "type": "string",
      "description": "Status of the personal data entity",
      "enum": [
        "Active",
        "Inactive",
        "Draft"
      ]
    },
    "tagId": {
      "type": "string",
      "description": "ID of the associated tag"
    },
    "termId": {
      "type": "string",
      "description": "ID of the associated term"
    },
    "value": {
      "type": "string",
      "description": "Name of the personal data entity"
    }
  },
  "required": [
    "PCID",
    "value"
  ]
}

---

onetrust_data_mapping_create_inventory_using_post

Create Inventory

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
generator	string	No	—	Optional generator type for the create operation.
createAsMaster	boolean	No	—	Flag to create the inventory as a master record.
sourceId	string	No	—	Optional source inventory UUID to copy from.
body	string	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "generator": {
      "type": "string",
      "description": "Optional generator type for the create operation."
    },
    "createAsMaster": {
      "type": "boolean",
      "description": "Flag to create the inventory as a master record."
    },
    "sourceId": {
      "type": "string",
      "description": "Optional source inventory UUID to copy from."
    },
    "body": {
      "type": "string",
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "body"
  ]
}

---

onetrust_data_mapping_create_relations_using_post

Link Inventory

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The unique identifier of an inventory record. The value can be obtained using the List Inventories API.
entityType	string	No	—	Entity type parameter
body	object[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API."
    },
    "entityType": {
      "type": "string",
      "description": "Entity type parameter",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "relation": {
            "type": "string",
            "enum": [
              "ControllerLinkType",
              "JointControllerLinkType",
              "RelatedLinkType",
              "RecipientOfSaleLinkType",
              "SubProcessorLinkType",
              "ProcessorLinkType",
              "DestinationAccessLinkType",
              "ProductOrServiceProviderLinkType",
              "StorageProcessingLinkType",
              "SourceCollectionLinkType"
            ],
            "description": "The type of relationship between inventory records"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier of the inventory record to link to"
          },
          "entityType": {
            "type": "string",
            "description": "The type of the inventory entity"
          }
        },
        "required": [
          "id"
        ]
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "id",
    "body"
  ]
}

---

onetrust_data_mapping_delete_category_using_delete

Delete Data Category

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data category to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data category to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_delete_classification_using_delete

Delete Data Classification

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data classification to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data classification to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_delete_element_using_delete

Delete Data Element

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data element to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data element to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_delete_inventory_using_delete

Delete Inventory

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
id	string	Yes	—	The unique identifier of an inventory record.
deleteType	string	No	—	The type of deletion to perform. SOFT marks the record as deleted but retains it, HARD permanently deletes it.
deleteReason	string	No	—	An optional message for auditing indicating why the record was deleted.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record."
    },
    "deleteType": {
      "type": "string",
      "description": "The type of deletion to perform. SOFT marks the record as deleted but retains it, HARD permanently deletes it.",
      "enum": [
        "SOFT",
        "HARD"
      ]
    },
    "deleteReason": {
      "type": "string",
      "description": "An optional message for auditing indicating why the record was deleted."
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "id"
  ]
}

---

onetrust_data_mapping_delete_relations_using_delete

Delete Inventory Link

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The unique identifier of an inventory record. The value can be obtained using the List Inventories API.
body	object[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API."
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "inventoryAssociationId": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier of the association to remove"
          }
        },
        "required": [
          "inventoryAssociationId"
        ]
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "id",
    "body"
  ]
}

---

onetrust_data_mapping_delete_subject_using_delete

Delete Data Subject

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data subject to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data subject to delete"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_get_all_schemas_using_get

Get List of Inventory Schemas

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

onetrust_data_mapping_get_categories_by_partial_name_using_get

Get List of Data Categories

Parameters:

Parameter	Type	Required	Default	Description
filter	string	No	—	Optional filter string to search data categories by name
page	integer	No	—	Results page to be retrieved (0..N)
size	integer	No	—	Number of records per page (1..50)
sort	string	No	—	Sorting criteria in the format: property(,asc|desc). Default sort order is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "string",
      "description": "Optional filter string to search data categories by name"
    },
    "page": {
      "type": "integer",
      "description": "Results page to be retrieved (0..N)"
    },
    "size": {
      "type": "integer",
      "description": "Number of records per page (1..50)"
    },
    "sort": {
      "type": "string",
      "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending",
      "enum": [
        "name,asc",
        "name,desc",
        "createdDate,asc",
        "createdDate,desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

onetrust_data_mapping_get_category_using_get

Get Data Category

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data category to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data category to retrieve"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_get_classification_using_get

Get Data Classification

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data classification to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data classification to retrieve"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_get_element_using_get

Get Data Element

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the data element to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the data element to retrieve"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_get_hierarchy_for_inventory_id_using_get

Get List of Child Inventories by Root Inventory

Parameters:

Parameter	Type	Required	Default	Description
rootInventoryId	string	Yes	—	The unique identifier of the root inventory
inventoryType	string	Yes	—	The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)
page	integer	No	—	Results page to be retrieved (0..N)
size	integer	No	—	Number of records per page (1..50)
sort	string	No	—	Sorting criteria in the format: property(,asc|desc). Default sort order is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rootInventoryId": {
      "type": "string",
      "description": "The unique identifier of the root inventory"
    },
    "inventoryType": {
      "type": "string",
      "description": "The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Results page to be retrieved (0..N)"
    },
    "size": {
      "type": "integer",
      "description": "Number of records per page (1..50)"
    },
    "sort": {
      "type": "string",
      "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending",
      "enum": [
        "name,asc",
        "name,desc",
        "createdDate,asc",
        "createdDate,desc"
      ]
    }
  },
  "required": [
    "PCID",
    "rootInventoryId",
    "inventoryType"
  ]
}

---

onetrust_data_mapping_get_inventory_by_external_id_using_get

Get Inventory by External ID

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema. The value can be obtained using the Get Schemas API.
externalId	string	Yes	—	The external identifier of the inventory item.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema. The value can be obtained using the [Get Schemas](/onetrust/reference/getSchemas) API.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "externalId": {
      "type": "string",
      "description": "The external identifier of the inventory item."
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "externalId"
  ]
}

---

onetrust_data_mapping_get_inventory_by_id_using_get

Get Inventory by ID

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema. The value can be obtained using the Get Schemas API.
id	string	Yes	—	The unique identifier of an inventory record. The value can be obtained using the List Inventories API.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema. The value can be obtained using the [Get Schemas](/onetrust/reference/getSchemas) API.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API."
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "id"
  ]
}

---

onetrust_data_mapping_get_inventory_relations_by_id_using_get

Get Inventory Links

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The unique identifier of an inventory record. The value can be obtained using the List Inventories API.
inventoryType	string	Yes	—	The type of inventory records to check relations for.
page	integer	No	—	Results page to be retrieved (0..N)
size	integer	No	—	Number of records per page (1..50)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API."
    },
    "inventoryType": {
      "type": "string",
      "description": "The type of inventory records to check relations for.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities",
        "data-elements"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Results page to be retrieved (0..N)"
    },
    "size": {
      "type": "integer",
      "description": "Number of records per page (1..50)"
    }
  },
  "required": [
    "PCID",
    "id",
    "inventoryType"
  ]
}

---

onetrust_data_mapping_get_list_of_inventories_by_filter_criteria_using_post

Get List of Inventories by Criteria

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
markForDelete	boolean	No	—	Flag to include soft-deleted inventories.
page	integer	No	—	Results page to be retrieved (0..N)
size	integer	No	—	Number of records per page (1..50)
filters	object[]	No	—	A list of criteria definitions to apply. All criteria in this list are typically combined with a logical AND.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "markForDelete": {
      "type": "boolean",
      "description": "Flag to include soft-deleted inventories."
    },
    "page": {
      "type": "integer",
      "description": "Results page to be retrieved (0..N)"
    },
    "size": {
      "type": "integer",
      "description": "Number of records per page (1..50)"
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "attributeKey": {
            "type": "string",
            "description": "The key or path of the attribute to filter on (e.g., 'name', 'status.key', 'customFields.someCustomField')."
          },
          "dataType": {
            "type": "integer",
            "format": "int32",
            "enum": [
              "0",
              "1",
              "2"
            ],
            "description": "The data type of the attribute being filtered. (Note: Consider replacing with a more descriptive enum or String if specific integer values have meanings, e.g., 0 for String, 1 for Number, 2 for Date). For now, assuming it's an internal type identifier."
          },
          "operator": {
            "type": "string",
            "enum": [
              "FilterOperator.EQUAL_TO(description=Equal To)",
              "FilterOperator.EQ(description=Equals)",
              "FilterOperator.LT(description=LessThan)",
              "FilterOperator.GT(description=GreaterThan)",
              "FilterOperator.LE(description=LessThanOrEquals)",
              "FilterOperator.GE(description=GreaterThanOrEquals)",
              "FilterOperator.IN_BETWEEN(description=InBetween)",
              "FilterOperator.CONTAINS(description=Contains)",
              "FilterOperator.DOES_NOT_CONTAIN(description=DoesNotContain)",
              "EQUAL_TO",
              "EQ",
              "LT",
              "GT",
              "LE",
              "GE",
              "IN_BETWEEN",
              "CONTAINS",
              "DOES_NOT_CONTAIN"
            ],
            "description": "The operator to use for comparing the attribute with the provided values (e.g., EQUALS, CONTAINS, GREATER_THAN)."
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "An array of string values to match against the attribute. For operators like 'IN', multiple values can be provided. For others, typically one value is used."
          },
          "date": {
            "type": "object",
            "description": "The date value"
          }
        }
      },
      "description": "A list of criteria definitions to apply. All criteria in this list are typically combined with a logical AND."
    }
  },
  "required": [
    "PCID",
    "schemaName"
  ]
}

---

onetrust_data_mapping_get_list_of_inventories_using_get

Get List of Inventories

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema. The value can be obtained using the Get Schemas API.
filter	string	No	—	Filter string for searching inventories. Format: ‘searchText=value’.
markForDelete	boolean	No	—	Flag to include soft-deleted inventories.
page	integer	No	—	Results page to be retrieved (0..N)
size	integer	No	—	Number of records per page (1..50)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema. The value can be obtained using the [Get Schemas](/onetrust/reference/getSchemas) API.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "filter": {
      "type": "string",
      "description": "Filter string for searching inventories. Format: 'searchText=value'."
    },
    "markForDelete": {
      "type": "boolean",
      "description": "Flag to include soft-deleted inventories."
    },
    "page": {
      "type": "integer",
      "description": "Results page to be retrieved (0..N)"
    },
    "size": {
      "type": "integer",
      "description": "Number of records per page (1..50)"
    }
  },
  "required": [
    "PCID",
    "schemaName"
  ]
}

---

onetrust_data_mapping_get_schema_details_using_field_name

Get Inventory Schema Details

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	Type of the inventory or schema. The supporting types are ‘processing-activities’, ‘vendors’, ‘assets’, and ‘entities’.
fieldName	string	Yes	—	Field name of the attribute to retrieve details for
showAll	boolean	No	—	Flag to show all attribute values including inactive ones
optionsSize	integer	No	—	Options Size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "Type of the inventory or schema. The supporting types are 'processing-activities', 'vendors', 'assets', and 'entities'.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "fieldName": {
      "type": "string",
      "description": "Field name of the attribute to retrieve details for"
    },
    "showAll": {
      "type": "boolean",
      "description": "Flag to show all attribute values including inactive ones",
      "enum": [
        "true",
        "false"
      ]
    },
    "optionsSize": {
      "type": "integer",
      "description": "Options Size"
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "fieldName"
  ]
}

---

onetrust_data_mapping_get_subject_using_get

Get Data Subject

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the Data Subject

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the Data Subject"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

onetrust_data_mapping_get_subjects_by_partial_name_using_get

Get List of Data Subjects

Parameters:

Parameter	Type	Required	Default	Description
filter	string	No	—	Optional filter string to search data subjects by name
page	integer	No	—	Results page to be retrieved (0..N)
size	integer	No	—	Number of records per page (1..50)
sort	string	No	—	Sorting criteria in the format: property(,asc|desc). Default sort order is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "string",
      "description": "Optional filter string to search data subjects by name"
    },
    "page": {
      "type": "integer",
      "description": "Results page to be retrieved (0..N)"
    },
    "size": {
      "type": "integer",
      "description": "Number of records per page (1..50)"
    },
    "sort": {
      "type": "string",
      "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending",
      "enum": [
        "name,asc",
        "name,desc",
        "createdDate,asc",
        "createdDate,desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

onetrust_data_mapping_link_asset_inventory_to_parent_asset_id_using_post

Add Asset Inventory as Child to Parent Inventory

Parameters:

Parameter	Type	Required	Default	Description
parentInventoryId	string	Yes	—	The unique identifier of the parent asset inventory
body	string[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "parentInventoryId": {
      "type": "string",
      "description": "The unique identifier of the parent asset inventory"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "parentInventoryId",
    "body"
  ]
}

---

onetrust_data_mapping_link_legal_entity_inventory_to_parent_legal_entity_id_using_post

Add Legal Entity Inventory as Child to Parent Inventory

Parameters:

Parameter	Type	Required	Default	Description
parentInventoryId	string	Yes	—	The unique identifier of the parent legal entity inventory
body	string[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "parentInventoryId": {
      "type": "string",
      "description": "The unique identifier of the parent legal entity inventory"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "parentInventoryId",
    "body"
  ]
}

---

onetrust_data_mapping_link_processing_activity_inventory_to_parent_processing_activity_id_using_post

Add Processing Activity Inventory as Child to Parent Inventory

Parameters:

Parameter	Type	Required	Default	Description
parentInventoryId	string	Yes	—	The unique identifier of the parent processing activity inventory
body	string[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "parentInventoryId": {
      "type": "string",
      "description": "The unique identifier of the parent processing activity inventory"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "parentInventoryId",
    "body"
  ]
}

---

onetrust_data_mapping_link_vendor_inventory_to_parent_vendor_id_using_post

Add Vendor Inventory as Child to Parent Inventory

Parameters:

Parameter	Type	Required	Default	Description
parentInventoryId	string	Yes	—	The unique identifier of the parent vendor inventory
body	any[]	Yes	—	List of child vendor inventory IDs to link to the parent

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "parentInventoryId": {
      "type": "string",
      "description": "The unique identifier of the parent vendor inventory"
    },
    "body": {
      "type": "array",
      "description": "List of child vendor inventory IDs to link to the parent"
    }
  },
  "required": [
    "PCID",
    "parentInventoryId",
    "body"
  ]
}

---

onetrust_data_mapping_set_inventory_as_parent_inventory_using_put

Set Inventory as Parent

Parameters:

Parameter	Type	Required	Default	Description
inventoryId	string	Yes	—	The unique identifier of the inventory to set as parent
inventoryType	string	Yes	—	The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "inventoryId": {
      "type": "string",
      "description": "The unique identifier of the inventory to set as parent"
    },
    "inventoryType": {
      "type": "string",
      "description": "The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    }
  },
  "required": [
    "PCID",
    "inventoryId",
    "inventoryType"
  ]
}

---

onetrust_data_mapping_unlink_child_inventory_from_hierarchy_using_delete

Remove Child Inventory from Root Inventory

Parameters:

Parameter	Type	Required	Default	Description
rootInventoryId	string	Yes	—	The unique identifier of the root inventory
inventoryType	string	Yes	—	The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)
childInventoryId	string	Yes	—	The unique identifier of the child inventory to unlink

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rootInventoryId": {
      "type": "string",
      "description": "The unique identifier of the root inventory"
    },
    "inventoryType": {
      "type": "string",
      "description": "The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "childInventoryId": {
      "type": "string",
      "description": "The unique identifier of the child inventory to unlink"
    }
  },
  "required": [
    "PCID",
    "rootInventoryId",
    "inventoryType",
    "childInventoryId"
  ]
}

---

onetrust_data_mapping_unset_inventory_as_parent_inventory_using_put

Unset Inventory as Parent

Parameters:

Parameter	Type	Required	Default	Description
inventoryId	string	Yes	—	The unique identifier of the inventory to unset as parent
inventoryType	string	Yes	—	The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "inventoryId": {
      "type": "string",
      "description": "The unique identifier of the inventory to unset as parent"
    },
    "inventoryType": {
      "type": "string",
      "description": "The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    }
  },
  "required": [
    "PCID",
    "inventoryId",
    "inventoryType"
  ]
}

---

onetrust_data_mapping_update_advanced_attributes_for_personal_data_association_using_put

Update Advanced Attributes for Personal Data Association

Parameters:

Parameter	Type	Required	Default	Description
inventoryType	string	Yes	—	Type of the inventory
personalDataAssociationId	string	Yes	—	ID of the personal data association
linkAttributes	object	No	—	Link Attributes

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "inventoryType": {
      "type": "string",
      "description": "Type of the inventory",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "personalDataAssociationId": {
      "type": "string",
      "description": "ID of the personal data association"
    },
    "linkAttributes": {
      "type": "object",
      "description": "Link Attributes"
    }
  },
  "required": [
    "PCID",
    "inventoryType",
    "personalDataAssociationId"
  ]
}

---

onetrust_data_mapping_update_inventory_association_using_put

Update Inventory Link

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The unique identifier of an inventory record
associationId	string	Yes	—	The unique identifier of the association
relation	string	No	—	The type of relationship between inventory records

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record"
    },
    "associationId": {
      "type": "string",
      "description": "The unique identifier of the association"
    },
    "relation": {
      "type": "string",
      "description": "The type of relationship between inventory records",
      "enum": [
        "ControllerLinkType",
        "JointControllerLinkType",
        "RelatedLinkType",
        "RecipientOfSaleLinkType",
        "SubProcessorLinkType",
        "ProcessorLinkType",
        "DestinationAccessLinkType",
        "ProductOrServiceProviderLinkType",
        "StorageProcessingLinkType",
        "SourceCollectionLinkType"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "associationId"
  ]
}

---

onetrust_data_mapping_update_inventory_status_by_id_using_put

Update Inventory Status

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
id	string	Yes	—	The unique identifier of an inventory record.
key	string	Yes	—	The key identifier
name	string	No	—	The display name associated with the key

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record."
    },
    "key": {
      "type": "string",
      "description": "The key identifier"
    },
    "name": {
      "type": "string",
      "description": "The display name associated with the key"
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "id",
    "key"
  ]
}

---

onetrust_data_mapping_update_inventory_using_put

Update Inventory by ID

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
id	string	Yes	—	The unique identifier of an inventory record.
primaryEntity	boolean	No	—	Flag to indicate if this is a primary entity update.
inventoryIds	string[]	No	—	List of inventory record UUIDs to be updated.
inventoryRequest	object	No	—	Inventory Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record."
    },
    "primaryEntity": {
      "type": "boolean",
      "description": "Flag to indicate if this is a primary entity update."
    },
    "inventoryIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "List of inventory record UUIDs to be updated."
    },
    "inventoryRequest": {
      "type": "object",
      "description": "Inventory Request"
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "id"
  ]
}

---

onetrust_data_mapping_update_relations_using_put

Link Inventory

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The unique identifier of an inventory record
entityType	string	No	—	Entity type parameter
body	object[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of an inventory record"
    },
    "entityType": {
      "type": "string",
      "description": "Entity type parameter",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "relation": {
            "type": "string",
            "enum": [
              "ControllerLinkType",
              "JointControllerLinkType",
              "RelatedLinkType",
              "RecipientOfSaleLinkType",
              "SubProcessorLinkType",
              "ProcessorLinkType",
              "DestinationAccessLinkType",
              "ProductOrServiceProviderLinkType",
              "StorageProcessingLinkType",
              "SourceCollectionLinkType"
            ],
            "description": "The type of relationship between inventory records"
          },
          "InventoryType": {
            "type": "string",
            "enum": [
              "processing-activities",
              "vendors",
              "assets",
              "entities"
            ],
            "description": "Inventory Type"
          },
          "Ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The ids value"
          }
        },
        "required": [
          "Ids",
          "InventoryType"
        ]
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "id",
    "body"
  ]
}

---

onetrust_data_mapping_upsert_inventory_using_put

Update Inventory by External ID

Parameters:

Parameter	Type	Required	Default	Description
schemaName	string	Yes	—	The name property of the schema.
generator	string	No	—	Optional generator type for the operation.
body	string	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schemaName": {
      "type": "string",
      "description": "The `name` property of the schema.",
      "enum": [
        "processing-activities",
        "vendors",
        "assets",
        "entities"
      ]
    },
    "generator": {
      "type": "string",
      "description": "Optional generator type for the operation."
    },
    "body": {
      "type": "string",
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "schemaName",
    "body"
  ]
}