{"openapi":"3.1.0","info":{"title":"Privacy Automation - Assessment Automation","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.surrey.idm.oclc.org/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Assessment Automation APIs provide functionality for managing assessment template lifecycle operations, including template export and import for cross-environment migration, retrieving published template metadata with filtering by template type, and template deletion with comprehensive validation checks."},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Assessment Actions","description":"The Assessment Actions APIs are used to perform workflows on assessments, such as launching, approving, or creating tasks.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"x-displayName":"Assessment Actions"},{"name":"Assessment Management","description":"The Assessment Management APIs are used to modify, link, and manage existing assessments.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"x-displayName":"Assessment Management"},{"name":"Assessments","description":"The Assessments APIs are used to retrieve assessment data and details.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"x-displayName":"Assessments"},{"name":"Template","description":"APIs to manage assessment template operations including import and export functionality for cross-tenant migration, retrieval of published template listings with type-based filtering, and template deletion with dependency validation.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"x-displayName":"Template"}],"paths":{"/api/assessment/v2/assessment-tags":{"get":{"operationId":"getTagsUsingGET","summary":"Get List of Assessment Tags","description":"Use this API to retrieve all available assessment tags that can be used to categorize or label assessments.\n\n > 🗒 Things to Know  \n > \n > - The list of tag IDs returned in the response can be used to update a specific assessment's tag using the [Update Assessment Tags](/onetrust/reference/addorupdatetagsusingput) API.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_TagEntityDetail"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT_READ","ASSESSMENT"]}]}},"/api/assessment/v2/assessments":{"get":{"operationId":"getAllAssessmentBasicDetailsUsingGET","summary":"Get List of Assessments","description":"Use this API to retrieve a list of all assessments with basic assessment details. The response will include details such as the assessment ID, number, stage, result, and associated organization.\n\n > 🗒 Things to Know  \n >\n > - All assessments regardless of their stage are returned in the response by default.\n >\n > - The assessments can be filtered by stage using the `assessmentStatuses` query parameter. \n >\n > - The `size` and `page` query parameters can be used to paginate the response (list of assessments). The `size` parameter defines the number of assessments to be returned in each page. The `page` parameter defines the page number. The first page and default `page` is page number 0. The `size` parameter is optional and default value is 20, but cannot exceed 2000. If you input a value greater than 2000, then 2000 will be used for the `size`.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"templateTypes","in":"query","description":"List of template types to filter assessments by. Available options:\n\n- **PIA** (PIA & DPIA Automation)\n- **VENDOR** (Third-Party Risk Management)\n- **ITRM** (IT & Security Risk Management)\n- **CONTROL** (Risk and Controls)\n- **INCIDENT** (Incident Management)\n- **EXCHANGE** (Third-Party Risk Exchange)\n- **ESG** (ESG Program Reporting)\n- **DISCLOSURE** (Disclosure Management)\n- **DISCLOSURE_YOY** (Year Over Year Disclosures)\n- **ERM** (Enterprise Risk Management)\n- **TPDD** (Third-Party Due Diligence)\n- **AIGOVERNANCE** (AI Governance)","required":false,"schema":{"type":"array","items":{"type":"string","description":"Template types used in assessments","enum":["PIA","VENDOR","ITRM","CONTROL","INCIDENT","EXCHANGE","ESG","DISCLOSURE","DISCLOSURE_YOY","ERM","TPDD","AIGOVERNANCE"]}},"example":["PIA","VENDOR","ITRM"]},{"name":"assessmentStatuses","in":"query","description":"List of assessment statuses to filter by","required":false,"schema":{"type":"array","items":{"type":"string","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]}},"example":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]},{"name":"assessmentArchivalState","in":"query","description":"Filter by archival state","required":false,"schema":{"type":"string","enum":["ALL","ARCHIVED","NON_ARCHIVED"]},"example":"NON_ARCHIVED"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N). Example- '?page=1","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1…N).","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","default":"createdDate,desc","enum":["number,asc","number,desc","status,asc","status,desc","createdDate,asc","createdDate,desc","name,asc","name,desc","result,asc","result,desc","orgGroupName,asc","orgGroupName,desc","deadline,asc","deadline,desc","openRiskCount,asc","openRiskCount,desc","openInfoRequestCount,asc","openInfoRequestCount,desc"]},"example":"createdDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_PageAssessmentListViewBasicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT_READ","ASSESSMENT"]}]},"post":{"operationId":"createAssessmentUsingPOST_1","summary":"Launch Assessment","description":"Use this API to launch a new assessment. The new assessment will be created with the details provided in the request body and assigned to the indicated respondents. If the selected template includes an 'Approver-only' Section, a user with the \"Project Owner\" permission can be assigned to that section.\n\n > 🗒 Things to Know  \n > \n > - `inventoryDetails` information can be added in order to set a primary record and pre-populate inventory information on the assessment.\n > \n > - The `templateRootVersionId` parameter can be used instead of the `templateId` parameter to create the new assessment using the latest published version of a template.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/activities/types/assessmentdelete":{"get":{"operationId":"getAssessmentDeleteLogsUsingGET","summary":"Export Deleted Assessment Audit Log","description":"Use this API to export a log of all deleted assessments. The response will include details such as the assessment name, assessment ID, user who deleted the assessment, and deletion timestamp.\n\n > 🗒 Things to Know  \n >\n > - The exported log only includes assessments deleted after OneTrust 4.1.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentDeleteLogInformation"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT_READ","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/archive":{"put":{"operationId":"archiveAssessmentsUsingPUT","summary":"Archive Assessment","description":"Use this API to archive a single assessment or multiple assessments. Multiple assessment IDs can be provided in the API request to archive assessments in bulk.\n\n > 🗒 Things to Know  \n > \n > - Archived assessments will be moved into the Archive list after archiving.\n > \n > - Archived assessments will be read-only.\n > \n > - Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be archived.\n","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"examples":{"Assessment IDs":{"description":"Assessment IDs","value":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/assessment-links":{"post":{"operationId":"addManualAssessmentLinksUsingPOST","summary":"Link Assessments","description":"Use this API to link an assessment to multiple assessments.\n\n > 🗒 Things to Know  \n > \n > - This API can be used for linking active and archived assessments.\n > \n > - Only assessments with the following template types can be linked: PIA, Vendor, ITRM, Control, Exchange, Incident and ESG.","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentManualLinkRequest"}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/assessment-results":{"get":{"operationId":"getAssessmentResultsUsingGET","summary":"Get List of Assessment Results","description":"Use this API to retrieve a list of all assessment result options that can be used to complete an assessment. The `id` corresponding to each result option in the response can be used to complete assessments using the [Complete Assessment](/onetrust/reference/reviewassessmentusingpost) API.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"filterValue","in":"query","description":"Filter to apply when retrieving assessment results. Use ACTIVE_EXCLUDING_INTERNAL to exclude internal results.","required":false,"schema":{"type":"string","enum":["ACTIVE_EXCLUDING_INTERNAL"]},"example":"ACTIVE_EXCLUDING_INTERNAL"},{"name":"templateTypes","in":"query","description":"List of template types to filter assessment results by. Available options:\n\n- **PIA** (PIA & DPIA Automation)\n- **VENDOR** (Third-Party Risk Management)\n- **ITRM** (IT & Security Risk Management)\n- **CONTROL** (Risk and Controls)\n- **INCIDENT** (Incident Management)\n- **EXCHANGE** (Third-Party Risk Exchange)\n- **ESG** (ESG Program Reporting)\n- **ERM** (Enterprise Risk Management)\n- **TPDD** (Third-Party Due Diligence)\n- **AIGOVERNANCE** (AI Governance)","required":false,"schema":{"type":"array","items":{"type":"string","description":"Template types used in assessments","enum":["PIA","VENDOR","ITRM","CONTROL","INCIDENT","EXCHANGE","ESG","DISCLOSURE","DISCLOSURE_YOY","ERM","TPDD","AIGOVERNANCE"]}},"example":["PIA","VENDOR","ITRM"]},{"name":"includeMasterResults","in":"query","description":"Flag to include master results","required":false,"schema":{"type":"boolean","default":true},"example":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentResultDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT_READ","ASSESSMENT","INTEGRATION"]}]}},"/api/assessment/v2/assessments/bulk":{"post":{"operationId":"createBulkAssessmentUsingPOST","summary":"Launch Assessments in Bulk","description":"Use this API to create assessments in bulk. One assessment will be created for each inventory ID passed in the request body. The assessments will be created with the details provided in the request body and assigned to the indicated respondents.\n\n > 🗒 Things to Know  \n > \n > - The same template or different templates can be used per inventory ID in the API response body.\n > \n > - The `templateRootVersionId` parameter can be used instead of the `templateId` parameter to use the latest published version of a template for the new assessment.","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"List of assessment creation details including template, respondents, and metadata","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentCreateRequest"}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT"]}]}},"/api/assessment/v2/assessments/reference-objects/{id}/assessments":{"get":{"operationId":"getLinkedAssessmentsInformationUsingGET","summary":"Get List of Linked Assessments","description":"Use this API to retrieve a list of all assessments linked to a particular record. The linked assessments list will support all copied, reassessed, and rule triggered related assessments.\n\n > 🗒 Things to Know  \n > \n > - The following APIs can be used to retrieve the record ID (`id`): \n > \n > - For Assets, Processing Activities, & Entities, use the [Get List of Inventories](/onetrust/reference/getlistofinventoriesusingget) API.\n > \n > - For Vendors, use the [List Vendors](/onetrust/reference/getlistofinventoriesusingget-1) API.\n > \n > - For Engagements, use the [Get List of Engagements](/onetrust/reference/loadengagementusingget) API.\n > \n > - For Incidents, use the [List Incidents](/onetrust/reference/searchincidentsusingpost) API.\n > \n > - For Control Implementations, use the [List Controls](/onetrust/reference/findallcontrolimplementationsusingpost) API.\n > \n > - If the ID does not match the entered reference-object from the URL, 0 results will be returned.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"id","in":"path","description":"UUID of the reference object","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"referenceType","in":"query","description":"Type of reference object","required":true,"schema":{"type":"string","enum":["INVENTORY","CONTROL_IMPLEMENTATION","ENGAGEMENT","INCIDENT","CUSTOM_ENTITY","DYNAMIC"]},"example":"INVENTORY"},{"name":"linkTypes","in":"query","description":"Types of links to filter by","required":false,"schema":{"type":"array","items":{"type":"string","enum":["PRIMARY","AUTO","MANUAL"]}},"example":["PRIMARY","AUTO"]},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1…N)","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","default":"createdDate,desc","enum":["number,asc","number,desc","status,asc","status,desc","createdDate,asc","createdDate,desc","name,asc","name,desc","result,asc","result,desc","orgGroupName,asc","orgGroupName,desc","deadline,asc","deadline,desc","openRiskCount,asc","openRiskCount,desc","openInfoRequestCount,asc","openInfoRequestCount,desc"]},"example":"createdDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_PageLinkedAssessmentInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT_READ","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/un-archive":{"put":{"operationId":"unarchiveAssessmentsUsingPUT","summary":"Unarchive Assessment","description":"Use this API to unarchive a single assessment or multiple assessments. Multiple assessment IDs can be provided in the API request to unarchive assessments in bulk.\n\n > 🗒 Things to Know  \n > \n > - Unarchived assessments will be moved back to the Active list after unarchiving.\n > \n > - Unarchived assessments will be editable.\n > \n > - Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be unarchived.\n","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"examples":{"Single Assessment":{"summary":"Unarchive a single assessment","description":"Single Assessment","value":["550e8400-e29b-41d4-a716-446655440000"]},"Multiple Assessments":{"summary":"Unarchive multiple assessments in bulk","description":"Multiple Assessments","value":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001","550e8400-e29b-41d4-a716-446655440002"]}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{assessmentId}/export":{"get":{"operationId":"exportAssessmentUsingGET","summary":"Get Assessment","description":"Use this API to retrieve details of a specific assessment. The response will include details such as basic assessment information, respondents, approvers, assessment questions and responses, and assessment risks.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to export","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"excludeSkippedQuestions","in":"query","description":"Flag to exclude skipped questions from the export","required":false,"schema":{"type":"boolean","default":false},"example":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentExportInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT_READ","ASSESSMENT","INTEGRATION"]}]}},"/api/assessment/v2/assessments/{assessmentId}/metadata":{"patch":{"operationId":"updateBasicAssessmentDetailsUsingPATCH","summary":"Modify Assessment","description":"Use this API to update basic assessment details such as assessment name, assessment description, assessment deadline and reminder.\n \n > 🗒 Things to Know  \n > \n > - If the assessment is in **Completed** stage, updates made using this API will be ignored.\n > \n > - If an update is made using this API, an event will be shown in the Assessment Activity.\n > \n > - This API can update assessments of the following types: PIA, Vendor, ITRM, Control, Exchange and Incident.\n","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to update","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentBasicDetailsUpdateRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{assessmentId}/primary-records":{"put":{"operationId":"updatePrimaryRecordUsingPUT","summary":"Set Primary Record","description":"Use this API to edit the existing primary record or set a new primary record on an assessment. For the given `assessmentId`, the existing primary record will either be updated or a new primary record will be created using the attributes in the API request body.\n\n > 🗒 Things to Know  \n > \n > - If the template has a question with the primary record enabled, then the primary record is set as the response to that question and the related attributes and inventory questions will be pre-populated.\n > \n > - The primary record can be edited for Inventory and Assess Control primary record types.\n > \n > - The primary record list cannot be greater than 1 for Inventory primary record types.\n > \n > - The primary record list can be greater than 1 for Assess Control primary record types.\n","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to update primary record for","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentPrimaryRecordUpdateRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{assessmentId}/reassign":{"put":{"operationId":"reassignAssessmentUsingPUT","summary":"Reassign Assessment","description":"Use this API to reassign the organization, approvers, and/or respondents of an assessment. The assessment will be updated with the new organization, approvers, and/or respondents provided in the request body.\n\n > 🗒 Things to Know  \n > \n > - If the assessment is in **Completed** stage, reassignments made using this API will be ignored.\n > \n > - The reassigned respondents and/or approvers should exist in the `orgGroupId` provided in the request.\n > \n > - New respondents that do not already exist in the application will be created as Invited Users unless `PROJECT_RESPONDENT` is specified in the `respondentCreationType` parameter.\n > \n > - If an update is made using this API, an event will be shown in the Assessment Activity.\n > \n > - This API can update assessments of the following types: PIA, Vendor, ITRM, Control, Exchange, and Incident.\n > \n > - The `stageId` parameter values returned in the [Get Assessment Workflow Stages](/onetrust/reference/getworkflowdetailsforassessmentusingget) API response can be used to reassign approvers to different stages of an assessment.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to reassign","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ReassignAssessmentRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{assessmentId}/soft-delete":{"put":{"operationId":"softDeleteAssessmentUsingPUT","summary":"Move Assessment to Recycle Bin","description":"Use this API to soft delete an assessment by moving it to the recycle bin. The assessment will then be stored in the recycle bin until it is either restored or permanently deleted.\n\n > 🗒 Things to Know  \n > \n > - Only assessments found in the PIA & DPIA Automation and IT & Security Risk Management modules can be soft deleted.\n >\n > - Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be soft deleted.\n","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to soft delete","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{assessmentId}/tags":{"put":{"operationId":"addOrUpdateTagsUsingPUT","summary":"Update Assessment Tags","description":"Use this API to update the tags associated with a specific assessment. The tags submitted through this API will overwrite all existing tags on the assessment. \n\n > 🗒 Things to Know  \n > \n > - The [Get Assessment](/onetrust/reference/exportassessmentusingget) API can be used to retrieve the current list of assessment tags for the specified assessment. You can include these tags within the request of this API to keep them on the assessment.\n >\n > - New tags can be created using this API and can then be associated with an assessment.\n","tags":["Assessment Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to update tags for","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"Tags":{"description":"Tags","value":["GDPR","SIG","tag3"]}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{assessmentId}/tasks":{"post":{"operationId":"createTaskUsingPOST","summary":"Create Assessment Task","description":"Use this API to create new tasks on an assessment. Only a single task can be created on an assessment per API call.\n\n > 🗒 Things to Know  \n > \n > - Tasks cannot be created for the following assessment types:\n > \n > - Global Readiness Assessment\n >\n > - Readiness Assessment\n >\n > - Program Benchmarking\n >\n > - Dynamic Incident Notification Assessment\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"The unique ID of the assessment in which to create the task.","required":true,"schema":{"type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_TaskCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT","INTEGRATION"]}]}},"/api/assessment/v2/assessments/{assessmentId}/workflows":{"get":{"operationId":"getWorkflowDetailsForAssessmentUsingGET","summary":"Get Assessment Workflow Stages","description":"Use this API to retrieve workflow and approval stage details of an assessment. The response will include details such as the workflow ID, workflow name, stage ID, and stage name.\n\n > 🗒 Things to Know  \n >\n > - Workflow stage indicates the current stage of the workflow that the assessment is in.\n","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"The unique ID of the assessment to retrieve workflow details for","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_WorkflowAndApprovalStageDetails"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT_READ","ASSESSMENT","INTEGRATION"]}]}},"/api/assessment/v2/assessments/{id}/reassess":{"post":{"operationId":"reassessAssessmentUsingPOST","summary":"Reassess Assessment","description":"Use this API to launch a reassessment of an existing assessment. The reassessment will use the latest published template version.\n > 🗒 Things to Know  \n > \n > - Basic assessment details, such as name, organization, deadline, reminder, approver, and respondent, can be copied from the source assessment to the new assessment if the `copyAssessmentMetadata` parameter is set to `true`. Otherwise, `assessmentMetadata` can be passed through the API when the `copyAssessmentMetadata` parameter is set to `false`.\n > \n > - The responses, comments, attachments, notes, and linked risks from the original assessment can also be copied to the new assessment using this API.\n > \n > - The `archiveSourceAssessment` parameter can be used to indicate whether to archive the source assessment or not.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the assessment to be reassessed","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ReassessAssessmentRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{id}/reopen":{"post":{"operationId":"reopenAssessmentUsingPOST","summary":"Reopen Assessment","description":"Use this API to reopen a specific assessment to request more information from respondents. This action will move the assessment from the Completed stage to the Under Review stage and comments will be provided to the respondent in an email notification.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the assessment to reopen from Completed to Under Review stage","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ReopenAssessmentRequest"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v2/assessments/{id}/send-back":{"post":{"operationId":"sendBackAssessmentToInProgressUsingPOST","summary":"Send Back Assessment","description":"Use this API to send back a specific assessment to request more information from respondents. This action will move the assessment from the Under Review stage to the In Progress stage and comments will be provided to the respondent in an email notification.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the assessment to send back to the In Progress stage","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_SendBackAssessmentRequest"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v3/assessments":{"post":{"operationId":"createAssessmentUsingPOST","summary":"Launch Assessment","description":"Use this API to launch a new assessment. The new assessment will be created with the details provided in the request body and assigned to the indicated respondents. If the selected template includes an 'Approver-only' Section, a user with the \"Project Owner\" permission can be assigned to that section.\n\n > 🗒 Things to Know  \n > \n > - `inventoryDetails` information can be added in order to set a primary record and pre-populate inventory information on the assessment.\n > \n > - The `templateRootVersionId` parameter can be used instead of the `templateId` parameter to create the new assessment using the latest published version of a template.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/assessment/v3/assessments/list":{"post":{"operationId":"getAssessmentsUsingPOST","summary":"Get List of Assessments by Criteria","description":"Use this API to retrieve list of all the assessments or assessments by filter criteria like Approver Ids, Respondent Ids, Template Ids etc. The response will include details such as the assessment ID, number, stage, result, primary record, and associated organization.\n\n > 🗒 Things to Know  \n >\n > - All assessments regardless of their stage are returned in the response by default.\n >\n > - The assessments can be filtered by stage using the `assessmentStatuses, templateTypes, assessmentArchivalState` query parameter. Other than these commonly used filters, request body can be used to filter assessments by approver Ids, respondent Ids, template Ids, workflow stage name.","tags":["Assessments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"templateTypes","in":"query","description":"List of template types to filter assessments by. Available options:\n\n- **PIA** (PIA & DPIA Automation)\n- **VENDOR** (Third-Party Risk Management)\n- **ITRM** (IT & Security Risk Management)\n- **CONTROL** (Risk and Controls)\n- **INCIDENT** (Incident Management)\n- **EXCHANGE** (Third-Party Risk Exchange)\n- **ESG** (ESG Program Reporting)\n- **DISCLOSURE** (Disclosure Management)\n- **DISCLOSURE_YOY** (Year Over Year Disclosures)\n- **ERM** (Enterprise Risk Management)\n- **TPDD** (Third-Party Due Diligence)\n- **AIGOVERNANCE** (AI Governance)","required":false,"schema":{"type":"array","items":{"type":"string","description":"Template types used in assessments","enum":["PIA","VENDOR","ITRM","CONTROL","INCIDENT","EXCHANGE","ESG","DISCLOSURE","DISCLOSURE_YOY","ERM","TPDD","AIGOVERNANCE"]}},"example":["PIA","VENDOR","ITRM"]},{"name":"assessmentStatuses","in":"query","description":"List of assessment statuses to filter assessments by","required":false,"schema":{"type":"array","items":{"type":"string","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]}},"example":["IN_PROGRESS","UNDER_REVIEW"]},{"name":"assessmentArchivalState","in":"query","description":"Filter assessments by their archival state. Use ALL to include both archived and non-archived assessments, ARCHIVED to include only archived assessments, or NON_ARCHIVED to include only non-archived assessments.","required":false,"schema":{"type":"string","example":"NON_ARCHIVED","default":"NON_ARCHIVED","enum":["ALL","ARCHIVED","NON_ARCHIVED"]}},{"name":"page","in":"query","description":"Results page to be retrieved (0..N). Example- '?page=1","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1…N).","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","default":"createdDate,desc","enum":["number,asc","number,desc","status,asc","status,desc","createdDate,asc","createdDate,desc","name,asc","name,desc","result,asc","result,desc","orgGroupName,asc","orgGroupName,desc","deadline,asc","deadline,desc","openRiskCount,asc","openRiskCount,desc","openInfoRequestCount,asc","openInfoRequestCount,desc"]},"example":"createdDate,desc"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentListRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentListResponseListAssessmentListViewResponseV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT_READ","ASSESSMENT"]}]}},"/api/assessment/v3/assessments/{assessmentId}/approve":{"post":{"operationId":"approveAssessmentUsingPOST","summary":"Approve Assessment","description":"Use this API to move an assessment to Completed stage. The assessment should be submitted before invoking this API.\n","tags":["Assessment Actions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"assessmentId","in":"path","description":"UUID of the assessment to approve","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ClosureRequest"}}}},"responses":{"204":{"description":"Assessment approved successfully. No content returned.","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"deprecated":true,"security":[{"PrivacyAutomation-AssessmentAutomation_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/template/v1/published-template-metadata":{"get":{"operationId":"getAllBasicTemplateDetailsUsingGET","summary":"Get List of Templates","description":"Use this API to retrieve the details of all the published templates. The response includes basic template details such as the template name, template root version ID, and template type.\n\n > 🗒 Things to Know\n > \n > - The following template types are available:\n > \n > <details>\n > \n > <summary><b>Template Types</b></summary>\n > \n > CONTROL: Control templates created in IT & Security Risk Management\n > \n > DISCLOSURE: Disclosure Management\n > \n > ESG: ESG Program Reporting & Disclosures\n > \n > EXCHANGE: Third-Party Risk Exchange\n > \n > INCIDENT: Incident Management\n > \n > ITRM: IT & Security Risk Management\n > \n > PIA: PIA & DPIA Automation\n > \n > VENDOR: Third-Party Risk Management\n > \n > </details>\n > \n > - If the template type is not specified in the API request body, all template types will be included in the response.","tags":["Template"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"template-types","in":"query","description":"The array of template types to filter by when retrieving published templates.","required":false,"schema":{"type":"array","items":{"type":"string","description":"Template types to filter by. If not specified, all template types will be included.","enum":["CONTROL","DISCLOSURE","ESG","EXCHANGE","INCIDENT","ITRM","PIA","VENDOR"],"example":["CONTROL","ITRM"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template_TemplateBasicDetailsDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"Template_OAUTH2":["INTEGRATION","ASSESSMENT_READ","ASSESSMENT"]}]}},"/api/template/v2/templates/import":{"post":{"operationId":"importTemplateByIdUsingPOST","summary":"Import Template","description":"Use this API to import the metadata of a specific template in JSON format in order to migrate the template from one environment/tenant to another environment/tenant. Before calling this API, use the [Export Template](/onetrust/reference/exporttemplatewithbusinesskeysusingget) API to obtain the template metadata in JSON format. The JSON response body obtained from the Export Template API can then be pasted within the Import Template request body (BODY PARAMS).\n\n > 🗒 Things to Know\n > \n > - After the import, the template will reflect on the Templates page in Draft status.\n >\n > - If a template with the same name already exists on the destination environment, then the migration will fail (HTTP Response Status Code 400: Duplicate template name). Please ensure that no templates (Active or Archived) already exist with the same name as the template being migrated.\n >\n > - If your template contains questions linked to custom inventory attributes, it is crucial that the same attributes have already been created in the destination environment/tenant and are an identical match.","tags":["Template"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"matchAttributesByName","in":"query","description":"The flag indicating whether to match attributes by name during template import.","required":true,"schema":{"description":"If true, will match attributes by name during import","type":"boolean","example":true}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","example":"{\"template\": {\"id\": \"7d271be5-0601-4190-96a7-65d7c427a725\", \"name\": \"OnePIA\", \"status\": \"PUBLISHED\" }","additionalProperties":true}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template_TemplateCreateResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"Template_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/template/v2/templates/root-version/{rootVersionId}/templates":{"delete":{"operationId":"deleteTemplateVersionsUsingDELETE","summary":"Delete Template","description":"The API can be used to delete a template using its root version identifier.\n\n > 🗒 Things to Know\n > \n > - The template should not be associated with any Assessment or any action rules of other templates.\n >\n > - Template of specific types PIA, VENDOR, ITRM, CONTROL, INCIDENT, EXCHANGE, ESG, DISCLOSURE, ERM, TPDD, DISCLOSURE_YOY can be deleted using the API.\n >\n > - The root version identifier of a template can be retrieved by calling the [Get List of Templates](/onetrust/reference/getallbasictemplatedetailsusingget) API.","tags":["Template"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"rootVersionId","in":"path","description":"The root version identifier of the template to be deleted.","required":true,"schema":{"description":"The UUID of the root version of the template to delete","type":"string","format":"uuid","example":"7d271be5-0601-4190-96a7-65d7c427a725"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"Template_OAUTH2":["INTEGRATION","ASSESSMENT"]}]}},"/api/template/v2/templates/{templateId}/export":{"get":{"operationId":"exportTemplateWithBusinessKeysUsingGET","summary":"Export Template","description":"Use this API to export the metadata of a specific template in JSON format in order to migrate the template from one environment/tenant to another environment/tenant. The response body will be returned in JSON format and will include template details such as questions, rules, skip/show logic, etc. \n\n > 🗒 Things to Know\n >\n > - The JSON response body returned by this API can be pasted within the [Import Template](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/importtemplatebyidusingpost) API's request body to import the metadata of the template into the environment/tenant.\n > - The `templateRootVersionId` must be passed as the value for the `templateId` parameter if you are passing the `templateVersion` query parameter in the request.\n > - The response of this API will vary based on whether the `templateVersion` parameter is passed.\n > - If this parameter is not passed, then the template corresponding to the `templateId` will be exported.\n > - If a specific version value is passed for this parameter, then that version of the template will be exported.\n > - If `latest` is passed for this parameter, then the latest version of the template will be exported.","tags":["Template"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/privacy-automation-assessment-automation.json"},"parameters":[{"name":"templateId","in":"path","description":"The unique identifier of the template to export.","required":true,"schema":{"description":"The UUID of the template to export","type":"string","format":"uuid","example":"7d271be5-0601-4190-96a7-65d7c427a725"}},{"name":"templateVersion","in":"query","description":"The specific version of the template to export or 'latest' for newest version.","required":false,"schema":{"description":"The version of the template to export. If not specified, exports the template corresponding to templateId. If 'latest' is passed, exports the latest version of the template.","type":"string","example":"latest"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","example":{"template":{"id":"7d271be5-0601-4190-96a7-65d7c427a725","name":"OnePIA","status":"PUBLISHED"}},"additionalProperties":true}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"Template_OAUTH2":["INTEGRATION","ASSESSMENT_READ","ASSESSMENT"]}]}}},"components":{"schemas":{"PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest":{"type":"object","properties":{"approverId":{"description":"Unique identifier for the approver","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"approverName":{"description":"Display name of the approver","type":"string","example":"John Doe"},"comment":{"description":"Optional comment for the approver assignment","type":"string","example":"Primary approver"},"workflowStageIds":{"type":"array","items":{"format":"uuid","description":"Workflow stage identifier","example":"550e8400-e29b-41d4-a716-446655440000"},"uniqueItems":true}},"required":["approverId"]},"PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest":{"type":"object","properties":{"respondentId":{"description":"Unique identifier for the respondent user","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"respondentName":{"description":"Display name of the respondent","type":"string","example":"John Doe"},"comment":{"description":"Optional comment for the respondent assignment","type":"string","example":"Assessment responses added"},"sectionIds":{"type":"array","items":{"format":"uuid","description":"Section identifier","example":"550e8400-e29b-41d4-a716-446655661111"},"uniqueItems":true},"isRespondentOfApproverSection":{"description":"Flag indicating whether this respondent is assigned to approver sections","type":"boolean","example":false,"default":"false"}},"required":["respondentName"]},"PrivacyAutomation-AssessmentAutomation_ReassignAssessmentRequest":{"type":"object","properties":{"orgGroupId":{"description":"The ID of the organization that the assessment should be reassigned to","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"approvers":{"description":"The user(s) that will override the current approvers if any are added","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest","minItems":0},"example":[{"approverId":"550e8400-e29b-41d4-a716-446655440001","approverName":"John Doe","comment":"Primary approver"}],"minItems":0,"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"}}},"respondents":{"description":"The user(s) that will override the current respondents if any are added","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest","minItems":0},"example":[{"respondentId":"550e8400-e29b-41d4-a716-446655440002","respondentName":"Jane Smith","comment":"Main respondent","sectionIds":["550e8400-e29b-41d4-a716-446655440003"],"isRespondentOfApproverSection":false}],"minItems":0,"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"}}},"respondentCreationType":{"description":"If adding new users that don't already exist, this is the type of user they will be created as","type":"string","example":"INVITED","default":"INVITED","enum":["INVITED","PROJECT_RESPONDENT"]}}},"PrivacyAutomation-AssessmentAutomation_AssessmentPrimaryRecordUpdateRequest":{"type":"object","properties":{"primaryRecordType":{"description":"Type of Inventory record to be updated.","type":"string","example":"ASSETS","enum":["ASSETS","PROCESSING_ACTIVITY","VENDORS","ENTITIES","ASSESS_CONTROL","ENGAGEMENT"]},"primaryRecordIds":{"description":"The unique UUIDs of the primary records","type":"array","items":{"type":"string","format":"uuid"},"example":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"],"minimum":1,"minItems":1,"uniqueItems":true}},"required":["primaryRecordIds","primaryRecordType"]},"PrivacyAutomation-AssessmentAutomation_ReminderScheduleDto":{"type":"object","properties":{"id":{"description":"Unique identifier for the reminder schedule.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assessmentId":{"description":"Identifier of the assessment this reminder schedule applies to.","type":"string","format":"uuid","example":"8f14e45f-ea9e-4d1b-9b5f-42d5f6a8b9c1"},"sectionId":{"description":"Identifier of a specific assessment section this reminder schedule targets (optional).","type":"string","format":"uuid","example":"9a1b2c3d-4e5f-6789-abcd-ef0123456789"},"reminderInterval":{"description":"Interval in days between consecutive reminders.","type":"integer","format":"int32","example":7},"reminderReceiverEntityType":{"description":"Recipient type who will receive the reminder notifications.","type":"string","example":"RESPONDENT","enum":["APPROVER","RESPONDENT","ALL"]}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","assessmentId":"8f14e45f-ea9e-4d1b-9b5f-42d5f6a8b9c1","sectionId":"9a1b2c3d-4e5f-6789-abcd-ef0123456789","reminderInterval":7,"reminderReceiverEntityType":"RESPONDENT"},"required":["reminderReceiverEntityType"]},"PrivacyAutomation-AssessmentAutomation_ApproverOnlySectionRespondentRequest":{"type":"object","properties":{"respondentId":{"description":"Id of the respondent for approver only sections","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"respondentName":{"description":"Name of the respondent for approver only sections","type":"string","example":"John Doe"}}},"PrivacyAutomation-AssessmentAutomation_AssessableEntityDetail":{"type":"object","properties":{"id":{"description":"ID of the assessable entity","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"description":"Name of the assessable entity","type":"string","example":"Vendor name"},"number":{"description":"Number of the assessable entity","type":"integer","format":"int64","example":1},"relationshipResponseDetails":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_RelationshipResponseDetailsDto"}},"displayName":{"description":"Display name of the entity","type":"string","example":"Vendor display name","readOnly":true},"entityBusinessKey":{"description":"Business Key of the entity","type":"string","example":"Vendor business key"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentAttachmentRequest":{"type":"object","properties":{"attachmentId":{"description":"Unique identifier for the attachment","type":"string","format":"uuid","example":"456e7890-e89b-12d3-a456-426614174000"},"fileName":{"description":"Name of the file being attached to the assessment","type":"string","example":"Privacy_Impact_Assessment_Report.pdf"},"fileDescription":{"description":"Optional description of the attached file and its relevance to the assessment","type":"string","example":"Comprehensive privacy impact assessment report for customer data processing activities"}},"example":{"attachmentId":"456e7890-e89b-12d3-a456-426614174000","fileName":"Privacy_Impact_Assessment_Report.pdf","fileDescription":"Comprehensive privacy impact assessment report for customer data processing activities"},"required":["attachmentId","fileName"]},"PrivacyAutomation-AssessmentAutomation_AssessmentCreateRequest":{"type":"object","properties":{"workflowId":{"description":"Workflow identifier for which the assessment is associated with","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"description":"Name of the assessment","type":"string","example":"GDPR Assessment","maxLength":2500,"minLength":0},"description":{"description":"Description of the assessment","type":"string","example":"Annual GDPR compliance assessment"},"orgGroupId":{"description":"Organization group identifier to which the assessment should belong","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"orgGroupName":{"description":"Organization group name to which the assessment should belong","type":"string","example":"Legal Department"},"approverId":{"description":"Approver identifier of the assessment (deprecated, use approvers list instead)","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","deprecated":true},"approverName":{"description":"Approver name of the assessment (deprecated, use approvers list instead)","type":"string","example":"John Smith","deprecated":true},"approvers":{"description":"List of approvers for the assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"},"example":[{"approverId":"550e8400-e29b-41d4-a716-446655440001","approverName":"Jane Smith","comment":"Primary approver"}],"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"}}},"templateId":{"description":"Template identifier for which the assessment has to be created (mandatory if templateRootVersionId is not provided)","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"templateRootVersionId":{"description":"Template root version identifier for which the assessment has to be created","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"deadline":{"description":"Deadline to complete the assessment (format: YYYY-MM-DDTHH:MM:SS.FFFZ)","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"reminder":{"description":"Number of days before the deadline when the reminder should be sent to the respondent","type":"integer","format":"int64","example":7},"reminderSchedules":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ReminderScheduleDto","uniqueItems":true},"uniqueItems":true},"respondents":{"description":"List of respondents. A minimum of one respondent must be assigned to the assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"},"example":[{"respondentId":"550e8400-e29b-41d4-a716-446655440002","respondentName":"John Doe","comment":"Primary respondent"}],"maxItems":2147483647,"minimum":1,"minItems":1,"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"}}},"approverOnlySectionRespondents":{"description":"List of respondents for approver-only sections","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ApproverOnlySectionRespondentRequest"},"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ApproverOnlySectionRespondentRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ApproverOnlySectionRespondentRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ApproverOnlySectionRespondentRequest"}}},"respondentCreationType":{"description":"Type of user creation for respondents","type":"string","example":"INVITED","default":"INVITED","enum":["INVITED","PROJECT_RESPONDENT"]},"inventoryDetails":{"description":"If the assessment is for an inventory, contains the inventory identifier and type","example":{"inventoryId":"550e8400-e29b-41d4-a716-446655440000","inventoryType":"ASSET"},"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentInventoryRequest"},"incidentDetails":{"description":"If the assessment is for an incident, contains the incident identifier and type","example":{"incidentId":"550e8400-e29b-41d4-a716-446655440000"},"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentIncidentRequest"},"controlImplementationDetails":{"description":"Populated when Control Implementations are selected as Primary for Assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ControlImplementationRequest"},"example":[{"controlImplementationId":"550e8400-e29b-41d4-a716-446655440000"}]},"primaryEntityDetails":{"description":"Populated when Business Object needs to be selected as Primary for Assessment (except Inventory, Incident, Control Implementations and Engagements)","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessableEntityDetail"}},"primaryRecordTypeReference":{"description":"Type of primary record when primaryEntityDetails are populated","type":"string","example":"INVENTORY"},"engagementLink":{"description":"If the assessment is launched from engagement, contains the engagement identifier","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentEngagementLinkRequest"},"ruleId":{"description":"Identifier of the rule that triggered this assessment creation","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"triggeredByAssessmentId":{"description":"Identifier of the assessment that triggered this assessment creation","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"triggeredByAssessmentName":{"description":"Name of the assessment that triggered this assessment creation","type":"string","example":"Parent GDPR Assessment"},"tags":{"description":"List of tag identifiers to attach to the assessment during creation","type":"array","items":{"type":"string"},"example":["tag1","tag2"]},"userAssignmentMode":{"description":"Mode of user assignment for the assessment","type":"string","example":"ASSESSMENT","default":"ASSESSMENT","enum":["ASSESSMENT","SECTION"]},"creationSource":{"description":"Source of assessment creation","type":"string","example":"DEFAULT","default":"DEFAULT","enum":["RULE_ENGINE_ASSESSMENT_SOURCE","DEFAULT","COPY","REASSESS","BULK_IMPORT","INVENTORY_STAGE_RULES"]},"checkForInFlightAssessments":{"description":"Whether to check if any in-flight (status < COMPLETED) assessments exist with the same templateRootVersionId","type":"boolean","example":false,"default":"false"},"defaultTemplateDeadlineReminder":{"type":"boolean"},"labels":{"description":"List of labels to attach to the assessment","type":"array","items":{"type":"string"},"example":["label1","label2"]},"entityLabels":{"description":"List of entity attribute labels for the assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentQuestionLabelDto"}},"duplicateNotAllowed":{"type":"boolean","example":false,"default":"false"},"attachmentRequests":{"description":"List of assessment attachment request","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentAttachmentRequest"}}},"required":["name","respondents"]},"PrivacyAutomation-AssessmentAutomation_AssessmentEngagementLinkRequest":{"type":"object","properties":{"engagementId":{"description":"Engagement identifier for which the assessment is created","type":"string","format":"uuid","example":"987e6543-e21b-12d3-a456-426614174000"},"engagementName":{"description":"Name of the engagement linked to the assessment","type":"string","example":"Q4 2024 Vendor Risk Assessment Engagement"},"number":{"description":"Sequential number assigned to the engagement","type":"integer","format":"int64","example":2024001}},"example":{"engagementId":"987e6543-e21b-12d3-a456-426614174000","engagementName":"Q4 2024 Vendor Risk Assessment Engagement","number":2024001},"required":["engagementId","engagementName"]},"PrivacyAutomation-AssessmentAutomation_AssessmentIncidentRequest":{"type":"object","properties":{"incidentId":{"description":"Unique identifier for the incident associated with the assessment","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"incidentName":{"description":"Name of the incident associated with the assessment","type":"string","example":"Data Breach - Customer Database Compromise"}},"example":{"incidentId":"123e4567-e89b-12d3-a456-426614174000","incidentName":"Data Breach - Customer Database Compromise"},"required":["incidentId","incidentName"]},"PrivacyAutomation-AssessmentAutomation_AssessmentInventoryRequest":{"type":"object","properties":{"inventoryId":{"description":"Inventory ID for which the assessment is created","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"inventoryTypeId":{"description":"Type of the inventory for which the assessment is created","type":"integer","format":"int64","example":1},"inventoryTypeName":{"description":"type name of the inventory for which the assessment is created.","type":"string","example":"Data Processing Activity"},"inventoryNumber":{"description":"External number of the inventory for which the assessment is created","type":"integer","format":"int64","example":12345},"inventoryName":{"description":"Name of the inventory for which the assessment is created","type":"string","example":"Customer Data Processing for Marketing"}},"example":{"inventoryId":"550e8400-e29b-41d4-a716-446655440000","inventoryTypeId":1,"inventoryTypeName":"Data Processing Activity","inventoryNumber":12345,"inventoryName":"Customer Data Processing for Marketing"},"required":["inventoryId","inventoryName","inventoryNumber","inventoryTypeId"]},"PrivacyAutomation-AssessmentAutomation_AssessmentQuestionLabelDto":{"type":"object","properties":{"name":{"description":"Display name of the label","type":"string","example":"Personal Data Processing"},"nameKey":{"description":"Internationalization key for the label name","type":"string","example":"label.personal.data.processing"},"referenceEntity":{"description":"Type of the reference entity this label is associated with","type":"string","example":"DATA_CATEGORY","enum":["DATA_CATEGORY","PROCESSING_PURPOSE","LEGAL_BASIS","DATA_SUBJECT","RETENTION_PERIOD","TRANSFER_METHOD","SECURITY_MEASURE"]},"valueRefId":{"description":"Unique identifier of the referenced entity value. Null for custom labels.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"valueKey":{"description":"Internationalization key for the referenced entity value","type":"string","example":"data.category.personal.information"}},"example":{"name":"Personal Data Processing","nameKey":"label.personal.data.processing","referenceEntity":"DATA_CATEGORY","valueRefId":"123e4567-e89b-12d3-a456-426614174000","valueKey":"data.category.personal.information"},"required":["name"]},"PrivacyAutomation-AssessmentAutomation_ControlImplementationRequest":{"type":"object","properties":{"controlImplementationId":{"description":"Unique identifier for the control implementation","type":"string","format":"uuid","example":"789e4567-e89b-12d3-a456-426614174000"},"controlImplementationName":{"description":"Name of the control implementation","type":"string","example":"SOC 2 Type II Access Control Implementation"},"controlImplementationNumber":{"description":"External number of the control implementation","type":"integer","format":"int64","example":98765},"sourceId":{"description":"Unique identifier for the source entity associated with the control implementation","type":"string","format":"uuid","example":"456e7890-e89b-12d3-a456-426614174000"},"sourceName":{"description":"Name of the source entity associated with the control implementation","type":"string","example":"Customer Portal Application"},"sourceType":{"description":"Type of the source entity associated with the control implementation","type":"string","example":"APPLICATION","enum":["APPLICATION","SYSTEM","DATABASE","NETWORK","INFRASTRUCTURE"]},"entityBusinessKey":{"description":"Business key for the control implementation entity","type":"string","example":"98765|SOC 2 Type II Access Control Implementation"}},"example":{"controlImplementationId":"789e4567-e89b-12d3-a456-426614174000","controlImplementationName":"SOC 2 Type II Access Control Implementation","controlImplementationNumber":98765,"sourceId":"456e7890-e89b-12d3-a456-426614174000","sourceName":"Customer Portal Application","sourceType":"APPLICATION","entityBusinessKey":"98765|SOC 2 Type II Access Control Implementation"},"required":["controlImplementationId","controlImplementationName"]},"PrivacyAutomation-AssessmentAutomation_RelationshipResponseDetailsDto":{"type":"object","properties":{"relationshipNodeType":{"description":"Type of the relationship node","type":"string","example":"ASSESSMENT","minLength":1},"entityId":{"description":"Unique identifier of the related entity","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"entityDisplayName":{"description":"Display name of the related entity","type":"string","example":"Customer Data Assessment","minLength":1},"entityType":{"description":"Type information of the related entity","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_entityType"}},"example":{"relationshipNodeType":"ASSESSMENT","entityId":"123e4567-e89b-12d3-a456-426614174000","entityDisplayName":"Customer Data Assessment","entityType":{"id":1,"name":"Privacy Impact Assessment","description":"Assessment type for privacy impact evaluation"}},"required":["entityId","entityType"]},"PrivacyAutomation-AssessmentAutomation_entityType":{"type":"object","properties":{"id":{"description":"The unique identifier for the entity type.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the entity type.","type":"string","example":"Vendor"},"seeded":{"description":"This parameter indicates whether the entity type is seeded or custom.","type":"boolean","example":true},"moduleName":{"description":"The name of the module where the entity exists.","type":"string","example":"CustomEntityManagement"},"schemaName":{"description":"The name of the schema.","type":"string","example":"vendor"}},"required":["id","name"]},"PrivacyAutomation-AssessmentAutomation_ClosureRequest":{"type":"object","properties":{"forceOverride":{"description":"Flag to force override any validation errors during closure","type":"boolean","example":false,"default":"false"},"excludeRules":{"description":"Flag to exclude rule execution during closure","type":"boolean","example":false,"default":"false"},"closureComment":{"description":"Comment to include with the assessment closure","type":"string","example":"Approved after thorough review. All requirements have been met."},"resultId":{"description":"Identifier of the result option to apply to the assessment","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"attestationRequired":{"description":"Flag indicating whether attestation is required for closure","type":"boolean","example":false,"default":"false"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentListRequest":{"type":"object","properties":{"filterCriteria":{"description":"List of reminder schedules to trigger notifications to configured users (respondents or approvers)","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_SearchCriteriaInformation"},"example":[{"reminderType":"DEADLINE","daysBeforeDeadline":7,"userTypes":["RESPONDENT"]}]},"assessmentListViewType":{"description":"Load assessments for corresponding view types","type":"string","example":"ASSESSMENT_AUTOMATION_LIST_VIEW","enum":["VENDOR_VIEW","CONTROL_VIEW","ASSESSMENT_AUTOMATION_LIST_VIEW","DATA_MAPPING_LIST_VIEW","ITRM_LIST_VIEW","INCIDENT_LIST_VIEW","ESG_LIST_VIEW","ENGAGEMENT_LIST_VIEW","EXCHANGE_LIST_VIEW","DISCLOSURE_LIST_VIEW","EMPLOYEE_DISCLOSURE_LIST_VIEW","TPDD_LIST_VIEW","GENERAL_LIST"]},"visibleColumns":{"type":"array","items":{"type":"string","example":"number"},"maxItems":2147483647,"minItems":1},"adminOnlyView":{"description":"Loads admin view","type":"boolean","example":false,"default":"false"}},"required":["assessmentListViewType","visibleColumns"]},"PrivacyAutomation-AssessmentAutomation_SearchCriteriaInformation":{"type":"object","properties":{"field":{"description":"The field name to apply the search criterion to","type":"string","example":"status"},"operation":{"description":"The operation to apply (eq, ne, gt, lt, in, between, etc.)","type":"string","example":"eq"},"value":{"description":"The value to compare against. Can be a single value or a list of values depending on the operation","type":"object"},"toValue":{"description":"The upper bound value for 'between' operations","type":"object"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentListResponseListAssessmentListViewResponseV2":{"type":"object","properties":{"content":{"description":"The assessment data content","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentListViewResponseV2"},"type":"array"},"page":{"description":"Pagination information for the response","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentPage"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentListViewResponseV2":{"type":"object","properties":{"assessmentId":{"description":"Unique identifier for the assessment","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"number":{"description":"Assessment number used for reference","type":"integer","format":"int32","example":1001},"name":{"description":"Name of the assessment","type":"string","example":"GDPR Compliance Assessment"},"status":{"description":"Current status of the assessment","type":"string","example":"IN_PROGRESS","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]},"result":{"description":"Result of the assessment approval process","type":"string","example":"APPROVED"},"orgGroupId":{"description":"Unique identifier of the organization group this assessment belongs to","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"orgGroupName":{"description":"Name of the organization group this assessment belongs to","type":"string","example":"Marketing Department"},"assessmentCreatedBy":{"description":"Details of the user who created the assessment","example":{"id":"123e4567-e89b-12d3-a456-426614174000","fullName":"John Doe","email":"john.doe@example.com","deleted":false,"assigneeType":"USER"},"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"respondent":{"type":"string"},"respondents":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"uniqueItems":true},"approver":{"type":"string"},"creator":{"description":"Name of the assessment creator","type":"string","example":"John Doe"},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"uniqueItems":true},"deadline":{"description":"Deadline date for assessment completion","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"createDT":{"description":"Date and time when the assessment was created","type":"string","format":"date-time","example":"2025-01-15T10:30:00Z"},"createdBy":{"description":"Unique identifier of the user who created the assessment","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174002"},"completedOn":{"description":"Date and time when the assessment was completed","type":"string","format":"date-time","example":"2025-06-15T14:45:00Z"},"templateId":{"description":"Unique identifier of the template used for this assessment","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174003"},"templateRootVersionId":{"description":"Unique identifier of the template root version","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174004"},"templateName":{"description":"Name of the template used for this assessment","type":"string","example":"GDPR PIA Template"},"assessmentRiskLevelId":{"description":"Identifier of the assessment risk level","type":"integer","format":"int64","example":3},"assessmentRiskScore":{"description":"Numerical score representing the assessment risk","type":"number","format":"decimal","example":7.5},"assessmentRiskLevelName":{"description":"Name of the assessment risk level","type":"string","example":"HIGH"},"templateType":{"description":"Type of the assessment template","type":"string","example":"PIA","enum":["PIA","VENDOR","ITRM","CONTROL","INCIDENT","EXCHANGE","ESG","DISCLOSURE","DISCLOSURE_YOY","ERM","TPDD","AIGOVERNANCE"],"x-enumDescriptions":{"ERM":"Enterprise Risk Management","AIGOVERNANCE":"AI Governance","ITRM":"IT & Security Risk Management","DISCLOSURE":"Disclosure Management","INCIDENT":"Incident Management","ESG":"ESG Program Reporting","PIA":"PIA & DPIA Automation","VENDOR":"Third-Party Risk Management","TPDD":"Third-Party Due Diligence","EXCHANGE":"Third-Party Risk Exchange","DISCLOSURE_YOY":"Year Over Year Disclosures","CONTROL":"Risk and Controls"}},"templateVersion":{"description":"Version number of the template","type":"integer","format":"int32","example":2},"editAllResponsesWhenInProgress":{"description":"Flag indicating if all responses can be edited when assessment is in progress","type":"boolean","example":true},"deletedDT":{"description":"Date and time when the assessment was deleted (if applicable)","type":"string","format":"date-time","example":"2025-07-20T09:15:00Z"},"deletedBy":{"description":"Unique identifier of the user who deleted the assessment","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174005"},"assessmentDeletedBy":{"description":"Details of the user who deleted the assessment","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"pendingReviews":{"description":"Comma-separated list of pending reviewer names","type":"string","example":"Charlie Brown, Diana Prince"},"pendingReviewers":{"description":"Set of pending reviewer user details","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"uniqueItems":true},"submittedDT":{"description":"Date and time when the assessment was submitted","type":"string","format":"date-time","example":"2025-05-10T16:20:00Z"},"canResendLink":{"description":"Flag indicating if assessment link can be resent","type":"boolean","example":true},"inherentRiskScore":{"description":"Numerical score representing the inherent risk","type":"number","format":"decimal","example":8.2},"inherentRiskLevelId":{"description":"Identifier of the inherent risk level","type":"integer","format":"int64","example":4},"inherentRiskLevelName":{"description":"Name of the inherent risk level","type":"string","example":"CRITICAL"},"primaryRecordName":{"description":"Name of the primary record associated with this assessment","type":"string","example":"Customer Database"},"primaryRecordNumber":{"description":"Reference number of the primary record","type":"string","example":"DB-2025-001"},"targetRiskScore":{"description":"Target numerical score for risk after mitigation","type":"number","format":"decimal","example":3.5},"targetRiskLevelId":{"description":"Identifier of the target risk level","type":"integer","format":"int64","example":2},"targetRiskLevelName":{"description":"Name of the target risk level","type":"string","example":"MEDIUM"},"workflowId":{"description":"Unique identifier of the workflow","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174006"},"workflowStageId":{"description":"Unique identifier of the current workflow stage","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174007"},"workflowName":{"description":"Name of the workflow","type":"string","example":"Standard PIA Approval Process"},"approvalStageName":{"description":"Name of the current approval stage","type":"string","example":"Legal Review"},"badgeColor":{"description":"Color code for the approval stage badge","type":"string","example":"#4287f5"},"updatedDT":{"description":"Date and time when the assessment was last updated","type":"string","format":"date-time","example":"2025-07-01T11:25:30Z"},"assessmentDeleteStatus":{"description":"Status of assessment deletion","type":"string","example":"SOFT_DELETED","enum":["ACTIVE","SOFT_DELETED","HARD_DELETED"]},"attestationRequired":{"description":"Flag indicating if attestation is required","type":"boolean","example":true},"attestationCompleted":{"description":"Date and time when attestation was completed","type":"string","format":"date-time","example":"2025-06-20T14:30:00Z"},"finalComment":{"description":"Final comment provided on the assessment","type":"string","example":"All requirements have been met with appropriate controls in place."},"openRiskCount":{"description":"Count of open risks associated with this assessment","type":"integer","format":"int32","example":3,"minimum":0},"openInfoRequestCount":{"description":"Count of open information requests associated with this assessment","type":"integer","format":"int32","example":2,"minimum":0},"tags":{"description":"Comma-separated list of tags associated with the assessment","type":"string","example":"GDPR,High Priority,Marketing"},"redacted":{"description":"Flag indicating if the assessment is redacted","type":"boolean","example":false}}},"PrivacyAutomation-AssessmentAutomation_AssessmentPage":{"type":"object","properties":{"number":{"description":"Current page number (zero-based)","type":"integer","format":"int64","example":0},"size":{"description":"Number of items per page","type":"integer","format":"int64","example":20},"totalElements":{"description":"Total number of elements across all pages","type":"integer","format":"int64","example":100},"totalPages":{"description":"Total number of pages available","type":"integer","format":"int64","example":5}}},"PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail":{"type":"object","properties":{"id":{"description":"Unique identifier of the user","type":"string","format":"uuid"},"fullName":{"description":"Full name of the user","type":"string"},"email":{"description":"Email address of the user","type":"string"},"deleted":{"description":"Flag indicating whether the user has been deleted","type":"boolean"},"assigneeType":{"description":"Type of assignee (e.g., USER, GROUP)","type":"string"}}},"PrivacyAutomation-AssessmentAutomation_SendBackAssessmentRequest":{"type":"object","properties":{"emailComment":{"description":"Comment to be put in notification email.","type":"string","example":"Assessment needs additional data."},"sendBulkInfoRequestEmail":{"description":"Use this field to send notifications at the same time to the users to get more information on several questions.","type":"boolean","example":false,"default":"false"},"editAllResponses":{"description":"Use this field to all respondents to edit any question response when an assessment is sent back.","type":"boolean","example":false,"default":"false"},"resetApproverReviews":{"description":"When an assessment is sent back, the approver’s vote is either retained or removed depending on the setting.","type":"boolean","example":false,"default":"false"},"reopenSectionIds":{"type":"array","items":{"type":"string","format":"uuid","description":"When an assessment is sent back, these sections will be reopened.","example":"550e8400-e29b-41d4-a716-446655440000"},"uniqueItems":true}}},"PrivacyAutomation-AssessmentAutomation_ReopenAssessmentRequest":{"type":"object","properties":{"emailComment":{"description":"Comment to be put in notification email when the assessment is reopened","type":"string","example":"Assessment reopened for additional review and data collection"}}},"PrivacyAutomation-AssessmentAutomation_ReassessAssessmentRequest":{"type":"object","properties":{"assessmentMetadata":{"description":"Use this field to provide details such as Assessment name, Description, Organization, Approvers and Respondents, when copyAssessmentMetadata value is false.","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_assessmentMetadata"},"deadline":{"description":"Deadline (date) to complete the assessment","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"reminder":{"description":"Use this field to input the number of days before the deadline to send a automatic notification to the respondent. Deadline must be set for this field to be enabled.","type":"integer","format":"int64","example":7},"reminderSchedules":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ReminderScheduleDto"},"uniqueItems":true},"copyAttachments":{"description":"This field will copy over the attachments linked to the source assessment.","type":"boolean","example":true,"default":"false"},"copyResponses":{"description":"This field will copy over the question responses from the source assessment.","type":"boolean","example":true,"default":"false"},"copyNotes":{"description":"This field will copy over the user notes from the source assessment.","type":"boolean","example":true,"default":"false"},"copyComments":{"description":"This field will copy over the comments from the source assessment.","type":"boolean","example":true,"default":"false"},"linkRisks":{"description":"Any risk rules created based on the template risk rules for the original assessment will be linked to the newly created assessment upon submission.","type":"boolean","example":true,"default":"false"},"copyAssessmentMetadata":{"description":"This field will copy assessment name, description, organisation, approver, respondent details from source assessment to new assessment.","type":"boolean","example":true,"default":"false"},"archiveSourceAssessment":{"description":"Use this field to provide a \"true\" or a \"false\" value to archive the original assessment. When reassessing, setting it to \"true\" will archive the original assessment and setting it to \"false\" will not archive the original assessment","type":"boolean","example":false,"default":"false"}}},"PrivacyAutomation-AssessmentAutomation_assessmentMetadata":{"type":"object","properties":{"name":{"description":"Name of the assessment","type":"string"},"description":{"description":"Description about the assessment","type":"string"},"orgGroupId":{"description":"Organization Group ID to which the assessment belongs to","type":"string","format":"uuid"},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"},"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentApproverRequest"}}},"respondents":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"},"properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"}},"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"},"last":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentRespondentRequest"}}},"respondentCreationType":{"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.","type":"string","enum":["INVITED","PROJECT_RESPONDENT"]}}},"PrivacyAutomation-AssessmentAutomation_TaskCollaboratorDto":{"type":"object","properties":{"collaboratorId":{"description":"Unique identifier of the collaborator","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"collaboratorEmail":{"description":"Email address of the collaborator","type":"string","example":"collaborator@example.com","maxLength":255,"minLength":5},"type":{"description":"Type of assignee (User or Group)","type":"string","example":"USER","enum":["USER","GROUP"]}},"example":{"collaboratorId":"123e4567-e89b-12d3-a456-426614174000","collaboratorEmail":"collaborator@example.com","type":"USER"},"required":["type"]},"PrivacyAutomation-AssessmentAutomation_TaskCreateRequest":{"type":"object","properties":{"taskName":{"description":"Name of the task","type":"string","example":"Complete security review","maxLength":255,"minLength":1},"description":{"description":"Description of the task","type":"string","example":"Review security controls and document findings","maxLength":2000,"minLength":0},"assigneeId":{"description":"The UUID of the user assigned to the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"deadline":{"description":"The date by which the task must be completed","type":"string","format":"date","example":"2025-12-31"},"collaborators":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_TaskCollaboratorDto"}}},"required":["taskName"]},"PrivacyAutomation-AssessmentAutomation_AssessmentManualLinkRequest":{"type":"object","properties":{"fromId":{"description":"The unique ID of the source assessment to create the link from","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"toIds":{"type":"array","items":{"type":"string","format":"uuid","example":"223e4567-e89b-12d3-a456-426614174001"},"maxItems":2147483647,"minItems":1,"uniqueItems":true}},"required":["fromId","toIds"]},"PrivacyAutomation-AssessmentAutomation_AssessmentBasicDetailsUpdateRequest":{"type":"object","properties":{"name":{"description":"The name of the assessment to be displayed in the UI","type":"string","example":"GDPR Compliance Assessment 2025","maxLength":255},"description":{"description":"Detailed description of the assessment's purpose and scope","type":"string","example":"This assessment evaluates the organization's compliance with GDPR requirements and identifies potential data protection gaps","maxLength":4000},"deadline":{"description":"The date by which the assessment must be completed","type":"string","format":"date-time","example":"2025-12-31T23:59:59.000Z"},"reminder":{"description":"The number of days before the deadline when a reminder notification should be sent to respondents","type":"integer","format":"int32","example":7,"minimum":1}}},"PrivacyAutomation-AssessmentAutomation_AssessmentListViewBasicDto":{"type":"object","properties":{"assessmentId":{"description":"Unique identifier for the assessment","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"number":{"description":"Sequential number assigned to the assessment","type":"integer","format":"int32","example":12345},"name":{"description":"Name of the assessment","type":"string","example":"Annual Security Review"},"status":{"description":"Current status of the assessment","type":"string","example":"In Progress","enum":["Not Started","In Progress","Under Review","Completed"]},"state":{"description":"Current state of the assessment","type":"string","example":"Active"},"result":{"type":"string","deprecated":true},"resultId":{"description":"Unique identifier for the assessment result","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"resultName":{"description":"Name of the assessment result","type":"string","example":"Approved with Conditions"},"orgGroupName":{"description":"Name of the organization group to which the assessment belongs","type":"string","example":"Finance Department"},"createDt":{"description":"Date when the assessment was created","type":"string","format":"date-time","example":"2025-07-01T10:30:00Z"},"tags":{"type":"array","items":{"type":"string"}},"templateName":{"description":"Name of the template used for the assessment","type":"string","example":"Security Assessment Template v2"},"templateId":{"description":"Unique identifier for the template","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174002"},"templateRootVersionId":{"description":"Root version identifier for the template","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174003"},"primaryInventoryDetails":{"description":"Details about the primary inventory associated with the assessment","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_primaryInventoryDetails"},"residualRiskScore":{"description":"Risk score after controls have been applied","type":"number","format":"decimal","example":3.5},"openRiskCount":{"description":"Number of open risks associated with the assessment","type":"integer","format":"int64","example":5},"inherentRiskScore":{"description":"Risk score before any controls are applied","type":"number","format":"decimal","example":7.2},"targetRiskScore":{"description":"Target risk score to achieve","type":"number","format":"decimal","example":2},"lastUpdated":{"description":"Date and time when the assessment was last updated","type":"string","format":"date-time","example":"2025-07-23T15:30:45Z"}}},"PrivacyAutomation-AssessmentAutomation_PageAssessmentListViewBasicDto":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentListViewBasicDto","description":"The assessment data content"},"page":{"description":"Pagination information for the response","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentPage"}}},"PrivacyAutomation-AssessmentAutomation_primaryInventoryDetails":{"type":"object","properties":{"primaryInventoryName":{"description":"Name of the primary inventory record","type":"string","example":"Server Infrastructure"},"primaryInventoryId":{"description":"Unique identifier for the primary inventory record","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"primaryInventoryNumber":{"description":"Sequential number assigned to the primary inventory record","type":"integer","format":"int64","example":10042}}},"PrivacyAutomation-AssessmentAutomation_WorkflowStageBasicDetails":{"type":"object","properties":{"stageId":{"description":"The unique identifier of the workflow stage","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"stageName":{"description":"The name of the workflow stage","type":"string","example":"Under Review"},"stageNameKey":{"description":"The key for the stage name used for localization","type":"string","example":"workflow.stage.under.review"},"badgeColor":{"description":"The color code for the badge representing this stage","type":"string","example":"#FF9800"}}},"PrivacyAutomation-AssessmentAutomation_WorkflowAndApprovalStageDetails":{"type":"object","properties":{"workflowId":{"description":"The unique identifier of the workflow","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"workflowName":{"description":"The name of the workflow","type":"string","example":"Standard Approval Workflow"},"workflowNameKey":{"description":"The key for the workflow name used for localization","type":"string","example":"workflow.standard.approval"},"approvalStageDetails":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_WorkflowStageBasicDetails"}}}},"PrivacyAutomation-AssessmentAutomation_AssessmentResponseInformation":{"type":"object","properties":{"responseId":{"type":"string","format":"uuid"},"response":{"type":"string"},"responseKey":{"type":"string"},"type":{"type":"string","enum":["NOT_SURE, JUSTIFICATION, NOT_APPLICABLE, DEFAULT, OTHERS"]},"responseSourceType":{"type":"string","enum":["LAUNCH_FROM_INVENTORY/LAUNCH_FROM_INCIDENT/INCIDENT_TEMPLATE/LAUNCH_FROM_CONTROL_IMPLEMENTATION/AI_IMPORT/AI_ACCEPT"]},"errorCode":{"description":"not required","type":"string","enum":["ATTRIBUTE_DISABLED","ATTRIBUTE_OPTION_DISABLED","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","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","ERROR_CREATING_CONTRACT"]},"responseMap":{"description":"only applicable for inventory type responses. Allowable values for the key: ASSETS, PROCESSING_ACTIVITY, VENDORS, DATA_SUBJECTS, DATA_ELEMENTS, DATA_CATEGORIES","type":"object","additionalProperties":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"}},"scaleResponseMap":{"description":"only applicable for YES_NO_PARTIALLY type responses. key should be OVERALL or LAW Name","type":"object","additionalProperties":{"type":"number"}},"controlResponse":{"description":"only applicable for control responses","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ControlResponse"},"responseAdditionalDetails":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ResponseAdditionalDetails"},"contractResponse":{"description":"only applicable for contract responses","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ContractAdditionalResponseInformation"},"relationshipResponseDetails":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_RelationshipResponseDetailsDto"}},"valid":{"description":"not required","type":"boolean"},"textRedacted":{"description":"Applicable for attribute text questions","type":"boolean"},"lastModifiedDate":{"type":"string","format":"date-time"},"dataCategory":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"dataElement":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"dataSubject":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"}}},"PrivacyAutomation-AssessmentAutomation_BasicEntityDetail":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity (organization group, user, etc.)","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"description":"Display name of the entity (organization name or user's full name)","type":"string","example":"Entity Name"},"nameKey":{"description":"Translation key for the name, used for internationalization","type":"string","example":"EntityName"}}},"PrivacyAutomation-AssessmentAutomation_ContractAdditionalResponseInformation":{"type":"object","properties":{"attachmentId":{"type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_ControlResponse":{"type":"object","properties":{"control id":{"type":"string","format":"uuid"},"control identifier":{"type":"string"},"control name":{"type":"string"},"framework id":{"type":"string","format":"uuid"},"framework name":{"type":"string"},"category id":{"type":"string","format":"uuid"},"category name":{"type":"string"}}},"PrivacyAutomation-AssessmentAutomation_ResponseAdditionalDetails":{"type":"object","properties":{"entity Number":{"type":"integer","format":"int64"},"source Id":{"type":"string","format":"uuid"},"source Name":{"type":"string"},"source type":{"type":"string","enum":["Risks, Assets, ProcessingActivities, Vendors, Entities"]},"Business key":{"type":"string"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentQuestionResponseInformation":{"type":"object","properties":{"responses":{"items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentResponseInformation"},"type":"array"},"justification":{"description":"Justification text provided for the response","type":"string"},"maturityScale":{"description":"Maturity scale value selected for the question","type":"integer","format":"int32"},"effectivenessScale":{"description":"Effectiveness scale value selected for the question","type":"integer","format":"int32"},"parentAssessmentDetailId":{"description":"Identifier of the parent assessment detail","type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentQuestionRiskInformation":{"type":"object","properties":{"questionId":{"description":"Identifier of the question associated with this risk","type":"string","format":"uuid"},"parentQuestionResponseDetailId":{"description":"Identifier of the parent question response detail","type":"string","format":"uuid"},"riskId":{"description":"Unique identifier of the risk","type":"string","format":"uuid"},"level":{"description":"Risk level value","type":"integer","format":"int64"},"score":{"description":"Numerical risk score","type":"integer","format":"int64"},"probability":{"description":"Probability component of risk score","type":"integer","format":"int64"},"impactLevel":{"description":"Impact level component of risk score","type":"integer","format":"int64"},"riskLevelValue":{"description":"Display value of the risk level (e.g., 'High', 'Medium', 'Low')","type":"string"},"riskLevelValueKey":{"description":"Key for the risk level value for localization","type":"string"},"riskLevelColorCode":{"description":"Color code associated with the risk level for UI display","type":"string"},"attributeOptionId":{"description":"Identifier of the attribute option associated with this risk level","type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_QuestionAssociationInformation":{"type":"object","properties":{"associationType":{"type":"string","enum":["SOURCE","TARGET","ADDITIONAL_LINK_1","ADDITIONAL_LINK_2","RESTRICT_RESPONSE_OPTIONS"]},"associatedQuestionIds":{"type":"array","items":{"type":"string","format":"uuid"}}}},"PrivacyAutomation-AssessmentAutomation_AssessmentQuestionIssueInformation":{"type":"object","properties":{"questionId":{"type":"string","format":"uuid"},"issueId":{"type":"string","format":"uuid"},"parentQuestionResponseDetailId":{"type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentAttachmentResponse":{"type":"object","properties":{"attachmentId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"questionId":{"type":"string","format":"uuid"},"createdDate":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"fileDescription":{"type":"string"},"creator":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"createdBy":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"resourcePath":{"type":"string"},"attributeParentResponseId":{"type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentQuestionInformation":{"type":"object","properties":{"question":{"description":"Core information about the question including text, type, and configuration","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_QuestionInformation"},"sectionInformation":{"description":"Information about the section containing this question","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentQuestionSectionBasicInfo"},"hidden":{"description":"Indicates if the question should be hidden or not based on the responses provided so far","type":"boolean"},"lockReason":{"description":"Reason why the question is locked, if applicable","type":"string","enum":["LAUNCH_FROM_INVENTORY, LAUNCH_FROM_INCIDENT, LAUNCH_FROM_CONTROL_IMPLEMENTATION"]},"copyErrors":{"type":"array","items":{"type":"string","enum":["OTHER_RESPONSE_NOT_ALLOWED","NOT_SURE_NOT_ALLOWED","NOT_APPLICABLE_NOT_ALLOWED","NEW_QUESTION","MULTI_SELECT_NOT_ALLOWED","OPTION_REMOVED","INVENTORY_REMOVED","ENTITY_REMOVED"]},"uniqueItems":true},"hasNavigationRules":{"description":"Indicates if the question has navigation rules associated with it","type":"boolean"},"questionResponses":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentQuestionResponseInformation"}},"risks":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentQuestionRiskInformation"}},"rootRequestInformationIds":{"type":"array","items":{"format":"uuid"},"uniqueItems":true},"totalAttachments":{"description":"Total number of attachments for this question","type":"integer","format":"int64"},"attachmentIds":{"type":"array","items":{"format":"uuid"},"uniqueItems":true},"canReopenWithAllowEditOption":{"description":"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.","type":"boolean"},"riskCreationAllowed":{"description":"Indicates if the question can be allowed to flag risk manually","type":"boolean"},"riskDeletionPopupAllowed":{"description":"Indicates if risk deletion alert popup is allowed on this question","type":"boolean"},"allowMaturityScaleOnQuestions":{"description":"Indicates if Maturity Scale is allowed on this question","type":"boolean"},"questionAssociations":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_QuestionAssociationInformation"}},"attachmentsById":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentAttachmentResponse"}},"issues":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentQuestionIssueInformation"}},"responseEditableWhileUnderReview":{"type":"boolean"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentQuestionSectionBasicInfo":{"type":"object","properties":{"name":{"description":"Name of the section","type":"string"},"description":{"description":"Description of the section","type":"string"},"sequence":{"description":"Sequence number indicating the order of the section in the assessment","type":"integer","format":"int32"}}},"PrivacyAutomation-AssessmentAutomation_LawInformation":{"type":"object","properties":{"name":{"type":"string"}}},"PrivacyAutomation-AssessmentAutomation_OptionInformation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"option":{"type":"string"},"optionKey":{"type":"string"},"sequence":{"type":"integer","format":"int32"},"hint":{"type":"string"},"hintKey":{"type":"string"},"attributes":{"type":"string"},"optionType":{"type":"string","enum":["NOT_SURE","NOT_APPLICABLE","OTHERS","DEFAULT"]},"score":{"type":"integer","format":"int32"},"preSelectedOption":{"type":"boolean"},"translationIdentifier":{"type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_QuestionInformation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"rootVersionId":{"type":"string","format":"uuid"},"sequence":{"type":"integer","format":"int32"},"questionType":{"type":"string","enum":["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":{"type":"boolean"},"attributes":{"type":"string"},"friendlyName":{"type":"string"},"description":{"type":"string"},"hint":{"type":"string"},"parentQuestionId":{"type":"string","format":"uuid"},"prePopulateResponse":{"type":"boolean"},"linkAssessmentToInventory":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_OptionInformation"}},"valid":{"type":"boolean"},"businessKeyReference":{"type":"string"},"topic":{"type":"string"},"questionLaws":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_LawInformation"}},"attachmentRequired":{"type":"boolean"},"responseFilter":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ResponseFilter"},"linkAssessmentToResponseEntity":{"type":"boolean"},"attachmentIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"readOnly":{"type":"boolean"},"translationIdentifier":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["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":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_SchemaIdentifier"},"allowMultiSelect":{"type":"boolean"},"seeded":{"type":"boolean"},"attributeId":{"type":"string","format":"uuid"},"assetQuestion":{"type":"boolean"},"vendorQuestion":{"type":"boolean"},"entityQuestion":{"type":"boolean"},"allowJustification":{"type":"boolean"},"requireJustification":{"type":"boolean"},"inventoryTypeEnum":{"type":"string","enum":["ASSETS","PROCESSING_ACTIVITY","VENDORS","DATA_SUBJECTS","DATA_ELEMENTS","DATA_CATEGORIES","ENTITIES","PERSONAL_DATA"]},"paquestion":{"type":"boolean"},"forceOther":{"type":"boolean"},"content":{"type":"string"},"isParentQuestionMultiSelect":{"type":"boolean"}}},"PrivacyAutomation-AssessmentAutomation_ResponseFilter":{"type":"object","properties":{"Collection of key-value(s) pairs":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","format":"uuid"}}},"operator":{"type":"string"}}},"PrivacyAutomation-AssessmentAutomation_SchemaIdentifier":{"type":"object","properties":{"schemaName":{"type":"string"},"moduleName":{"type":"string"}}},"PrivacyAutomation-AssessmentAutomation_ApproverInformation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workflowStageId":{"type":"string","format":"uuid"},"name":{"type":"string"},"approver":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicUserEntityDetail"},"approvedOn":{"type":"string","format":"date-time"},"approvalState":{"type":"string","enum":["OPEN","APPROVED","REJECTED"]},"resultId":{"type":"string","format":"uuid"},"resultName":{"type":"string"},"resultNameKey":{"type":"string"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentExportInformation":{"type":"object","properties":{"assessmentId":{"description":"Unique identifier of the assessment","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"assessmentNumber":{"description":"Sequential number assigned to the assessment","type":"integer","format":"int64","example":12345},"name":{"description":"Name of the assessment","type":"string","example":"GDPR Assessment"},"description":{"description":"Description of the assessment","type":"string","example":"Annual GDPR compliance assessment"},"welcomeText":{"description":"Welcome text displayed at the beginning of the assessment","type":"string","example":"Welcome to the annual GDPR compliance assessment. Please answer all questions thoroughly."},"orgGroup":{"description":"Organization group to which the assessment belongs","example":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Legal Department"},"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"template":{"description":"Template used to create the assessment","example":{"id":"550e8400-e29b-41d4-a716-446655440001","name":"GDPR Assessment Template"},"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"status":{"description":"Current status of the assessment","type":"string","example":"COMPLETED","enum":["NOT_STARTED","IN_PROGRESS","UNDER_REVIEW","COMPLETED"]},"createdBy":{"description":"User who created the assessment","example":{"id":"550e8400-e29b-41d4-a716-446655440002","name":"John Doe"},"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"createdDT":{"description":"Date and time when the assessment was created (in UTC)","type":"string","format":"date-time","example":"2023-01-15T10:30:45Z"},"sections":{"description":"List of sections in the assessment with their questions and responses","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentSectionInformation"}},"approvers":{"description":"List of users who are approvers for the assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_ApproverInformation"},"example":[{"id":"550e8400-e29b-41d4-a716-446655440003","name":"Jane Smith","email":"jane.smith@example.com"}]},"respondents":{"description":"List of users who are respondents for the assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"example":[{"id":"550e8400-e29b-41d4-a716-446655440004","name":"Bob Johnson"}]},"respondent":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_BasicEntityDetail"},"deadline":{"description":"Deadline for completing the assessment","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"submittedOn":{"description":"Date when the assessment was submitted for review","type":"string","format":"date-time","example":"2023-11-10T09:15:30Z"},"completedOn":{"description":"Date when the assessment was completed","type":"string","format":"date-time","example":"2023-11-15T14:22:33Z"},"result":{"description":"Result of the assessment (deprecated, use resultName instead)","type":"string","deprecated":true},"resultId":{"description":"Unique identifier of the assessment result","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440005"},"resultName":{"description":"Name of the assessment result","type":"string","example":"Approved"},"lowRisk":{"description":"Count of low risk findings in the assessment","type":"integer","format":"int32","example":3},"mediumRisk":{"description":"Count of medium risk findings in the assessment","type":"integer","format":"int32","example":2},"highRisk":{"description":"Count of high risk findings in the assessment","type":"integer","format":"int32","example":1},"veryHighRisk":{"description":"Count of very high risk findings in the assessment","type":"integer","format":"int32","example":0},"totalRiskCount":{"description":"Total count of all risk findings in the assessment","type":"integer","format":"int64","example":6},"riskLevel":{"description":"Overall risk level of the assessment","type":"string","example":"LOW"},"residualRiskScore":{"description":"Residual risk score after mitigations","type":"number","example":2.5},"openRiskCount":{"description":"Count of open risks in the assessment","type":"integer","format":"int64","example":2},"inherentRiskScore":{"description":"Inherent risk score before mitigations","type":"number","example":4.8},"targetRiskScore":{"description":"Target risk score to achieve","type":"number","example":1.5},"lastUpdated":{"description":"Date and time when the assessment was last updated (in UTC)","type":"string","format":"date-time","example":"2023-11-05T16:42:18Z"},"primaryEntityDetails":{"description":"Details of the primary entities associated with the assessment","type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessableEntityDetail"}},"primaryRecordType":{"description":"Type of the primary record associated with the assessment","type":"string","example":"INVENTORY"},"tags":{"description":"List of tags associated with the assessment","type":"array","items":{"type":"string"},"example":["GDPR","Annual","High Priority"]}}},"PrivacyAutomation-AssessmentAutomation_AssessmentSectionInformation":{"type":"object","properties":{"header":{"description":"Assessment section header information containing basic details like name, description, and sequence","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_header"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_AssessmentQuestionInformation"}},"hasNavigationRules":{"description":"Indicates if the section has navigation rules that affect question flow","type":"boolean"},"submittedBy":{"description":"Information about the user who submitted this section","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_submittedBy"},"submittedDt":{"description":"Date and time when the section was submitted","type":"string","format":"date-time","example":"2025-07-23T15:30:45Z"},"name":{"description":"Name of the section","type":"string"},"isHidden":{"description":"Indicates if the section is hidden","type":"boolean"},"isValid":{"description":"Indicates if the section is valid","type":"boolean"},"submitted":{"type":"boolean"},"description":{"description":"Description of the section","type":"string"},"sequence":{"description":"Sequence number of the section","type":"integer","format":"int32"},"sectionId":{"description":"Unique identifier for the section","type":"string","format":"uuid"}}},"PrivacyAutomation-AssessmentAutomation_header":{"type":"object","properties":{"sectionId":{"description":"Unique identifier for the section","type":"string","format":"uuid"},"name":{"description":"Name of the section","type":"string"},"description":{"description":"Description of the section","type":"string"},"sequence":{"description":"Sequence number indicating the order of the section in the assessment","type":"integer","format":"int32"},"hidden":{"description":"Indicates if the section is hidden based on navigation rules","type":"boolean","default":"false"},"invalidQuestionIds":{"type":"array","items":{"format":"uuid"}},"requiredUnansweredQuestionIds":{"type":"array","items":{"format":"uuid"}},"requiredQuestionIds":{"type":"array","items":{"format":"uuid"}},"unansweredQuestionIds":{"type":"array","items":{"format":"uuid"}},"effectivenessQuestionIds":{"type":"array","items":{"format":"uuid","description":"Set of question identifiers that are related to effectiveness assessment","example":"550e8400-e29b-41d4-a716-446655440000"},"uniqueItems":true},"autoAnsweredQuestionIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"riskStatistics":{"description":"Risk statistics for the section","$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_riskStatistics"},"status":{"description":"Current status of the section","type":"string"},"nameKey":{"description":"Translation key for the section name","type":"string"},"descriptionKey":{"description":"Translation key for the section description","type":"string"},"openNMIQuestionIds":{"type":"array","items":{"format":"uuid"},"uniqueItems":true},"sectionUserType":{"description":"Type of user assigned to the section (e.g., RESPONDENT, APPROVER)","type":"string","enum":["APPROVER","RESPONDENT"]},"submitted":{"type":"boolean"}}},"PrivacyAutomation-AssessmentAutomation_riskStatistics":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"riskCount":{"type":"integer","format":"int64"},"maxRiskLevel":{"type":"integer","format":"int64"}}},"PrivacyAutomation-AssessmentAutomation_submittedBy":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity (organization group, user, etc.)","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"description":"Display name of the entity (organization name or user's full name)","type":"string","example":"Entity Name"},"nameKey":{"description":"Translation key for the name, used for internationalization","type":"string","example":"EntityName"}}},"PrivacyAutomation-AssessmentAutomation_LinkedAssessmentInformation":{"type":"object","properties":{"assessmentId":{"description":"Unique identifier of the linked assessment","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"assessmentName":{"description":"Name of the linked assessment","type":"string","example":"GDPR Assessment for Marketing Department"},"assessmentNumber":{"description":"Numeric identifier of the linked assessment","type":"integer","format":"int64","example":1001},"linkType":{"description":"Type of link between the entity and the assessment. Can be PRIMARY, AUTO, or MANUAL","type":"string","example":"PRIMARY","enum":["PRIMARY","AUTO","MANUAL"]}}},"PrivacyAutomation-AssessmentAutomation_PageLinkedAssessmentInformation":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_LinkedAssessmentInformation","description":"List of linked assessments in the current page","items":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_LinkedAssessmentInformation"}},"empty":{"description":"Flag to check if the result list is empty or not","type":"boolean"},"first":{"description":"Flag to check if this is the first page","type":"boolean"},"last":{"description":"Flag to check if this is the last page","type":"boolean"},"number":{"description":"Current page number (0-based)","type":"integer","format":"int32"},"numberOfElements":{"description":"Number of elements in the current page","type":"integer","format":"int32","example":1},"size":{"description":"Page size","type":"integer","format":"int32","example":20},"totalElements":{"description":"Total number of elements across all pages","type":"integer","format":"int64","example":1},"totalPages":{"description":"Total number of pages","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/PrivacyAutomation-AssessmentAutomation_SortObject"},"pageable":{"description":"Pagination information with page number (0-based, min: 0) and page size (min: 1)","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}},"example":{"content":[{"assessmentId":"550e8400-e29b-41d4-a716-446655440000","assessmentName":"Privacy Impact Assessment - Customer Portal","assessmentNumber":12345,"templateName":"PIA Template","status":"IN_PROGRESS"}],"totalElements":1,"totalPages":1,"size":20,"number":0,"numberOfElements":1,"first":true,"last":true,"empty":false}},"PrivacyAutomation-AssessmentAutomation_SortObject":{"type":"object","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentResultDto":{"type":"object","properties":{"id":{"description":"Assessment Result ID","type":"string","format":"uuid"},"name":{"description":"Assessment Result Name","type":"string"},"optionHint":{"description":"Assessment Result Option Hint","type":"string"},"nameKey":{"description":"Assessment Result name Key for translation","type":"string"},"optionHintKey":{"description":"Assessment Result optionHint Key for translation","type":"string"},"updateOtherServcies":{"description":"This value determines whether the result will update inventories and launch follow-up assessments (like the system result 'Approved').","type":"boolean"},"templateType":{"description":"Assessment Result template type","type":"string","enum":["PIA","VENDOR","RA","GRA","DINA","BENCHMARKING","ITRM","CONTROL","INCIDENT","EXCHANGE","ESG","DISCLOSURE","DISCLOSURE_YOY","ERM","TPDD","AIGOVERNANCE","DYNAMIC"],"x-enumDescriptions":{"ERM":"Enterprise Risk Management","AIGOVERNANCE":"AI Governance","ITRM":"IT & Security Risk Management","DISCLOSURE":"Disclosure Management","INCIDENT":"Incident Management","ESG":"ESG Program Reporting","PIA":"PIA & DPIA Automation","VENDOR":"Third-Party Risk Management","TPDD":"Third-Party Due Diligence","EXCHANGE":"Third-Party Risk Exchange","DISCLOSURE_YOY":"Year Over Year Disclosures","CONTROL":"Risk and Controls"}},"active":{"type":"boolean"},"system":{"type":"boolean"},"internal":{"type":"boolean"}}},"PrivacyAutomation-AssessmentAutomation_AssessmentDeleteLogInformation":{"type":"object","properties":{"assessmentGuid":{"description":"Unique identifier (UUID) of the deleted assessment","type":"string","format":"uuid"},"assessmentName":{"description":"Name of the deleted assessment","type":"string"},"deletedBy":{"description":"Username or identifier of the user who deleted the assessment","type":"string"},"deletedDT":{"description":"Date and time when the assessment was deleted, in UTC timezone","type":"string","format":"date-time"},"assessmentId":{"description":"Numeric identifier of the deleted assessment","type":"integer","format":"int64"}}},"PrivacyAutomation-AssessmentAutomation_TagEntityDetail":{"type":"object","properties":{"id":{"description":"Unique identifier for the tag","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"option":{"description":"Display text for the tag that appears in the UI","type":"string","example":"High Priority"}}},"Template_TemplateCreateResponse":{"type":"object","properties":{"id":{"description":"The unique identifier of the created template.","type":"string","format":"uuid","example":"7d271be5-0601-4190-96a7-65d7c427a725"},"rootVersionId":{"description":"The root version identifier of the template used for version management.","type":"string","format":"uuid","example":"7d271be5-0601-4190-96a7-65d7c427a725"},"templateVersion":{"description":"The version number of the template indicating its iteration.","type":"integer","format":"int32","example":1},"languageCode":{"description":"The language code specifying the localization of the template.","type":"string","example":"en"}}},"Template_TemplateBasicDetailsDto":{"type":"object","properties":{"name":{"description":"The display name of the published template.","type":"string","example":"Sample Template"},"rootVersionId":{"description":"The root version identifier used for template management and operations.","type":"string","format":"uuid","example":"7d271be5-0601-4190-96a7-65d7c427a725"},"templateType":{"description":"The classification type of the template indicating its purpose and module.","type":"string","example":"PIA","default":"PIA","enum":["PIA","VENDOR","ITRM","CONTROL","ESG","TPDD","AIGOVERNANCE"]}}}},"securitySchemes":{"PrivacyAutomation-AssessmentAutomation_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"ASSESSMENT":"Access to assessment scope for external systems","ASSESSMENT_READ":"Access to read assessment scope for external systems"}}}},"Template_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"ASSESSMENT":"Access to assessment scope for external systems","ASSESSMENT_READ":"Access to read assessment scope for external systems"}}}}}}}