/onetrust-ai-governance | Type: Application | PCID required: Yes
Tools
onetrust_ai_governance_add_attribute_using_post
Add Attribute to Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
schemaName | string | Yes | — | Name of the schema where the attribute will be created |
abacBasicAssignmentInfo | any[] | No | — | GUID, name and the objectType of the linked assignment |
allowOther | boolean | No | — | Indicates if user-specified values are allowed |
associatedAttributeRequest | object | No | — | Associated Attribute Request |
context | object | No | — | The context value |
description | string | No | — | Attribute description |
descriptionKey | string | No | — | Attribute description key used for translation |
encrypted | boolean | No | — | Indicates if this attribute should be encrypted |
fieldName | string | Yes | — | Field name used to uniquely identify the attribute |
formula | string | No | — | Formula expression for calculated attributes |
intakeQuestion | object | No | — | Intake Question |
maxMultiSelectAllowedOptionValues | integer | No | — | Maximum number of option values allowed for MultiSelect attributes |
metadata | string | No | — | Metadata about the attribute in JSON format |
name | string | Yes | — | Attribute name |
nameKey | string | No | — | Attribute name key used for translation |
options | any[] | No | — | List of options for the attribute (applicable for SingleSelect and MultiSelect) |
optionType | string | No | — | Source for attribute options |
referenceCategoryIds | any[] | No | — | List of category IDs associated with the attribute |
required | boolean | No | — | Indicates if this attribute is required |
responseSubType | string | No | — | Response sub type for the attribute |
responseType | string | Yes | — | Response type for the attribute |
source | string | No | — | Source of the attribute |
validationRuleId | string | No | — | ID 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityTypeId | string | No | — | Identifier of the entity type |
entityTypeName | string | No | — | Name of the entity type |
attributes | object | No | — | The custom attributes for the entity defined by its schema. Contains attribute paths mapped to their values. |
entityLinks | any[] | No | — | Entity link requests to create relationships with other entities during entity creation |
name | string | Yes | — | The name of the entity. Required field used as the primary identifier for users. |
organization | object | No | — | The organization value |
workflowAndStage | object | No | — | Workflow And Stage |
onetrust_ai_governance_add_options_using_post
Add Options to Attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attributeId | string | Yes | — | Unique identifier of the attribute to which options will be added |
colorCode | string | No | — | Color code in hexadecimal format for UI representation |
metadata | object | No | — | The metadata value |
option | string | Yes | — | The option text to be displayed |
optionKey | string | No | — | Option key which can be used for translation and internationalization |
optionSelectionValue | string | No | — | Option selection value used to identify the option in forms or programmatic interfaces |
onetrust_ai_governance_assign_stage_by_name
Update Entity Workflow Stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityId | string | Yes | — | Identifier of the entity |
type | string | Yes | — | Workflow Type |
nextStageName | string | Yes | — | Name of the next stage to navigate to |
parameters | object | No | — | Additional 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linkTypeId | string | Yes | — | Unique identifier of the link type to use for creating the relationship |
attributes | object | No | — | Custom Attributes based on schema defined for given link type |
entity1 | object | Yes | — | The entity1 value |
entity2 | object | Yes | — | The entity2 value |
onetrust_ai_governance_create_task_using_post_1
Create Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assigneeEmail | string | No | — | Email of the assignee |
assigneeId | string | No | — | ID of the assignee |
collaborators | any[] | No | — | List of task collaborators |
context | object | No | — | The context value |
deadline | string | No | — | Deadline for the task |
description | string | No | — | Description of the task |
isActive | boolean | No | — | Flag indicating if the task is active |
isRequired | boolean | No | — | Flag indicating if the task is required |
moduleSource | string | No | — | Source module |
orgGroupId | string | Yes | — | Organization group ID |
parentEntityId | string | Yes | — | ID of the parent entity |
priority | string | No | — | Priority level of the task |
resourceId | string | No | — | ID of the resource |
resourceTypeNameKey | string | No | — | Key identifying the resource type |
sourceId | string | No | — | ID of the source that created the task |
sourceType | string | No | — | Type of source that created the task |
taskName | string | Yes | — | Name of the task |
taskTypeNameKey | string | Yes | — | Key identifying the task type |
onetrust_ai_governance_delete_link_record_by_id_and_type_using_link_type_id_using_delete
Remove Relationship Record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linkTypeId | string | Yes | — | Unique identifier of the link type |
linkId | string | Yes | — | Unique identifier of the link record to delete |
onetrust_ai_governance_delete_using_entity_type_id_or_entity_type_name_using_delete
Delete Entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityTypeId | string | No | — | Identifier of the entity type |
entityTypeName | string | No | — | Name of the entity type |
entityId | string | Yes | — | Identifier of the entity being removed using the API. |
onetrust_ai_governance_disable_attribute_using_put
Disable Attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
schemaId | string | Yes | — | Unique identifier of the schema containing the attribute |
attributeId | string | Yes | — | Unique identifier of the attribute to be disabled |
onetrust_ai_governance_enable_attribute_using_put
Enable Attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
schemaId | string | Yes | — | Unique identifier of the schema containing the attribute |
attributeId | string | Yes | — | Unique 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Results page to be retrieved (0..N). Example: ‘?page=1’ |
size | integer | No | — | Number of records per page (1..50). Example: ‘?size=20’ |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Example: ‘?sort=name,asc’ |
filters | any[] | No | — | The fields and values used to filter results. |
fullText | string | No | — | The key terms for the search criteria. |
onetrust_ai_governance_find_all_by_type_id_and_criteria_using_post
Get Full Entity Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Results page to be retrieved (0..N). Example: ‘?page=1’ |
size | integer | No | — | Number of records per page (1..50). Example: ‘?size=20’ |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Example: ‘?sort=name,asc’ |
entityTypeName | string | No | — | Entity Type Name |
context | object | No | — | The context value |
queryRequest | object | No | — | Query Request |
requestedFields | object | No | — | Requested Fields |
onetrust_ai_governance_find_entity_basic_details_by_type_and_criteria_using_post
Get Basic Entity Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Results page to be retrieved (0..N). Example: ‘?page=1’ |
size | integer | No | — | Number of records per page (1..50). Example: ‘?size=20’ |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Example: ‘?sort=name,asc’ |
criteria | object | No | — | The criteria value |
organizationTraversalStrategy | string | No | — | The strategy for fetching entities across related organizations. Default: null (no organization traversal applicable) |
queryAction | string | No | — | The query action specifies the source of the API call and allows a service to apply a predicate |
requestedOrganizationId | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Task Id |
includePermissionsMetadata | boolean | No | — | Flag to include permissions metadata |
excludeInactiveTasks | boolean | No | — | Flag to exclude inactive tasks |
onetrust_ai_governance_get_entity_information_using_entity_type_id_or_entity_type_name_using_get
Get Entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityTypeId | string | No | — | Identifier of the entity type |
entityTypeName | string | No | — | Name of the entity type |
entityId | string | Yes | — | Identifier of the entity |
onetrust_ai_governance_get_entity_type_information_using_get_1
Get Entity Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityTypeId | string | Yes | — | The unique identifier of the entity type. |
onetrust_ai_governance_get_link_record_information_using_link_type_id_using_get
Get Relationship Record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linkTypeId | string | Yes | — | Unique identifier of the link type to use for getting the relationship |
linkId | string | Yes | — | Unique 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Results page to be retrieved (0..N). Example: ‘?page=1’ |
size | integer | No | — | Number of records per page (1..50). Example: ‘?size=20’ |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Example: ‘?sort=id,desc’ |
entityTypeName | string | Yes | — | Name of the Entity Type |
entityId | string | Yes | — | Entity Identifier |
filters | any[] | No | — | The fields and values used to filter results. |
fullText | string | No | — | The key terms for the search criteria. |
onetrust_ai_governance_update_task_using_put_1
Update Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | UUID of the Task to be updated |
assigneeEmail | string | No | — | Email of the assignee |
assigneeId | string | No | — | ID of the assignee |
collaborators | any[] | No | — | List of task collaborators |
context | object | No | — | The context value |
deadline | string | No | — | Deadline for the task |
description | string | No | — | Description of the task |
isRequired | boolean | No | — | Flag indicating if the task is required |
priority | string | No | — | Priority level of the task |
sourceId | string | No | — | ID of the source that created the task |
sourceType | string | No | — | Type of source that created the task |
status | string | No | — | Status of the task |
taskName | string | Yes | — | Name of the task |
onetrust_ai_governance_update_using_entity_type_id_or_entity_type_name_using_patch
Modify Entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityTypeId | string | No | — | Identifier of the entity type |
entityTypeName | string | No | — | Name of the entity type |
entityId | string | Yes | — | Entity Identifier |
attributes | object | No | — | Custom attributes to update on the entity. Only the attributes provided will be updated; others will retain their existing values. |
name | string | No | — | The updated name of the entity. If not provided, the existing name will be retained. |
organization | object | No | — | The organization value |

