--- title: "Get Assessment Record" method: GET path: "/api/assessment/v2/assessments/{assessmentId}/record" tags: ["Assessments"] --- # Get Assessment Record `GET /api/assessment/v2/assessments/{assessmentId}/record` ## Request - Base URL: `https://hostname` - URL: `https://hostname/api/assessment/v2/assessments/{assessmentId}/record` - Auth: OAuth 2 - Client credentials - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `ASSESSMENT_READ`, `ASSESSMENT` Use this API to retrieve an assessment record containing basic assessment information, sections with questions and responses, and current status. By default, returns a lightweight version that excludes risk information, approvers, respondents, attachments, and other detailed metadata. Set showAllDetails=true to get the full export equivalent response. The informationRequests, notes and stageHistory datasets are not returned by this API; use the `include` parameter of Get Assessment to retrieve them. ## Path parameters - `assessmentId` string, uuid, required ## Query parameters - `showAllDetails` boolean - `excludeSkippedQuestions` boolean ## Response `200` OK - union - object - `assessmentId` string, uuid: Unique identifier of the assessment - `assessmentNumber` integer: Sequential number assigned to the assessment - `name` string: Name of the assessment - `orgGroup` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `template` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'UNDER_REVIEW' | 'COMPLETED': Current status of the assessment - `createdBy` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `createdDT` string, date-time: Date and time when the assessment was created (in UTC) - `sections` PrivacyAutomationAssessmentAutomationAssessmentSectionInformation[]: List of sections in the assessment with their questions and responses - `header` PrivacyAutomationAssessmentAutomationAssessmentSectionHeaderInformation - `sectionId` string, uuid: Unique identifier for the section - `name` string: Name of the section - `description` string: Description of the section - `sequence` integer: Sequence number indicating the order of the section in the assessment - `hidden` boolean: Indicates if the section is hidden based on navigation rules - `invalidQuestionIds` unknown[] - unknown - `requiredUnansweredQuestionIds` unknown[] - unknown - `requiredQuestionIds` unknown[] - unknown - `unansweredQuestionIds` unknown[] - unknown - `effectivenessQuestionIds` string[] - `autoAnsweredQuestionIds` string[] - `riskStatistics` PrivacyAutomationAssessmentAutomationRiskStatistics - `sectionId` string, uuid - `riskCount` integer - `maxRiskLevel` integer - `status` string: Current status of the section - `nameKey` string: Translation key for the section name - `descriptionKey` string: Translation key for the section description - `openNMIQuestionIds` unknown[] - unknown - `sectionUserType` 'APPROVER' | 'RESPONDENT': Type of user assigned to the section (e.g., RESPONDENT, APPROVER) - `flaggedQuestionIds` unknown[] - unknown - `submitted` boolean - `questions` PrivacyAutomationAssessmentAutomationAssessmentQuestionInformation[] - `question` PrivacyAutomationAssessmentAutomationQuestionInformation - `id` string, uuid - `rootVersionId` string, uuid - `sequence` integer - `questionType` 'TEXTBOX' | 'MULTICHOICE' | 'YESNO' | 'DATE' | 'STATEMENT' | 'INVENTORY' | 'INCIDENT' | 'ATTRIBUTE' | 'PERSONAL_DATA' | 'YES_NO_PARTIALLY' | 'CONTROL' | 'CONTRACT' | 'ENGAGEMENT' | 'ASSESS_CONTROL' | 'ASSESS_RISK' | 'ASSESS_ISSUE' | 'CUSTOM_ENTITY' | 'RELATIONSHIP' | 'DISCLOSURE' - `required` boolean - `attributes` string - `friendlyName` string - `description` string - `hint` string - `parentQuestionId` string, uuid - `prePopulateResponse` boolean - `linkAssessmentToInventory` boolean - `options` PrivacyAutomationAssessmentAutomationOptionInformation[] - `id` string, uuid - `option` string - `optionKey` string - `sequence` integer - `hint` string - `hintKey` string - `attributes` string - `optionType` 'NOT_SURE' | 'NOT_APPLICABLE' | 'OTHERS' | 'DEFAULT' - `score` integer - `preSelectedOption` boolean - `translationIdentifier` string, uuid - `valid` boolean - `businessKeyReference` string - `topic` string - `questionLaws` PrivacyAutomationAssessmentAutomationLawInformation[] - `name` string - `attachmentRequired` boolean - `responseFilter` PrivacyAutomationAssessmentAutomationResponseFilter - `filters` object: Filter criteria as a map of filter key to the list of allowed UUIDs - `operator` string - `linkAssessmentToResponseEntity` boolean - `attachmentIds` string[] - `readOnly` boolean - `translationIdentifier` string, uuid - `optionMetadata` PrivacyAutomationAssessmentAutomationAttributeOptionMetadataInformation - `entityTypeName` string: Option Source Entity Type - `basicServiceContextPath` string: Basic Url for the Option source Service - `optionUrl` string: Api URL for the Drop Down Api - `viewType` string: This will help to identify the view type of list - `type` 'TEXTBOX' | 'MULTICHOICE' | 'YESNO' | 'DATE' | 'STATEMENT' | 'INVENTORY' | 'INCIDENT' | 'ATTRIBUTE' | 'PERSONAL_DATA' | 'YES_NO_PARTIALLY' | 'CONTROL' | 'CONTRACT' | 'ENGAGEMENT' | 'ASSESS_CONTROL' | 'ASSESS_RISK' | 'ASSESS_ISSUE' | 'CUSTOM_ENTITY' | 'RELATIONSHIP' | 'DISCLOSURE' - `schema` PrivacyAutomationAssessmentAutomationSchemaIdentifier - `schemaName` string - `moduleName` string - `allowMultiSelect` boolean - `attributeId` string, uuid - `allowJustification` boolean - `assetQuestion` boolean - `vendorQuestion` boolean - `entityQuestion` boolean - `paquestion` boolean - `inventoryTypeEnum` 'ASSETS' | 'PROCESSING_ACTIVITY' | 'VENDORS' | 'DATA_SUBJECTS' | 'DATA_ELEMENTS' | 'DATA_CATEGORIES' | 'ENTITIES' | 'PERSONAL_DATA' - `seeded` boolean - `forceOther` boolean - `requireJustification` boolean - `content` string - `isParentQuestionMultiSelect` boolean - `sectionInformation` PrivacyAutomationAssessmentAutomationAssessmentQuestionSectionBasicInfo - `id` string, uuid: UUID of the section - `name` string: Name of the section - `description` string: Description of the section - `sequence` integer: Sequence number indicating the order of the section in the assessment - `hidden` boolean: Indicates if the question should be hidden or not based on the responses provided so far - `lockReason` 'LAUNCH_FROM_INVENTORY' | 'LAUNCH_FROM_INCIDENT' | 'LAUNCH_FROM_INCIDENT_TEMPLATE_QUESTION' | 'READ_ONLY_ATTRIBUTE' | 'LAUNCH_FROM_CONTROL_IMPLEMENTATION' | 'RESPONSE_DRIVEN_INVENTORY' | 'RESPONSE_DRIVEN_CONTROL_IMPLEMENTATION' | 'PRIMARY_LOCK' | 'PRIMARY_PARENT_LOCK' | 'RESPONSE_DRIVEN_PRIMARY_LOCK' | 'FORCE_CREATION_LOCK': Reason why the question is locked, if applicable - `copyErrors` string[] - `hasNavigationRules` boolean: Indicates if the question has navigation rules associated with it - `questionResponses` PrivacyAutomationAssessmentAutomationAssessmentQuestionResponseInformation[] - `responses` PrivacyAutomationAssessmentAutomationAssessmentResponseInformation[] - `responseId` string, uuid - `response` string - `responseKey` string - `type` 'NOT_SURE' | 'JUSTIFICATION' | 'NOT_APPLICABLE' | 'DEFAULT' | 'MATURITY_SCALE' | 'EFFECTIVENESS_SCALE' | 'OTHERS': Type of response provided - `responseSourceType` 'LAUNCH_FROM_INVENTORY' | 'LAUNCH_FROM_INCIDENT' | 'INCIDENT_TEMPLATE' | 'LAUNCH_FROM_CONTROL_IMPLEMENTATION' | 'RESPONSE_DRIVEN_INVENTORY' | 'RESPONSE_DRIVEN_CONTROL_IMPLEMENTATION' | 'PRIMARY_SOURCE' | 'PRIMARY_PARENT_SOURCE' | 'RESPONSE_DRIVEN_PRIMARY_SOURCE' | 'FORCE_CREATED_SOURCE' | 'AI_IMPORT' | 'AI_ACCEPT': Source that produced this response - `errorCode` 'ATTRIBUTE_DISABLED' | 'ATTRIBUTE_OPTION_DISABLED' | 'INVALID_RESPONSE_VALUE' | 'INVENTORY_NOT_EXISTS' | 'RELATED_INVENTORY_ATTRIBUTE_DISABLED' | 'DATA_ELEMENT_NOT_EXISTS' | 'DATA_SUBJECT_NOT_EXISTS' | 'DUPLICATE_INVENTORY' | 'INVENTORY_ASSOCIATION_TYPE_INVALID' | 'INVENTORY_ASSOCIATION_TYPE_NOT_APPLICABLE' | 'MULTIPLE_SERVICE_PROVIDER_VENDOR_ASSET_RELATION' | 'EMAIL_INVALID' | 'RELATIONSHIP_ATTRIBUTE_OPTION_DISABLED' | 'CONTRACT_NOT_FOUND' | 'VENDOR_CHILD_ATTRIBUTE_INVALID_VALUE_FORMAT' | 'VENDOR_CHILD_ATTRIBUTE_VALUE_LONG' | 'CONTRACT_INVALID_NAME' | 'ENGAGEMENT_NOT_FOUND' | 'DUPLICATE_ENGAGEMENT' | 'INVALID_ENTITY' | 'NOT_FOUND_LINK_TYPE' | 'LINK_TYPE_DOES_NOT_BELONG_TO_ENTITY_TYPE' | 'LINK_RECORD_CANNOT_BE_CREATED_BETWEEN_SAME_ENTITY' | 'LINK_TYPE_DISABLED' | 'INVALID_CONTROL' | 'GENERIC_EXCEPTION' | 'UNKNOWN_MODULE_CLIENT_ERROR' | 'DATE_DISCOVERED_BEFORE_DATE_OCCURRED' | 'UNSAFE_HTML_EXCEPTION': not required - `errorTranslationKey` string: not required - `responseMap` object: only applicable for inventory type responses. Allowable values for the key: ASSETS, PROCESSING_ACTIVITY, VENDORS, DATA_SUBJECTS, DATA_ELEMENTS, DATA_CATEGORIES - `scaleResponseMap` object: only applicable for YES_NO_PARTIALLY type responses. key should be OVERALL or LAW Name - `controlResponse` PrivacyAutomationAssessmentAutomationControlResponse - … - `responseAdditionalDetails` PrivacyAutomationAssessmentAutomationResponseAdditionalDetails - … - `contractResponse` PrivacyAutomationAssessmentAutomationContractAdditionalResponseInformation - … - `relationshipResponseDetails` PrivacyAutomationAssessmentAutomationRelationshipResponseDetailsDto[] - … - `valid` boolean: not required - `textRedacted` boolean: Applicable for attribute text questions - `lastModifiedDate` string, date-time - `assessmentDetailId` string, uuid: Assessment Detail Identifier of the question response - `personalDataDetailId` string, uuid: Pre-generated ID for AssessmentPersonalDataDetail entity, used in AI auto-suggestion mode - `dataSubject` PrivacyAutomationAssessmentAutomationBasicEntityDetail - … - `dataCategory` PrivacyAutomationAssessmentAutomationBasicEntityDetail - … - `dataElement` PrivacyAutomationAssessmentAutomationBasicEntityDetail - … - `justification` string: Justification text provided for the response - `maturityScale` integer: Maturity scale value selected for the question - `effectivenessScale` integer: Effectiveness scale value selected for the question - `parentAssessmentDetailId` string, uuid: Identifier of the parent assessment detail - `risks` PrivacyAutomationAssessmentAutomationAssessmentQuestionRiskInformation[] - `questionId` string, uuid: Identifier of the question associated with this risk - `parentQuestionResponseDetailId` string, uuid: Identifier of the parent question response detail - `riskId` string, uuid: Unique identifier of the risk - `level` integer: Risk level value - `score` integer: Numerical risk score - `probability` integer: Probability component of risk score - `impactLevel` integer: Impact level component of risk score - `riskLevelValue` string: Display value of the risk level (e.g., 'High', 'Medium', 'Low') - `riskLevelValueKey` string: Key for the risk level value for localization - `riskLevelColorCode` string: Color code associated with the risk level for UI display - `attributeOptionId` string, uuid: Identifier of the attribute option associated with this risk level - `rootRequestInformationIds` unknown[] - unknown - `totalAttachments` integer: Total number of attachments for this question - `attachmentIds` unknown[] - unknown - `canReopenWithAllowEditOption` boolean: Indicates if a question can be opened for allowing a response to be edited. If true, it means the question has no skip logic tied to it, or it is not an inventory/attribute/incident question. - `riskCreationAllowed` boolean: Indicates if the question can be allowed to flag risk manually - `riskDeletionPopupAllowed` boolean: Indicates if risk deletion alert popup is allowed on this question - `allowMaturityScaleOnQuestions` boolean: Indicates if Maturity Scale is allowed on this question - `questionAssociations` PrivacyAutomationAssessmentAutomationQuestionAssociationInformation[] - `associationType` 'SOURCE' | 'TARGET' | 'ADDITIONAL_LINK_1' | 'ADDITIONAL_LINK_2' | 'RESTRICT_RESPONSE_OPTIONS' - `associatedQuestionIds` string[] - `attachmentsById` object - `issues` PrivacyAutomationAssessmentAutomationAssessmentQuestionIssueInformation[] - `questionId` string, uuid - `issueId` string, uuid - `parentQuestionResponseDetailId` string, uuid - `questionResponseReviewStatus` PrivacyAutomationAssessmentAutomationQuestionResponseReviewStatus - `questionId` string, uuid - `responseAnswerSource` 'AI' | 'HUMAN': Source type for question responses - `isReviewed` boolean - `isFlagged` boolean - `responseEditableWhileUnderReview` boolean - `hasNavigationRules` boolean: Indicates if the section has navigation rules that affect question flow - `submittedBy` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `submittedDt` string, date-time: Date and time when the section was submitted - `name` string: Name of the section - `isHidden` boolean: Indicates if the section is hidden - `isValid` boolean: Indicates if the section is valid - `submitted` boolean - `description` string: Description of the section - `sectionId` string, uuid: Unique identifier for the section - `sequence` integer: Sequence number of the section - object - `assessmentId` string, uuid: Unique identifier of the assessment - `assessmentNumber` integer: Sequential number assigned to the assessment - `name` string: Name of the assessment - `description` string: Description of the assessment - `welcomeText` string: Welcome text displayed at the beginning of the assessment - `orgGroup` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `template` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'UNDER_REVIEW' | 'COMPLETED': Current status of the assessment - `createdBy` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `createdDT` string, date-time: Date and time when the assessment was created (in UTC) - `sections` PrivacyAutomationAssessmentAutomationAssessmentSectionInformation[]: List of sections in the assessment with their questions and responses - `header` PrivacyAutomationAssessmentAutomationAssessmentSectionHeaderInformation - `sectionId` string, uuid: Unique identifier for the section - `name` string: Name of the section - `description` string: Description of the section - `sequence` integer: Sequence number indicating the order of the section in the assessment - `hidden` boolean: Indicates if the section is hidden based on navigation rules - `invalidQuestionIds` unknown[] - unknown - `requiredUnansweredQuestionIds` unknown[] - unknown - `requiredQuestionIds` unknown[] - unknown - `unansweredQuestionIds` unknown[] - unknown - `effectivenessQuestionIds` string[] - `autoAnsweredQuestionIds` string[] - `riskStatistics` PrivacyAutomationAssessmentAutomationRiskStatistics - `sectionId` string, uuid - `riskCount` integer - `maxRiskLevel` integer - `status` string: Current status of the section - `nameKey` string: Translation key for the section name - `descriptionKey` string: Translation key for the section description - `openNMIQuestionIds` unknown[] - unknown - `sectionUserType` 'APPROVER' | 'RESPONDENT': Type of user assigned to the section (e.g., RESPONDENT, APPROVER) - `flaggedQuestionIds` unknown[] - unknown - `submitted` boolean - `questions` PrivacyAutomationAssessmentAutomationAssessmentQuestionInformation[] - `question` PrivacyAutomationAssessmentAutomationQuestionInformation - `id` string, uuid - `rootVersionId` string, uuid - `sequence` integer - `questionType` 'TEXTBOX' | 'MULTICHOICE' | 'YESNO' | 'DATE' | 'STATEMENT' | 'INVENTORY' | 'INCIDENT' | 'ATTRIBUTE' | 'PERSONAL_DATA' | 'YES_NO_PARTIALLY' | 'CONTROL' | 'CONTRACT' | 'ENGAGEMENT' | 'ASSESS_CONTROL' | 'ASSESS_RISK' | 'ASSESS_ISSUE' | 'CUSTOM_ENTITY' | 'RELATIONSHIP' | 'DISCLOSURE' - `required` boolean - `attributes` string - `friendlyName` string - `description` string - `hint` string - `parentQuestionId` string, uuid - `prePopulateResponse` boolean - `linkAssessmentToInventory` boolean - `options` PrivacyAutomationAssessmentAutomationOptionInformation[] - `id` string, uuid - `option` string - `optionKey` string - `sequence` integer - `hint` string - `hintKey` string - `attributes` string - `optionType` 'NOT_SURE' | 'NOT_APPLICABLE' | 'OTHERS' | 'DEFAULT' - `score` integer - `preSelectedOption` boolean - `translationIdentifier` string, uuid - `valid` boolean - `businessKeyReference` string - `topic` string - `questionLaws` PrivacyAutomationAssessmentAutomationLawInformation[] - `name` string - `attachmentRequired` boolean - `responseFilter` PrivacyAutomationAssessmentAutomationResponseFilter - `filters` object: Filter criteria as a map of filter key to the list of allowed UUIDs - `operator` string - `linkAssessmentToResponseEntity` boolean - `attachmentIds` string[] - `readOnly` boolean - `translationIdentifier` string, uuid - `optionMetadata` PrivacyAutomationAssessmentAutomationAttributeOptionMetadataInformation - `entityTypeName` string: Option Source Entity Type - `basicServiceContextPath` string: Basic Url for the Option source Service - `optionUrl` string: Api URL for the Drop Down Api - `viewType` string: This will help to identify the view type of list - `type` 'TEXTBOX' | 'MULTICHOICE' | 'YESNO' | 'DATE' | 'STATEMENT' | 'INVENTORY' | 'INCIDENT' | 'ATTRIBUTE' | 'PERSONAL_DATA' | 'YES_NO_PARTIALLY' | 'CONTROL' | 'CONTRACT' | 'ENGAGEMENT' | 'ASSESS_CONTROL' | 'ASSESS_RISK' | 'ASSESS_ISSUE' | 'CUSTOM_ENTITY' | 'RELATIONSHIP' | 'DISCLOSURE' - `schema` PrivacyAutomationAssessmentAutomationSchemaIdentifier - `schemaName` string - `moduleName` string - `allowMultiSelect` boolean - `attributeId` string, uuid - `allowJustification` boolean - `assetQuestion` boolean - `vendorQuestion` boolean - `entityQuestion` boolean - `paquestion` boolean - `inventoryTypeEnum` 'ASSETS' | 'PROCESSING_ACTIVITY' | 'VENDORS' | 'DATA_SUBJECTS' | 'DATA_ELEMENTS' | 'DATA_CATEGORIES' | 'ENTITIES' | 'PERSONAL_DATA' - `seeded` boolean - `forceOther` boolean - `requireJustification` boolean - `content` string - `isParentQuestionMultiSelect` boolean - `sectionInformation` PrivacyAutomationAssessmentAutomationAssessmentQuestionSectionBasicInfo - `id` string, uuid: UUID of the section - `name` string: Name of the section - `description` string: Description of the section - `sequence` integer: Sequence number indicating the order of the section in the assessment - `hidden` boolean: Indicates if the question should be hidden or not based on the responses provided so far - `lockReason` 'LAUNCH_FROM_INVENTORY' | 'LAUNCH_FROM_INCIDENT' | 'LAUNCH_FROM_INCIDENT_TEMPLATE_QUESTION' | 'READ_ONLY_ATTRIBUTE' | 'LAUNCH_FROM_CONTROL_IMPLEMENTATION' | 'RESPONSE_DRIVEN_INVENTORY' | 'RESPONSE_DRIVEN_CONTROL_IMPLEMENTATION' | 'PRIMARY_LOCK' | 'PRIMARY_PARENT_LOCK' | 'RESPONSE_DRIVEN_PRIMARY_LOCK' | 'FORCE_CREATION_LOCK': Reason why the question is locked, if applicable - `copyErrors` string[] - `hasNavigationRules` boolean: Indicates if the question has navigation rules associated with it - `questionResponses` PrivacyAutomationAssessmentAutomationAssessmentQuestionResponseInformation[] - `responses` PrivacyAutomationAssessmentAutomationAssessmentResponseInformation[] - `responseId` string, uuid - `response` string - `responseKey` string - `type` 'NOT_SURE' | 'JUSTIFICATION' | 'NOT_APPLICABLE' | 'DEFAULT' | 'MATURITY_SCALE' | 'EFFECTIVENESS_SCALE' | 'OTHERS': Type of response provided - `responseSourceType` 'LAUNCH_FROM_INVENTORY' | 'LAUNCH_FROM_INCIDENT' | 'INCIDENT_TEMPLATE' | 'LAUNCH_FROM_CONTROL_IMPLEMENTATION' | 'RESPONSE_DRIVEN_INVENTORY' | 'RESPONSE_DRIVEN_CONTROL_IMPLEMENTATION' | 'PRIMARY_SOURCE' | 'PRIMARY_PARENT_SOURCE' | 'RESPONSE_DRIVEN_PRIMARY_SOURCE' | 'FORCE_CREATED_SOURCE' | 'AI_IMPORT' | 'AI_ACCEPT': Source that produced this response - `errorCode` 'ATTRIBUTE_DISABLED' | 'ATTRIBUTE_OPTION_DISABLED' | 'INVALID_RESPONSE_VALUE' | 'INVENTORY_NOT_EXISTS' | 'RELATED_INVENTORY_ATTRIBUTE_DISABLED' | 'DATA_ELEMENT_NOT_EXISTS' | 'DATA_SUBJECT_NOT_EXISTS' | 'DUPLICATE_INVENTORY' | 'INVENTORY_ASSOCIATION_TYPE_INVALID' | 'INVENTORY_ASSOCIATION_TYPE_NOT_APPLICABLE' | 'MULTIPLE_SERVICE_PROVIDER_VENDOR_ASSET_RELATION' | 'EMAIL_INVALID' | 'RELATIONSHIP_ATTRIBUTE_OPTION_DISABLED' | 'CONTRACT_NOT_FOUND' | 'VENDOR_CHILD_ATTRIBUTE_INVALID_VALUE_FORMAT' | 'VENDOR_CHILD_ATTRIBUTE_VALUE_LONG' | 'CONTRACT_INVALID_NAME' | 'ENGAGEMENT_NOT_FOUND' | 'DUPLICATE_ENGAGEMENT' | 'INVALID_ENTITY' | 'NOT_FOUND_LINK_TYPE' | 'LINK_TYPE_DOES_NOT_BELONG_TO_ENTITY_TYPE' | 'LINK_RECORD_CANNOT_BE_CREATED_BETWEEN_SAME_ENTITY' | 'LINK_TYPE_DISABLED' | 'INVALID_CONTROL' | 'GENERIC_EXCEPTION' | 'UNKNOWN_MODULE_CLIENT_ERROR' | 'DATE_DISCOVERED_BEFORE_DATE_OCCURRED' | 'UNSAFE_HTML_EXCEPTION': not required - `errorTranslationKey` string: not required - `responseMap` object: only applicable for inventory type responses. Allowable values for the key: ASSETS, PROCESSING_ACTIVITY, VENDORS, DATA_SUBJECTS, DATA_ELEMENTS, DATA_CATEGORIES - `scaleResponseMap` object: only applicable for YES_NO_PARTIALLY type responses. key should be OVERALL or LAW Name - `controlResponse` PrivacyAutomationAssessmentAutomationControlResponse - … - `responseAdditionalDetails` PrivacyAutomationAssessmentAutomationResponseAdditionalDetails - … - `contractResponse` PrivacyAutomationAssessmentAutomationContractAdditionalResponseInformation - … - `relationshipResponseDetails` PrivacyAutomationAssessmentAutomationRelationshipResponseDetailsDto[] - … - `valid` boolean: not required - `textRedacted` boolean: Applicable for attribute text questions - `lastModifiedDate` string, date-time - `assessmentDetailId` string, uuid: Assessment Detail Identifier of the question response - `personalDataDetailId` string, uuid: Pre-generated ID for AssessmentPersonalDataDetail entity, used in AI auto-suggestion mode - `dataSubject` PrivacyAutomationAssessmentAutomationBasicEntityDetail - … - `dataCategory` PrivacyAutomationAssessmentAutomationBasicEntityDetail - … - `dataElement` PrivacyAutomationAssessmentAutomationBasicEntityDetail - … - `justification` string: Justification text provided for the response - `maturityScale` integer: Maturity scale value selected for the question - `effectivenessScale` integer: Effectiveness scale value selected for the question - `parentAssessmentDetailId` string, uuid: Identifier of the parent assessment detail - `risks` PrivacyAutomationAssessmentAutomationAssessmentQuestionRiskInformation[] - `questionId` string, uuid: Identifier of the question associated with this risk - `parentQuestionResponseDetailId` string, uuid: Identifier of the parent question response detail - `riskId` string, uuid: Unique identifier of the risk - `level` integer: Risk level value - `score` integer: Numerical risk score - `probability` integer: Probability component of risk score - `impactLevel` integer: Impact level component of risk score - `riskLevelValue` string: Display value of the risk level (e.g., 'High', 'Medium', 'Low') - `riskLevelValueKey` string: Key for the risk level value for localization - `riskLevelColorCode` string: Color code associated with the risk level for UI display - `attributeOptionId` string, uuid: Identifier of the attribute option associated with this risk level - `rootRequestInformationIds` unknown[] - unknown - `totalAttachments` integer: Total number of attachments for this question - `attachmentIds` unknown[] - unknown - `canReopenWithAllowEditOption` boolean: Indicates if a question can be opened for allowing a response to be edited. If true, it means the question has no skip logic tied to it, or it is not an inventory/attribute/incident question. - `riskCreationAllowed` boolean: Indicates if the question can be allowed to flag risk manually - `riskDeletionPopupAllowed` boolean: Indicates if risk deletion alert popup is allowed on this question - `allowMaturityScaleOnQuestions` boolean: Indicates if Maturity Scale is allowed on this question - `questionAssociations` PrivacyAutomationAssessmentAutomationQuestionAssociationInformation[] - `associationType` 'SOURCE' | 'TARGET' | 'ADDITIONAL_LINK_1' | 'ADDITIONAL_LINK_2' | 'RESTRICT_RESPONSE_OPTIONS' - `associatedQuestionIds` string[] - `attachmentsById` object - `issues` PrivacyAutomationAssessmentAutomationAssessmentQuestionIssueInformation[] - `questionId` string, uuid - `issueId` string, uuid - `parentQuestionResponseDetailId` string, uuid - `questionResponseReviewStatus` PrivacyAutomationAssessmentAutomationQuestionResponseReviewStatus - `questionId` string, uuid - `responseAnswerSource` 'AI' | 'HUMAN': Source type for question responses - `isReviewed` boolean - `isFlagged` boolean - `responseEditableWhileUnderReview` boolean - `hasNavigationRules` boolean: Indicates if the section has navigation rules that affect question flow - `submittedBy` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `submittedDt` string, date-time: Date and time when the section was submitted - `name` string: Name of the section - `isHidden` boolean: Indicates if the section is hidden - `isValid` boolean: Indicates if the section is valid - `submitted` boolean - `description` string: Description of the section - `sectionId` string, uuid: Unique identifier for the section - `sequence` integer: Sequence number of the section - `approvers` PrivacyAutomationAssessmentAutomationApproverInformation[]: List of users who are approvers for the assessment - `id` string, uuid - `workflowStageId` string, uuid - `name` string - `approver` PrivacyAutomationAssessmentAutomationBasicUserEntityDetail - `id` string, uuid: Unique identifier of the user - `fullName` string: Full name of the user - `email` string: Email address of the user - `deleted` boolean: Flag indicating whether the user has been deleted - `assigneeType` string: Type of assignee (e.g., USER, GROUP) - `approvedOn` string, date-time - `approvalState` 'OPEN' | 'APPROVED' | 'REJECTED' - `resultId` string, uuid - `resultName` string - `resultNameKey` string - `approverAssignedDate` string, date-time: Date and time when the approver was assigned to the assessment. - `respondents` PrivacyAutomationAssessmentAutomationBasicEntityDetail[]: List of users who are respondents for the assessment - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `respondent` PrivacyAutomationAssessmentAutomationBasicEntityDetail - `id` string, uuid: Unique identifier of the entity (organization group, user, etc.) - `name` string: Display name of the entity (organization name or user's full name) - `nameKey` string: Translation key for the name, used for internationalization - `deadline` string, date-time: Deadline for completing the assessment - `submittedOn` string, date-time: Date when the assessment was submitted for review - `completedOn` string, date-time: Date when the assessment was completed - `result` string: Result of the assessment (deprecated, use resultName instead) - `resultId` string, uuid: Unique identifier of the assessment result - `resultName` string: Name of the assessment result - `lowRisk` integer: Count of low risk findings in the assessment - `mediumRisk` integer: Count of medium risk findings in the assessment - `highRisk` integer: Count of high risk findings in the assessment - `veryHighRisk` integer: Count of very high risk findings in the assessment - `totalRiskCount` integer: Total count of all risk findings in the assessment - `riskLevel` string: Overall risk level of the assessment - `residualRiskScore` number: Residual risk score after mitigations - `openRiskCount` integer: Count of open risks in the assessment - `openInfoRequestCount` integer: Count of open information requests in the assessment. Counts requests, not responses, so a request with a long response thread counts once. - `closedInfoRequestCount` integer: Count of closed information requests in the assessment - `totalInfoRequestCount` integer: Count of all information requests in the assessment, open and closed - `inherentRiskScore` number: Inherent risk score before mitigations - `targetRiskScore` number: Target risk score to achieve - `lastUpdated` string, date-time: Date and time when the assessment was last updated (in UTC) - `primaryEntityDetails` PrivacyAutomationAssessmentAutomationAssessableEntityDetail[]: Details of the primary entities associated with the assessment - `id` string, uuid: ID of the assessable entity - `name` string: Name of the assessable entity - `number` integer: Number of the assessable entity - `relationshipResponseDetails` PrivacyAutomationAssessmentAutomationRelationshipResponseDetailsDto[] - `relationshipNodeType` string: Type of the relationship node - `entityId` string, uuid, required: Unique identifier of the related entity - `entityDisplayName` string: Display name of the related entity - `entityType` PrivacyAutomationAssessmentAutomationEntityTypeInformation, required - `id` string, uuid: Unique identifier of the entity type - `name` string: Name of the entity type - `nameKey` string: Translation key for the entity type name - `moduleName` string: Module name that owns this entity type - `schemaName` string: Schema name for this entity type - `seeded` boolean: Whether this entity type is seeded - `validEntityType` boolean - `displayName` string: Display name of the entity - `entityBusinessKey` string: Business Key of the entity - `primaryRecordType` string: Type of the primary record associated with the assessment - `tags` string[]: List of tags associated with the assessment - `profileScoreInformationList` PrivacyAutomationAssessmentAutomationProfileScoreInformation[]: List of profile scores for the assessment, containing profile name and calculated score - `scoreProfileName` string - `profileScore` number - `informationRequests` PrivacyAutomationAssessmentAutomationAssessmentInformationRequestExport[]: Needs-more-information (NMI) requests raised on the assessment with their response threads, oldest request first. Returned only when include=INFORMATION_REQUESTS is requested; empty when the assessment has no requests. - `rootRequestId` string, uuid: Unique identifier of the information request. Groups the request with its responses. - `status` 'OPEN' | 'CLOSED': Current state of the information request - `section` PrivacyAutomationAssessmentAutomationInformationRequestSectionDetail - `id` string, uuid: Unique identifier of the section - `sequence` integer: Sequence of the section within the assessment. Null when the section no longer exists on the template. - `name` string: Name of the section. Null when the section no longer exists on the template. - `question` PrivacyAutomationAssessmentAutomationInformationRequestQuestionDetail - `id` string, uuid: Unique identifier of the question - `sequence` integer: Sequence of the question within its section. Null when the question no longer exists on the template. - `content` string: Text of the question. Null when the question no longer exists on the template. - `requestText` string: Text of the information request - `requester` PrivacyAutomationAssessmentAutomationBasicUserDetail - `userId` string, uuid - `fullName` string - `email` string - `responseCount` integer: Number of responses in the thread. Excludes the request itself. - `responses` PrivacyAutomationAssessmentAutomationAssessmentInformationRequestResponseExport[]: Responses in the thread, oldest first. Empty when nobody has responded yet. - `id` string, uuid: Unique identifier of the response - `responseText` string: Text of the response - `respondedBy` PrivacyAutomationAssessmentAutomationBasicUserDetail - `userId` string, uuid - `fullName` string - `email` string - `createdAt` string, date-time: Date and time the response was added (in UTC) - `createdAt` string, date-time: Date and time the request was raised (in UTC) - `updatedAt` string, date-time: Date and time of the last edit to the request text, or the close action (in UTC). It does not move on reopen, which is a bulk update that bypasses auditing. - `updatedBy` PrivacyAutomationAssessmentAutomationBasicUserDetail - `userId` string, uuid - `fullName` string - `email` string - `latestResponseAt` string, date-time: Date and time of the most recent response (in UTC). Null when nobody has responded yet. - `notes` PrivacyAutomationAssessmentAutomationNoteExport[]: Assessment-level notes, ordered by created date descending. Returned only when include=NOTES is requested; empty when the assessment has no visible 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. - `id` string, uuid: Unique identifier of the note - `type` 'ONLY_ME' | 'APPROVER' | 'EVERYONE': Visibility class of the note - `noteText` string: Text of the note - `author` PrivacyAutomationAssessmentAutomationBasicUserDetail - `userId` string, uuid - `fullName` string - `email` string - `createdAt` string, date-time: Date and time the note was created (in UTC) - `updatedBy` PrivacyAutomationAssessmentAutomationBasicUserDetail - `userId` string, uuid - `fullName` string - `email` string - `updatedAt` string, date-time: Date and time the note was last edited (in UTC). Null when the note has never been edited. - `stageHistory` PrivacyAutomationAssessmentAutomationStageHistoryExport[]: Chronological stage transitions for the assessment, oldest first, starting from the assessment creation entry. Returned only when include=STAGE_HISTORY is requested; empty when the assessment has no stage-change-eligible activities. - `fromStage` PrivacyAutomationAssessmentAutomationStageHistoryStageDetail - `id` string, uuid: Workflow stage UUID resolved from the workflow stage definitions. Null when the UUID cannot be cleanly recovered: legacy activity rows with no workflowId, a stage that was renamed or deleted from the workflow, an ambiguous custom stage name matching multiple stages, or a workflow that cannot be loaded. This is a real UUID, not the AssessmentStatus translation key. - `name` string: Display name of the stage, e.g. "Not Started", "In Progress", "Under Review", "Completed", or a custom approval stage name. - `stageType` string: The stage type, sourced from the WorkflowStage BadgeColor column. One of the BadgeColorCode values: "New", "InProgress", "UnderReview", "Rejected", "Completed", or "Archived". Null when the stage cannot be resolved from the workflow stage definitions (legacy rows, renamed/deleted stages, ambiguous custom stage names, missing workflow) - null in the same cases id is null. - `toStage` PrivacyAutomationAssessmentAutomationStageHistoryStageDetail - `id` string, uuid: Workflow stage UUID resolved from the workflow stage definitions. Null when the UUID cannot be cleanly recovered: legacy activity rows with no workflowId, a stage that was renamed or deleted from the workflow, an ambiguous custom stage name matching multiple stages, or a workflow that cannot be loaded. This is a real UUID, not the AssessmentStatus translation key. - `name` string: Display name of the stage, e.g. "Not Started", "In Progress", "Under Review", "Completed", or a custom approval stage name. - `stageType` string: The stage type, sourced from the WorkflowStage BadgeColor column. One of the BadgeColorCode values: "New", "InProgress", "UnderReview", "Rejected", "Completed", or "Archived". Null when the stage cannot be resolved from the workflow stage definitions (legacy rows, renamed/deleted stages, ambiguous custom stage names, missing workflow) - null in the same cases id is null. - `transitionedAt` string, date-time: Date and time the transition occurred (in UTC). For the creation entry this is the assessment's created date. - `transitionedBy` PrivacyAutomationAssessmentAutomationBasicUserDetail - `userId` string, uuid - `fullName` string - `email` string - `workflow` PrivacyAutomationAssessmentAutomationStageHistoryWorkflowDetail - `id` string, uuid: UUID of the approval workflow. Null for legacy activity rows that carry no workflow metadata. - `name` string: Display name of the approval workflow. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500`: Internal Server Error --- [API](https://skmtc.dev/onetrust/apis/privacy-automation-assessment-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/privacy-automation-assessment-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/privacy-automation-assessment-automation/revisions/fbdf0c71bfe5?raw)