openapi: 3.2.0
info:
  title: Tech Risk & Compliance - Management Issues API
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: The Issues Management APIs are used to integrate external systems and streamline the flow of data with Issues Management in the OneTrust platform.
servers:
- url: https://{hostname}/api/issue-management
  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: Issues
  description: The Issues APIs are used to manage issues, issue tasks, and issue relationships.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
paths:
  /v1/attributes:
    get:
      operationId: getAttributesBySchemaNameUsingGET
      summary: Get Attribute Schema
      description: Use this API to retrieve the attribute schema for the specified attribute type.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: schemaName
        in: query
        description: The name of the attribute schema.
        required: true
        schema:
          type: string
          example: Issue
          enum:
          - Issue
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AttributeInformation'
        '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/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:
      - OAUTH2:
        - ISSUE
        - ISSUE_READ
  /v1/issuelink/issue/{issueId}:
    post:
      operationId: createIssueRelationshipLinksUsingPOST
      summary: Create Issue Relationship
      description: Use this API to create a relationship between an issue and related records.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: issueId
        in: path
        description: The unique identifier of the issue. This value is obtained using the [Get Issue API](/onetrust/reference/findAllIssuesByFilter).
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example:
                linkTypeLabel: is related to
                relatedEntityType: Risk
                relatedEntityId: 00000000-0000-0000-0000-000000000000
              $ref: '#/components/schemas/CreateIssueLinkRequest'
      responses:
        '201':
          description: Successfully linked the Issue to the provided entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIssueLinkResponse'
        '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/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:
      - OAUTH2:
        - ISSUE
  /v1/issuelinks/{issueId}:
    get:
      operationId: getIssueLinksUsingGET
      summary: Get Issue Relationships
      description: Use this API to retrieve relationship details between an issue and related records.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: issueId
        in: path
        description: The unique identifier of the issue. This value is obtained using the [Get List of Issues API](/onetrust/reference/findAllIssuesByFilter).
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      - name: page
        in: query
        description: The page number of the results.
        schema:
          description: Results page to be retrieved (0..N). Example- '?page=1
          type: integer
          format: int32
          default: 0
          minimum: 0
        example: 1
      - name: size
        in: query
        description: The number of results per page.
        schema:
          description: Number of records per page (1..50). Example- '?size=20
          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.
        schema:
          type: string
          enum:
          - Id,asc
          - Id,desc
        example: Id,desc
      responses:
        '200':
          description: Relationship details fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinkResponse'
        '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/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: Invalid sort criteria
          content:
            application/json:
              schema:
                type: string
                example:
                  errors:
                  - code: ERROR_GENERIC_DATA_ACCESS
                    title: Error Accessing Data
                  traceId: 00000000-0000-0000-0000-000000000000
      security:
      - OAUTH2:
        - ISSUE
        - ISSUE_READ
  /v1/issues:
    post:
      operationId: createIssueUsingPOST
      summary: Create Issue
      description: Use this API to create an issue.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueCreateRequest'
              required:
              - name
              - orgGroupId
              - priority
      responses:
        '201':
          description: Issue created successfully
          headers:
            location:
              description: URI to get Issue details
              style: simple
              schema:
                example: https://app.onetrust.com/api/issue-management/v1/issues/a129a021-3d3d-4352-9daf-71f6ea234abc
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueResponse'
        '400':
          description: Source entity Not Found
          content:
            application/json:
              schema:
                type: string
                example:
                  errors:
                  - title: Entity:00000000-0000-0000-0000-000000000000 of type:Risk not found
                    detail: Entity:00000000-0000-0000-0000-000000000000 of type:Risk not found
                    code: ERROR_ONETRUST_ENTITY_NOT_FOUND
                  traceId: 00000000-0000-0000-0000-000000000000
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/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:
      - OAUTH2:
        - ISSUE
  /v1/issues/search:
    post:
      operationId: findAllIssuesByFilterUsingPOST
      summary: Get List of Issues
      description: Use this API to retrieve a list of all issues or search for issues based on the specified criteria.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: page
        in: query
        description: The page number of the results.
        schema:
          description: Results page to be retrieved (0..N). Example- '?page=1
          type: integer
          format: int32
          default: 0
          minimum: 0
        example: 1
      - name: size
        in: query
        description: The number of results per page.
        schema:
          description: Number of records per page (1..50). Example- '?size=20
          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.
        schema:
          type: string
          enum:
          - Id,asc
          - Id,desc
          - Name,asc
          - Name,desc
          - createdDate,asc
          - createdDate,desc
          - Priority,asc
          - Priority,desc
          - deadline,asc
          - deadline,desc
        example: Id,desc
      requestBody:
        content:
          application/json:
            schema:
              example:
                criteria:
                  filters:
                  - field: owner
                    value:
                    - 00000000-0000-0000-0000-000000000000
                    operator: EQUAL_TO
              $ref: '#/components/schemas/PageSearchRequest'
      responses:
        '200':
          description: Issues fetched successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IssueResponse'
        '400':
          description: Invalid search criteria
          content:
            application/json:
              schema:
                type: string
                example:
                  errors:
                  - title: Operation Failed
                    detail: Request could not be parsed
                    code: ERROR_GENERIC_OPERATION_FAILED
                  traceId: 00000000-0000-0000-0000-000000000000
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/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:
      - OAUTH2:
        - ISSUE
        - ISSUE_READ
  /v1/issues/{issueId}:
    get:
      operationId: getIssueUsingGET
      summary: Get Issue
      description: Use this API to retrieve details for a specific issue.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: issueId
        in: path
        description: The unique identifier of the issue. This value is obtained using the [Get List of Issues API](/onetrust/reference/findAllIssuesByFilter).
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Issue details fetched successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Issue not found.
          content:
            application/json:
              schema:
                type: string
                example:
                  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/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:
      - OAUTH2:
        - ISSUE
        - ISSUE_READ
    put:
      operationId: updateIssueUsingPUT
      summary: Update Issue
      description: 'Use this API to update all details for a specific issue.


        > 🗒 Things to Know

        >

        > - The `attributes` parameter must be included in the request body but is not required to have values. If there are no attributes to send, pass an empty object {} in the following manner: "attributes": {}. However, if values exist for an attribute, you must include the values for each of those attribute to ensure the values are retained. Otherwise, they will be overwritten.'
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: issueId
        in: path
        description: The unique identifier of the issue. This value is obtained using the [Get List of Issues API](/onetrust/reference/findAllIssuesByFilter).
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example:
                name: Updated Issue Name
                orgGroupId: 00000000-0000-0000-0000-000000000000
                priority: High
                description: Updated description of the issue.
                attributes: {}
              $ref: '#/components/schemas/IssueUpdateRequest'
              required:
              - attributes
              - name
              - orgGroupId
              - priority
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueResponse'
        '400':
          description: Missing required attributes
          content:
            application/json:
              schema:
                type: string
                example: '{"errors": [{"code": "ERROR_GENERIC_BIND", "source": "OneTrust", "detail": "Unable to process request due to invalid content/data type: name", "title": "Bad Request"}, ], "traceId": "00000000-0000-0000-0000-000000000000"}'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/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:
      - OAUTH2:
        - ISSUE
    patch:
      operationId: updateIssueUsingPATCH
      summary: Modify Issue
      description: Use this API to partially update details for a specific issue.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: issueId
        in: path
        description: The unique identifier of the issue. This value is obtained using the [Get List of Issues API](/onetrust/reference/findAllIssuesByFilter).
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example: '{"name": "Updated Issue Name",}'
              $ref: '#/components/schemas/IssuePatchRequest'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueResponse'
        '400':
          description: Validation errors
          content:
            application/json:
              schema:
                type: string
                example:
                  errors:
                  - code: INVALID_REQUEST
                    source: OneTrust
                    detail: At least one field must be provided for update
                    title: Bad Request
                  traceId: 00000000-0000-0000-0000-000000000000
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/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:
      - OAUTH2:
        - ISSUE
  /v1/issuetasks/{issueId}:
    get:
      operationId: getIssueRelatedTasksUsingGET
      summary: Get Issue Tasks
      description: Use this API to retrieve a list of all tasks for a specific issue.
      tags:
      - Issues
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-issues-management.json
      parameters:
      - name: issueId
        in: path
        description: The unique identifier of the issue. This value is obtained using the [Get List of Issues API](/onetrust/reference/findAllIssuesByFilter).
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      - name: page
        in: query
        description: The page number of the results.
        schema:
          description: Results page to be retrieved (0..N). Example- '?page=1
          type: integer
          format: int32
          default: 0
          minimum: 0
        example: 1
      - name: size
        in: query
        description: The number of results per page.
        schema:
          description: Number of records per page (1..20). Example- '?size=20
          type: integer
          format: int32
          default: 20
          maximum: 2000
          minimum: 1
        example: 20
      - name: sort
        in: query
        description: The sort criteria that dictates the order of the results.
        schema:
          type: string
          enum:
          - taskName,asc
          - taskName,desc
          - id,asc
          - id,desc
          - priority,asc
          - priority,desc
          - createdDate,asc
          - createdDate,desc
          - deadline,asc
          - deadline,desc
          pattern: ^(taskName|id|priority|createdDate|deadline),(asc|desc)$
        example: taskName,desc
      responses:
        '200':
          description: Successfully fetched tasks related to the issue
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IssueRelatedTasksDto'
        '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/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: Invalid sort criteria
          content:
            application/json:
              schema:
                type: string
                example:
                  errors:
                  - code: ERROR_GENERIC_DATA_ACCESS
                    title: Error Accessing Data
                  traceId: 00000000-0000-0000-0000-000000000000
      security:
      - OAUTH2:
        - ISSUE
        - ISSUE_READ
