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

Tools

ToolDescription
onetrust_assessments_add_manual_assessment_links_using_postLink Assessments
onetrust_assessments_add_or_update_tags_using_putUpdate Assessment Tags
onetrust_assessments_archive_assessments_using_putArchive Assessment
onetrust_assessments_create_assessment_using_postLaunch Assessment
onetrust_assessments_create_bulk_assessment_using_postLaunch Assessments in Bulk
onetrust_assessments_create_task_using_postCreate Assessment Task
onetrust_assessments_delete_template_versions_using_deleteDelete Template
onetrust_assessments_export_assessment_using_getGet Assessment
onetrust_assessments_export_template_with_business_keys_using_getExport Template
onetrust_assessments_get_all_assessment_basic_details_using_getGet List of Assessments
onetrust_assessments_get_all_basic_template_details_using_getGet List of Templates
onetrust_assessments_get_assessment_delete_logs_using_getExport Deleted Assessment Audit Log
onetrust_assessments_get_assessment_results_using_getGet List of Assessment Results
onetrust_assessments_get_linked_assessments_information_using_getGet List of Linked Assessments
onetrust_assessments_get_tags_using_getGet List of Assessment Tags
onetrust_assessments_get_using_postGet List of Assessments by Criteria
onetrust_assessments_get_workflow_details_for_assessment_using_getGet Assessment Workflow Stages
onetrust_assessments_import_template_by_id_using_postImport Template
onetrust_assessments_reassess_assessment_using_postReassess Assessment
onetrust_assessments_reassign_assessment_using_putReassign Assessment
onetrust_assessments_reopen_assessment_using_postReopen Assessment
onetrust_assessments_send_back_assessment_to_in_progress_using_postSend Back Assessment
onetrust_assessments_soft_delete_assessment_using_putMove Assessment to Recycle Bin
onetrust_assessments_unarchive_assessments_using_putUnarchive Assessment
onetrust_assessments_update_basic_assessment_details_using_patchModify Assessment
onetrust_assessments_update_primary_record_using_putSet Primary Record

onetrust_assessments_add_manual_assessment_links_using_post

Link Assessments Parameters:
ParameterTypeRequiredDefaultDescription
fromIdstringYesThe unique ID of the source assessment to create the link from
toIdsany[]YesTo Ids

onetrust_assessments_add_or_update_tags_using_put

Update Assessment Tags Parameters:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesUUID of the assessment to update tags for
bodyany[]YesRequest body

onetrust_assessments_archive_assessments_using_put

Archive Assessment Parameters:
ParameterTypeRequiredDefaultDescription
bodyany[]YesRequest body

onetrust_assessments_create_assessment_using_post

