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

Tools

ToolDescription
onetrust_ai_governance_add_attribute_using_postAdd Attribute to Schema
onetrust_ai_governance_add_entity_using_entity_type_id_or_entity_type_name_using_postCreate Entity
onetrust_ai_governance_add_options_using_postAdd Options to Attribute
onetrust_ai_governance_assign_stage_by_nameUpdate Entity Workflow Stage
onetrust_ai_governance_create_link_record_between_entities_using_link_type_id_using_postCreate Relationship Record between Entities
onetrust_ai_governance_create_task_using_post_1Create Task
onetrust_ai_governance_delete_link_record_by_id_and_type_using_link_type_id_using_deleteRemove Relationship Record
onetrust_ai_governance_delete_using_entity_type_id_or_entity_type_name_using_deleteDelete Entity
onetrust_ai_governance_disable_attribute_using_putDisable Attribute
onetrust_ai_governance_enable_attribute_using_putEnable Attribute
onetrust_ai_governance_find_all_by_type_and_criteria_using_post_1Get List of Entity Types
onetrust_ai_governance_find_all_by_type_id_and_criteria_using_postGet Full Entity Details
onetrust_ai_governance_find_entity_basic_details_by_type_and_criteria_using_postGet Basic Entity Details
onetrust_ai_governance_find_task_using_get_1Get Task
onetrust_ai_governance_get_entity_information_using_entity_type_id_or_entity_type_name_using_getGet Entity
onetrust_ai_governance_get_entity_type_information_using_get_1Get Entity Type
onetrust_ai_governance_get_link_record_information_using_link_type_id_using_getGet Relationship Record
onetrust_ai_governance_get_related_entities_for_an_entity_using_postGet List of Relationship Records by Entity
onetrust_ai_governance_update_task_using_put_1Update Task
onetrust_ai_governance_update_using_entity_type_id_or_entity_type_name_using_patchModify Entity

onetrust_ai_governance_add_attribute_using_post

Add Attribute to Schema Parameters:
ParameterTypeRequiredDefaultDescription
schemaNamestringYesName of the schema where the attribute will be created
abacBasicAssignmentInfoany[]NoGUID, name and the objectType of the linked assignment
allowOtherbooleanNoIndicates if user-specified values are allowed
associatedAttributeRequestobjectNoAssociated Attribute Request
contextobjectNoThe context value
descriptionstringNoAttribute description
descriptionKeystringNoAttribute description key used for translation
encryptedbooleanNoIndicates if this attribute should be encrypted
fieldNamestringYesField name used to uniquely identify the attribute
formulastringNoFormula expression for calculated attributes
intakeQuestionobjectNoIntake Question
maxMultiSelectAllowedOptionValuesintegerNoMaximum number of option values allowed for MultiSelect attributes
metadatastringNoMetadata about the attribute in JSON format
namestringYesAttribute name
nameKeystringNoAttribute name key used for translation
optionsany[]NoList of options for the attribute (applicable for SingleSelect and MultiSelect)
optionTypestringNoSource for attribute options
referenceCategoryIdsany[]NoList of category IDs associated with the attribute
requiredbooleanNoIndicates if this attribute is required
responseSubTypestringNoResponse sub type for the attribute
responseTypestringYesResponse type for the attribute
sourcestringNoSource of the attribute
validationRuleIdstringNoID of the validation rule to associate with the attribute

onetrust_ai_governance_add_entity_using_entity_type_id_or_entity_type_name_using_post

Create Entity Parameters:
ParameterTypeRequiredDefaultDescription
entityTypeIdstringNoIdentifier of the entity type
entityTypeNamestringNoName of the entity type
attributesobjectNoThe custom attributes for the entity defined by its schema. Contains attribute paths mapped to their values.
entityLinksany[]NoEntity link requests to create relationships with other entities during entity creation
namestringYesThe name of the entity. Required field used as the primary identifier for users.
organizationobjectNoThe organization value
workflowAndStageobjectNoWorkflow And Stage

onetrust_ai_governance_add_options_using_post

Add Options to Attribute Parameters:
ParameterTypeRequiredDefaultDescription
attributeIdstringYesUnique identifier of the attribute to which options will be added
colorCodestringNoColor code in hexadecimal format for UI representation
metadataobjectNoThe metadata value
optionstringYesThe option text to be displayed
optionKeystringNoOption key which can be used for translation and internationalization
optionSelectionValuestringNoOption selection value used to identify the option in forms or programmatic interfaces

onetrust_ai_governance_assign_stage_by_name

Update Entity Workflow Stage Parameters:
ParameterTypeRequiredDefaultDescription
entityIdstringYesIdentifier of the entity
typestringYesWorkflow Type
nextStageNamestringYesName of the next stage to navigate to
parametersobjectNoAdditional parameters for workflow navigation customization

onetrust_ai_governance_create_link_record_between_entities_using_link_type_id_using_post

Create Relationship Record between Entities Parameters:
ParameterTypeRequiredDefaultDescription
linkTypeIdstringYesUnique identifier of the link type to use for creating the relationship
attributesobjectNoCustom Attributes based on schema defined for given link type
entity1objectYesThe entity1 value
entity2objectYesThe entity2 value

onetrust_ai_governance_create_task_using_post_1

Create Task Parameters:
ParameterTypeRequiredDefaultDescription
assigneeEmailstringNoEmail of the assignee
assigneeIdstringNoID of the assignee
collaboratorsany[]NoList of task collaborators
contextobjectNoThe context value
deadlinestringNoDeadline for the task
descriptionstringNoDescription of the task
isActivebooleanNoFlag indicating if the task is active
isRequiredbooleanNoFlag indicating if the task is required
moduleSourcestringNoSource module
orgGroupIdstringYesOrganization group ID
parentEntityIdstringYesID of the parent entity
prioritystringNoPriority level of the task
resourceIdstringNoID of the resource
resourceTypeNameKeystringNoKey identifying the resource type
sourceIdstringNoID of the source that created the task
sourceTypestringNoType of source that created the task
taskNamestringYesName of the task
taskTypeNameKeystringYesKey identifying the task type

