ONonetrust
Assessments

Get Assessment

Use this API to retrieve details of a specific assessment. The response will include details such as basic assessment information, respondents, approvers, assessment questions and responses, and assessment risks.

🗒 Things to Know

  • The API response body will include all assessment responses received for that assessment after the assessment was launched. If a response record references an object (such as vendors, engagements, or assets) that was subsequently deleted from the OneTrust Platform after the assessment was launched, that record would still be included within the response body but would no longer exist in the OneTrust Platform.
get/api/assessment/v2/assessments/{assessmentId}/export

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/export
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT_READ, ASSESSMENT

Path parameters

assessmentIdstring uuid required

UUID of the assessment to export

Query parameters

ExcludeSkippedQuestionsboolean

Flag to exclude skipped questions from the export

includestring[]

Additional datasets to add to the response. Omit for the standard export. INFORMATION_REQUESTS adds the needs-more-information requests raised on the assessment, with their response threads. NOTES adds assessment-level notes; the returned set is scoped to the caller - machine callers receive EVERYONE and APPROVER notes, user callers receive the same notes the in-product notes view would show them, including their own ONLY_ME notes. STAGE_HISTORY adds chronological stage transitions with timestamps, oldest first, starting from assessment creation.

Response

OK

assessmentIdstring uuid

Unique identifier of the assessment

assessmentNumberinteger

Sequential number assigned to the assessment

namestring

Name of the assessment

descriptionstring

Description of the assessment

welcomeTextstring

Welcome text displayed at the beginning of the assessment

status'NOT_STARTED' | 'IN_PROGRESS' | 'UNDER_REVIEW' | 'COMPLETED'

Current status of the assessment

createdDTstring date-time

Date and time when the assessment was created (in UTC)

deadlinestring date-time

Deadline for completing the assessment

submittedOnstring date-time

Date when the assessment was submitted for review

completedOnstring date-time

Date when the assessment was completed

resultstring

Result of the assessment (deprecated, use resultName instead)

resultIdstring uuid

Unique identifier of the assessment result

resultNamestring

Name of the assessment result

lowRiskinteger

Count of low risk findings in the assessment

mediumRiskinteger

Count of medium risk findings in the assessment

highRiskinteger

Count of high risk findings in the assessment

veryHighRiskinteger

Count of very high risk findings in the assessment

totalRiskCountinteger

Total count of all risk findings in the assessment

riskLevelstring

Overall risk level of the assessment

residualRiskScorenumber

Residual risk score after mitigations

openRiskCountinteger

Count of open risks in the assessment

openInfoRequestCountinteger

Count of open information requests in the assessment. Counts requests, not responses, so a request with a long response thread counts once.

closedInfoRequestCountinteger

Count of closed information requests in the assessment

totalInfoRequestCountinteger

Count of all information requests in the assessment, open and closed

inherentRiskScorenumber

Inherent risk score before mitigations

targetRiskScorenumber

Target risk score to achieve

lastUpdatedstring date-time

Date and time when the assessment was last updated (in UTC)

primaryRecordTypestring

Type of the primary record associated with the assessment

tagsstring[]

List of tags associated with the assessment

Changes

No recorded changes to this operation across all 1 revision of this API.