{"openapi":"3.1.0","info":{"title":"Tech Risk & Compliance - Exception Management","description":"The Exception Management APIs are used to integrate external systems and streamline the flow of data for exceptions in the OneTrust Platform.","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.proxy-tu.researchport.umd.edu/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"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":"Exceptions","description":"The Exceptions APIs are used to manage the creation, update, and retrieval of exceptions."}],"paths":{"/v1/exceptions/search":{"post":{"tags":["Exceptions"],"summary":"Search Exceptions","description":"Use this API to retrieve a list of all exceptions or search for exceptions based on the specified criteria. A successful `200` response contains one page of exceptions in `content`, together with the paging details that are needed to request the next page. If no exception matches the request, the API still returns 200, with an empty `content` list and a `totalElements` of `0`; it does not return an error.\n\n> 🗒 Things to Know\n> \n> - If the request body is omitted or criteria is not provided, no filter is applied and all exceptions are returned.\n> - Use `sort` in the format `field,direction`. When `sort` is not provided, results are sorted by `createdDate` in descending order.\n> - `fullText` searches the text fields of an exception; it does not search every field.\n> - The `BETWEEN` operator requires both `value` for the lower bound and `toValue` for the upper bound.","operationId":"findAllExceptionsByFilterUsingPOST","parameters":[{"name":"page","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records per page.","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":50},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","required":false,"schema":{"type":"string","enum":["id,asc","id,desc","name,asc","name,desc","createdDate,asc","createdDate,desc"]},"example":"createdDate,desc"}],"requestBody":{"description":"The optional criteria used to filter the exceptions that are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSearchRequest"},"examples":{"filterByOrganization":{"description":"filterByOrganization","value":{"criteria":{"filters":[{"field":"organization","value":["00000000-0000-0000-0000-000000000000"],"operator":"EQUAL_TO"}]}}}}}},"required":false},"responses":{"200":{"description":"The search completed successfully. The response body contains one page of exceptions and the paging details. When no exception matches, `content` is empty.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionPageResponse"},"examples":{"matches":{"summary":"One exception matches","description":"matches","value":{"content":[{"id":"ab129a43-3d3d-4352-9daf-71f6ea2b3d70","number":12,"name":"Extended review cycle for vendor policy","orgGroupId":"cb49a431-3d3d-4352-9daf-71f6ea2b3d89","reasonForException":"Vendor contract renewal is in progress.","exceptionType":"POLICY","requestor":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","name":"John Doe","email":"jdoe@example.com"},"status":"APPROVED","closureNote":"Approved until the contract renewal is completed.","expirationDate":"2026-12-31","workflowAndStage":{"id":"5d3b7c9e-8f1a-4c2e-9b6d-2a4e8f0c1d37","name":"Default Exception Workflow","stageId":"7e2f4a10-3b9c-4d85-a1e6-90c4d2b8f357","stageName":"Completed","badgeColor":"Completed"},"dateResolved":"2026-10-05","exceptionApprovers":[{"id":"91c4e7d2-5a3f-4b08-8d1e-6f2a0c9b4e73","name":"Jane Smith"}],"source":{"id":"03978f28-60c8-4af7-ab16-d20ed1d77b19","name":"Acceptable Use Policy"},"reasonForClosure":"Resolved","auditFields":{"createdDate":"2026-09-30T14:21:07.310","lastUpdatedDate":"2026-10-05T09:12:45.122","createdBy":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","name":"John Doe","email":"jdoe@example.com","initials":"JD"},"lastModifiedBy":{"id":"91c4e7d2-5a3f-4b08-8d1e-6f2a0c9b4e73","name":"Jane Smith","email":"jsmith@example.com","initials":"JS"}},"attributes":{"businessImpact":[{"id":"e1c3f5a7-2b4d-4968-8a0c-3d5f7b9e1a24","value":"High","displayLabel":"High","disabled":false}]}}],"pageable":{"pageNumber":0,"pageSize":20,"sort":{"empty":false,"sorted":true,"unsorted":false},"offset":0,"paged":true,"unpaged":false},"totalElements":1,"totalPages":1,"size":20,"number":0,"numberOfElements":1,"first":true,"last":true,"empty":false,"sort":{"empty":false,"sorted":true,"unsorted":false}}},"noMatches":{"summary":"No exception matches","description":"noMatches","value":{"content":[],"pageable":{"pageNumber":0,"pageSize":20,"sort":{"empty":false,"sorted":true,"unsorted":false},"offset":0,"paged":true,"unpaged":false},"totalElements":0,"totalPages":0,"size":20,"number":0,"numberOfElements":0,"first":true,"last":true,"empty":true,"sort":{"empty":false,"sorted":true,"unsorted":false}}}}}}},"400":{"description":"The request is invalid. The request body could not be parsed (for example, it is not valid JSON, a value has the wrong data type, or a filter operator is unknown), or a query parameter has an invalid value. The response body contains the error details and a `traceId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionErrorResponse"},"examples":{"invalidRequest":{"description":"invalidRequest","value":{"errors":[{"title":"Operation Failed","detail":"Request could not be parsed","code":"ERROR_GENERIC_OPERATION_FAILED"}],"traceId":"00000000-0000-0000-0000-000000000000"}}}}}},"401":{"description":"The request is not authenticated. The `Authorization: Bearer <token>` header is missing, or the access token is invalid or has expired. Request a new access token and retry."},"403":{"description":"The access token is valid but does not have permission for this operation. The token must include the `EXCEPTION` or `EXCEPTION_READ` scope. Ask your administrator to grant the scope to the API client."},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy-tu.researchport.umd.edu/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"format":"int32","description":"The number of seconds after which requests will be allowed again."}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"format":"uuid","description":"The unique identifier for the rate-limiting event."}},"ot-request-made":{"schema":{"format":"int32","description":"The number of requests made within the specified period."}},"ot-requests-allowed":{"schema":{"format":"int32","description":"The number of requests allowed within the specified period."}}}},"500":{"description":"An unexpected error occurred on the server. Retry the request. If the problem persists, contact OneTrust support and quote the `traceId` from the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionErrorResponse"}}}}},"security":[{"OAUTH2":["EXCEPTION","EXCEPTION_READ"]}]}},"/v1/exceptions/{exceptionId}":{"get":{"tags":["Exceptions"],"summary":"Get Exception","description":"Use this API to retrieve the details of a specific exception by its unique identifier. A successful `200` response contains the exception, including its requestor, source, approvers, workflow stage, result, closure details, audit fields and attributes. If no exception exists with the given identifier, the API returns `404`.","operationId":"getExceptionUsingGET","parameters":[{"name":"exceptionId","in":"path","description":"The unique identifier of the exception. This value is obtained using the [Search Exceptions API](/onetrust/reference/findallexceptionsbyfilterusingpost).","required":true,"schema":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"200":{"description":"The exception was retrieved successfully. The response body contains the exception.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"},"examples":{"exception":{"summary":"An approved exception","description":"exception","value":{"id":"ab129a43-3d3d-4352-9daf-71f6ea2b3d70","number":12,"name":"Extended review cycle for vendor policy","orgGroupId":"cb49a431-3d3d-4352-9daf-71f6ea2b3d89","reasonForException":"Vendor contract renewal is in progress.","exceptionType":"POLICY","requestor":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","name":"John Doe","email":"jdoe@example.com"},"status":"APPROVED","closureNote":"Approved until the contract renewal is completed.","expirationDate":"2026-12-31","workflowAndStage":{"id":"5d3b7c9e-8f1a-4c2e-9b6d-2a4e8f0c1d37","name":"Default Exception Workflow","stageId":"7e2f4a10-3b9c-4d85-a1e6-90c4d2b8f357","stageName":"Completed","badgeColor":"Completed"},"dateResolved":"2026-10-05","exceptionApprovers":[{"id":"91c4e7d2-5a3f-4b08-8d1e-6f2a0c9b4e73","name":"Jane Smith"}],"source":{"id":"03978f28-60c8-4af7-ab16-d20ed1d77b19","name":"Acceptable Use Policy"},"reasonForClosure":"Resolved","auditFields":{"createdDate":"2026-09-30T14:21:07.310","lastUpdatedDate":"2026-10-05T09:12:45.122","createdBy":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","name":"John Doe","email":"jdoe@example.com","initials":"JD"},"lastModifiedBy":{"id":"91c4e7d2-5a3f-4b08-8d1e-6f2a0c9b4e73","name":"Jane Smith","email":"jsmith@example.com","initials":"JS"}},"attributes":{"businessImpact":[{"id":"e1c3f5a7-2b4d-4968-8a0c-3d5f7b9e1a24","value":"High","displayLabel":"High","disabled":false}]}}}}}}},"400":{"description":"The request is invalid. The `exceptionId` in the path is not a valid UUID. The response body contains the error details and a `traceId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionErrorResponse"},"examples":{"invalidId":{"description":"invalidId","value":{"errors":[{"title":"Operation Failed","detail":"Request could not be parsed","code":"ERROR_GENERIC_OPERATION_FAILED"}],"traceId":"00000000-0000-0000-0000-000000000000"}}}}}},"401":{"description":"The request is not authenticated. The `Authorization: Bearer <token>` header is missing, or the access token is invalid or has expired. Request a new access token and retry."},"403":{"description":"The access token is valid but does not have permission for this operation. The token must include the `EXCEPTION` or `EXCEPTION_READ` scope. Ask your administrator to grant the scope to the API client."},"404":{"description":"No exception exists with the given `exceptionId`. The response body contains the error details and a `traceId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionErrorResponse"},"examples":{"notFound":{"description":"notFound","value":{"errors":[{"title":"Operation Failed","detail":"Operation Failed","code":"ERROR_ONETRUST_ENTITY_NOT_FOUND"}],"traceId":"00000000-0000-0000-0000-000000000000"}}}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy-tu.researchport.umd.edu/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"format":"int32","description":"The number of seconds after which requests will be allowed again."}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"format":"uuid","description":"The unique identifier for the rate-limiting event."}},"ot-request-made":{"schema":{"format":"int32","description":"The number of requests made within the specified period."}},"ot-requests-allowed":{"schema":{"format":"int32","description":"The number of requests allowed within the specified period."}}}},"500":{"description":"An unexpected error occurred on the server. Retry the request. If the problem persists, contact OneTrust support and quote the `traceId` from the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionErrorResponse"}}}}},"security":[{"OAUTH2":["EXCEPTION","EXCEPTION_READ"]}]}}},"components":{"schemas":{"AttributePredicate":{"type":"object","example":{"field":"organization","operator":"EQUAL_TO","value":["00000000-0000-0000-0000-000000000000"]},"properties":{"field":{"type":"string","description":"The field name used to filter results.","example":"organization"},"operator":{"type":"string","description":"The relationship that must be met between the field and value.","enum":["EQUAL_TO","NOT_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","LESS_THAN","LESS_THAN_EQUAL_TO","BETWEEN"]},"value":{"description":"The field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter. \nExamples by type: UUID = 'e68d49c4-f11f-4cd9-8f1b-0be8ef945b8f', LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7","oneOf":[{"type":"string","format":"uuid"},{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"type":"string"},{"type":"number"}]},"toValue":{"description":"The field value for the end of the range. This field should be used in conjunction with the `value` parameter. \nExamples by type: LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7","oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"type":"string"},{"type":"number"}]}},"required":["field"]},"AttributeQueryCriteria":{"type":"object","example":{"fullText":"Policy renewal","filters":[{"field":"organization","value":["ff9e09ee-3a89-4af7-acc0-ccc45ba34970"],"operator":"EQUAL_TO"}]},"properties":{"filters":{"type":"array","description":"The fields and values used to filter results.","items":{"$ref":"#/components/schemas/AttributePredicate"},"uniqueItems":true},"fullText":{"type":"string","description":"The key terms for the search criteria."}}},"PageSearchRequest":{"type":"object","properties":{"criteria":{"$ref":"#/components/schemas/AttributeQueryCriteria","description":"The criteria that filter the exceptions that are returned. They combine a free-text search with filters on field values.","example":{"fullText":"Policy renewal","filters":[{"field":"organization","value":["ff9e09ee-3a89-4af7-acc0-ccc45ba34970"],"operator":"EQUAL_TO"}]}}}},"AssociatedAttributeValueInformation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the attribute option","example":"a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"},"value":{"type":"string","description":"Attribute value","example":"Text Value"},"valueKey":{"type":"string","description":"Translation key used for localizing the value","example":"attribute.option.valueKey"},"colorCode":{"type":"string","description":"Color code associated with the option. Used for score-based attributes.","example":"red"}},"required":["value"]},"AttributeValueInformation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the attribute option","example":"a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"},"value":{"type":"string","description":"Attribute value","example":"Text Value"},"valueKey":{"type":"string","description":"Translation key used for localizing the value","example":"attribute.option.valueKey"},"colorCode":{"type":"string","description":"Color code associated with the option. Used for score-based attributes.","example":"red"},"optionSelectionValue":{"type":"string","description":"Selection score value linked to the option. Used for score-based or numerical-based attributes.","example":"3.5"},"displayLabel":{"type":"string","description":"Display name for the option, used for external attributes managed by other systems","example":"United State | San Francisco"},"associatedAttributeValueInformation":{"type":"array","description":"Associated attribute option information","items":{"$ref":"#/components/schemas/AssociatedAttributeValueInformation"}},"valueType":{"type":"string","description":"Kind of the attribute value; meaning depends on the attribute's category (e.g. 'User'/'UserGroup' for user-type system attributes)","enum":["User","UserGroup"],"example":"UserGroup"},"disabled":{"type":"boolean","default":false,"description":"Indicates whether this attribute option is currently disabled.","example":false}},"required":["value"]},"BasicEntityDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the entity.","example":"03978f28-60c8-4af7-ab16-d20ed1d77b19"},"name":{"type":"string","description":"The name of the entity.","example":"Acceptable Use Policy"}}},"EntityBasicUserInformation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the user.","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"type":"string","description":"The full name of the user.","example":"First Last"},"email":{"type":"string","format":"email","description":"The email address of the user.","example":"user@gmail.com"},"initials":{"type":"string","description":"The initials for the first and last name of the user.","example":"FL"}}},"EntityRecordAuditInformation":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date and time that the entity was last created.","example":"2021-05-13T13:06:49.853Z"},"lastUpdatedDate":{"type":"string","format":"date-time","description":"The date and time that the entity was last updated.","example":"2021-05-13T13:06:49.853Z"},"createdBy":{"$ref":"#/components/schemas/EntityBasicUserInformation","description":"The information of the user who last created/modified the entity.","example":{"id":"c2131995-3b4b-4a42-8cb9-b78038cc4c51","name":"Name"}},"lastModifiedBy":{"$ref":"#/components/schemas/EntityBasicUserInformation","description":"The information of the user who last created/modified the entity.","example":{"id":"c2131995-3b4b-4a42-8cb9-b78038cc4c51","name":"Name"}}},"required":["createdDate"]},"ExceptionPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"The exceptions on this page. It is an empty list when no exception matches the request.","example":[{"id":"ab129a43-3d3d-4352-9daf-71f6ea2b3d70","number":12,"name":"Extended review cycle for vendor policy","exceptionType":"POLICY","status":"APPROVED"}],"items":{"$ref":"#/components/schemas/ExceptionResponse"}},"pageable":{"$ref":"#/components/schemas/PageableInformation","description":"The paging request that produced this page.","example":{"pageNumber":0,"pageSize":20,"sort":{"empty":false,"sorted":true,"unsorted":false},"offset":0,"paged":true,"unpaged":false}},"totalElements":{"type":"integer","format":"int64","description":"The total number of exceptions that match the request, across all pages.","example":42,"minimum":0},"totalPages":{"type":"integer","format":"int32","description":"The total number of pages that are available for the requested page size.","example":3,"minimum":0},"size":{"type":"integer","format":"int32","description":"The size that was applied to this page, which is the maximum number of records per page.","example":20,"maximum":2000,"minimum":1},"number":{"type":"integer","format":"int32","description":"The zero-based index of this page.","example":0,"minimum":0},"numberOfElements":{"type":"integer","format":"int32","description":"The number of exceptions on this page.","example":20,"minimum":0},"first":{"type":"boolean","description":"Whether this is the first page.","example":true},"last":{"type":"boolean","description":"Whether this is the last page. When it is true there is no next page to request.","example":false},"empty":{"type":"boolean","description":"Whether this page has no exceptions.","example":false},"sort":{"$ref":"#/components/schemas/SortInformation","description":"The sort order that was applied to the results.","example":{"empty":false,"sorted":true,"unsorted":false}}}},"ExceptionRequestor":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the user who requested the exception.","example":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86"},"name":{"type":"string","description":"The full name of the user who requested the exception.","example":"John Doe"},"email":{"type":"string","format":"email","description":"The email address of the user who requested the exception.","example":"jdoe@onetrust.com"}}},"ExceptionResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the exception.","example":"ab129a43-3d3d-4352-9daf-71f6ea2b3d70"},"number":{"type":"integer","format":"int64","description":"The sequence number of the exception.","example":1},"name":{"type":"string","description":"The name of the exception.","example":"Policy renewal delay"},"orgGroupId":{"type":"string","format":"uuid","description":"The unique identifier of the organization group that the exception belongs to.","example":"cb49a431-3d3d-4352-9daf-71f6ea2b3d89"},"reasonForException":{"type":"string","description":"The reason that the exception was requested.","example":"Vendor contract renewal in progress"},"exceptionType":{"type":"string","description":"The type of the exception, for example POLICY.","enum":["POLICY","STANDARD","PROCEDURE","MANUAL"],"example":"POLICY"},"requestor":{"$ref":"#/components/schemas/ExceptionRequestor","description":"The user who requested the exception.","example":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","name":"John Doe","email":"jdoe@example.com"}},"status":{"type":"string","description":"The result of the approval workflow of the exception. It is `REJECTED`, `APPROVED`, `EXPIRED`, `WITHDRAWN` or `RESTORE`.","enum":["REJECTED","APPROVED","EXPIRED","WITHDRAWN","RESTORE"],"example":"APPROVED"},"closureNote":{"type":"string","description":"The note that was recorded when the exception was approved, denied or closed. The reason that was selected for closing the exception is in the `reasonForClosure` property.","example":"Approved until the contract renewal is completed."},"expirationDate":{"type":"string","format":"date","description":"The date on which the exception expires.","example":"2026-12-31"},"workflowAndStage":{"$ref":"#/components/schemas/ExceptionWorkflowAndStage","description":"The approval workflow that the exception follows and the stage that it is currently in.","example":{"id":"5d3b7c9e-8f1a-4c2e-9b6d-2a4e8f0c1d37","name":"Default Exception Workflow","stageId":"7e2f4a10-3b9c-4d85-a1e6-90c4d2b8f357","stageName":"Completed","badgeColor":"Completed"}},"auditFields":{"$ref":"#/components/schemas/EntityRecordAuditInformation","description":"The audit details of the exception: when it was created and last updated, and by which users.","example":{"createdDate":"2026-09-30T14:21:07.310","lastUpdatedDate":"2026-10-05T09:12:45.122","createdBy":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","name":"John Doe"},"lastModifiedBy":{"id":"91c4e7d2-5a3f-4b08-8d1e-6f2a0c9b4e73","name":"Jane Smith"}}},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}},"description":"The values of the custom attributes of the exception, grouped by the field name of each attribute.","example":{"businessImpact":[{"id":"e1c3f5a7-2b4d-4968-8a0c-3d5f7b9e1a24","value":"High","displayLabel":"High","disabled":false}]}},"dateResolved":{"type":"string","format":"date","description":"The date on which the exception was resolved, which is when its result was recorded or when it was closed.","example":"2026-10-05"},"exceptionApprovers":{"type":"array","description":"The users who are assigned to approve the exception.","example":[{"id":"91c4e7d2-5a3f-4b08-8d1e-6f2a0c9b4e73","name":"Jane Smith"}],"items":{"$ref":"#/components/schemas/BasicEntityDetail"}},"source":{"$ref":"#/components/schemas/BasicEntityDetail","description":"The primary record that the exception was raised from.","example":{"id":"03978f28-60c8-4af7-ab16-d20ed1d77b19","name":"Acceptable Use Policy"}},"reasonForClosure":{"type":"string","description":"The reason that was selected when the exception was closed.","example":"Resolved"}}},"ExceptionWorkflowAndStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workflow.","example":"ab129a43-3d3d-4352-9daf-71f6ea2b3d70"},"name":{"type":"string","description":"The name of the workflow.","example":"Default Exception Workflow"},"stageId":{"type":"string","format":"uuid","description":"The unique identifier of the current stage.","example":"cb49a431-3d3d-4352-9daf-71f6ea2b3d89"},"stageName":{"type":"string","description":"The name of the current stage.","example":"Completed"},"badgeColor":{"type":"string","description":"The badge color name that is shown for the current stage.","example":"Completed"}}},"PageableInformation":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"The zero-based index of the page.","example":0,"minimum":0},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of records per page.","example":20,"maximum":2000,"minimum":1},"offset":{"type":"integer","format":"int64","description":"The position of the first record of the page in the full result set.","example":0,"minimum":0},"paged":{"type":"boolean","description":"Whether the results are paged.","example":true},"unpaged":{"type":"boolean","description":"Whether the results are not paged.","example":false},"sort":{"$ref":"#/components/schemas/SortInformation","description":"The sort order that was applied to the results.","example":{"empty":false,"sorted":true,"unsorted":false}}}},"SortInformation":{"type":"object","properties":{"empty":{"type":"boolean","description":"Whether no sort order was applied.","example":false},"sorted":{"type":"boolean","description":"Whether a sort order was applied.","example":true},"unsorted":{"type":"boolean","description":"Whether no sort order was applied.","example":false}}},"ErrorItem":{"type":"object","properties":{"title":{"type":"string","description":"The short summary of the error.","example":"Operation Failed"},"detail":{"type":"string","description":"The description of the error.","example":"Request could not be parsed"},"code":{"type":"string","description":"The code that identifies the kind of error.","example":"ERROR_GENERIC_OPERATION_FAILED"}}},"ExceptionErrorResponse":{"type":"object","properties":{"errors":{"type":"array","description":"The errors that caused the request to fail.","example":[{"title":"Operation Failed","detail":"Request could not be parsed","code":"ERROR_GENERIC_OPERATION_FAILED"}],"items":{"$ref":"#/components/schemas/ErrorItem"}},"traceId":{"type":"string","description":"The identifier of the request, to be quoted when contacting support.","example":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"OAUTH2":{"type":"oauth2","description":"The API uses the OAuth 2.0 client credentials grant. Send the access token with every request as a bearer token in the `Authorization` header: `Authorization: Bearer <token>`.\n\nTo get an access token, request one from the token URL of this scheme (`/api/access/v1/oauth/token` on your OneTrust host) with the client ID and client secret of your API client. For how to create the credentials and request a token, see the [Quick Start Guide](https://developer-onetrust-com.proxy-tu.researchport.umd.edu/onetrust/reference/quick-start-guide).\n\nThe token needs one of these scopes:\n- `EXCEPTION`: access to Exception information. This API exposes read operations only.\n- `EXCEPTION_READ`: read access to Exception information.\n\nCommon errors:\n- `401 Unauthorized`: the `Authorization` header is missing, or the access token is invalid or has expired. Request a new token.\n- `403 Forbidden`: the access token is valid but does not include the `EXCEPTION` or `EXCEPTION_READ` scope. Ask your administrator to grant the scope to the API client.","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"EXCEPTION":"Access Exception information. This API currently exposes read operations only (get and search); it has no write or delete operations.","EXCEPTION_READ":"Read Exception information"}}}}}},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"x-onetrust":{"spec-label":"OpenAPI 3.1.0"}}