{"openapi":"3.0.0","info":{"version":"2.0","title":"Privacy Automation - Assessment Automation (Swagger)"},"tags":[{"name":"Assessments"},{"name":"Assessment Management"},{"name":"Assessment Actions"}],"paths":{"/api/assessment/v2/assessments/{assessmentId}/responses":{"post":{"tags":["Assessment Actions"],"summary":"Submit Responses","description":"Use this API to submit responses for an assessment. The assessment will be updated with the submitted response.\n\n  > 🗒 Things to Know\n  >\n  > - Responses cannot be added to assessments that have already been completed.\n","operationId":"submitResponsesUsingPOST","parameters":[{"name":"assessmentId","in":"path","description":"ID of an assessment. The `assessmentId` can be retrieved by calling the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentSubmissionInformation"}}}},"description":"Assessment Submission Information"},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentInformationUiDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"oauth2":["ASSESSMENT"]}]}},"/api/assessment/v1/assessments/{assessmentId}/review":{"post":{"tags":["Assessment Actions"],"summary":"Complete Assessment","description":"Use this API to complete review of an assessment using any active result option. This action will move the assessment to the **Completed** stage.\n\n  > 🗒 Things to Know\n  > \n  > - The assessment must first be submitted for review before using this API. This can be done using the [Submit Assessment ](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/submitassessmentusingpost)API.\n  > \n  > - Only active assessment result options can be used to complete assessments.\n","operationId":"reviewAssessmentUsingPOST","parameters":[{"name":"assessmentId","in":"path","description":"ID of the assessment. `assessmentId` can be\nretrieved by calling the [Get Assessment\nResults](/onetrust/reference/getassessmentresultsusingget)\nAPI.\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentClosureRequest"}}},"description":"Assessment Closure Request","x-examples":{"application/json":{"closureComment":"All risks have been mitigated and reduced; this assessment is\napproved.\n","forceOverride":false,"excludeRules":false,"resultId":"0082c000-a000-4000-8fff-c30000000fff"}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"oauth2":["ASSESSMENT"]},{"apikey":[]}]}},"/api/assessment/v2/assessments/{assessmentId}/submit":{"post":{"tags":["Assessment Actions"],"summary":"Submit Assessment","description":"Use this API to submit an assessment for review. This action will move the assessment to the **Under Review** stage.\n\n  > 🗒 Things to Know\n  >\n  > - Responses for all required questions must be first submitted before using this API. This action can be done using the [Submit Responses](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/submitresponsesusingpost) API.\n  > - Do not include the **Content-Type** parameter in the header, as this API does not accept a request body. For APIs that do accept a request body, set **Content-Type** to **application/json**, as our APIs only support application/json.\n","operationId":"submitAssessmentUsingPOST","parameters":[{"name":"assessmentId","in":"path","description":"ID of an assessment. The `assessmentId` can be retrieved by calling the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"oauth2":["ASSESSMENT"]}]}},"/api/assessment-v2/v2/assessments/{assessmentId}/risks":{"post":{"tags":["Assessment Actions"],"summary":"Create Assessment Risk","operationId":"createAssessmentRiskUsingPOST","parameters":[{"name":"assessmentId","in":"path","description":"ID of the assessment. The `assessmentId` can be retrieved by calling the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API\n","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRiskCreateRequest"}}},"description":"Assessment Risk Create Request which consist of sectionId, questionId and riskCreateRequest.\nThe attribute id and value key is null in case of text Attributes.\nriskTemplate will be required when we create risk using library.\n","required":true,"x-examples":{"Example 1":{"sectionId":"8b5e4763-983d-45cd-96c1-9e869e3d9e98","questionId":"a0ac53a7-7881-4bd1-8c24-3a6be2c654f8","riskCreateRequest":{"attributeValues":{"attributeTextValue.value10":[{"id":"f8898a1d-f932-4ca4-b9d5-6f7d25ad9d90","value":2,"valueKey":"Risk.Attributes.5662ec64-ea24-4032-bbb6-39e6273391f8"}]},"level":1,"deadline":"2021-06-17T18:30:00.000Z","description":"Risk Test","levelId":1,"recommendation":"Recommendation","reminderDays":1,"impactLevel":"Low","riskOwners":[{"id":"3d047bdc-c818-46c0-84d6-062291162e0d","name":"AA Task Migration"}],"probabilityLevel":"High","previousState":"IDENTIFIED","state":"IDENTIFIED","typeId":10,"sourceTypeId":10,"references":[{"id":"96a86444-cd62-4498-b6d3-2016994a5164","typeId":30,"version":1},{"id":"8b5e4763-983d-45cd-96c1-9e869e3d9e98","typeId":20,"version":1},{"id":"a0ac53a7-7881-4bd1-8c24-3a6be2c654f8","typeId":10,"version":1}],"categoryIds":["e20a4b49-5d40-47d3-aec9-b83efc58f3c9"],"systemCreated":false,"impactLevelId":1,"probabilityLevelId":3,"riskScore":1,"riskTemplate":{"id":"d2f60678-ef0d-4a08-8a88-66b64bf3804f"},"controlIds":["c1c04228-6816-4ce0-9b73-ce670e99abd3"],"targetRiskLevel":{"levelId":2,"level":"Low","impactLevelId":2,"impactLevel":"Low","probabilityLevelId":2,"probabilityLevel":"Low","riskScore":1},"riskApproversId":["3d047bdc-c818-46c0-84d6-062291162e0d"]}},"Example 2":{"sectionId":"8b5e4763-983d-45cd-96c1-9e869e3d9e98","questionId":"a0ac53a7-7881-4bd1-8c24-3a6be2c654f8","riskCreateRequest":{"attributeValues":{"attributeSingleSelectValue.value8":[{"id":"f8898a1d-f932-4ca4-b9d5-6f7d25ad9d90","value":"2","valueKey":"Risk.Attributes.5662ec64-ea24-4032-bbb6-39e6273391f8"}]},"level":1,"deadline":"2021-06-17T18:30:00.000Z","description":"Risk Test ","levelId":1,"recommendation":"Recommendation","reminderDays":1,"impactLevel":"Low","riskOwners":[{"id":"3d047bdc-c818-46c0-84d6-062291162e0d","name":"AA Task Migration"}],"probabilityLevel":"High","previousState":"IDENTIFIED","state":"IDENTIFIED","typeId":10,"sourceTypeId":10,"references":[{"id":"96a86444-cd62-4498-b6d3-2016994a5164","typeId":30,"version":1},{"id":"8b5e4763-983d-45cd-96c1-9e869e3d9e98","typeId":20,"version":1},{"id":"a0ac53a7-7881-4bd1-8c24-3a6be2c654f8","typeId":10,"version":1}],"source":{"id":"96a86444-cd62-4498-b6d3-2016994a5164","name":"Task 0012","type":"PIA","additionalAttributes":{"Questions":["a0ac53a7-7881-4bd1-8c24-3a6be2c654f8"],"Section":"8b5e4763-983d-45cd-96c1-9e869e3d9e98"}},"categoryIds":["e20a4b49-5d40-47d3-aec9-b83efc58f3c9"],"systemCreated":false,"impactLevelId":1,"probabilityLevelId":3,"riskScore":1,"riskTemplate":{"id":"d2f60678-ef0d-4a08-8a88-66b64bf3804f"},"controlIds":["c1c04228-6816-4ce0-9b73-ce670e99abd3"],"targetRiskLevel":{"levelId":2,"level":"Low","impactLevelId":2,"impactLevel":"Low","probabilityLevelId":2,"probabilityLevel":"Low","riskScore":1},"riskApproversId":["3d047bdc-c818-46c0-84d6-062291162e0d"]}}}},"responses":{"201":{"description":"Risk successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentQuestionRiskDetailInformation"},"examples":{"response":{"value":{"questionIds":["a0ac53a7-7881-4bd1-8c24-3a6be2c654f8"],"riskId":"3a6c6b7d-4869-4da2-a025-20d35b2a7ab6","level":1,"riskResponse":{"id":"3a6c6b7d-4869-4da2-a025-20d35b2a7ab6","number":70,"type":"ASSESSMENTS","creationType":null,"state":"RECOMMENDATION_ADDED","previousState":null,"typeRefIds":["a0ac53a7-7881-4bd1-8c24-3a6be2c654f8","96a86444-cd62-4498-b6d3-2016994a5164"],"sourceType":"PIA","source":{"id":"96a86444-cd62-4498-b6d3-2016994a5164","name":"Task 0012","type":"PIA","additionalAttributes":{},"sectionId":"ca5e26ce-09d2-4120-a4ab-295e12e626eb","questionId":"926dc11f-ca01-4698-862f-55afd599d2da"},"description":"Risk Test ","recommendation":"Recommendation","remediationProposal":null,"orgGroup":{"id":"37d79f4a-9b6a-4f1b-9756-740470abe58d","name":"AA Task Migration","nameKey":null},"requestedException":null,"mitigation":null,"mitigatedDate":null,"justification":null,"deadline":"2021-06-17T18:30:00.000Z","references":[{"id":"96a86444-cd62-4498-b6d3-2016994a5164","type":"ASSESSMENT","name":null,"additionalAttributes":{}},{"id":"a0ac53a7-7881-4bd1-8c24-3a6be2c654f8","type":"QUESTION","name":null,"additionalAttributes":{}}],"createdUTCDateTime":"2021-06-10T10:38:50.137","levelId":1,"level":"LOW","levelDisplayName":"Low","probabilityLevelId":2,"probabilityLevel":"Medium","impactLevelId":1,"impactLevel":"Low","riskScore":1,"viewOnly":false,"controlsIdentifier":["CC6.6"],"categories":[{"id":"f006270e-b308-4b4f-8f78-4e24bc0de381","name":"Availability","nameKey":"RiskCategory.Availability"}],"riskOwnerId":"3d047bdc-c818-46c0-84d6-062291162e0d","riskOwner":"AA Task Migration","riskOwnersId":["3d047bdc-c818-46c0-84d6-062291162e0d"],"riskOwnersName":"AA Task Migration","riskApproversId":["3d047bdc-c818-46c0-84d6-062291162e0d"],"riskApprovers":"AA Task Migration","inherentRiskLevel":{"levelId":2,"level":"MEDIUM","impactLevelId":1,"impactLevel":"LOW","probabilityLevelId":2,"probabilityLevel":"MEDIUM","riskScore":3},"targetRiskLevel":{"levelId":3,"level":"HIGH","impactLevelId":1,"impactLevel":"Low","probabilityLevelId":512,"probabilityLevel":"Critical","riskScore":5},"treatmentPlan":null,"treatment":null,"result":null,"treatmentStatus":null,"workflow":{"id":"2c873f59-32cf-41b7-9cd1-3b4274bc444a","name":"Default Risk Workflow","nameKey":null},"stage":{"id":"8414eef9-912c-4bd4-922e-4308f72ddc7b","name":"IDENTIFIED","nameKey":"StageIdentified"},"actionId":null,"threatInformation":null,"vulnerabilitiesInformation":null,"reminderDays":1,"valid":true,"attributeValues":{"attributeSingleSelectValue.value7":[{"id":"30322ba4-2348-4f2f-9e9e-2fc3b330f278","value":"1","valueKey":"Risk.Attributes.5ef37295-be0b-4a8a-a238-2c3a3aff280b"}],"attributeSingleSelectValue.value9":[{"id":"c4badaf0-f578-498d-bf95-70c1529ade4a","value":"1","valueKey":"Risk.Attributes.1d3d8ee6-0d5b-4e33-8956-7a273b04496d"}]}},"questionId":"a0ac53a7-7881-4bd1-8c24-3a6be2c654f8"}}}}}},"400":{"description":"Bad Request\n\n\n### Possible reasons:\n\n\n* Risk is being created on a Not Started or In Progress assessment.\n"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false,"description":"Use this API to create a risk on an assessment. This API will return the risk owner, risk approver and target risk level in the response. The risk will be flagged on the assessment and assigned to the respective risk owners with the details defined in the API request body. \n\n > 🗒 Things to Know\n > \n > - This API can be used for assessments in **Under Review** and **Completed** stage.\n >\n > - Risks must have an assigned risk owner before you can send a recommendation. Once an approver has identified a risk, they can send the risk owner a recommendation that helps to rectify and minimize the risk.\n >\n > - If risk heatmaps are used by your organization, the available risk level options will be based on the heatmap set up for your organization. If risk heatmaps are not used, the available risk level options will be **Low**, **Medium**, **High**, and **Very High**.\n","security":[{"oauth2":["ASSESSMENT"]}]}}},"security":[{"oauth2":[]}],"x-readme":{"explorer-enabled":false,"metrics-enabled":false,"proxy-enabled":true},"x-onetrust":{"spec-label":"Swagger 2","links":{"PIA & DPIA Automation Knowledge Base":"https://my-onetrust-com.uleth.idm.oclc.org/s/topic/0TO1Q000000ItRvWAK/assessment-automation"}},"servers":[{"url":"https://customer-my-onetrust-com.uleth.idm.oclc.org"}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{$$.env.host}/api/access/v1/oauth/token","scopes":{"ASSESSMENT":"Read, write and delete templates and assessments","ASSESSMENT_READ":"Read template and assessment information"}}}}},"schemas":{"AssessmentCreateRequest":{"type":"object","title":"AssessmentCreateRequest","properties":{"approverId":{"type":"string","description":"ID of the user/user-group who should be assigned as the Approver of the\nassessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API or [Get List of Users-Groups](/onetrust/reference/getgroups) API.\n"},"approverName":{"type":"string","description":"Name of the user/user-group who should be assigned as the approver of the\nassessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API or [Get List of Users-Groups](/onetrust/reference/getgroups) API.\n"},"deadline":{"type":"string","format":"date-time","description":"Date by which the assessment should be completed. The format is YYYY-MM-DDTHH:MM:SS.FFFZ.\n"},"description":{"type":"string","description":"Description of the assessment."},"inventoryDetails":{"$ref":"#/components/schemas/AssessmentInventoryRequest"},"name":{"type":"string","description":"Name of the assessment. This value is obtained from the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API."},"orgGroupId":{"type":"string","description":"ID of the organization group that should be assigned to the assessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API.\n"},"orgGroupName":{"type":"string","description":"Name of the organization group that should be assigned to the assessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API.\n"},"reminder":{"type":"integer","format":"int64","description":"Number of days before the deadline to send an automatic reminder to the respondent. Note that this field is only applicable if a Deadline is set.\n"},"respondents":{"type":"array","description":"List of respondents assigned to the assessment. At least, one respondent must be added in order to launch the assessment.\n","items":{"$ref":"#/components/schemas/AssessmentRespondentRequest"}},"ruleId":{"type":"string","description":"This parameter value can be null."},"templateId":{"type":"string","description":"ID used to launch an assessment using a specific version of a template. You may use either this parameter or the templateRootVersionId parameter to launch an assessment. This value is obtained from the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API.\n"},"templateRootVersionId":{"type":"string","description":"ID used to launch an assessment using the latest published version of a template (recommended to use in integrations). You may use either this parameter or the templateRootVersionId parameter to launch an assessment. If both templateId and templateRootVersionId are provided, this API will use the templateRootVersionId. This value is obtained from the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API.\n"},"triggeredByAssessmentId":{"type":"string","description":"This parameter value is null."},"triggeredByAssessmentName":{"type":"string","description":"This parameter value is null."},"respondentCreationType":{"type":"string","description":"Indicates whether new respondents are created as Invited Users or Project Respondents when launching an assessment. New users can be set to Project Respondents only when the Allow Creating Project Respondents from Assessment setting is enabled in Global Settings for the account.\n"}},"required":["name","orgGroupId","orgGroupName","respondents"]},"AssessmentExportInformation":{"type":"object","properties":{"approvers":{"type":"array","description":"List of users assigned as approvers of the assessment.","items":{"$ref":"#/components/schemas/ApproverInformation"}},"assessmentId":{"type":"string","format":"uuid","description":"ID of an assessment."},"assessmentNumber":{"type":"integer","format":"int64","description":"Number assigned to an assessment."},"completedOn":{"type":"string","format":"date-time","description":"Date and time at which the assessment was completed."},"createdBy":{"$ref":"#/components/schemas/BasicEntityDetail"},"createdDT":{"type":"string","format":"date-time","description":"Date and time at which the assessment was created."},"deadline":{"type":"string","format":"date-time","description":"Date and time by which the assessment must be completed."},"description":{"type":"string","description":"Description of the assessment."},"highRisk":{"type":"integer","format":"int32","description":"Number of risks captured on the assessment with a high risk level."},"inherentRiskScore":{"type":"number","description":"Overall inherent risk score without considering the existing controls."},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time at which the assessment was last updated."},"lowRisk":{"type":"integer","format":"int32","description":"Number of risks captured on the assessment with a low risk level."},"mediumRisk":{"type":"integer","format":"int32","description":"Number of risks captured on the assessment with a medium risk level."},"name":{"type":"string","description":"Name of the assessment."},"openRiskCount":{"type":"integer","format":"int64","description":"Number of open risks that have not been addressed."},"primaryEntityDetails":{"type":"array","description":"Primary Entity Details","items":{"$ref":"#/components/schemas/PrimaryEntityDetail"}},"primaryRecordType":{"type":"string","description":"Type of inventory record designated as the primary record.","enum":["ASSETS","PROCESSING_ACTIVITY","VENDORS","ENTITIES","ASSESS_CONTROL","ENGAGEMENT"]},"residualRiskScore":{"type":"number","description":"Overall risk score after considering existing controls."},"orgGroup":{"$ref":"#/components/schemas/BasicEntityDetail"},"respondent":{"$ref":"#/components/schemas/BasicEntityDetail"},"respondents":{"type":"array","description":"Assessment Respondents","items":{"$ref":"#/components/schemas/BasicEntityDetail"}},"result":{"type":"string","description":"Result of the assessment."},"resultId":{"type":"string","format":"uuid","description":"ID of the result."},"resultName":{"type":"string","description":"Name of the result."},"riskLevel":{"type":"string","description":"Risk level of the assessment."},"sections":{"type":"array","description":"List of sections in the assessment.","items":{"$ref":"#/components/schemas/AssessmentSectionInformation"}},"status":{"type":"string","description":"Status of the assessment.","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]},"submittedOn":{"type":"string","format":"date-time","description":"Date and time at which the assessment was submitted."},"tags":{"type":"array","description":"List of tags associated with the assessment.","items":{"type":"string"}},"targetRiskScore":{"type":"number","description":"The desired target risk score."},"template":{"$ref":"#/components/schemas/BasicEntityDetail"},"totalRiskCount":{"type":"integer","format":"int64","description":"Number of total risks on the assessment."},"veryHighRisk":{"type":"integer","format":"int32","description":"Number of very high risks on the assessment."},"welcomeText":{"type":"string","description":"Welcome text if any in the assessment."}},"title":"AssessmentExportInformation"},"AssessmentBasicDetailsUpdateRequest":{"type":"object","title":"AssessmentBasicDetailsUpdateRequest","properties":{"deadline":{"type":"string","format":"date-time","description":"Date by which the assessment must be completed. The date format is YYYY-MM-DDTHH:MM:SS.FFFZ.","example":"2021-04-30T04:00:00:000Z"},"description":{"type":"string","description":"Description of the assessment."},"name":{"type":"string","description":"Name of the assessment."},"reminder":{"type":"integer","format":"int64","description":"Number of days before the deadline to send an automatic reminder to the respondent. Note that this field is only applicable if a Deadline is set. This is not a required field even when deadline is set, if deadline is sent in request and this is not set in the request then previous value gets cleared. If both deadline and reminder is not sent in request then there is no impact on these fields."}}},"AssessmentPrimaryRecordUpdateRequest":{"type":"object","required":["primaryRecordIds","primaryRecordType"],"properties":{"primaryRecordIds":{"type":"array","description":"Unique ID of the primary record. For Inventory record types,\nonly one ID is allowed. For Assess Control record types,\nmultiple IDs are allowed. This value is obtained from the [Get\nAssessment List](/onetrust/reference/getallassessmentbasicdetailsusingget)\nAPI.\n","items":{"type":"string","format":"uuid","minLength":1}},"primaryRecordType":{"type":"string","description":"Type of record designated as the main purpose of an assessment.\n","enum":["ASSETS","PROCESSING_ACTIVITY","VENDORS","ENTITIES","ASSESS_CONTROL","ENGAGEMENT"]}},"title":"AssessmentPrimaryRecordUpdateRequest"},"ReassignAssessmentRequest":{"type":"object","properties":{"approvers":{"type":"array","description":"The details of the user who is assigned as an approver to the assessment.","items":{"$ref":"#/components/schemas/AssessmentApproverRequest"}},"orgGroupId":{"type":"string","format":"uuid","description":"ID of the organization group that should be reassigned to the assessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API."},"respondentCreationType":{"type":"string","description":"Use this field to select whether new respondents are created as\nInvited Users or Project Respondents\n","enum":["INVITED","PROJECT_RESPONDENT"]},"respondents":{"type":"array","description":"Used to indicate whether the new respondents are created as Invited Users or Project Respondents.","items":{"$ref":"#/components/schemas/AssessmentRespondentRequest"}}},"title":"ReassignAssessmentRequest"},"AssessmentApproverRequest":{"type":"object","properties":{"approverId":{"type":"string","description":"ID of the user to assign to the assessment as an approver. This value is obtained from [Get List of Users](/onetrust/reference/getallusersusingget) API.","format":"uuid"},"approverName":{"type":"string","description":"Name of the user to assign to the assessment as a respondent. This can be an existing internal user or an email address for an invited user. This value is obtained from the [Get List of Users](/onetrust/reference/getallusersusingget) API."},"comment":{"type":"string","description":"Comments that will be provided to the approver in an email notification."},"workflowStageIds":{"type":"array","description":"User will be added as an approver for the workflowStageIds mentioned in the request. If the workflowStageIds is empty then the user will be added as an approver to all the stages. This can be retrieved by calling the [Get Assessment Workflow Stages](/onetrust/reference/getworkflowdetailsforassessmentusingget) API.\n","items":{"type":"string","format":"uuid"}}},"title":"AssessmentApproverRequest"},"AssessmentInformationUiDto":{"type":"object","properties":{"approvers":{"type":"array","items":{"$ref":"#/components/schemas/BasicEntityDetail"}},"assessmentId":{"type":"string"},"canApproveAssessment":{"type":"boolean"},"canSubmitAssessment":{"type":"boolean"},"createdBy":{"$ref":"#/components/schemas/BasicEntityDetail"},"createdDT":{"type":"string","format":"date-time"},"deadline":{"type":"string","format":"date-time"},"description":{"type":"string"},"displayState":{"type":"string","enum":["REFRESH_NONE","REFRESH_ALL","REFRESH_PARTIAL"]},"firstSection":{"type":"boolean"},"hasRequestInformation":{"type":"boolean"},"invalidQuestionToRiskIdMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"inventoryLinks":{"type":"array","items":{"$ref":"#/components/schemas/InventoryLink"}},"lastSection":{"type":"boolean"},"name":{"type":"string"},"orgGroup":{"$ref":"#/components/schemas/BasicEntityDetail"},"questions":{"$ref":"#/components/schemas/AssessmentQuestionInformationUiDto"},"respondent":{"$ref":"#/components/schemas/BasicEntityDetail"},"section":{"$ref":"#/components/schemas/AssessmentSectionInformationUiDto"},"sectionHeaders":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentSectionHeaderInformation"}},"status":{"type":"string","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]},"template":{"$ref":"#/components/schemas/BasicEntityDetail"},"welcomeSection":{"type":"boolean"},"welcomeText":{"type":"string"}},"title":"AssessmentInformationUiDto"},"AssessmentInventoryRequest":{"type":"object","title":"AssessmentInventoryRequest","properties":{"inventoryId":{"type":"string","description":"ID of the primary record of the assessment. This value is obtained from the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API."},"inventoryName":{"type":"string","description":"Name of the primary record of the assessment. This value is obtained from the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API."},"inventoryTypeId":{"type":"integer","description":"ID of the Primary Record Type (Assets, Processing Activities, Vendors, etc.). Values for inventoryTypeId-Assets = ''20''; Processing Activities = ''30''; Vendors = ''50''; Entities = ''60''.\n","enum":[20,30,50,60],"format":"int64"}},"required":["inventoryId","inventoryName","inventoryTypeId"]},"AssessmentQuestionInformation":{"type":"object","properties":{"hasNavigationRules":{"type":"boolean","description":"Indicates whether navigation rules are enabled for the question."},"hidden":{"type":"boolean","description":"Indicates whether the question is hidden on the assessment."},"lockReason":{"type":"string","description":"Reason for locking the question in the assessment.","enum":["LAUNCH_FROM_INVENTORY"]},"question":{"$ref":"#/components/schemas/QuestionInformation"},"questionResponses":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentQuestionResponseInformation"}},"risks":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentQuestionRiskInformation"}},"rootRequestInformationIds":{"type":"array","description":"List of IDs associated with the question root requests.","items":{"type":"string"}},"totalAttachments":{"type":"integer","description":"Number of attachments added to the question.","format":"int64"},"attachmentIds":{"type":"array","items":{"type":"string"},"description":"IDs of the attachment(s) added to the question.\n"}},"title":"AssessmentQuestionInformation"},"AssessmentQuestionInformationUiDto":{"type":"object","properties":{"allIds":{"type":"array","items":{"type":"string"}},"byId":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/QuestionInformationUiDto"}}},"title":"AssessmentQuestionInformationUiDto"},"AssessmentQuestionResponseInformation":{"type":"object","properties":{"justification":{"type":"string","description":"Justification comments for the given response."},"responses":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentResponseInformation"}}},"title":"AssessmentQuestionResponseInformation"},"AssessmentQuestionRiskInformation":{"type":"object","properties":{"level":{"type":"integer","format":"int64","description":"Level of risk flagged on the question."},"questionId":{"type":"string","description":"ID of the question for which the risk was flagged."},"riskId":{"type":"string","description":"ID of the flagged risk."}},"title":"AssessmentQuestionRiskInformation"},"AssessmentRespondentRequest":{"type":"object","title":"AssessmentRespondentRequest","properties":{"comment":{"type":"string","description":"Comments that will be provided to the respondent(s) in an email notification.\n"},"respondentId":{"type":"string","description":"ID of the user/user-group to assign to the assessment as a respondent. This value is obtained from the [Get List of Users](/onetrust/reference/getallusersusingget) API or [Get List of Users-Groups](/onetrust/reference/getgroups) API."},"respondentName":{"type":"string","description":"Name of the user/user-group to assign as a respondent. This can be an existing internal user or an email address for an invited user. This value is obtained from the [Get List of Users](/onetrust/reference/getallusersusingget) API or [Get List of Users-Groups](/onetrust/reference/getgroups) API.\n"},"sectionId":{"type":"string","description":"ID of a section within the assessment. This value can be passed as null. A specific sectionId can be obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API."}},"required":["respondentName"]},"AssessmentResponseInformation":{"type":"object","properties":{"dataCategory":{"$ref":"#/components/schemas/BasicEntityDetail"},"dataElement":{"$ref":"#/components/schemas/BasicEntityDetail"},"dataSubject":{"$ref":"#/components/schemas/BasicEntityDetail"},"errorCode":{"type":"string","description":"Error associated with the response.","enum":["ATTRIBUTE_DISABLED","ATTRIBUTE_OPTION_DISABLED","INVENTORY_NOT_EXISTS","RELATED_INVENTORY_ATTRIBUTE_DISABLED","DATA_ELEMENT_NOT_EXISTS","DUPLICATE_INVENTORY"]},"response":{"type":"string","description":"Content of the response."},"responseId":{"type":"string","description":"ID of the response."},"responseMap":{"type":"object","description":"This parameter is only applicable for inventory type responses (Example- ASSETS).\n","additionalProperties":{"$ref":"#/components/schemas/BasicEntityDetail"}},"responseSourceType":{"type":"string","description":"Source from which the assessment is launched.","enum":["LAUNCH_FROM_INVENTORY"]},"type":{"type":"string","description":"Type of response.","enum":["NOT_SURE","JUSTIFICATION","NOT_APPLICABLE","DEFAULT","OTHERS"]},"valid":{"type":"boolean","example":false,"description":"Indicates whether the response is valid."}},"title":"AssessmentResponseInformation"},"AssessmentResponseInformationUiDto":{"type":"object","properties":{"categoryById":{"type":"object","additionalProperties":{"type":"string"}},"dataSubjectById":{"type":"object","additionalProperties":{"type":"string"}},"response":{"type":"string"},"responseId":{"type":"string"},"responseMap":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/DataElementResponse"}}}},"type":{"type":"string","enum":["NOT_SURE","JUSTIFICATION","NOT_APPLICABLE","DEFAULT","OTHERS"]},"valid":{"type":"boolean"}},"title":"AssessmentResponseInformationUiDto"},"AssessmentSectionHeaderInformation":{"type":"object","properties":{"description":{"type":"string","description":"Description of the section header."},"hidden":{"type":"boolean","description":"Indicates whether the section is hidden in the assessment."},"invalidQuestionCount":{"type":"integer","format":"int32","description":"Number of invalid questions in the section."},"name":{"type":"string","description":"Name of the section."},"invalidQuestionIds":{"type":"array","description":"IDs of invalid questions in the section.","items":{"type":"string"}},"requiredUnansweredQuestionIds":{"type":"array","description":"IDs of required but unanswered questions in the section.","items":{"type":"string"}},"requiredQuestionIds":{"type":"array","description":"IDs of required questions in the section.","items":{"type":"string"}},"unansweredQuestionIds":{"type":"array","description":"IDs of unanswered questions in the section.","items":{"type":"string"}},"riskStatistics":{"$ref":"#/components/schemas/SectionRiskStats"},"sectionId":{"type":"string","description":"ID of the section in the assessment."}},"title":"AssessmentSectionHeaderInformation"},"AssessmentSectionInformation":{"type":"object","properties":{"description":{"type":"string","description":"Descriptions of the section."},"hasNavigationRules":{"type":"boolean","description":"Indicates whether navigation rules are enabled for the question."},"header":{"$ref":"#/components/schemas/AssessmentSectionHeaderInformation"},"hidden":{"type":"boolean","description":"Indicates whether navigation rules are enabled for the question."},"name":{"type":"string","description":"Name of the section."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentQuestionInformation"}},"sectionId":{"type":"string","description":"ID of the section in an assessment."},"valid":{"type":"boolean","description":"Indicates whether the section is valid."}},"title":"AssessmentSectionInformation"},"AssessmentSectionInformationUiDto":{"type":"object","properties":{"description":{"type":"string"},"hasNavigationRules":{"type":"boolean"},"hidden":{"type":"boolean"},"invalidQuestionCount":{"type":"integer","format":"int32"},"name":{"type":"string"},"invalidQuestionIds":{"type":"array","items":{"type":"string"}},"requiredUnansweredQuestionIds":{"type":"array","items":{"type":"string"}},"requiredQuestionIds":{"type":"array","items":{"type":"string"}},"unansweredQuestionIds":{"type":"array","items":{"type":"string"}},"riskStatistics":{"$ref":"#/components/schemas/SectionRiskStats"},"sectionId":{"type":"string"}},"title":"AssessmentSectionInformationUiDto"},"AssessmentSubmissionInformation":{"type":"object","required":["assessmentId","questionId","responses","sectionId"],"properties":{"assessmentId":{"type":"string","description":"ID of an assessment. This value is obtained from the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API."},"parentAssessmentDetailId":{"type":"string","description":"Parent assessment detail id."},"questionId":{"type":"string","description":"ID tagged to a question in an assessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API."},"responses":{"type":"array","description":"Responses for an assessment.","items":{"$ref":"#/components/schemas/AssessmentResponseInformation"}},"sectionId":{"type":"string","description":"ID tagged to a section in an assessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API."}},"title":"AssessmentSubmissionInformation"},"AssessmentListRequest":{"type":"object","properties":{"filterCriteria":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteriaInformation"},"example":[{"field":"respondentId","operation":"=","value":["1020d2b5-2fdb-40fd-8e20-289a1eb9a6ef","95a3e325-0aa2-432c-9d63-b7408828ed08"]},{"field":"approverId","operation":"=","value":["95a3e325-0aa2-432c-9d63-b7408828ed08","1020d2b5-2fdb-40fd-8e20-289a1eb9a6ef"]},{"field":"workflowStageName","operation":"=","value":["Stage-4"]},{"field":"deadline","operation":"=","value":"2023-07-01T18:30:00.000Z","toValue":"2023-07-04T18:29:59.000Z"},{"field":"deletedDate","operation":"=","value":"2023-07-01T18:30:00.000Z","toValue":"2023-07-04T18:29:59.000Z"},{"field":"primaryInventoryName","operation":"=","value":["Asset-03"]},{"field":"templateRootVersionId","operation":"=","value":["2dcae3a5-e1e0-46ae-ab92-4450ea1fd84b"]}]}},"title":"AssessmentListRequest"},"AssessmentListResponseListAssessmentListViewResponseV2":{"type":"object","properties":{"content":{"type":"array","description":"content/data displayed in the current page","items":{"$ref":"#/components/schemas/AssessmentListViewResponseV2"}},"page":{"$ref":"#/components/schemas/AssessmentPage"}},"title":"AssessmentListResponseListAssessmentListViewResponseV2"},"AssessmentListViewResponseV2":{"type":"object","properties":{"assessmentId":{"type":"string","format":"uuid","description":"Assessment Id"},"name":{"type":"string","description":"Assessment Name"},"number":{"type":"integer","format":"int32","description":"Assessment Number"},"orgGroupId":{"type":"string","format":"uuid","description":"Organization Id"},"orgGroupName":{"type":"string","description":"Organization Name"},"approver":{"type":"string","description":"Approvers"},"approvers":{"type":"array","description":"Approvers Detail","items":{"$ref":"#/components/schemas/BasicUserEntityDetail"}},"assessmentDeleteStatus":{"type":"string","description":"Assessment Delete Status","enum":["HARD","SOFT","ARCHIVE"]},"assessmentRiskLevelName":{"type":"string","description":"Assessment Risk Level Name"},"attestationRequired":{"type":"boolean","description":"Attestation Required"},"badgeColor":{"type":"string","description":"Approval Stage Badge Color"},"canResendLink":{"type":"boolean","description":"Can resend link"},"completedOn":{"type":"string","format":"date-time","description":"Completed On"},"createDT":{"type":"string","format":"date-time","description":"Create Date"},"createdBy":{"type":"string","format":"uuid","description":"Created By"},"deletedBy":{"type":"string","format":"uuid","description":"Deleted By"},"deletedDT":{"type":"string","format":"date-time","description":"Deleted Date"},"editAllResponsesWhenInProgress":{"type":"boolean","description":"Edit all response when in-progress"},"inherentRiskLevelName":{"type":"string","description":"Inherent Risk Level Name"},"openInfoRequestCount":{"type":"integer","format":"int32","description":"Open Info Request Count"},"openRiskCount":{"type":"integer","format":"int32","description":"Open Risk Count"},"pendingReviewers":{"type":"array","description":"Pending Reviewers detail","items":{"$ref":"#/components/schemas/BasicUserEntityDetail"}},"primaryRecordName":{"type":"string","description":"Primary Record Name"},"primaryRecordNumber":{"type":"string","description":"Primary Record Number"},"respondent":{"type":"string","description":"Respondents"},"respondents":{"type":"array","description":"Respondents Detail","items":{"$ref":"#/components/schemas/BasicUserEntityDetail"}},"result":{"type":"string","description":"Approval Result"},"status":{"type":"string","description":"Assessment Status","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]},"submittedDT":{"type":"string","format":"date-time","description":"Submitted Date"},"targetRiskLevelName":{"type":"string","description":"Target Risk Level Name"},"templateId":{"type":"string","format":"uuid","description":"Template Id"},"templateName":{"type":"string","description":"Template Name"},"templateRootVersionId":{"type":"string","format":"uuid","description":"Template Root Version Id"},"templateType":{"type":"string","description":"Template Type","enum":["PIA","VENDOR","RA","GRA","DINA","BENCHMARKING","ITRM","CONTROL","INCIDENT","EXCHANGE","ESG","DISCLOSURE","DISCLOSURE_YOY","ERM","TPDD"]},"templateVersion":{"type":"integer","format":"int32","description":"Template Version"},"updatedDT":{"type":"string","format":"date-time","description":"Last Updated Date"},"workflowId":{"type":"string","format":"uuid","description":"Workflow Id"},"workflowName":{"type":"string","description":"Workflow Name"},"workflowStageId":{"type":"string","format":"uuid","description":"Workflow Stage Id"}},"title":"AssessmentListViewResponseV2"},"BasicUserEntityDetail":{"type":"object","properties":{"assigneeType":{"type":"string","example":"USER"},"deleted":{"type":"boolean"},"email":{"type":"string"},"fullName":{"type":"string"},"id":{"type":"string","format":"uuid"}},"title":"BasicUserEntityDetail"},"SearchCriteriaInformation":{"type":"object","properties":{"field":{"type":"string","description":"Name of the property to be filtered on.","example":"respondentId","enum":["respondentId","approverId","deletedDate","deadline","workflowStageName","templateRootVersionId","primaryInventoryName"]},"operation":{"type":"string","example":"=","enum":["=","!="]},"value":{"type":"array","example":"aabdaf95-7eb3-4583-986e-d5d3868d4c14","items":{"type":"string"},"description":"Expected value of the provided field, can also be a list of values. For deadline and deletedDate, we can use a string (Option 1) and for rest of the parameters, use array of strings (Option 2). As an example, the value for deadline or deletedDate could be \"2023-08-27T18:30:00.000Z\"."},"toValue":{"type":"array","example":"aabdaf95-7eb3-4583-986e-d5d3868d4c14","items":{"type":"string"},"description":"Used for deletedDate, deadline filters."}},"title":"SearchCriteriaInformation"},"BasicEntityDetail":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"BasicEntityDetail"},"DataElementResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NOT_SURE","JUSTIFICATION","NOT_APPLICABLE","DEFAULT","OTHERS"]}},"title":"DataElementResponse"},"InventoryLink":{"type":"object","properties":{"link":{"type":"string"},"type":{"type":"string"}},"title":"InventoryLink"},"NavigationRuleEvaluationStats":{"type":"object","properties":{"evaluatedRuleExpression":{"type":"string"},"ruleExpressions":{"type":"array","items":{"type":"string"}}},"title":"NavigationRuleEvaluationStats"},"OptionInformation":{"type":"object","properties":{"attributes":{"type":"string","description":"Attribute for which the option is available."},"id":{"type":"string","description":"ID of the option."},"option":{"type":"string","description":"Name of the option."},"optionType":{"type":"string","description":"Type of option.","enum":["NOT_SURE","NOT_APPLICABLE","OTHERS","DEFAULT"]},"sequence":{"type":"integer","description":"Order in which the option appears.","format":"int32"}},"title":"OptionInformation"},"OptionInformationUiDto":{"type":"object","properties":{"attributes":{"type":"object"},"id":{"type":"string"},"option":{"type":"string"},"optionType":{"type":"string","enum":["NOT_SURE","NOT_APPLICABLE","OTHERS","DEFAULT"]},"sequence":{"type":"integer","format":"int32"}},"title":"OptionInformationUiDto"},"Pageable":{"type":"object","title":"Pageable","properties":{"offset":{"type":"integer","format":"int64","example":3,"description":"The offset of the list"},"pageNumber":{"type":"integer","format":"int32","description":"The page number","example":3},"pageSize":{"type":"integer","format":"int32","description":"Size of the page","example":23},"paged":{"type":"boolean","description":"Boolean to determine if the list is paged","example":true},"sort":{"$ref":"#/components/schemas/Sort"},"unpaged":{"type":"boolean","description":"Boolean to determine if the list is not paged","example":false}}},"PromptedQuestion":{"type":"object","properties":{"question":{"type":"string"},"questionId":{"type":"string"}},"title":"PromptedQuestion"},"QuestionInformation":{"type":"object","properties":{"attributes":{"type":"string","description":"Data element attributes that are directly updated by the question."},"content":{"type":"string","description":"The text of a question."},"description":{"type":"string","description":"Description of the question."},"friendlyName":{"type":"string","description":"Short, descriptive name for the question."},"hint":{"type":"string","description":"Tooltip text within a hint for the question."},"id":{"type":"string","description":"ID of the question."},"linkAssessmentToInventory":{"type":"boolean","description":"Indicates whether the assessment is linked to inventory records."},"options":{"type":"array","description":"List of attribute value options.","items":{"$ref":"#/components/schemas/OptionInformation"}},"parentQuestionId":{"type":"string","description":"ID of the parent question."},"prePopulateResponse":{"type":"boolean","description":"Indicates whether the response to the question is prepopulated."},"questionType":{"type":"string","description":"Type of question in the assessment.","enum":["TEXTBOX","MULTICHOICE","YESNO","DATE","STATEMENT","INVENTORY","ATTRIBUTE","PERSONAL_DATA"]},"requireJustification":{"type":"boolean","description":"Indicates whether justification comments are required for the question."},"required":{"type":"boolean","description":"Indicates whether a response to the question is required."},"rootVersionId":{"type":"string","description":"ID of the root version of the question."},"sequence":{"type":"integer","description":"Order in which the question appears in the assessment.","format":"int32"},"type":{"type":"string","description":"Type of question in the assessment.","enum":["TEXTBOX","MULTICHOICE","YESNO","DATE","STATEMENT","INVENTORY","ATTRIBUTE","PERSONAL_DATA"]},"valid":{"type":"boolean","description":"Indicates whether the question is valid."}},"title":"QuestionInformation"},"QuestionInformationUiDto":{"type":"object","properties":{"attributes":{"type":"object"},"content":{"type":"string"},"description":{"type":"string"},"errorCode":{"type":"string","enum":["ATTRIBUTE_DISABLED","ATTRIBUTE_OPTION_DISABLED","INVENTORY_NOT_EXISTS","RELATED_INVENTORY_ATTRIBUTE_DISABLED","DATA_ELEMENT_NOT_EXISTS","DUPLICATE_INVENTORY"]},"friendlyName":{"type":"string"},"hasNavigationRules":{"type":"boolean"},"hidden":{"type":"boolean"},"hint":{"type":"string"},"id":{"type":"string"},"justification":{"type":"string"},"lockReason":{"type":"string","enum":["LAUNCH_FROM_INVENTORY"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/OptionInformationUiDto"}},"questionType":{"type":"string","enum":["TEXTBOX","MULTICHOICE","YESNO","DATE","STATEMENT","INVENTORY","ATTRIBUTE","PERSONAL_DATA"]},"required":{"type":"boolean"},"responses":{"$ref":"#/components/schemas/ResponseInformationUiDto"},"risks":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentQuestionRiskInformation"}},"rootRequestIds":{"type":"array","items":{"type":"string"}},"sequence":{"type":"integer","format":"int32"},"subQuestions":{"$ref":"#/components/schemas/SubQuestionUiDto"},"totalAttachments":{"type":"integer","format":"int64"},"totalComments":{"type":"integer","format":"int64"},"valid":{"type":"boolean"}},"title":"QuestionInformationUiDto"},"ResponseInformationUiDto":{"type":"object","properties":{"allIds":{"type":"array","items":{"type":"string"}},"byId":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssessmentResponseInformationUiDto"}},"invalidQuestionIds":{"type":"array","items":{"type":"string"}}},"title":"ResponseInformationUiDto"},"RunSummary":{"type":"object","properties":{"assessmentId":{"type":"string"},"executionTime":{"type":"integer","format":"int64"},"runSummaryDetails":{"type":"array","items":{"$ref":"#/components/schemas/RunSummaryDetail"}}},"title":"RunSummary"},"RunSummaryDetail":{"type":"object","properties":{"description":{"type":"string"},"navigationRuleEvaluationStats":{"$ref":"#/components/schemas/NavigationRuleEvaluationStats"},"nextQuestion":{"type":"string"},"nextQuestionId":{"type":"string"},"nextSection":{"type":"string"},"nextSectionId":{"type":"string"},"promptedQuestion":{"$ref":"#/components/schemas/PromptedQuestion"},"section":{"type":"string"},"sectionId":{"type":"string"},"selectedResponses":{"type":"array","items":{"$ref":"#/components/schemas/SelectedResponse"}}},"title":"RunSummaryDetail"},"SectionRiskStats":{"type":"object","properties":{"maxRiskLevel":{"type":"integer","description":"Maximum level of risk in the section.","format":"int64"},"riskCount":{"type":"integer","description":"Number of risks in the section.","format":"int64"},"sectionId":{"type":"string","description":"ID of the section in the assessment."}},"title":"SectionRiskStats"},"SelectedResponse":{"type":"object","properties":{"response":{"type":"string"},"responseId":{"type":"string"}},"title":"SelectedResponse"},"Sort":{"type":"object","title":"Sort","properties":{"empty":{"type":"boolean","description":"Boolean to determine if the list is empty","example":true},"sorted":{"type":"boolean","description":"Boolean to determine if the list is sorted","example":true},"unsorted":{"type":"boolean","description":"Boolean to determine if the list is unsorted","example":"True"}}},"SubQuestionInformationUiDto":{"type":"object","properties":{"displayLabel":{"type":"string"},"errorCode":{"type":"string","enum":["ATTRIBUTE_DISABLED","ATTRIBUTE_OPTION_DISABLED","INVENTORY_NOT_EXISTS","RELATED_INVENTORY_ATTRIBUTE_DISABLED","DATA_ELEMENT_NOT_EXISTS","DUPLICATE_INVENTORY"]},"justification":{"type":"string"},"parentAssessmentDetailId":{"type":"string"},"responses":{"$ref":"#/components/schemas/ResponseInformationUiDto"},"totalComments":{"type":"integer","format":"int64"}},"title":"SubQuestionInformationUiDto"},"SubQuestionUiDto":{"type":"object","properties":{"allIds":{"type":"array","items":{"type":"string"}},"byId":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SubQuestionInformationUiDto"}}},"title":"SubQuestionUiDto"},"TagEntityDetail":{"type":"object","title":"TagEntityDetail","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the tag."},"option":{"type":"string","description":"Name of the tag."}}},"TaskCreateRequest":{"type":"object","required":["taskName"],"properties":{"assigneeId":{"type":"string","format":"uuid","description":"ID of the user to which the task is assigned. This value is obtained from the [Retrieve List of Users](/onetrust/reference/getallusersusingget) API."},"collaborators":{"type":"array","description":"Task Collaborator can be Users and User Groups to which a task can be associated to. The API to fetch User details can be obtained from [Get List of Users](/onetrust/reference/getallusersusingget) and the API to get User Group details can be obtained from [Retrieve List of User Groups](/onetrust/reference/retrieveusergroupsusingget)","items":{"$ref":"#/components/schemas/AssigneeDto"}},"deadline":{"type":"string","format":"date","description":"Date by which the task must be completed."},"description":{"type":"string","description":"Description of the task."},"taskName":{"type":"string","description":"Name of the task."}},"title":"TaskCreateRequest"},"AssigneeDto":{"type":"object","properties":{"collaboratorId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["USER","GROUP"]}},"title":"AssigneeDto"},"AssessmentDeleteLogInformation":{"type":"object","properties":{"assessmentGuid":{"type":"string","description":"GUID of an assessment."},"assessmentId":{"type":"integer","format":"int64","description":"ID of an assessment."},"assessmentName":{"type":"string","description":"Name of an assessment."},"deletedBy":{"type":"string","description":"GUID of the user who deleted the assessment."},"deletedDT":{"type":"string","format":"date-time","description":"The date at which the assessment is deleted in UTC timezone."}},"title":"AssessmentDeleteLogInformation"},"AssessmentListViewBasicDto":{"type":"object","properties":{"assessmentId":{"type":"string","description":"ID of the assessment."},"createDt":{"type":"string","format":"UTC","description":"Date that the assessment was created."},"name":{"type":"string","description":"Name of the assessment."},"number":{"type":"integer","format":"int32","description":"Number assigned to the assessment."},"orgGroupName":{"type":"string","description":"Name of the organization group assigned to the assessment."},"state":{"type":"string","description":"State of the assessment.","enum":["ARCHIVE","ACTIVE"]},"result":{"type":"string","description":"Result of the assessment. NOTE: This field will be deprecated soon.\nPlease reference the 'resultName' field instead.\n","enum":["Approved","AutoClosed","Rejected"]},"resultId":{"type":"string","format":"uuid","description":"ID of the result.","example":"7bbf3d92-3105-498c-b543-fc17cfa534f3"},"resultName":{"type":"string","description":"Name of the result.","example":"Approved"},"status":{"type":"string","description":"Status of the assessment.","enum":["NotStarted","InProgress","UnderReview","Completed"]},"tags":{"type":"array","description":"Name of the tag attached to the assessment.","items":{"type":"string"}},"templateName":{"type":"string","description":"Name of the template that is being used on the assessment.","example":"template_name"},"templateId":{"type":"string","format":"uuid","description":"ID used to launch an assessment using a specific version of a template.","example":"4bbf3d92-3105-498c-b543-fc17cfa534f1"},"templateRootVersionId":{"type":"string","format":"uuid","description":"ID used to launch an assessment using the latest published version of\na template.\n","example":"4bbf3d92-3105-498c-b543-fc17cfa534f1"},"primaryInventoryDetails":{"type":"array","items":{"$ref":"#/components/schemas/PrimaryInventoryDetails"}},"inherentRiskScore":{"type":"number","description":"Overall risk score without considering existing controls."},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time that the assessment was last updated."},"openRiskCount":{"type":"integer","format":"int64","description":"Number of risks that are open on the assessment."},"residualRiskScore":{"type":"number","description":"Overall risk score after considering existing controls."},"targetRiskScore":{"type":"number","description":"The desired risk score."}}},"PrimaryInventoryDetails":{"type":"object","properties":{"primaryInventoryName":{"type":"string","description":"Name of the inventory record which is the primary record of the\nassessment.\n","example":"Asset test name"},"primaryInventoryId":{"type":"string","format":"uuid","description":"GUID of the inventory record which is the primary record of the\nassessment.\n","example":"9cdc600e-dc9c-428c-8d71-a2123f4a9ca3"},"primaryInventoryNumber":{"type":"integer","format":"int32","description":"Integer ID of the inventory record which is the primary record of the\nassessment.\n","example":"157"}}},"AssessmentListResponseListAssessmentListViewBasicDto":{"type":"object","properties":{"content":{"type":"array","description":"Content/data displayed in the current page.","items":{"$ref":"#/components/schemas/AssessmentListViewBasicDto"}},"page":{"$ref":"#/components/schemas/AssessmentPage"}},"title":"AssessmentListResponseListAssessmentListViewBasicDto"},"AssessmentPage":{"type":"object","properties":{"number":{"type":"integer","format":"int64","description":"Page number of the results list (0…N)."},"size":{"type":"integer","format":"int64","description":"Number of records per page (0…N)."},"totalElements":{"type":"integer","format":"int64","description":"Total number of elements."},"totalPages":{"type":"integer","format":"int64","description":"Total number of pages."}},"title":"AssessmentPage"},"ClosureRequest":{"type":"object","properties":{"closureComment":{"type":"string","description":"Optional: Insert a comment about the assessment approval. This will\npopulate in the Result Comments field on the assessment and be sent to\nall respondents and approvers.\n"},"excludeRules":{"type":"boolean","description":"This controls whether or not template-level rules will be triggered\nupon invoking the API, i.e. Create Risk or Send Assessment.\n"},"forceOverride":{"type":"boolean","description":"This should be used if there are multiple approvers on the assessment.\nThis will bypass other approver’s reviews and move the assessment to\nCompleted.\n"}},"title":"ClosureRequest"},"AssessmentClosureRequest":{"type":"object","title":"AssessmentClosureRequest","properties":{"closureComment":{"type":"string","description":"The comment about the assessment result.\n","example":"All risks have been mitigated and reduced; this assessment is\napproved.\n"},"excludeRules":{"type":"boolean","description":"Flag that indicates if the template-level rules will be triggered or not upon invoking the APIs, i.e. Create Risk or Send Assessment.\n","example":true},"forceOverride":{"type":"boolean","description":"This should be used if there are multiple approvers on the assessment. If true, this will bypass other approver’s reviews and move the assessment to Completed status.\n","example":true},"resultId":{"type":"string","description":"ID of the assessment result option used to complete the assessment. Only Active result options can be used to complete assessments. This value is obtained from the [Get List of Assessment Results](/onetrust/reference/getassessmentresultsusingget) API.\n","example":"7bbf3d92-3105-498c-b543-fc17cfa534f3"}},"required":["resultId"]},"ReassessAssessmentRequest":{"type":"object","title":"ReassessAssessmentRequest","properties":{"assessmentMetadata":{"$ref":"#/components/schemas/AssessmentReassessMetadata"},"copyAssessmentMetadata":{"type":"boolean","description":"If this field is set to **true**, the assessment name, description, organization, approver, and respondent details from the source assessment will be copied to the new assessment. If this field is set to **false**, then the `assessmentMetadata` parameter values must be passed in the request body.\n","default":false},"copyAttachments":{"type":"boolean","description":"If this field is set to **true**, then the attachments that have been added to questions in the source assessment will be copied to the new assessment.\n"},"copyComments":{"type":"boolean","description":"If this field is set to **true**, then any comments currently associated with the initial assessment will be copied to the new assessment."},"copyNotes":{"type":"boolean","description":"If this field is set to **true**, then the user notes currently associated with the initial assessment will be copied to the new assessment."},"copyResponses":{"type":"boolean","description":"If this field is set to **true**, then the responses that have been given to the initial assessment will be copied to the new assessment.\n"},"deadline":{"type":"string","format":"date-time","description":"Date and time by which the assessment must be completed."},"linkRisks":{"type":"boolean","description":"If this field is set to **true**, then any risk rules created based on the template risk rules for the source assessment will be linked to the new assessment upon submission.\n"},"reminder":{"type":"integer","format":"int64","description":"Use this field to indicate whether to archive the source assessment. If this field is set to **true**, the source assessment will be archived. If this field is set to **false**, the source assessment will not be archived.\n"},"archiveSourceAssessment":{"type":"boolean","description":"The flag to indicate if the original assessment will be archived or not when reassessing.\n"}}},"SendBackAssessmentRequest":{"type":"object","properties":{"editAllResponses":{"type":"boolean","description":"Use this field to allow all respondents to edit any question response when an assessment is sent back.\n"},"emailComment":{"type":"string","description":"Comment to include in the email notification."},"resetApproverReviews":{"type":"boolean","description":"Use this field to indicate whether the approver’s review is retained or removed.\n"},"sendBulkInfoRequestEmail":{"type":"boolean","description":"Use this field to indicate whether to send notifications to all assessment respondents in bulk for additional information on multiple questions.\n"},"reopenSectionIds":{"type":"array","items":{"type":"string","format":"uuid"},"example":["9e139b4e-3817-42c3-b081-01c846240a00","50d545e5-87bd-433a-97a4-f1af954613a1"],"description":"List of section UUIDs to be reopened on assessment send-back. If empty, all sections are reopened."}},"title":"SendBackAssessmentRequest"},"ReopenAssessmentRequest":{"type":"object","properties":{"emailComment":{"type":"string","description":"Comment to include in the email notification."}},"title":"ReopenAssessmentRequest"},"AssessmentRiskCreateRequest":{"type":"object","title":"AssessmentRiskCreateRequest","properties":{"sectionId":{"type":"string","format":"uuid","description":"ID of the section in the assessment to which the risk was flagged. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API.\n","example":"7bbf3d92-3105-498c-b543-fc17cfa534f3"},"questionId":{"type":"string","format":"uuid","description":"ID of the question in the assessment to which the risk was flagged. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API.\n","example":"7bbf3d92-3105-498c-b543-fc17cfa534f2"},"parentQuestionResponseDetailId":{"type":"string","format":"uuid","description":"Assessment Detail Id of Parent Question's Response. This Id is required only\nwhen creating a risk to Attribute question belonging to a multiselect parent/domain question.\n","example":"7bbf3d92-3105-498c-b543-fc17cfa534f2"},"riskCreateRequest":{"$ref":"#/components/schemas/RiskRequest"}},"required":["sectionId","questionId","riskCreateRequest"]},"RiskRequest":{"type":"object","title":"RiskRequest","properties":{"levelId":{"type":"integer","format":"int64","description":"ID of the risk level to be created.","example":2},"typeId":{"type":"integer","format":"int64","description":"ID of the risk type. The value should be 10 since it is being created on an assessment.\n","example":10},"sourceTypeId":{"type":"integer","format":"int64","description":"ID for the Source Type of the risk. The value should be 10 since it is being created on an assessment.\n","example":10},"description":{"type":"string","description":"Description of the risk.","example":"Personal data collection is a risk "},"recommendation":{"type":"string","description":"Treatment plan for the risk being created.","example":"Implement the required controls"},"riskApproversId":{"type":"array","description":"List of risk approvers (GUIDS) responsible for approving the risk. Multiple risk approvers can be added if separated by commas. This value is obtained from the [Get List of Users](/onetrust/reference/getallusersusingget) API.\n","example":"e8756d08-953d-42a9-b0aa-9c2ba8617891\",\n\"54630b5f-47bb-409c-9f81-63ad1a4a9b4b\n","items":{"type":"string","format":"uuid"}},"riskOwners":{"type":"array","description":"List of risk owners responsible for remedying the risk. Multiple risk owners can be added if separated by commas. The user’s ID, first name, and last name must be included and can be obtained from the [Get List of Users](/onetrust/reference/getallusersusingget) API.\n","example":"\"1c412288-b9fa-4fd6-98be-467b2824d33a\", name: \"XXX YYY\"","items":{"$ref":"#/components/schemas/BasicEntityDetail"}},"deadline":{"type":"string","format":"date-time","description":"Date by which the risk must be closed. The Format is YYYY-MM-DDTHH:MM:SS.FFFZ.\n","example":"2021-03-19T04:00:00.000Z"},"reminderDays":{"type":"integer","format":"int64","description":"Number of days before the deadline that a reminder is sent.\n","example":2},"probabilityLevelId":{"type":"integer","format":"int64","description":"ID of the probability level for the risk.","example":3},"probabilityLevel":{"type":"string","description":"Probability level of the risk occurring.","example":"High"},"impactLevelId":{"type":"integer","format":"int64","description":"ID of the impact level of the risk would have on an organization if it occurred.","example":3},"impactLevel":{"type":"string","description":"Impact level the risk would have on an organization if it occurred.","example":"Low"},"riskScore":{"type":"number","description":"The risk score value.","example":4},"systemCreated":{"type":"boolean","description":"The parameter to determine if the risk is being created through a risk rule or manually flagged. Since it is being created through an API, it should always be set to \"False.\".\n","example":false},"categoryIds":{"type":"array","description":"List of the associated categories in which the risk is assigned. The GUIDs of the risk categories must be specified. Multiple risk categories can be added if separated by commas.\n","items":{"type":"string","format":"uuid"}},"controlIds":{"type":"array","description":"List of the associated controls in which the risk is assigned. The GUIDs of the risk controls must be specified. Multiple risk controls can be added if separated by commas.\n","items":{"type":"string","format":"uuid"}},"threatId":{"type":"string","format":"uuid","description":"List of the associated threats in which the risk is assigned. The GUIDs of the risk threats must be specified. Multiple threats can be added if separated by commas.\n","example":"54e3fbf2-ea1e-46aa-9236-d1d056612ded"},"vulnerabilityIds":{"type":"array","description":"List of the associated vulnarabilities in which the risk is assigned. The GUIDs of the risk vulnerabilities must be specified.\n","example":"3c1f376f-638f-4828-9e76-8fb24bc46cd7","items":{"type":"string","format":"uuid"}},"riskTemplate":{"$ref":"#/components/schemas/RiskTemplateIdentifier"},"targetRiskLevel":{"$ref":"#/components/schemas/RiskLevelDetail"},"attributeValues":{"additionalProperties":{"items":{"$ref":"#/components/schemas/AttributeValueInformation"},"type":"array"},"type":"object","description":"Risk attributes consists of risk attribute ID, Value and Value Key. The risk attribute ID and value key is null in case of text Attributes.\n"}},"required":["levelId","typeId","sourceTypeId"],"description":"The required fields for the request body are `levelId`, `typeId` and `sourceTypeId`. Standard values for `levelId` are 0 - ZERO, 1 - LOW, 2 - MEDIUM, 3 - HIGH and 4 - VERY HIGH. The value for `sourceTypeId` and `typeId` should be 10 since it is being created on an assessment.\n"},"RiskTemplateIdentifier":{"type":"object","title":"RiskTemplateIdentifer","properties":{"id":{"type":"string","format":"uuid","description":"The risk template GUID if a risk is created using a risk template. If not, the value must be null.\n","example":"null"}}},"RiskLevelDetail":{"type":"object","title":"RiskLevelDetail","properties":{"levelId":{"type":"integer","format":"int64","description":"ID of the target risk level. The default mapped values are Zero - 0, Low - 1, Medium - 2, High - 3 and Very High - 4.","example":2},"level":{"type":"string","description":"Desired risk level.","example":"Low"},"impactLevelId":{"type":"integer","format":"int64","description":"ID of the target impact level.","example":2},"impactLevel":{"type":"string","description":"Desired impact level the risk would have on an organization if it occurred.","example":"Low"},"probabilityLevelId":{"type":"integer","format":"int64","description":"The ID of the target probability level.","example":2},"probabilityLevel":{"type":"string","description":"The desired probability level of the risk occurring.","example":"Low"},"riskScore":{"type":"number","description":"The desired risk score.","example":1}}},"AssessmentQuestionRiskDetailInformation":{"type":"object","title":"AssessmentQuestionRiskDetailInformation","properties":{"questionIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"ID of the questions in the assessment to which risks were flagged."},"riskId":{"type":"string","format":"uuid","description":"ID of the newly created risk."},"level":{"type":"integer","format":"int64","description":"Risk level of the newly created risk."},"riskResponse":{"$ref":"#/components/schemas/RiskInformation"}}},"RiskInformation":{"type":"object","title":"RiskInformation","properties":{"id":{"type":"string","format":"uuid","description":"GUID of the new risk.","example":"e5f32529-9cbb-486f-b07e-7be91db15fb9"},"number":{"type":"integer","format":"int64","description":"The identifier of the new risk. (The numeric value shown in the risk register page).\n","example":2},"type":{"type":"string","description":"The type of the risk being created. If the risk is being created on an inventory question, the type will be the respective inventory like \"Vendors.\"\n","enum":["ASSESSMENTS","ASSETS","PROCESSING_ACTIVITIES","VENDORS","ENTITIES","INCIDENTS","GENERIC"],"example":"VENDORS"},"creationType":{"type":"string","description":"The Risk creation type.","example":"null"},"state":{"type":"string","description":"The current stage of the risk created.","enum":["IDENTIFIED","RECOMMENDATION_ADDED","RECOMMENDATION_SENT","REMEDIATION_PROPOSED","EXCEPTION_REQUESTED","REDUCED","RETAINED","ARCHIVED_IN_VERSION"],"example":"IDENTIFIED"},"previousState":{"type":"string","description":"The previous stage of the risk created.","enum":["IDENTIFIED","RECOMMENDATION_ADDED","RECOMMENDATION_SENT","REMEDIATION_PROPOSED","EXCEPTION_REQUESTED","REDUCED","RETAINED","ARCHIVED_IN_VERSION"],"example":"IDENTIFIED"},"typeRefIds":{"type":"array","description":"The list of references to the risk. Example, the assessment, question or inventory GUIDs on which the risk has been created.\n","example":"id: \"c1c04228-6816-4ce0-9b73-ce670e99abd3\", type: \"ASSESSMENT\", name:\nnull, additionalAttributes: {}\n","items":{"type":"string","format":"uuid"}},"sourceType":{"type":"string","description":"The type of the risk being created. If the risk is being created on an inventory question, the type will be the respective inventory (e.g. Vendors). Since this API created a risk on an assessment, this value will always be PIA.\n","enum":["PIA","DM","RA","GRA","DINA","INVENTORY"],"example":"PIA"},"source":{"$ref":"#/components/schemas/RiskSourceInformation"},"description":{"type":"string","description":"Description of the risk.","example":"Personal data collection is a risk "},"recommendation":{"type":"string","description":"Treatment plan for the risk being created.","example":"Implement the required controls "},"remediationProposal":{"type":"string","description":"Remediation proposal of the risk created.","example":"null"},"orgGroup":{"$ref":"#/components/schemas/BasicEntityDetail"},"requestedException":{"type":"string","description":"Requested exception of the created risk.","example":"null"},"mitigation":{"type":"string","description":"Risk mitigation of the created risk.","example":"null"},"mitigatedDate":{"type":"string","format":"date-time","description":"Date that the risk was mitigated, formatted as YYYY-MM-DDTHH:MM:SS.FFFZ.\n"},"justification":{"type":"string","description":"Justification of the risk.","example":"null"},"deadline":{"type":"string","format":"date-time","description":"Date by which the risk must be closed, formatted as  YYYY-MM-DDTHH:MM:SS.FFFZ.","example":"2021-03-18T04:00:00:000Z"},"references":{"type":"array","description":"List of risk references like the Question, Assessment and inventory if any that the risk is associated with.\n","example":"\"c1c04228-6816-4ce0-9b73-ce670e99abd3\", type: \"ASSESSMENT\", name:\nnull, additionalAttributes: {}\n","items":{"$ref":"#/components/schemas/RiskReferenceInformation"}},"createdUTCDateTime":{"type":"string","format":"date-time","description":"Date on which the risk was created, formatted as YYYY-MM-DDTHH:MM:SS.FFFZ.","example":"2021-03-19T15:22:50.853"},"levelId":{"type":"integer","format":"int64","description":"ID of the risk level for the created risk.","example":2},"level":{"type":"string","description":"Level of the created risk.","example":"MEDIUM"},"levelDisplayName":{"type":"string","description":"Name of the risk level as displayed in the application.","example":"Medium"},"probabilityLevelId":{"type":"integer","format":"int64","description":"ID of the probability level for the risk.","example":3},"probabilityLevel":{"type":"string","description":"Probability level of the risk occurring.","example":"HIGH"},"impactLevelId":{"type":"integer","format":"int64","description":"ID of the imapct level the risk would have on an organization if it occurred.","example":1},"impactLevel":{"type":"string","description":"Impact level the risk would have on an organization if it occurred.","example":"LOW"},"riskScore":{"type":"number","description":"The desired risk score.","example":1},"viewOnly":{"type":"boolean","description":"The flag to indicate if the risk is view only or not. The value should be set to false.","example":false},"controlsIdentifier":{"type":"array","description":"List of risk control identifiers added to the risk.","example":"\"4e26b3cb-8f00-4ebe-ae82-60be0c96017d\",\n\"46c92dc7-cb33-44c4-acb1-db9c63aacd09\"\n","items":{"type":"string"}},"categories":{"type":"array","description":"List of risk categories","items":{"$ref":"#/components/schemas/RiskCategoryInformation"}},"riskOwnersId":{"type":"array","description":"GUIDs of risk owners responsible for remedying the risk.","example":"\"1c412288-b9fa-4fd6-98be-467b2824d33a\",\n\"e8756d08-953d-42a9-b0aa-9c2ba8617891\"\n","items":{"type":"string","format":"uuid"}},"riskOwnersName":{"type":"string","description":"Names of risk owners responsible for remedying the risk.","example":"\"XXX YYY, AAA BBB\""},"riskApproversId":{"type":"array","description":"GUIDs of risk approvers responsible for approving the risk.","example":"\"54630b5f-47bb-409c-9f81-63ad1a4a9b4b\",\n\"e8756d08-953d-42a9-b0aa-9c2ba8617891\"\n","items":{"type":"string","format":"uuid"}},"riskApprovers":{"type":"string","description":"Names of risk approvers responsible for approving the risk."},"inherentRiskLevel":{"$ref":"#/components/schemas/RiskLevelDetail"},"targetRiskLevel":{"$ref":"#/components/schemas/RiskLevelDetail"},"treatmentPlan":{"type":"string","description":"Plan that includes completing specific tasks, assigning a risk owner, and adding controls to mitigate the risk.","example":"Implement the required controls "},"treatment":{"type":"string","description":"Process by which the risk owner actively mitigates the risk.","example":"The necessary controls are implemented "},"result":{"type":"string","description":"Result of the risk. This value will be null for newly created risks.","example":"null"},"treatmentStatus":{"type":"string","description":"Current status of the treatment plan. This value will be null for newly created risks.\n","example":"null"},"workflow":{"$ref":"#/components/schemas/BasicEntityDetail"},"stage":{"$ref":"#/components/schemas/BasicEntityDetail"},"actionId":{"type":"integer","format":"int64","description":"ID of a risk action.","example":null},"threatInformation":{"$ref":"#/components/schemas/RiskThreatInformation"},"vulnerabilitiesInformation":{"type":"array","description":"GUID of the vulnerability assigned to the risk.","items":{"$ref":"#/components/schemas/RiskVulnerabilityInformation"}},"reminderDays":{"type":"integer","format":"int64","description":"Number of days to submit the risk.","example":2},"attributeValues":{"additionalProperties":{"items":{"$ref":"#/components/schemas/AttributeValueInformation"},"type":"array"},"type":"object","description":"Risk attributes consists of risk attribute ID, Value and Value Key.\n"}}},"RiskSourceInformation":{"type":"object","title":"RiskSourceInformation","properties":{"id":{"type":"string","format":"uuid","description":"The GUID of the assessment on which the risk is created.","example":"c1c04228-6816-4ce0-9b73-ce670e99abd3"},"name":{"type":"string","description":"The name of the assessment on which the risk is created.","example":"Microsoft Azure PIA"},"type":{"type":"string","description":"The type for the risk source. Since this API created a risk on an assessment, this value will always be PIA.\n","enum":["PIA","DM","RA","GRA","DINA","INVENTORY"],"example":"PIA"},"additionalAttributes":{"type":"object","description":"Additional attributes of risk source entity.\n","example":{}}}},"RiskReferenceInformation":{"type":"object","title":"RiskReferenceInformation","properties":{"id":{"type":"string","format":"uuid","description":"ID of the risk reference."},"name":{"type":"string","description":"Name of the risk reference."},"type":{"type":"string","description":"Type of the risk reference.","enum":["QUESTION","ASSESSMENT","INVENTORY","GENERIC"]},"additionalAttributes":{"type":"object","description":"Additional information about the Reference Entity.\n"}}},"RiskCategoryInformation":{"type":"object","title":"RiskCategoryInformation","properties":{"id":{"type":"string","format":"uuid","description":"GUID of the risk category added to the risk.","example":"3c1f376f-638f-4828-9e76-8fb24bc46cd7"},"name":{"type":"string","description":"The name of risk category added to the risk.","example":"Privacy"},"nameKey":{"type":"string","description":"Name key added to Risk category for translation.","example":"Privacy"}}},"RiskThreatInformation":{"type":"object","title":"RiskThreatInformation","properties":{"id":{"type":"string","format":"uuid","description":"GUID of the threat assigned to the risk.","example":"54e3fbf2-ea1e-46aa-9236-d1d056612ded"},"name":{"type":"string","description":"Name of the threat assigned to the risk.","example":"Abuse of rights"}}},"RiskVulnerabilityInformation":{"type":"object","title":"RiskVulnerabilityInformation","properties":{"id":{"type":"string","format":"uuid","description":"GUID of vulnerability added to the risk.","example":"54e3fbf2-567hg-46aa-9236-d1d056612ded"},"name":{"type":"string","description":"Name of vulnerability added to the risk.","example":"Absence of Personnel"}}},"AttributeValueInformation":{"type":"object","title":"AttributeValueInformation","properties":{"id":{"type":"string","format":"uuid","description":"ID of an attribute."},"value":{"type":"string","description":"Value of an attribute."},"valueKey":{"type":"string","description":"Value key of an attribute."}}},"AssessmentResultDto":{"type":"object","title":"AssessmentResultDto","properties":{"active":{"type":"boolean","description":"This value determines whether the result option is Active or Inactive. Inactive result options cannot be used to complete an assessment.\n","example":true},"id":{"type":"string","format":"uuid","description":"ID of the result option.","example":"7bbf3d92-3105-498c-b543-fc17cfa534f3"},"internal":{"type":"boolean","description":"This value determines if the result option is used for internal purposes only (i.e. if an assessment is Auto-Approved or Auto-Rejected). Internal result options cannot be set by users.\n","example":false},"name":{"type":"string","description":"Name of the result option.","example":"Approved"},"nameKey":{"type":"string","description":"Translation key for the result option name.","example":"Approved"},"optionHint":{"type":"string","description":"Hint that accompanies the result option.","example":"Approved"},"optionHintKey":{"type":"string","description":"Translation key for the result option’s hint.","example":"Approved"},"system":{"type":"boolean","description":"This value determines whether the result option is a system (i.e. Approved or Rejected) generated or a custom result (i.e. Approved with Conditions).\n","example":true},"updateOtherServices":{"type":"boolean","description":"This value determines if the result option will update inventories and launch follow-up assessments.\n","example":true}}},"PageLinkedAssessmentInformation":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/LinkedAssessmentInformation"}},"empty":{"type":"boolean"},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/Pageable"},"size":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/Sort"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"}},"title":"PageLinkedAssessmentInformation"},"LinkedAssessmentInformation":{"type":"object","title":"LinkedAssessmentInformation","properties":{"assessmentId":{"type":"string","format":"uuid","description":"ID of an assessment."},"assessmentName":{"type":"string","description":"Name of an assessment."},"assessmentNumber":{"type":"integer","format":"int64","description":"Number assigned to an assessment."},"linkType":{"type":"string","description":"This field represents the type of link between the record and the\nassessment.\n\n\n* \"PRIMARY\" link type means the record is the primary record of the\nassessment.\n\n* \"MANUAL\" link type means the assessment was manually linked to the\ninventory record from the inventory details.\n\n* \"AUTO\" link type means the record was selected as a question\nresponse in the assessment, but is not the primary record.\n","enum":["PRIMARY","AUTO","MANUAL"],"example":"MANUAL"}}},"ApproverInformation":{"type":"object","properties":{"approvalState":{"type":"string","description":"Assessment approval status.\n","enum":["OPEN","APPROVED","REJECTED"]},"approvedOn":{"type":"string","format":"date-time","description":"Date and time at which the assessment was approved."},"id":{"type":"string","format":"uuid","description":"ID of the user assigned as an approver."},"name":{"type":"string","description":"Name of the user assigned as an approver."},"resultId":{"type":"string","format":"uuid","description":"ID of the assessment result."},"resultName":{"type":"string","description":"Name of the assessment result."}},"title":"ApproverInformation"},"AssessmentReassessMetadata":{"type":"object","title":"AssessmentReassessMetadata","properties":{"approvers":{"type":"array","description":"List of users assigned as approvers of the assessment.","items":{"$ref":"#/components/schemas/AssessmentApproverRequest"}},"description":{"type":"string","description":"Description of the assessment."},"name":{"type":"string","description":"Name of the assessment."},"orgGroupId":{"type":"string","format":"uuid","description":"ID of the organization group assigned to the assessment. This value is obtained from the [Get Assessment](/onetrust/reference/exportassessmentusingget) API."},"respondentCreationType":{"type":"string","description":"Use this field to select if new respondents are created as Invited Users or Project Respondents when calling the Public Reassess API. The **Allow Creating Project Respondents from Assessment** global setting should be enabled for new users to be set as Project Respondents.\n"},"respondents":{"type":"array","description":"List of users that are assigned to an assessment to provide answers. At least one respondent must be assigned to reassess.\n","items":{"$ref":"#/components/schemas/AssessmentRespondentRequest"}}},"required":["name","orgGroupId","respondents"]},"WorkflowAndApprovalStageDetails":{"type":"object","properties":{"approvalStageDetails":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStageBasicDetails"}},"workflowId":{"type":"string","format":"uuid","description":"ID of the workflow."},"workflowName":{"type":"string","description":"Name of the workflow."},"workflowNameKey":{"type":"string","description":"Translation key for the workflow name."}},"title":"WorkflowAndApprovalStageDetails"},"WorkflowStageBasicDetails":{"type":"object","description":"Stage Details of the Workflow","properties":{"badgeColor":{"type":"string"},"stageId":{"type":"string","format":"uuid","description":"ID of the stage in the workflow. The `stageId` can be used to reassign approvers to different stages of an assessment using the [Reassign Assessment](/onetrust/reference/reassignassessmentusingput) API."},"stageName":{"type":"string","description":"Name of the stage in the workflow."},"stageNameKey":{"type":"string","description":"Translation key for the stage name."}},"title":"WorkflowStageBasicDetails"},"PrimaryEntityDetail":{"type":"object","properties":{"displayName":{"type":"string","description":"Name and number of the primary record."},"id":{"type":"string","format":"uuid","description":"Unique ID for the primary record."},"name":{"type":"string","description":"Name of the primary record."},"number":{"type":"integer","format":"int64","description":"The number associated with the primary record."}},"title":"PrimaryEntityDetail"},"AssessmentManualLinkRequest":{"type":"object","title":"AssessmentManualLinkRequest","properties":{"fromId":{"type":"string","format":"uuid","description":"ID of the assessment to create the manual relation. This value can be obtained using the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API."},"toIds":{"type":"array","description":"IDs of the assessments to be manually related. This value can be obtained using the [Get List of Assessments](/onetrust/reference/getallassessmentbasicdetailsusingget) API.","items":{"type":"string","format":"uuid"}}}}}}}