Skip to main content
Server path: /onetrust-data-mapping | Type: Application | PCID required: Yes

Tools

ToolDescription
onetrust_data_mapping_add_controls_to_inventory_using_postCreate Control Implementation
onetrust_data_mapping_copy_inventory_using_postCopy Inventory
onetrust_data_mapping_create_data_category_using_postCreate Data Category
onetrust_data_mapping_create_data_classification_using_postCreate Data Classification
onetrust_data_mapping_create_data_element_using_postCreate Data Element
onetrust_data_mapping_create_data_subject_using_postCreate Data Subject
onetrust_data_mapping_create_inventory_using_postCreate Inventory
onetrust_data_mapping_create_relations_using_postLink Inventory
onetrust_data_mapping_delete_category_using_deleteDelete Data Category
onetrust_data_mapping_delete_classification_using_deleteDelete Data Classification
onetrust_data_mapping_delete_element_using_deleteDelete Data Element
onetrust_data_mapping_delete_inventory_using_deleteDelete Inventory
onetrust_data_mapping_delete_relations_using_deleteDelete Inventory Link
onetrust_data_mapping_delete_subject_using_deleteDelete Data Subject
onetrust_data_mapping_get_all_schemas_using_getGet List of Inventory Schemas
onetrust_data_mapping_get_categories_by_partial_name_using_getGet List of Data Categories
onetrust_data_mapping_get_category_using_getGet Data Category
onetrust_data_mapping_get_classification_using_getGet Data Classification
onetrust_data_mapping_get_element_using_getGet Data Element
onetrust_data_mapping_get_hierarchy_for_inventory_id_using_getGet List of Child Inventories by Root Inventory
onetrust_data_mapping_get_inventory_by_external_id_using_getGet Inventory by External ID
onetrust_data_mapping_get_inventory_by_id_using_getGet Inventory by ID
onetrust_data_mapping_get_inventory_relations_by_id_using_getGet Inventory Links
onetrust_data_mapping_get_list_of_inventories_by_filter_criteria_using_postGet List of Inventories by Criteria
onetrust_data_mapping_get_list_of_inventories_using_getGet List of Inventories
onetrust_data_mapping_get_schema_details_using_field_nameGet Inventory Schema Details
onetrust_data_mapping_get_subject_using_getGet Data Subject
onetrust_data_mapping_get_subjects_by_partial_name_using_getGet List of Data Subjects
onetrust_data_mapping_link_asset_inventory_to_parent_asset_id_using_postAdd Asset Inventory as Child to Parent Inventory
onetrust_data_mapping_link_legal_entity_inventory_to_parent_legal_entity_id_using_postAdd Legal Entity Inventory as Child to Parent Inventory
onetrust_data_mapping_link_processing_activity_inventory_to_parent_processing_activity_id_using_postAdd Processing Activity Inventory as Child to Parent Inventory
onetrust_data_mapping_link_vendor_inventory_to_parent_vendor_id_using_postAdd Vendor Inventory as Child to Parent Inventory
onetrust_data_mapping_set_inventory_as_parent_inventory_using_putSet Inventory as Parent
onetrust_data_mapping_unlink_child_inventory_from_hierarchy_using_deleteRemove Child Inventory from Root Inventory
onetrust_data_mapping_unset_inventory_as_parent_inventory_using_putUnset Inventory as Parent
onetrust_data_mapping_update_advanced_attributes_for_personal_data_association_using_putUpdate Advanced Attributes for Personal Data Association
onetrust_data_mapping_update_inventory_association_using_putUpdate Inventory Link
onetrust_data_mapping_update_inventory_status_by_id_using_putUpdate Inventory Status
onetrust_data_mapping_update_inventory_using_putUpdate Inventory by ID
onetrust_data_mapping_update_relations_using_putLink Inventory
onetrust_data_mapping_upsert_inventory_using_putUpdate Inventory by External ID

onetrust_data_mapping_add_controls_to_inventory_using_post