components:
  schemas:
    AttributeInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the attribute.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          description: The name of the attribute.
          type: string
          example: Type of the Record
          maxLength: 255
          minLength: 1
        nameKey:
          description: The fallback name of the attribute that is used if a translation is not provided for a language.
          type: string
          example: IM.Name
          maxLength: 255
        description:
          description: The description of the attribute.
          type: string
          example: Gather Type for the record - provide some value related to nature of record
          maxLength: 1000
        descriptionKey:
          description: The fallback description of the attribute that is used if a translation is not provided for a language.
          type: string
          example: IM.Name.Description
          maxLength: 255
        fieldName:
          description: The fieldName parameter value of the attribute.
          type: string
          example: nameOfRecord
          maxLength: 100
          minLength: 1
        mappedFieldName:
          description: The fieldName parameter value of the attribute.
          type: string
          example: name
          maxLength: 100
        enabled:
          description: This flag indicates whether the attribute is enabled.
          type: boolean
          example: true
          default: 'true'
        required:
          description: This flag indicates whether the attribute is required.
          type: boolean
          example: false
          default: 'false'
        readOnly:
          description: This flag indicates whether the attribute is read-only.
          type: boolean
          example: false
          default: 'false'
        encrypted:
          description: This flag indicates whether the attribute is encrypted.
          type: boolean
          example: false
          default: 'false'
        allowOther:
          description: This flag indicates whether Other can be selected as an option for the attribute value.
          type: boolean
          example: false
          default: 'false'
        baseAttribute:
          description: This flag indicates whether the attribute is a system attribute.
          type: boolean
          example: false
          default: 'false'
        responseType:
          description: The type of response associated with the attribute value.
          type: string
          example: Text
          enum:
          - Text
          - SingleSelect
          - MultiSelect
          - Date
          - Formula
          - Score
          - Level
          - Range
        formula:
          description: The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.
          type: string
          example: Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)
          maxLength: 4000
        optionType:
          description: The type of system list used to source the attribute option.
          type: string
          example: None
          enum:
          - None
          - Static
          - Dynamic
        optionAllowed:
          description: This flag indicates whether options were configured for the attribute.
          type: boolean
          example: false
          default: 'false'
        schemaId:
          description: The unique identifier of the attribute schema.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        schemaName:
          description: 'The name of the attribute schema. '
          type: string
          example: vendors
          maxLength: 100
        options:
          description: The details of the attribute options.
          type: array
          items:
            $ref: '#/components/schemas/AttributeOptionInformation'
        referenceCategories:
          description: The category details of the attribute.
          type: array
          items:
            $ref: '#/components/schemas/CategoryInformation'
        responseMaxLength:
          description: The maximum number of characters that can be entered for the attribute value.
          type: integer
          format: int32
          example: 4000
          default: '4000'
          maximum: 4000
          minimum: 1
        responseSubType:
          description: The type of scoring method associated with the attribute value.
          type: string
          example: STANDARD
          enum:
          - STANDARD
          - FORMULA
          - MATRIX
        associatedAttributeInformation:
          description: The details of the attribute.
          type: array
          items:
            $ref: '#/components/schemas/AssociatedAttributeInformation'
        multiSelectMaxOptionValues:
          description: The maximum number of options that can be selected for the attribute.
          type: integer
          format: int32
          example: 10
          maximum: 100
          minimum: 1
        hidden:
          description: This flag indicates whether the attribute is hidden.
          type: boolean
          example: false
          default: 'false'
        optionUrl:
          description: The API URL path used to source the attribute option.
          type: string
          example: /api/risk-v2/risk-categories
          maxLength: 255
        intakeQuestion:
          description: The details of the assessment question for which the issue was flagged.
          $ref: '#/components/schemas/IntakeQuestion'
        deleteMarker:
          description: The status of the attribute marked for deletion.
          type: string
          example: MARKED_FOR_DELETE
          enum:
          - MARKED_FOR_DELETE
          - DELETING
          - DELETED
        optionMetadata:
          description: The metadata of the attribute option.
          $ref: '#/components/schemas/AttributeOptionMetadataInformation'
        validationRuleId:
          description: The validation rule configured for the attribute.
          type: string
          example: email
        abacBasicAssignmentInfo:
          description: The details of the attribute-based access control (ABAC) assignments linked to the attribute.
          type: array
          items:
            $ref: '#/components/schemas/AbacBasicAssignmentInfo'
        optionsByDomain:
          description: The attribute options that are overridden by domain.
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeDomainOptionOverrideInformation'
        formulaByDomain:
          description: The formula for the attribute, specified by domain.
          type: object
          additionalProperties:
            type: string
        associatedAttributeFieldName:
          description: The fieldName parameter value of the attribute.
          type: string
      required:
      - enabled
      - fieldName
      - name
    AssociatedAttributeInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the attribute.
          type: string
          format: uuid
        name:
          description: The name of the attribute.
          type: string
          example: Count of members
        nameKey:
          description: The fallback name of the attribute that is used if a translation is not provided for a language.
          type: string
          example: IM.CountOfMembersName
        description:
          description: The description of the attribute.
          type: string
          example: Provide details about count associated with this attribute
        descriptionKey:
          description: The fallback description of the attribute that is used if a translation is not provided for a language.
          type: string
          example: IM.CountOfMembersDesc
        schemaId:
          description: The unique identifier of the attribute schema.
          type: string
          format: uuid
        schemaName:
          description: The name of the attribute schema.
          type: string
          example: risk
        fieldName:
          description: The fieldName parameter value of the attribute.
          type: string
          example: countOfMembers
        mappedFieldName:
          description: The fieldName parameter value of the attribute.
          type: string
          example: count
        enabled:
          description: This flag indicates if the attribute is enabled.
          type: boolean
        responseType:
          description: The type of response associated with the attribute.
          type: string
          enum:
          - Text
          - SingleSelect
          - MultiSelect
          - Date
          - DateTime
          - NumericalText
          - NumericalSingleSelect
          - RadioButton
          - TextArea
          - Formula
          - Level
          - Range
          - Score
          - System
        responseSubType:
          description: The type of scoring method associated with the attribute.
          type: string
          enum:
          - Standard
          - Formula
          - Matrix
          - RollUp
        formula:
          description: The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.
          type: string
          example: sum(1, 3)
        options:
          description: The options for the attribute.
          type: array
          items:
            $ref: '#/components/schemas/AttributeOptionInformation'
        optionsByDomain:
          description: The attribute options that are overridden by domain.
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeDomainOptionOverrideInformation'
      required:
      - enabled
      - fieldName
      - id
      - name
      - responseType
    AttributeOptionMetadata:
      type: object
      properties:
        hint:
          description: The hint of the attribute option.
          type: string
        hintKey:
          description: The fallback hint of the attribute option that is used if a translation is not provided for a language.
          type: string
    IssueRelatedTasksDto:
      type: object
      properties:
        issueId:
          description: The unique identifier of the issue. This value is obtained using the [Get Issue API](/onetrust/reference/findAllIssuesByFilter).
          type: string
          format: uuid
          example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
        taskId:
          description: The unique identifier of the task.
          type: string
          format: uuid
          example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
        taskName:
          description: The name of the task.
          type: string
          example: Review Policy Task
        deadline:
          description: The date and time by which the task should be completed.
          type: string
          format: date-time
          example: '2024-12-31T01:00:00'
        status:
          description: The status of the task.
          type: string
          example: Completed
        priority:
          description: The priority level of the task.
          type: string
          example: High
        description:
          description: The description of the task.
          type: string
          example: Review and update the policies.
        orgGroupId:
          description: The unique identifier of the organization associated with the task.
          type: string
          example: cb49a431-3d3d-4352-9daf-71f6ea2b3d89
        assigneeId:
          description: The unique identifier of the user assigned to the task.
          type: string
          format: uuid
          example: 84819d7e-8e52-4dba-957c-71f0b7c201c6
        collaboratorIds:
          description: The unique identifiers of the users added as collaborators on the task.
          type: array
          items:
            type: string
            format: uuid
          example: '[''84819d7e-8e52-4dba-957c-71f0b7c201c6'']'
        createdDate:
          description: The date and time that the task was created.
          type: string
          format: date-time
          example: '2024-12-18T01:00:00'
        createdBy:
          description: The unique identifier of the user who created the task.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        modifiedDate:
          description: The date and time that the task was last modified.
          type: string
          format: date-time
          example: '2024-12-18T01:00:00'
        modifiedBy:
          description: The unique identifier of the user who last modified the task.
          type: string
          example: 00000000-0000-0000-0000-000000000000
    IssueUpdateRequest:
      type: object
      properties:
        name:
          description: The name that describes the issue.
          type: string
          example: Expired Policies
          maxLength: 300
        orgGroupId:
          description: The unique identifier of the organization associated with the issue.
          type: string
          format: uuid
          example: cb49a431-3d3d-4352-9daf-71f6ea2b3d89
        priority:
          description: The priority level of the issue.
          type: string
          example: High
          enum:
          - Low
          - Medium
          - High
          - Critical
        description:
          description: The description of the issue.
          type: string
          example: System would be at risk if we do not renew access policies
          maxLength: 4000
        deadline:
          description: The date by which the issue should be resolved.
          type: string
          format: date
          example: '2021-12-31'
        ownerIds:
          description: The unique identifiers of the issue owners who will remediate the issue.
          type: array
          items:
            type: string
            format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        approverIds:
          description: The unique identifier(s) of the users assigned as approvers of the issue.
          type: array
          items:
            type: string
            format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        reasonForClosure:
          description: The reason why the issue was closed.
          type: string
          example: Resolved
        category:
          description: The category of the issue.
          type: string
          example: General
        note:
          description: The notes related to resolving the issue.
          type: string
          example: Closed the issue as its been resolved
        actionPlan:
          description: The remediation plan for the issue.
          type: string
          example: "1. Disabled user's unauthorized access.\n 2. Informed relevant teams."
        attributes:
          description: The details of the associated attributes.
          type: object
          example:
            textAttributeName:
            - value: Text
            optionBasedAttributeName:
            - id: f2229953-b4b5-4042-8cb9-b78038cc4c46
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeValueInformation'
      required:
      - name
      - orgGroupId
      - priority
    IntakeQuestion:
      type: object
      properties:
        nameKey:
          description: The fallback name of the question that is used if a translation is not provided for a language.
          type: string
        name:
          description: The name of the question.
          type: string
        descriptionKey:
          description: The fallback description of the question that is used if a translation is not provided for a language.
          type: string
        description:
          description: The description of the question.
          type: string
    AttributeOptionInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the attribute option.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        option:
          description: The name of the attribute option.
          type: string
          example: TypeA
          maxLength: 255
          minLength: 1
        optionKey:
          description: The fallback name of the attribute option that is used if a translation is not provided for a language.
          type: string
          example: IM.TypeA
          maxLength: 255
        colorCode:
          description: The color code associated with the attribute option.
          type: string
          example: '#FF5733'
          maxLength: 7
        sequence:
          description: The sequential order in which the attribute options display.
          type: integer
          format: int32
          example: 1
          maximum: 32767
          minimum: 1
        enabled:
          description: This flag indicates whether the attribute option is enabled.
          type: boolean
          example: true
          default: 'true'
        metadata:
          description: The metadata of the attribute option.
          $ref: '#/components/schemas/AttributeOptionMetadata'
      required:
      - option
    EntityRecordAuditInformation:
      type: object
      properties:
        createdDate:
          description: The date and time that the issue was created.
          type: string
          format: date-time
          example: '2021-05-13T13:06:49.853Z'
        lastUpdatedDate:
          description: The date and time that the issue was last updated.
          type: string
          format: date-time
          example: '2021-05-13T13:06:49.853Z'
        createdBy:
          description: The creation details of the issue.
          example:
            id: c21319953-b4b5-4042-8cb9-b78038cc4c51
            name: Name
          $ref: '#/components/schemas/EntityBasicUserInformation'
        lastModifiedBy:
          description: The last modified details of the issue.
          example:
            id: c21319953-b4b5-4042-8cb9-b78038cc4c51
            name: Name
          $ref: '#/components/schemas/EntityBasicUserInformation'
      required:
      - createdDate
    EntityBasicUserInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the user who last modified the issue.
          type: string
          format: uuid
          example: f2229953-b4b5-4042-8cb9-b78038cc4c46
        name:
          description: The name of the user who last modified the issue.
          type: string
          example: First Last
        email:
          description: The email address of the user who last modified the issue.
          type: string
          example: user@gmail.com
        initials:
          description: The initials of the user who last modified the issue.
          type: string
          example: FL
    CreateIssueLinkResponse:
      type: object
      properties:
        linkId:
          description: The unique identifier of the relationship link.
          type: string
          format: uuid
          example: ab129a431-3d3d-4352-9daf-71f6ea2b3d70
        linkType:
          description: The type of relationship between the related records.
          type: string
          example: issue-related
        entity1:
          description: The details of the related record.
          $ref: '#/components/schemas/EntityDetails'
        entity2:
          description: The details of the related record.
          $ref: '#/components/schemas/EntityDetails'
      required:
      - entity1
      - entity2
      - linkId
      - linkType
    IssueLinkResponse:
      type: object
      properties:
        issueId:
          description: 'The unique identifier of the issue. '
          type: string
          format: uuid
          example: ab129a431-3d3d-4352-9daf-71f6ea2b3d70
        issueName:
          description: The name that describes the issue.
          type: string
          example: Security Issue
        relatedId:
          description: The unique identifier of the related record.
          type: string
          format: uuid
          example: ab129a431-3d3d-4352-9daf-71f6ea2b3d70
        relatedName:
          description: The name of the related record.
          type: string
          example: Storage Asset
        relatedType:
          description: The entity type of the related record.
          type: string
          example: assets
        relationshipType:
          description: The type of relationship between the related records.
          type: string
          example: issue-related
        relationshipLabel:
          description: The label that describes the relationship between the related records.
          type: string
          example: is related to
    PageSearchRequest:
      type: object
      properties:
        criteria:
          description: The details of the filter criteria.
          example:
            fullText: Expired Policies
            filters:
            - field: organization
              value:
              - ff9e09ee-3a89-4af7-acc0-ccc45ba34970
              operator: EQUAL_TO
            - field: owner
              value:
              - f4894a72-c2a1-4b1d-85af-176bf16558f8
              - aca8be12-c379-4577-a9ff-6d31e70299c1
              operator: EQUAL_TO
          $ref: '#/components/schemas/AttributeQueryCriteria'
    IssueResponse:
      type: object
      properties:
        id:
          description: The unique identifier of the issue.
          type: string
          format: uuid
          example: ab129a431-3d3d-4352-9daf-71f6ea2b3d70
        number:
          description: The page number of the results.
          type: integer
          format: int64
          example: 1
        name:
          description: The name that describes the issue.
          type: string
          example: Expired Policies
        orgGroupId:
          description: The unique identifier of the organization associated with the issue.
          type: string
          format: uuid
          example: cb49a431-3d3d-4352-9daf-71f6ea2b3d89
        description:
          description: The description of the issue.
          type: string
          example: System would be at risk if we do not renew access policies
        deadline:
          description: The date by which the issue should be resolved.
          type: string
          format: date
          example: '2021-12-31'
        ownerIds:
          description: The unique identifiers of the issue owners who will remediate the issue.
          type: array
          items:
            type: string
            format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        approverIds:
          description: The unique identifier(s) of the users assigned as approvers of the issue.
          type: array
          items:
            type: string
            format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        reasonForClosure:
          description: The reason why the issue was closed.
          type: string
          example: Resolved
        category:
          description: The category of the issue.
          type: string
          example: General
        status:
          description: The status of the issue.
          type: string
          example: Open
          enum:
          - Open
          - Closed
        sourceType:
          description: The entity type of the source record.
          type: string
          example: Risk
          enum:
          - Control
          - Evidence
          - Initiative
          - Issue
          - Risk
          - assessment
          - assets
          - entities
          - policies
          - procedures
          - processing-activities
          - standards
          - vendors
        sourceId:
          description: The unique identifier of the source record.
          type: string
          format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        note:
          description: The notes related to resolving the issue.
          type: string
          example: Closed the issue as its been resolved
        actionPlan:
          description: The remediation plan for the issue.
          type: string
          example: "1. Disabled user's unauthorized access.\n 2. Informed relevant teams."
        closedBy:
          description: The unique identifier of the user who closed the issue.
          type: string
          format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        closedDate:
          description: The date when the issue is closed.
          type: string
          example: '2025-05-07T14:42:32.950Z'
          pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$
        createdBy:
          description: The unique identifier of the user who created the issue.
          type: string
          format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        createdDate:
          description: The date when the issue is created.
          type: string
          format: date
          example: '2021-12-31'
        workflowAndStage:
          description: The details of the workflow and stage.
          $ref: '#/components/schemas/EntityWorkflowInformation'
        auditFields:
          description: The activity details of when the issue was created and last updated.
          $ref: '#/components/schemas/EntityRecordAuditInformation'
        attributes:
          description: The details of the associated attributes.
          type: object
          example:
            textAttributeName:
            - value: Text
            optionBasedAttributeName:
            - id: f2229953-b4b5-4042-8cb9-b78038cc4c46
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeValueInformation'
    AttributeValueInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the attribute.
          type: string
          format: uuid
          example: a34ccec7-1ec0-4d65-9075-bdd0d923f1d1
        value:
          description: The value of the attribute.
          type: string
          example: Text Value
        valueKey:
          description: The fallback value of the attribute that is used if a translation is not provided for a language.
          type: string
          example: attribute.option.valueKey
        colorCode:
          description: The color code associated with the attribute option.
          type: string
          example: red
        optionSelectionValue:
          description: The value used for scoring and reporting.
          type: string
          example: '3.5'
        displayLabel:
          description: The label that displays for the attribute option.
          type: string
          example: United State | San Francisco
        associatedAttributeValueInformation:
          description: The details of the associated attribute options.
          type: array
          items:
            $ref: '#/components/schemas/AssociatedAttributeValueInformation'
        disabled:
          description: This flag indicates whether the attribute option is disabled.
          type: boolean
          example: false
          default: 'false'
      required:
      - value
    AttributeDomainOptionOverrideInformation:
      type: object
      properties:
        id:
          description: Override Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        attributeDomainOptionId:
          description: Domain Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440001
        targetAttributeId:
          description: Target Attribute GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440002
        targetOptionId:
          description: Target Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440003
        option:
          description: Option name
          type: string
          example: TypeA
        optionKey:
          description: Option name key
          type: string
          example: TypeB
        optionSelectionValue:
          description: Option selection value
          type: string
          example: 10
        colorCode:
          description: Color code for the option
          type: string
          example: '#FF5733'
          maxLength: 7
        sequence:
          description: Option sequence for ordering
          type: integer
          format: int32
          example: 1
          maximum: 32767
          minimum: 1
        enabled:
          description: Indicates if the option is enabled or disabled
          type: boolean
          example: true
          default: 'true'
        optionSelectionValueAsDouble:
          type: number
          format: double
    AbacBasicAssignmentInfo:
      type: object
      properties:
        assignmentId:
          description: The unique identifier of the linked assignment.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        assignmentName:
          description: The name of the linked assignment.
          type: string
          example: Assignment1
    IssueCreateRequest:
      type: object
      properties:
        name:
          description: The name that describes the issue.
          type: string
          example: Expired Policies
          maxLength: 300
        orgGroupId:
          description: The unique identifier of the organization associated with the issue.
          type: string
          format: uuid
          example: cb49a431-3d3d-4352-9daf-71f6ea2b3d89
        priority:
          description: The priority level of the issue.
          type: string
          example: High
          enum:
          - Low
          - Medium
          - High
          - Critical
        description:
          description: The description of the issue.
          type: string
          example: System would be at risk if we do not renew access policies
          maxLength: 4000
        deadline:
          description: The date by which the issue should be resolved.
          type: string
          format: date
          example: '2021-12-31'
        ownerIds:
          description: The unique identifiers of the issue owners who will remediate the issue.
          type: array
          items:
            type: string
            format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        approverIds:
          description: The unique identifier(s) of the users assigned as approvers of the issue.
          type: array
          items:
            type: string
            format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        reasonForClosure:
          description: The reason why the issue was closed.
          type: string
          example: Resolved
        category:
          description: The category of the issue.
          type: string
          example: General
        sourceType:
          description: The entity type of the source record.
          type: string
          example: Risk
          enum:
          - Control
          - Evidence
          - Initiative
          - Issue
          - Risk
          - assessment
          - assets
          - entities
          - policies
          - procedures
          - processing-activities
          - standards
          - vendors
        sourceId:
          description: The unique identifier of the source record.
          type: string
          format: uuid
          example: ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86
        note:
          description: The notes related to resolving the issue.
          type: string
          example: Closed the issue as its been resolved
        actionPlan:
          description: The remediation plan for the issue.
          type: string
          example: "1. Disabled user's unauthorized access.\n 2. Informed relevant teams."
        attributes:
          description: The details of the associated attributes.
          type: object
          example:
            textAttributeName:
            - value: Text
            optionBasedAttributeName:
            - id: f2229953-b4b5-4042-8cb9-b78038cc4c46
            priorityLevel:
            - id: f27598c0-c5b9-466d-8a2e-9afdf61e6fe3
              value: High
              valueKey: IM.Issue.Attribute.PriorityLevel.Option.High
              colorCode: '#cd491d'
              optionSelectionValue: '20'
              displayLabel: null
              disabled: false
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeValueInformation'
      required:
      - name
      - orgGroupId
      - priority
    CreateIssueLinkRequest:
      type: object
      properties:
        linkTypeLabel:
          description: The label of the relationship.
          type: string
          example: is related to
          enum:
          - is related to
        relatedEntityType:
          description: The entity type of the related record.
          type: string
          example: Risk
          enum:
          - Control
          - Evidence
          - Initiative
          - Issue
          - Risk
          - assessment
          - assets
          - entities
          - policies
          - procedures
          - processing-activities
          - standards
          - vendors
        relatedEntityId:
          description: The unique identifier of the related record.
          type: string
          format: uuid
          example: ab129a431-3d3d-4352-9daf-71f6ea2b3d70
      required:
      - linkTypeLabel
      - relatedEntityId
      - relatedEntityType
    EntityDetails:
      type: object
      properties:
        id:
          description: The unique identifier of the related record.
          type: string
          format: uuid
          example: ab129a431-3d3d-4352-9daf-71f6ea2b3d70
        name:
          description: The name of the related record.
          type: string
          example: Test risk
      required:
      - id
      - name
    EntityWorkflowInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the workflow.
          type: string
          format: uuid
          example: b271c01a-89a9-41b1-8185-0a3e2bfdad84
        name:
          description: The name of the workflow.
          type: string
          example: Vendor On-Boarding Workflow
        type:
          description: The type of workflow.
          type: string
          example: Vendor
        workflowMode:
          description: The mode in which the workflow was created.
          type: string
          example: BASIC
          enum:
          - ADVANCED, BASIC
        stageId:
          description: The unique identifier of the workflow stage.
          type: string
          format: uuid
          example: 9fc111cb-c379-4f08-8aff-5be954c1a6e6
        stageName:
          description: The name of the workflow stage.
          type: string
          example: Start On-Boarding
      example:
        id: b271c01a-89a9-41b1-8185-0a3e2bfdad84
        name: Vendor On-Boarding Workflow
        nameKey: Workflow.VendorOnBoarding.Name
        type: Vendor
        workflowMode: BASIC
        stageId: 9fc111cb-c379-4f08-8aff-5be954c1a6e6
        stageName: Start On-Boarding
        stageNameKey: Workflow.VendorOnBoarding.Stage.StartOnBoarding
        badgeColor: '#4287f5'
      required:
      - id
      - name
      - stageId
      - stageName
      - type
    IssuePatchRequest:
      type: object
      properties:
        fields:
          description: The issue parameters to update, can contain simple values or complex attribute objects.
          type: object
          example:
            name: Updated Issue Name
          additionalProperties:
            type: object
        empty:
          description: The flag that indicates whether the request is empty.
          type: boolean
    AttributePredicate:
      type: object
      properties:
        field:
          description: The field name used to filter results.
          type: string
        operator:
          description: The relationship that must be met between the field and value.
          type: string
          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 = 8"
          type: object
          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 = 8"
          type: object
          oneOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: string
          - type: number
      required:
      - field
    AttributeOptionMetadataInformation:
      type: object
      properties:
        entityTypeName:
          description: The type of system list used to source the attribute option.
          type: string
          example: Location
        basicServiceContextPath:
          description: The base path of the API URL used to source the attribute option.
          type: string
          example: /api/location
        optionUrl:
          description: The API URL path used to source the attribute option.
          type: string
          example: /api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages
        optionListUrl:
          description: The API URL to retrieve the complete list of entities for the dropdown.
          type: string
          example: /api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details
        viewType:
          description: The display format of the attribute option.
          type: string
        optionType:
          description: The type of option.
          type: string
          example: BusinessLocations
        permissions:
          description: The permissions required to access the attribute options.
          type: array
          items:
            type: string
          example: '[features.core-constructs.view]'
        applicationUrl:
          description: The URL of the application where the attribute options are managed.
          type: string
          example: /settings/location-management/location/Location
    AssociatedAttributeValueInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the attribute option.
          type: string
          format: uuid
          example: a34ccec7-1ec0-4d65-9075-bdd0d923f1d1
        value:
          description: The value of the attribute.
          type: string
          example: Text Value
        valueKey:
          description: The fallback value of the attribute that is used if a translation is not provided for a language.
          type: string
          example: attribute.option.valueKey
        colorCode:
          description: The color code associated with the attribute option.
          type: string
          example: red
      required:
      - value
    CategoryInformation:
      type: object
      properties:
        id:
          description: The unique identifier of the category.
          type: string
          format: uuid
        name:
          description: The name of the category.
          type: string
          example: Financial Category
        nameKey:
          description: The fallback name of the category that is used if a translation is not provided for a language.
          type: string
          example: IM.FinancialCategoryName
    AttributeQueryCriteria:
      type: object
      properties:
        filters:
          description: The fields and values used to filter results.
          type: array
          items:
            $ref: '#/components/schemas/AttributePredicate'
          uniqueItems: true
        fullText:
          description: The key terms for the search criteria.
          type: string
      example:
        fullText: Expired Policies
        filters:
        - field: organization
          value:
          - ff9e09ee-3a89-4af7-acc0-ccc45ba34970
          operator: EQUAL_TO
        - field: owner
          value:
          - f4894a72-c2a1-4b1d-85af-176bf16558f8
          - aca8be12-c379-4577-a9ff-6d31e70299c1
          operator: EQUAL_TO
  securitySchemes:
    OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            ISSUE: Grants full access to Issues related APIs.
            ISSUE_READ: Grants read access to Issues related APIs
x-onetrust:
  spec-label: OpenAPI 3.1.0
  links:
  - '{''Issues Management Knowledge Base'': ''https://my.onetrust.com/s/topic/0TO3q000000sjDAGAY/issues-management''}'
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false