/onetrust-assessments | Type: Application | PCID required: Yes
Tools
onetrust_assessments_add_manual_assessment_links_using_post
Link Assessments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromId | string | Yes | — | The unique ID of the source assessment to create the link from |
toIds | any[] | Yes | — | To Ids |
onetrust_assessments_add_or_update_tags_using_put
Update Assessment Tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | UUID of the assessment to update tags for |
body | any[] | Yes | — | Request body |
onetrust_assessments_archive_assessments_using_put
Archive Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | any[] | Yes | — | Request body |
onetrust_assessments_create_assessment_using_post
Launch Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
approverId | string | No | — | Approver identifier of the assessment (deprecated, use approvers list instead) |
approverName | string | No | — | Approver name of the assessment (deprecated, use approvers list instead) |
approverOnlySectionRespondents | any[] | No | — | List of respondents for approver-only sections |
approvers | any[] | No | — | List of approvers for the assessment |
attachmentRequests | any[] | No | — | List of assessment attachment request |
checkForInFlightAssessments | boolean | No | — | Whether to check if any in-flight (status < COMPLETED) assessments exist with the same templateRootVersionId |
controlImplementationDetails | any[] | No | — | Populated when Control Implementations are selected as Primary for Assessment |
creationSource | string | No | — | Source of assessment creation |
deadline | string | No | — | Deadline to complete the assessment (format: YYYY-MM-DDTHH:MM:SS.FFFZ) |
defaultTemplateDeadlineReminder | boolean | No | — | Default Template Deadline Reminder |
description | string | No | — | Description of the assessment |
duplicateNotAllowed | boolean | No | — | Duplicate Not Allowed |
engagementLink | object | No | — | Engagement Link |
entityLabels | any[] | No | — | List of entity attribute labels for the assessment |
incidentDetails | object | No | — | Incident Details |
inventoryDetails | object | No | — | Inventory Details |
labels | any[] | No | — | List of labels to attach to the assessment |
name | string | Yes | — | Name of the assessment |
orgGroupId | string | No | — | Organization group identifier to which the assessment should belong |
orgGroupName | string | No | — | Organization group name to which the assessment should belong |
primaryEntityDetails | any[] | No | — | Populated when Business Object needs to be selected as Primary for Assessment (except Inventory, Incident, Control Implementations and Engagements) |
primaryRecordTypeReference | string | No | — | Type of primary record when primaryEntityDetails are populated |
reminder | integer | No | — | Number of days before the deadline when the reminder should be sent to the respondent |
reminderSchedules | any[] | No | — | Reminder Schedules |
respondentCreationType | string | No | — | Type of user creation for respondents |
respondents | any[] | Yes | — | List of respondents. A minimum of one respondent must be assigned to the assessment |
ruleId | string | No | — | Identifier of the rule that triggered this assessment creation |
tags | any[] | No | — | List of tag identifiers to attach to the assessment during creation |
templateId | string | No | — | Template identifier for which the assessment has to be created (mandatory if templateRootVersionId is not provided) |
templateRootVersionId | string | No | — | Template root version identifier for which the assessment has to be created |
triggeredByAssessmentId | string | No | — | Identifier of the assessment that triggered this assessment creation |
triggeredByAssessmentName | string | No | — | Name of the assessment that triggered this assessment creation |
userAssignmentMode | string | No | — | Mode of user assignment for the assessment |
workflowId | string | No | — | Workflow identifier for which the assessment is associated with |
onetrust_assessments_create_bulk_assessment_using_post
Launch Assessments in Bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | any[] | Yes | — | List of assessment creation details including template, respondents, and metadata |
onetrust_assessments_create_task_using_post
Create Assessment Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | The unique ID of the assessment in which to create the task. |
assigneeId | string | No | — | The UUID of the user assigned to the task |
collaborators | any[] | No | — | The collaborators value |
deadline | string | No | — | The date by which the task must be completed |
description | string | No | — | Description of the task |
taskName | string | Yes | — | Name of the task |
onetrust_assessments_delete_template_versions_using_delete
Delete Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rootVersionId | string | Yes | — | The root version identifier of the template to be deleted. |
onetrust_assessments_export_assessment_using_get
Get Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | UUID of the assessment to export |
excludeSkippedQuestions | boolean | No | — | Flag to exclude skipped questions from the export |
onetrust_assessments_export_template_with_business_keys_using_get
Export Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateId | string | Yes | — | The unique identifier of the template to export. |
templateVersion | string | No | — | The specific version of the template to export or ‘latest’ for newest version. |
onetrust_assessments_get_all_assessment_basic_details_using_get
Get List of Assessments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateTypes | any[] | No | — | List of template types to filter assessments by. Available options: - PIA (PIA & DPIA Automation) - VENDOR (Third-Party Risk Management) - ITRM (IT & Security Risk Management) - CONTROL (Risk and Controls) - INCIDENT (Incident Management) - EXCHANGE (Third-Party Risk Exchange) - ESG (ESG Program Reporting) - DISCLOSURE (Disclosure Management) - DISCLOSURE_YOY (Year Over Year Disclosures) - ERM (Enterprise Risk Management) - TPDD (Third-Party Due Diligence) - AIGOVERNANCE (AI Governance) |
assessmentStatuses | any[] | No | — | List of assessment statuses to filter by |
assessmentArchivalState | string | No | — | Filter by archival state |
page | integer | No | — | Results page to be retrieved (0..N). Example- ‘?page=1 |
size | integer | No | — | Number of records per page (1…N). |
sort | string | No | — | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
onetrust_assessments_get_all_basic_template_details_using_get
Get List of Templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template-types | any[] | No | — | The array of template types to filter by when retrieving published templates. |
onetrust_assessments_get_assessment_delete_logs_using_get
Export Deleted Assessment Audit Logonetrust_assessments_get_assessment_results_using_get
Get List of Assessment Results Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterValue | string | No | — | Filter to apply when retrieving assessment results. Use ACTIVE_EXCLUDING_INTERNAL to exclude internal results. |
templateTypes | any[] | No | — | List of template types to filter assessment results by. Available options: - PIA (PIA & DPIA Automation) - VENDOR (Third-Party Risk Management) - ITRM (IT & Security Risk Management) - CONTROL (Risk and Controls) - INCIDENT (Incident Management) - EXCHANGE (Third-Party Risk Exchange) - ESG (ESG Program Reporting) - ERM (Enterprise Risk Management) - TPDD (Third-Party Due Diligence) - AIGOVERNANCE (AI Governance) |
includeMasterResults | boolean | No | — | Flag to include master results |
onetrust_assessments_get_linked_assessments_information_using_get
Get List of Linked Assessments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID of the reference object |
referenceType | string | Yes | — | Type of reference object |
linkTypes | any[] | No | — | Types of links to filter by |
page | integer | No | — | Results page to be retrieved (0..N) |
size | integer | No | — | Number of records per page (1…N) |
sort | string | No | — | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
onetrust_assessments_get_tags_using_get
Get List of Assessment Tagsonetrust_assessments_get_using_post
Get List of Assessments by Criteria Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateTypes | any[] | No | — | List of template types to filter assessments by. Available options: - PIA (PIA & DPIA Automation) - VENDOR (Third-Party Risk Management) - ITRM (IT & Security Risk Management) - CONTROL (Risk and Controls) - INCIDENT (Incident Management) - EXCHANGE (Third-Party Risk Exchange) - ESG (ESG Program Reporting) - DISCLOSURE (Disclosure Management) - DISCLOSURE_YOY (Year Over Year Disclosures) - ERM (Enterprise Risk Management) - TPDD (Third-Party Due Diligence) - AIGOVERNANCE (AI Governance) |
assessmentStatuses | any[] | No | — | List of assessment statuses to filter assessments by |
assessmentArchivalState | string | No | — | Filter assessments by their archival state. Use ALL to include both archived and non-archived assessments, ARCHIVED to include only archived assessments, or NON_ARCHIVED to include only non-archived assessments. |
page | integer | No | — | Results page to be retrieved (0..N). Example- ‘?page=1 |
size | integer | No | — | Number of records per page (1…N). |
sort | string | No | — | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
adminOnlyView | boolean | No | — | Loads admin view |
assessmentListViewType | string | Yes | — | Load assessments for corresponding view types |
filterCriteria | any[] | No | — | List of reminder schedules to trigger notifications to configured users (respondents or approvers) |
visibleColumns | any[] | Yes | — | Visible Columns |
onetrust_assessments_get_workflow_details_for_assessment_using_get
Get Assessment Workflow Stages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | The unique ID of the assessment to retrieve workflow details for |
onetrust_assessments_import_template_by_id_using_post
Import Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
matchAttributesByName | boolean | Yes | — | The flag indicating whether to match attributes by name during template import. |
body | object | Yes | — | Request body |
onetrust_assessments_reassess_assessment_using_post
Reassess Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier of the assessment to be reassessed |
archiveSourceAssessment | boolean | No | — | Use this field to provide a “true” or a “false” value to archive the original assessment. When reassessing, setting it to “true” will archive the original assessment and setting it to “false” will not archive the original assessment |
assessmentMetadata | object | No | — | Assessment Metadata |
copyAssessmentMetadata | boolean | No | — | This field will copy assessment name, description, organisation, approver, respondent details from source assessment to new assessment. |
copyAttachments | boolean | No | — | This field will copy over the attachments linked to the source assessment. |
copyComments | boolean | No | — | This field will copy over the comments from the source assessment. |
copyNotes | boolean | No | — | This field will copy over the user notes from the source assessment. |
copyResponses | boolean | No | — | This field will copy over the question responses from the source assessment. |
deadline | string | No | — | Deadline (date) to complete the assessment |
linkRisks | boolean | No | — | Any risk rules created based on the template risk rules for the original assessment will be linked to the newly created assessment upon submission. |
reminder | integer | No | — | Use this field to input the number of days before the deadline to send a automatic notification to the respondent. Deadline must be set for this field to be enabled. |
reminderSchedules | any[] | No | — | Reminder Schedules |
onetrust_assessments_reassign_assessment_using_put
Reassign Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | UUID of the assessment to reassign |
approvers | any[] | No | — | The user(s) that will override the current approvers if any are added |
orgGroupId | string | No | — | The ID of the organization that the assessment should be reassigned to |
respondentCreationType | string | No | — | If adding new users that don’t already exist, this is the type of user they will be created as |
respondents | any[] | No | — | The user(s) that will override the current respondents if any are added |
onetrust_assessments_reopen_assessment_using_post
Reopen Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier of the assessment to reopen from Completed to Under Review stage |
emailComment | string | No | — | Comment to be put in notification email when the assessment is reopened |
onetrust_assessments_send_back_assessment_to_in_progress_using_post
Send Back Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier of the assessment to send back to the In Progress stage |
editAllResponses | boolean | No | — | Use this field to all respondents to edit any question response when an assessment is sent back. |
emailComment | string | No | — | Comment to be put in notification email. |
reopenSectionIds | any[] | No | — | Reopen Section Ids |
resetApproverReviews | boolean | No | — | When an assessment is sent back, the approver’s vote is either retained or removed depending on the setting. |
sendBulkInfoRequestEmail | boolean | No | — | Use this field to send notifications at the same time to the users to get more information on several questions. |
onetrust_assessments_soft_delete_assessment_using_put
Move Assessment to Recycle Bin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | UUID of the assessment to soft delete |
onetrust_assessments_unarchive_assessments_using_put
Unarchive Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | any[] | Yes | — | Request body |
onetrust_assessments_update_basic_assessment_details_using_patch
Modify Assessment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | UUID of the assessment to update |
deadline | string | No | — | The date by which the assessment must be completed |
description | string | No | — | Detailed description of the assessment’s purpose and scope |
name | string | No | — | The name of the assessment to be displayed in the UI |
reminder | integer | No | — | The number of days before the deadline when a reminder notification should be sent to respondents |
onetrust_assessments_update_primary_record_using_put
Set Primary Record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assessmentId | string | Yes | — | UUID of the assessment to update primary record for |
primaryRecordIds | any[] | Yes | — | The unique UUIDs of the primary records |
primaryRecordType | string | Yes | — | Type of Inventory record to be updated. |