Launch Assessment Parameters:
ParameterTypeRequiredDefaultDescription
approverIdstringNoApprover identifier of the assessment (deprecated, use approvers list instead)
approverNamestringNoApprover name of the assessment (deprecated, use approvers list instead)
approverOnlySectionRespondentsany[]NoList of respondents for approver-only sections
approversany[]NoList of approvers for the assessment
attachmentRequestsany[]NoList of assessment attachment request
checkForInFlightAssessmentsbooleanNoWhether to check if any in-flight (status < COMPLETED) assessments exist with the same templateRootVersionId
controlImplementationDetailsany[]NoPopulated when Control Implementations are selected as Primary for Assessment
creationSourcestringNoSource of assessment creation
deadlinestringNoDeadline to complete the assessment (format: YYYY-MM-DDTHH:MM:SS.FFFZ)
defaultTemplateDeadlineReminderbooleanNoDefault Template Deadline Reminder
descriptionstringNoDescription of the assessment
duplicateNotAllowedbooleanNoDuplicate Not Allowed
engagementLinkobjectNoEngagement Link
entityLabelsany[]NoList of entity attribute labels for the assessment
incidentDetailsobjectNoIncident Details
inventoryDetailsobjectNoInventory Details
labelsany[]NoList of labels to attach to the assessment
namestringYesName of the assessment
orgGroupIdstringNoOrganization group identifier to which the assessment should belong
orgGroupNamestringNoOrganization group name to which the assessment should belong
primaryEntityDetailsany[]NoPopulated when Business Object needs to be selected as Primary for Assessment (except Inventory, Incident, Control Implementations and Engagements)
primaryRecordTypeReferencestringNoType of primary record when primaryEntityDetails are populated
reminderintegerNoNumber of days before the deadline when the reminder should be sent to the respondent
reminderSchedulesany[]NoReminder Schedules
respondentCreationTypestringNoType of user creation for respondents
respondentsany[]YesList of respondents. A minimum of one respondent must be assigned to the assessment
ruleIdstringNoIdentifier of the rule that triggered this assessment creation
tagsany[]NoList of tag identifiers to attach to the assessment during creation
templateIdstringNoTemplate identifier for which the assessment has to be created (mandatory if templateRootVersionId is not provided)
templateRootVersionIdstringNoTemplate root version identifier for which the assessment has to be created
triggeredByAssessmentIdstringNoIdentifier of the assessment that triggered this assessment creation
triggeredByAssessmentNamestringNoName of the assessment that triggered this assessment creation
userAssignmentModestringNoMode of user assignment for the assessment
workflowIdstringNoWorkflow identifier for which the assessment is associated with

onetrust_assessments_create_bulk_assessment_using_post

Launch Assessments in Bulk Parameters:
ParameterTypeRequiredDefaultDescription
bodyany[]YesList of assessment creation details including template, respondents, and metadata

onetrust_assessments_create_task_using_post

Create Assessment Task Parameters:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesThe unique ID of the assessment in which to create the task.
assigneeIdstringNoThe UUID of the user assigned to the task
collaboratorsany[]NoThe collaborators value
deadlinestringNoThe date by which the task must be completed
descriptionstringNoDescription of the task
taskNamestringYesName of the task

onetrust_assessments_delete_template_versions_using_delete

Delete Template Parameters:
ParameterTypeRequiredDefaultDescription
rootVersionIdstringYesThe root version identifier of the template to be deleted.

onetrust_assessments_export_assessment_using_get

Get Assessment Parameters:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesUUID of the assessment to export
excludeSkippedQuestionsbooleanNoFlag to exclude skipped questions from the export

onetrust_assessments_export_template_with_business_keys_using_get

Export Template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdstringYesThe unique identifier of the template to export.
templateVersionstringNoThe 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:
ParameterTypeRequiredDefaultDescription
templateTypesany[]NoList 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)
assessmentStatusesany[]NoList of assessment statuses to filter by
assessmentArchivalStatestringNoFilter by archival state
pageintegerNoResults page to be retrieved (0..N). Example- ‘?page=1
sizeintegerNoNumber of records per page (1…N).
sortstringNoSorting 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:
ParameterTypeRequiredDefaultDescription
template-typesany[]NoThe array of template types to filter by when retrieving published templates.

onetrust_assessments_get_assessment_delete_logs_using_get

Export Deleted Assessment Audit Log

onetrust_assessments_get_assessment_results_using_get

Get List of Assessment Results Parameters:
ParameterTypeRequiredDefaultDescription
filterValuestringNoFilter to apply when retrieving assessment results. Use ACTIVE_EXCLUDING_INTERNAL to exclude internal results.
templateTypesany[]NoList 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)
includeMasterResultsbooleanNoFlag to include master results

onetrust_assessments_get_linked_assessments_information_using_get

Get List of Linked Assessments Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID of the reference object
referenceTypestringYesType of reference object
linkTypesany[]NoTypes of links to filter by
pageintegerNoResults page to be retrieved (0..N)
sizeintegerNoNumber of records per page (1…N)
sortstringNoSorting 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 Tags

