/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 | object[] | 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 | object[] | No | — | List of options for the attribute (applicable for SingleSelect and MultiSelect) |
optionType | string | No | — | Source for attribute options |
referenceCategoryIds | string[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"schemaName": {
"type": "string",
"description": "Name of the schema where the attribute will be created"
},
"abacBasicAssignmentInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"assignmentId": {
"type": "string",
"format": "uuid",
"description": "GUID of the linked assignment"
},
"assignmentName": {
"type": "string",
"description": "Name of the linked assignment"
},
"policyStatus": {
"type": "string",
"enum": [
"INACTIVE",
"ACTIVE",
"PROCESSING",
"FAILED"
],
"description": "Policy status of the linked assignment"
}
}
},
"description": "GUID, name and the objectType of the linked assignment"
},
"allowOther": {
"type": "boolean",
"description": "Indicates if user-specified values are allowed"
},
"associatedAttributeRequest": {
"type": "object",
"description": "Associated Attribute Request",
"properties": {
"associatedAttributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Associated attributes"
}
}
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"parameters": {
"type": "object",
"description": "The parameters value"
}
}
},
"description": {
"type": "string",
"description": "Attribute description"
},
"descriptionKey": {
"type": "string",
"description": "Attribute description key used for translation"
},
"encrypted": {
"type": "boolean",
"description": "Indicates if this attribute should be encrypted"
},
"fieldName": {
"type": "string",
"description": "Field name used to uniquely identify the attribute"
},
"formula": {
"type": "string",
"description": "Formula expression for calculated attributes"
},
"intakeQuestion": {
"type": "object",
"description": "Intake Question",
"properties": {
"nameKey": {
"type": "string",
"description": "Name Key"
},
"name": {
"type": "string",
"description": "The name value"
},
"descriptionKey": {
"type": "string",
"description": "Description Key"
},
"description": {
"type": "string",
"description": "The description value"
}
}
},
"maxMultiSelectAllowedOptionValues": {
"type": "integer",
"description": "Maximum number of option values allowed for MultiSelect attributes"
},
"metadata": {
"type": "string",
"description": "Metadata about the attribute in JSON format"
},
"name": {
"type": "string",
"description": "Attribute name"
},
"nameKey": {
"type": "string",
"description": "Attribute name key used for translation"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"option": {
"type": "string",
"description": "The option text to be displayed"
},
"optionKey": {
"type": "string",
"description": "Option key which can be used for translation and internationalization"
},
"optionSelectionValue": {
"type": "string",
"description": "Option selection value used to identify the option in forms or programmatic interfaces"
},
"colorCode": {
"type": "string",
"enum": [
"#000000",
"#FFFFFF",
"#FF0000",
"#00FF00",
"#0000FF"
],
"description": "Color code in hexadecimal format for UI representation"
},
"metadata": {
"type": "object",
"description": "The metadata value"
}
},
"required": [
"option"
]
},
"description": "List of options for the attribute (applicable for SingleSelect and MultiSelect)"
},
"optionType": {
"type": "string",
"description": "Source for attribute options",
"enum": [
"None",
"Static",
"Dynamic"
]
},
"referenceCategoryIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of category IDs associated with the attribute"
},
"required": {
"type": "boolean",
"description": "Indicates if this attribute is required"
},
"responseSubType": {
"type": "string",
"description": "Response sub type for the attribute",
"enum": [
"STANDARD",
"FORMULA",
"MATRIX"
]
},
"responseType": {
"type": "string",
"description": "Response type for the attribute",
"enum": [
"Text",
"SingleSelect",
"MultiSelect",
"Date",
"Formula",
"Score",
"Level",
"Range"
]
},
"source": {
"type": "string",
"description": "Source of the attribute"
},
"validationRuleId": {
"type": "string",
"description": "ID of the validation rule to associate with the attribute"
}
},
"required": [
"PCID",
"schemaName",
"fieldName",
"name",
"responseType"
]
}
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityTypeId": {
"type": "string",
"description": "Identifier of the entity type"
},
"entityTypeName": {
"type": "string",
"description": "Name of the entity type"
},
"attributes": {
"type": "object",
"description": "The custom attributes for the entity defined by its schema. Contains attribute paths mapped to their values."
},
"entityLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Custom attributes for the link based on the link type schema. Contains attribute paths mapped to their values."
},
"entity1": {
"type": "object",
"description": "The entity1 value"
},
"entity2": {
"type": "object",
"description": "The entity2 value"
},
"entityLinkTypeId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the link type that defines the relationship. Required if sourceSystemGenerator is not provided."
},
"sourceSystemGenerator": {
"type": "string",
"description": "Identifier of the system that generates this link. Required if entityLinkTypeId is not provided."
},
"linkTypeLabel": {
"type": "string",
"description": "Display name for the relationship direction. Used for showing the relationship in UI."
}
},
"required": [
"entity2"
]
},
"description": "Entity link requests to create relationships with other entities during entity creation"
},
"name": {
"type": "string",
"description": "The name of the entity. Required field used as the primary identifier for users."
},
"organization": {
"type": "object",
"description": "The organization value",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the organization."
},
"name": {
"type": "string",
"description": "The name of the organization."
}
},
"required": [
"id"
]
},
"workflowAndStage": {
"type": "object",
"description": "Workflow And Stage",
"properties": {
"workflow": {
"type": "object",
"description": "The workflow value"
},
"stage": {
"type": "object",
"description": "The stage value"
},
"closedDate": {
"type": "string",
"description": "Date when the entity was closed. Only relevant for workflows with closed stages."
}
}
}
},
"required": [
"PCID",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"attributeId": {
"type": "string",
"description": "Unique identifier of the attribute to which options will be added"
},
"colorCode": {
"type": "string",
"description": "Color code in hexadecimal format for UI representation",
"enum": [
"#000000",
"#FFFFFF",
"#FF0000",
"#00FF00",
"#0000FF"
]
},
"metadata": {
"type": "object",
"description": "The metadata value",
"properties": {
"hint": {
"type": "string",
"description": "The hint value"
},
"hintKey": {
"type": "string",
"description": "Hint key which can be used for translation"
}
}
},
"option": {
"type": "string",
"description": "The option text to be displayed"
},
"optionKey": {
"type": "string",
"description": "Option key which can be used for translation and internationalization"
},
"optionSelectionValue": {
"type": "string",
"description": "Option selection value used to identify the option in forms or programmatic interfaces"
}
},
"required": [
"PCID",
"attributeId",
"option"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityId": {
"type": "string",
"description": "Identifier of the entity"
},
"type": {
"type": "string",
"description": "Workflow Type"
},
"nextStageName": {
"type": "string",
"description": "Name of the next stage to navigate to"
},
"parameters": {
"type": "object",
"description": "Additional parameters for workflow navigation customization"
}
},
"required": [
"PCID",
"entityId",
"type",
"nextStageName"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"linkTypeId": {
"type": "string",
"description": "Unique identifier of the link type to use for creating the relationship"
},
"attributes": {
"type": "object",
"description": "Custom Attributes based on schema defined for given link type"
},
"entity1": {
"type": "object",
"description": "The entity1 value",
"properties": {
"linkEntityDetail": {
"type": "object",
"description": "Link Entity Detail"
},
"id": {
"type": "string",
"description": "Unique identifier of the entity"
},
"number": {
"type": "integer",
"description": "Auto-generated sequential entity number"
},
"name": {
"type": "string",
"description": "Name of the entity"
},
"detailsAccessRestricted": {
"type": "boolean",
"description": "Flag indicating whether entity is view-only"
},
"redirectURL": {
"type": "string",
"description": "Redirect URL for the entity"
},
"entityType": {
"type": "object",
"description": "Entity Type"
},
"deleted": {
"type": "boolean",
"description": "The deleted value"
}
},
"required": [
"entityType",
"id",
"number"
]
},
"entity2": {
"type": "object",
"description": "The entity2 value",
"properties": {
"linkEntityDetail": {
"type": "object",
"description": "Link Entity Detail"
},
"id": {
"type": "string",
"description": "Unique identifier of the entity"
},
"number": {
"type": "integer",
"description": "Auto-generated sequential entity number"
},
"name": {
"type": "string",
"description": "Name of the entity"
},
"detailsAccessRestricted": {
"type": "boolean",
"description": "Flag indicating whether entity is view-only"
},
"redirectURL": {
"type": "string",
"description": "Redirect URL for the entity"
},
"entityType": {
"type": "object",
"description": "Entity Type"
},
"deleted": {
"type": "boolean",
"description": "The deleted value"
}
},
"required": [
"entityType",
"id",
"number"
]
}
},
"required": [
"PCID",
"linkTypeId",
"entity1",
"entity2"
]
}
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assigneeEmail": {
"type": "string",
"description": "Email of the assignee"
},
"assigneeId": {
"type": "string",
"description": "ID of the assignee"
},
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collaboratorId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the collaborator"
},
"collaboratorEmail": {
"type": "string",
"description": "Email address of the collaborator"
},
"type": {
"type": "string",
"enum": [
"USER",
"GROUP"
],
"description": "Type of assignee (User or Group)"
}
},
"required": [
"type"
]
},
"description": "List of task collaborators"
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"parameters": {
"type": "object",
"description": "Dynamic key-value parameters for task context"
}
}
},
"deadline": {
"type": "string",
"description": "Deadline for the task"
},
"description": {
"type": "string",
"description": "Description of the task"
},
"isActive": {
"type": "boolean",
"description": "Flag indicating if the task is active"
},
"isRequired": {
"type": "boolean",
"description": "Flag indicating if the task is required"
},
"moduleSource": {
"type": "string",
"description": "Source module",
"enum": [
"assessment",
"audit-mgmt",
"cyber-risk",
"data-mapping",
"data-governance",
"esg",
"erm",
"incident",
"issue",
"itrm",
"program-benchmarking",
"maturity-planning",
"risk",
"vendor",
"vendor-portal",
"compliance-automation",
"SpeakUp",
"EntityScoping",
"ControlObjective",
"exception"
]
},
"orgGroupId": {
"type": "string",
"description": "Organization group ID"
},
"parentEntityId": {
"type": "string",
"description": "ID of the parent entity"
},
"priority": {
"type": "string",
"description": "Priority level of the task",
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"resourceId": {
"type": "string",
"description": "ID of the resource"
},
"resourceTypeNameKey": {
"type": "string",
"description": "Key identifying the resource type"
},
"sourceId": {
"type": "string",
"description": "ID of the source that created the task"
},
"sourceType": {
"type": "string",
"description": "Type of source that created the task"
},
"taskName": {
"type": "string",
"description": "Name of the task"
},
"taskTypeNameKey": {
"type": "string",
"description": "Key identifying the task type"
}
},
"required": [
"PCID",
"orgGroupId",
"parentEntityId",
"taskName",
"taskTypeNameKey"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"linkTypeId": {
"type": "string",
"description": "Unique identifier of the link type"
},
"linkId": {
"type": "string",
"description": "Unique identifier of the link record to delete"
}
},
"required": [
"PCID",
"linkTypeId",
"linkId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityTypeId": {
"type": "string",
"description": "Identifier of the entity type"
},
"entityTypeName": {
"type": "string",
"description": "Name of the entity type"
},
"entityId": {
"type": "string",
"description": "Identifier of the entity being removed using the API."
}
},
"required": [
"PCID",
"entityId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"schemaId": {
"type": "string",
"description": "Unique identifier of the schema containing the attribute"
},
"attributeId": {
"type": "string",
"description": "Unique identifier of the attribute to be disabled"
}
},
"required": [
"PCID",
"schemaId",
"attributeId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"schemaId": {
"type": "string",
"description": "Unique identifier of the schema containing the attribute"
},
"attributeId": {
"type": "string",
"description": "Unique identifier of the attribute to be enabled"
}
},
"required": [
"PCID",
"schemaId",
"attributeId"
]
}
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 | object[] | No | — | The fields and values used to filter results. |
fullText | string | No | — | The key terms for the search criteria. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Results page to be retrieved (0..N). Example: '?page=1'"
},
"size": {
"type": "integer",
"description": "Number of records per page (1..50). Example: '?size=20'"
},
"sort": {
"type": "string",
"description": "Sorting criteria in the format: property,(asc|desc). Example: '?sort=name,asc'",
"enum": [
"name,asc",
"name,desc"
]
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The field name used to filter results."
},
"operator": {
"type": "string",
"enum": [
"EQUAL_TO",
"NOT_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_EQUAL_TO",
"LESS_THAN",
"LESS_THAN_EQUAL_TO",
"BETWEEN"
],
"description": "The relationship that must be met between the field and value."
},
"value": {
"type": "object",
"description": "The field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter. Examples by type: UUID = 'e68d49c4-f11f-4cd9-8f1b-0be8ef945b8f', LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7"
},
"toValue": {
"type": "object",
"description": "The field value for the end of the range. This field should be used in conjunction with the `value` parameter. Examples by type: LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7"
}
},
"required": [
"field"
]
},
"description": "The fields and values used to filter results."
},
"fullText": {
"type": "string",
"description": "The key terms for the search criteria."
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Results page to be retrieved (0..N). Example: '?page=1'"
},
"size": {
"type": "integer",
"description": "Number of records per page (1..50). Example: '?size=20'"
},
"sort": {
"type": "string",
"description": "Sorting criteria in the format: property,(asc|desc). Example: '?sort=name,asc'",
"enum": [
"name,asc",
"name,desc"
]
},
"entityTypeName": {
"type": "string",
"description": "Entity Type Name"
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"parameters": {
"type": "object",
"description": "The parameters value"
}
}
},
"queryRequest": {
"type": "object",
"description": "Query Request",
"properties": {
"criteria": {
"type": "object",
"description": "The criteria value"
},
"organizationTraversalStrategy": {
"type": "string",
"description": "The strategy for fetching entities across related organizations. Default: null (no organization traversal applicable)",
"enum": [
"ancestors_and_descendants",
"descendants",
"all"
]
},
"requestedOrganizationId": {
"type": "string",
"description": "The overridden requested organization identifier. If supplied, would be used instead of request context organization"
},
"queryAction": {
"type": "string",
"description": "The query action specifies the source of the API call and allows a service to apply a predicate"
}
}
},
"requestedFields": {
"type": "object",
"description": "Requested Fields",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "The requested non-base fields."
},
"mode": {
"type": "string",
"description": "The mode based on which required non-base fields would be selected.",
"enum": [
"select_all",
"ignore_all",
"specific"
]
},
"includeSelectedFullTextSearchFields": {
"type": "boolean",
"description": "The full text search mode would only includes passed \"fields\" of Text/Date/NumericalText/DateTime response type."
},
"overriddenSearchFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "The caller can override search (system) fields which need to included."
}
}
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Results page to be retrieved (0..N). Example: '?page=1'"
},
"size": {
"type": "integer",
"description": "Number of records per page (1..50). Example: '?size=20'"
},
"sort": {
"type": "string",
"description": "Sorting criteria in the format: property,(asc|desc). Example: '?sort=name,asc'",
"enum": [
"name,asc",
"name,desc"
]
},
"criteria": {
"type": "object",
"description": "The criteria value",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object"
},
"description": "The fields and values used to filter results."
},
"fullText": {
"type": "string",
"description": "The key terms for the search criteria."
}
}
},
"organizationTraversalStrategy": {
"type": "string",
"description": "The strategy for fetching entities across related organizations. Default: null (no organization traversal applicable)",
"enum": [
"ancestors_and_descendants",
"descendants",
"all"
]
},
"queryAction": {
"type": "string",
"description": "The query action specifies the source of the API call and allows a service to apply a predicate"
},
"requestedOrganizationId": {
"type": "string",
"description": "The overridden requested organization identifier. If supplied, would be used instead of request context organization"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "Task Id"
},
"includePermissionsMetadata": {
"type": "boolean",
"description": "Flag to include permissions metadata"
},
"excludeInactiveTasks": {
"type": "boolean",
"description": "Flag to exclude inactive tasks"
}
},
"required": [
"PCID",
"taskId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityTypeId": {
"type": "string",
"description": "Identifier of the entity type"
},
"entityTypeName": {
"type": "string",
"description": "Name of the entity type"
},
"entityId": {
"type": "string",
"description": "Identifier of the entity"
}
},
"required": [
"PCID",
"entityId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityTypeId": {
"type": "string",
"description": "The unique identifier of the entity type."
}
},
"required": [
"PCID",
"entityTypeId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"linkTypeId": {
"type": "string",
"description": "Unique identifier of the link type to use for getting the relationship"
},
"linkId": {
"type": "string",
"description": "Unique identifier of the link record to retrieve"
}
},
"required": [
"PCID",
"linkTypeId",
"linkId"
]
}
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 | object[] | No | — | The fields and values used to filter results. |
fullText | string | No | — | The key terms for the search criteria. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Results page to be retrieved (0..N). Example: '?page=1'"
},
"size": {
"type": "integer",
"description": "Number of records per page (1..50). Example: '?size=20'"
},
"sort": {
"type": "string",
"description": "Sorting criteria in the format: property,(asc|desc). Example: '?sort=id,desc'",
"enum": [
"id,asc",
"id,desc"
]
},
"entityTypeName": {
"type": "string",
"description": "Name of the Entity Type",
"enum": [
"aisystems",
"datasets",
"models",
"aiagents"
]
},
"entityId": {
"type": "string",
"description": "Entity Identifier"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The field name used to filter results."
},
"operator": {
"type": "string",
"enum": [
"EQUAL_TO",
"NOT_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_EQUAL_TO",
"LESS_THAN",
"LESS_THAN_EQUAL_TO",
"BETWEEN"
],
"description": "The relationship that must be met between the field and value."
},
"value": {
"type": "object",
"description": "The field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter. Examples by type: UUID = 'e68d49c4-f11f-4cd9-8f1b-0be8ef945b8f', LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7"
},
"toValue": {
"type": "object",
"description": "The field value for the end of the range. This field should be used in conjunction with the `value` parameter. Examples by type: LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7"
}
},
"required": [
"field"
]
},
"description": "The fields and values used to filter results."
},
"fullText": {
"type": "string",
"description": "The key terms for the search criteria."
}
},
"required": [
"PCID",
"entityTypeName",
"entityId"
]
}
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "UUID of the Task to be updated"
},
"assigneeEmail": {
"type": "string",
"description": "Email of the assignee"
},
"assigneeId": {
"type": "string",
"description": "ID of the assignee"
},
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collaboratorId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the collaborator"
},
"collaboratorEmail": {
"type": "string",
"description": "Email address of the collaborator"
},
"type": {
"type": "string",
"enum": [
"USER",
"GROUP"
],
"description": "Type of assignee (User or Group)"
}
},
"required": [
"type"
]
},
"description": "List of task collaborators"
},
"context": {
"type": "object",
"description": "The context value",
"properties": {
"parameters": {
"type": "object",
"description": "Dynamic key-value parameters for task context"
}
}
},
"deadline": {
"type": "string",
"description": "Deadline for the task"
},
"description": {
"type": "string",
"description": "Description of the task"
},
"isRequired": {
"type": "boolean",
"description": "Flag indicating if the task is required"
},
"priority": {
"type": "string",
"description": "Priority level of the task",
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"sourceId": {
"type": "string",
"description": "ID of the source that created the task"
},
"sourceType": {
"type": "string",
"description": "Type of source that created the task"
},
"status": {
"type": "string",
"description": "Status of the task",
"enum": [
"Open",
"Closed"
]
},
"taskName": {
"type": "string",
"description": "Name of the task"
}
},
"required": [
"PCID",
"taskId",
"taskName"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityTypeId": {
"type": "string",
"description": "Identifier of the entity type"
},
"entityTypeName": {
"type": "string",
"description": "Name of the entity type"
},
"entityId": {
"type": "string",
"description": "Entity Identifier"
},
"attributes": {
"type": "object",
"description": "Custom attributes to update on the entity. Only the attributes provided will be updated; others will retain their existing values."
},
"name": {
"type": "string",
"description": "The updated name of the entity. If not provided, the existing name will be retained."
},
"organization": {
"type": "object",
"description": "The organization value",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the organization."
},
"name": {
"type": "string",
"description": "The name of the organization."
}
},
"required": [
"id"
]
}
},
"required": [
"PCID",
"entityId"
]
}