Remove Relationship Record Parameters:
ParameterTypeRequiredDefaultDescription
linkTypeIdstringYesUnique identifier of the link type
linkIdstringYesUnique identifier of the link record to delete

onetrust_ai_governance_delete_using_entity_type_id_or_entity_type_name_using_delete

Delete Entity Parameters:
ParameterTypeRequiredDefaultDescription
entityTypeIdstringNoIdentifier of the entity type
entityTypeNamestringNoName of the entity type
entityIdstringYesIdentifier of the entity being removed using the API.

onetrust_ai_governance_disable_attribute_using_put

Disable Attribute Parameters:
ParameterTypeRequiredDefaultDescription
schemaIdstringYesUnique identifier of the schema containing the attribute
attributeIdstringYesUnique identifier of the attribute to be disabled

onetrust_ai_governance_enable_attribute_using_put

Enable Attribute Parameters:
ParameterTypeRequiredDefaultDescription
schemaIdstringYesUnique identifier of the schema containing the attribute
attributeIdstringYesUnique identifier of the attribute to be enabled

onetrust_ai_governance_find_all_by_type_and_criteria_using_post_1

Get List of Entity Types Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoResults page to be retrieved (0..N). Example: ‘?page=1’
sizeintegerNoNumber of records per page (1..50). Example: ‘?size=20’
sortstringNoSorting criteria in the format: property,(asc|desc). Example: ‘?sort=name,asc’
filtersany[]NoThe fields and values used to filter results.
fullTextstringNoThe key terms for the search criteria.

onetrust_ai_governance_find_all_by_type_id_and_criteria_using_post

Get Full Entity Details Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoResults page to be retrieved (0..N). Example: ‘?page=1’
sizeintegerNoNumber of records per page (1..50). Example: ‘?size=20’
sortstringNoSorting criteria in the format: property,(asc|desc). Example: ‘?sort=name,asc’
entityTypeNamestringNoEntity Type Name
contextobjectNoThe context value
queryRequestobjectNoQuery Request
requestedFieldsobjectNoRequested Fields

onetrust_ai_governance_find_entity_basic_details_by_type_and_criteria_using_post

Get Basic Entity Details Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoResults page to be retrieved (0..N). Example: ‘?page=1’
sizeintegerNoNumber of records per page (1..50). Example: ‘?size=20’
sortstringNoSorting criteria in the format: property,(asc|desc). Example: ‘?sort=name,asc’
criteriaobjectNoThe criteria value
organizationTraversalStrategystringNoThe strategy for fetching entities across related organizations. Default: null (no organization traversal applicable)
queryActionstringNoThe query action specifies the source of the API call and allows a service to apply a predicate
requestedOrganizationIdstringNoThe overridden requested organization identifier. If supplied, would be used instead of request context organization

onetrust_ai_governance_find_task_using_get_1

Get Task Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesTask Id
includePermissionsMetadatabooleanNoFlag to include permissions metadata
excludeInactiveTasksbooleanNoFlag to exclude inactive tasks

onetrust_ai_governance_get_entity_information_using_entity_type_id_or_entity_type_name_using_get

Get Entity Parameters:
ParameterTypeRequiredDefaultDescription
entityTypeIdstringNoIdentifier of the entity type
entityTypeNamestringNoName of the entity type
entityIdstringYesIdentifier of the entity

onetrust_ai_governance_get_entity_type_information_using_get_1

Get Entity Type Parameters:
ParameterTypeRequiredDefaultDescription
entityTypeIdstringYesThe unique identifier of the entity type.

Get Relationship Record Parameters:
ParameterTypeRequiredDefaultDescription
linkTypeIdstringYesUnique identifier of the link type to use for getting the relationship
linkIdstringYesUnique identifier of the link record to retrieve

onetrust_ai_governance_get_related_entities_for_an_entity_using_post

Get List of Relationship Records by Entity Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoResults page to be retrieved (0..N). Example: ‘?page=1’
sizeintegerNoNumber of records per page (1..50). Example: ‘?size=20’
sortstringNoSorting criteria in the format: property,(asc|desc). Example: ‘?sort=id,desc’
entityTypeNamestringYesName of the Entity Type
entityIdstringYesEntity Identifier
filtersany[]NoThe fields and values used to filter results.
fullTextstringNoThe key terms for the search criteria.

onetrust_ai_governance_update_task_using_put_1

Update Task Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesUUID of the Task to be updated
assigneeEmailstringNoEmail of the assignee
assigneeIdstringNoID of the assignee
collaboratorsany[]NoList of task collaborators
contextobjectNoThe context value
deadlinestringNoDeadline for the task
descriptionstringNoDescription of the task
isRequiredbooleanNoFlag indicating if the task is required
prioritystringNoPriority level of the task
sourceIdstringNoID of the source that created the task
sourceTypestringNoType of source that created the task
statusstringNoStatus of the task
taskNamestringYesName of the task

onetrust_ai_governance_update_using_entity_type_id_or_entity_type_name_using_patch

Modify Entity Parameters:
ParameterTypeRequiredDefaultDescription
entityTypeIdstringNoIdentifier of the entity type
entityTypeNamestringNoName of the entity type
entityIdstringYesEntity Identifier
attributesobjectNoCustom attributes to update on the entity. Only the attributes provided will be updated; others will retain their existing values.
namestringNoThe updated name of the entity. If not provided, the existing name will be retained.
organizationobjectNoThe organization value