Create Control Implementation Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesThe type of inventory to add controls to
inventoryIdstringYesThe unique identifier of an inventory record. This value can be obtained using the Get List of Inventories API.
controlIdsany[]YesSet of control IDs to be implemented for the given inventory entity
statusstringNoImplementation 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:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
idstringYesThe unique identifier of the inventory record to copy.
inheritFromMasterbooleanNoFlag to indicate if the copy should inherit attributes from the master inventory.
copyRelatedbooleanNoFlag to indicate if related records should also be copied.
copyAsChildbooleanNoFlag to indicate if the copy should be created as a child of the original inventory.
canViewDetailsbooleanNoFlag indicating if the current user can view inventory details
createdByobjectNoCreated By
createdDatestringNoDate and time when the inventory was created
deletablebooleanNoThe deletable value
deletedBystringNoID of the user who deleted the inventory
deletedDatestringNoDate and time when the inventory was deleted
deletedReasonstringNoReason for deletion of the inventory
editablebooleanNoThe editable value
externalIdstringNoExternal identifier of the inventory
inherentRiskLevelstringNoInherent risk level of the inventory
inherentRiskScorenumberNoInherent risk score of the inventory
integrationWorkflowIdstringNoID of the integration workflow
inventoryDeleteTypestringNoType of deletion for the inventory
isGlobalAttributeConfigurationEnabledbooleanNoFlag indicating if global attribute configuration is enabled
isParentbooleanNoFlag indicating if this inventory is a parent
masterRecordstringNoReference to the master record
namestringNoName of the inventory
numberintegerNoSequence number of the inventory
organizationobjectNoThe organization value
parentInventoryIdstringNoID of the parent inventory
reviewTypestringNoType of review for the inventory
riskLevelstringNoRisk level of the inventory
riskScorenumberNoRisk score of the inventory
selectFieldsobjectNoMap of select fields with their values
similarRecordobjectNoSimilar Record
sourceIdstringNoID of the source inventory
sourceTypestringNoType of the source inventory
statusobjectNoThe status value
targetRiskLevelstringNoTarget risk level of the inventory
targetRiskScorenumberNoTarget risk score of the inventory
textFieldsobjectNoMap of text fields with their values
totalHierarchyInherentRiskLevelstringNoTotal hierarchy inherent risk level of the inventory
totalHierarchyInherentRiskScorenumberNoTotal hierarchy inherent risk score of the inventory
totalHierarchyRiskLevelstringNoTotal hierarchy risk level of the inventory
totalHierarchyRiskScorenumberNoTotal hierarchy risk score of the inventory
totalHierarchyTargetRiskLevelstringNoTotal hierarchy target risk level of the inventory
totalHierarchyTargetRiskScorenumberNoTotal hierarchy target risk score of the inventory
updatedByobjectNoUpdated By
updatedDatestringNoDate and time when the inventory was last updated
workflowobjectNoThe workflow value
workflowStageobjectNoWorkflow Stage

onetrust_data_mapping_create_data_category_using_post

Create Data Category Parameters:
ParameterTypeRequiredDefaultDescription
generatorstringNoOptional generator parameter
descriptionstringNoDescription of the personal data entity
statusstringNoStatus of the personal data entity
tagIdstringNoID of the associated tag
termIdstringNoID of the associated term
valuestringYesName of the personal data entity

onetrust_data_mapping_create_data_classification_using_post

Create Data Classification Parameters:
ParameterTypeRequiredDefaultDescription
generatorstringNoOptional generator parameter
descriptionstringNoDescription of the personal data entity
statusstringNoStatus of the personal data entity
tagIdstringNoID of the associated tag
termIdstringNoID of the associated term
valuestringYesName of the personal data entity

onetrust_data_mapping_create_data_element_using_post

Create Data Element Parameters:
ParameterTypeRequiredDefaultDescription
generatorstringNoOptional generator parameter
assignToAllSubjectsbooleanNoFlag indicating whether to assign the data element to all subjects
categoriesany[]YesList of data categories to associate with the data element
classificationsany[]NoList of data classifications to associate with the data element
descriptionstringNoDescription of the personal data entity
statusstringNoStatus of the personal data entity
subjectsany[]NoList of data subjects to associate with the data element
tagIdstringNoID of the associated tag
termIdstringNoID of the associated term
valuestringYesName of the personal data entity

onetrust_data_mapping_create_data_subject_using_post

Create Data Subject Parameters:
ParameterTypeRequiredDefaultDescription
generatorstringNoThe generator value
descriptionstringNoDescription of the personal data entity
statusstringNoStatus of the personal data entity
tagIdstringNoID of the associated tag
termIdstringNoID of the associated term
valuestringYesName of the personal data entity

onetrust_data_mapping_create_inventory_using_post

Create Inventory Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
generatorstringNoOptional generator type for the create operation.
createAsMasterbooleanNoFlag to create the inventory as a master record.
sourceIdstringNoOptional source inventory UUID to copy from.
bodystringYesRequest body

onetrust_data_mapping_create_relations_using_post

Link Inventory Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of an inventory record. The value can be obtained using the List Inventories API.
entityTypestringNoEntity type parameter
bodyany[]YesRequest body

onetrust_data_mapping_delete_category_using_delete

Delete Data Category Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the data category to delete

onetrust_data_mapping_delete_classification_using_delete

Delete Data Classification Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the data classification to delete

onetrust_data_mapping_delete_element_using_delete

Delete Data Element Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the data element to delete

onetrust_data_mapping_delete_inventory_using_delete

Delete Inventory Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
idstringYesThe unique identifier of an inventory record.
deleteTypestringNoThe type of deletion to perform. SOFT marks the record as deleted but retains it, HARD permanently deletes it.
deleteReasonstringNoAn optional message for auditing indicating why the record was deleted.

onetrust_data_mapping_delete_relations_using_delete

Delete Inventory Link Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of an inventory record. The value can be obtained using the List Inventories API.
bodyany[]YesRequest body

onetrust_data_mapping_delete_subject_using_delete