onetrust_assessments_get_using_post

Get List of Assessments by Criteria Parameters:
ParameterTypeRequiredDefaultDescription
templateTypesany[]NoList 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)
assessmentStatusesany[]NoList of assessment statuses to filter assessments by
assessmentArchivalStatestringNoFilter 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.
pageintegerNoResults page to be retrieved (0..N). Example- ‘?page=1
sizeintegerNoNumber of records per page (1…N).
sortstringNoSorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
adminOnlyViewbooleanNoLoads admin view
assessmentListViewTypestringYesLoad assessments for corresponding view types
filterCriteriaany[]NoList of reminder schedules to trigger notifications to configured users (respondents or approvers)
visibleColumnsany[]YesVisible Columns

onetrust_assessments_get_workflow_details_for_assessment_using_get

Get Assessment Workflow Stages Parameters:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesThe unique ID of the assessment to retrieve workflow details for

onetrust_assessments_import_template_by_id_using_post

Import Template Parameters:
ParameterTypeRequiredDefaultDescription
matchAttributesByNamebooleanYesThe flag indicating whether to match attributes by name during template import.
bodyobjectYesRequest body

onetrust_assessments_reassess_assessment_using_post

Reassess Assessment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier of the assessment to be reassessed
archiveSourceAssessmentbooleanNoUse 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
assessmentMetadataobjectNoAssessment Metadata
copyAssessmentMetadatabooleanNoThis field will copy assessment name, description, organisation, approver, respondent details from source assessment to new assessment.
copyAttachmentsbooleanNoThis field will copy over the attachments linked to the source assessment.
copyCommentsbooleanNoThis field will copy over the comments from the source assessment.
copyNotesbooleanNoThis field will copy over the user notes from the source assessment.
copyResponsesbooleanNoThis field will copy over the question responses from the source assessment.
deadlinestringNoDeadline (date) to complete the assessment
linkRisksbooleanNoAny risk rules created based on the template risk rules for the original assessment will be linked to the newly created assessment upon submission.
reminderintegerNoUse 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.
reminderSchedulesany[]NoReminder Schedules

onetrust_assessments_reassign_assessment_using_put

Reassign Assessment Parameters:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesUUID of the assessment to reassign
approversany[]NoThe user(s) that will override the current approvers if any are added
orgGroupIdstringNoThe ID of the organization that the assessment should be reassigned to
respondentCreationTypestringNoIf adding new users that don’t already exist, this is the type of user they will be created as
respondentsany[]NoThe user(s) that will override the current respondents if any are added

onetrust_assessments_reopen_assessment_using_post

Reopen Assessment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier of the assessment to reopen from Completed to Under Review stage
emailCommentstringNoComment 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:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier of the assessment to send back to the In Progress stage
editAllResponsesbooleanNoUse this field to all respondents to edit any question response when an assessment is sent back.
emailCommentstringNoComment to be put in notification email.
reopenSectionIdsany[]NoReopen Section Ids
resetApproverReviewsbooleanNoWhen an assessment is sent back, the approver’s vote is either retained or removed depending on the setting.
sendBulkInfoRequestEmailbooleanNoUse 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:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesUUID of the assessment to soft delete

onetrust_assessments_unarchive_assessments_using_put

Unarchive Assessment Parameters:
ParameterTypeRequiredDefaultDescription
bodyany[]YesRequest body

onetrust_assessments_update_basic_assessment_details_using_patch

Modify Assessment Parameters:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesUUID of the assessment to update
deadlinestringNoThe date by which the assessment must be completed
descriptionstringNoDetailed description of the assessment’s purpose and scope
namestringNoThe name of the assessment to be displayed in the UI
reminderintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
assessmentIdstringYesUUID of the assessment to update primary record for
primaryRecordIdsany[]YesThe unique UUIDs of the primary records
primaryRecordTypestringYesType of Inventory record to be updated.