/onetrust-data-mapping | Type: Application | PCID required: Yes
Tools
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 | any[] | 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’ |
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 |
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 |
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 |
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 | any[] | Yes | — | List of data categories to associate with the data element |
classifications | any[] | 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 | any[] | 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 |
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 |
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 |
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 | any[] | Yes | — | Request 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 |
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 |
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 |
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. |
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 | any[] | Yes | — | Request 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 |
onetrust_data_mapping_get_all_schemas_using_get
Get List of Inventory Schemasonetrust_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 |
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 |
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 |
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 |
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 |
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. |
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. |
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) |
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 | any[] | No | — | A list of criteria definitions to apply. All criteria in this list are typically combined with a logical AND. |
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) |
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 |
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 |
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 |
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 | any[] | Yes | — | Request 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 | any[] | Yes | — | Request 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 | any[] | Yes | — | Request 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 |
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) |
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 |
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) |
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 |
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 |
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 |
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 | any[] | No | — | List of inventory record UUIDs to be updated. |
inventoryRequest | object | No | — | Inventory Request |
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 | any[] | Yes | — | Request 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 |