Delete Data Subject Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the data subject to delete

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 Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoOptional filter string to search data categories by name
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber of records per page (1..50)
sortstringNoSorting criteria in the format: property(,asc|desc). Default sort order is ascending

onetrust_data_mapping_get_category_using_get

Get Data Category Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the data category to retrieve

onetrust_data_mapping_get_classification_using_get

Get Data Classification Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the data classification to retrieve

onetrust_data_mapping_get_element_using_get

Get Data Element Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe 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:
ParameterTypeRequiredDefaultDescription
rootInventoryIdstringYesThe unique identifier of the root inventory
inventoryTypestringYesThe type of inventory (e.g., assets, vendors, processing-activities, legal-entities)
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber of records per page (1..50)
sortstringNoSorting 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:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema. The value can be obtained using the Get Schemas API.
externalIdstringYesThe external identifier of the inventory item.

onetrust_data_mapping_get_inventory_by_id_using_get

Get Inventory by ID Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema. The value can be obtained using the Get Schemas API.
idstringYesThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of an inventory record. The value can be obtained using the List Inventories API.
inventoryTypestringYesThe type of inventory records to check relations for.
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber 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:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
markForDeletebooleanNoFlag to include soft-deleted inventories.
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber of records per page (1..50)
filtersany[]NoA 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:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema. The value can be obtained using the Get Schemas API.
filterstringNoFilter string for searching inventories. Format: ‘searchText=value’.
markForDeletebooleanNoFlag to include soft-deleted inventories.
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber of records per page (1..50)

onetrust_data_mapping_get_schema_details_using_field_name

Get Inventory Schema Details Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesType of the inventory or schema. The supporting types are ‘processing-activities’, ‘vendors’, ‘assets’, and ‘entities’.
fieldNamestringYesField name of the attribute to retrieve details for
showAllbooleanNoFlag to show all attribute values including inactive ones
optionsSizeintegerNoOptions Size

onetrust_data_mapping_get_subject_using_get

Get Data Subject Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the Data Subject

onetrust_data_mapping_get_subjects_by_partial_name_using_get

Get List of Data Subjects Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoOptional filter string to search data subjects by name
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber of records per page (1..50)
sortstringNoSorting 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:
ParameterTypeRequiredDefaultDescription
parentInventoryIdstringYesThe unique identifier of the parent asset inventory
bodyany[]YesRequest 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:
ParameterTypeRequiredDefaultDescription
parentInventoryIdstringYesThe unique identifier of the parent legal entity inventory
bodyany[]YesRequest 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:
ParameterTypeRequiredDefaultDescription
parentInventoryIdstringYesThe unique identifier of the parent processing activity inventory
bodyany[]YesRequest body

onetrust_data_mapping_link_vendor_inventory_to_parent_vendor_id_using_post

Add Vendor Inventory as Child to Parent Inventory Parameters:
ParameterTypeRequiredDefaultDescription
parentInventoryIdstringYesThe unique identifier of the parent vendor inventory
bodyany[]YesList 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:
ParameterTypeRequiredDefaultDescription
inventoryIdstringYesThe unique identifier of the inventory to set as parent
inventoryTypestringYesThe type of inventory (e.g., assets, vendors, processing-activities, legal-entities)

Remove Child Inventory from Root Inventory Parameters:
ParameterTypeRequiredDefaultDescription
rootInventoryIdstringYesThe unique identifier of the root inventory
inventoryTypestringYesThe type of inventory (e.g., assets, vendors, processing-activities, legal-entities)
childInventoryIdstringYesThe unique identifier of the child inventory to unlink

onetrust_data_mapping_unset_inventory_as_parent_inventory_using_put

Unset Inventory as Parent Parameters:
ParameterTypeRequiredDefaultDescription
inventoryIdstringYesThe unique identifier of the inventory to unset as parent
inventoryTypestringYesThe 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:
ParameterTypeRequiredDefaultDescription
inventoryTypestringYesType of the inventory
personalDataAssociationIdstringYesID of the personal data association
linkAttributesobjectNoLink Attributes

onetrust_data_mapping_update_inventory_association_using_put

Update Inventory Link Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of an inventory record
associationIdstringYesThe unique identifier of the association
relationstringNoThe type of relationship between inventory records

onetrust_data_mapping_update_inventory_status_by_id_using_put

Update Inventory Status Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
idstringYesThe unique identifier of an inventory record.
keystringYesThe key identifier
namestringNoThe display name associated with the key

onetrust_data_mapping_update_inventory_using_put

Update Inventory by ID Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
idstringYesThe unique identifier of an inventory record.
primaryEntitybooleanNoFlag to indicate if this is a primary entity update.
inventoryIdsany[]NoList of inventory record UUIDs to be updated.
inventoryRequestobjectNoInventory Request

onetrust_data_mapping_update_relations_using_put

Link Inventory Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of an inventory record
entityTypestringNoEntity type parameter
bodyany[]YesRequest body

onetrust_data_mapping_upsert_inventory_using_put

Update Inventory by External ID Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesThe name property of the schema.
generatorstringNoOptional generator type for the operation.
bodystringYesRequest body