openapi: 3.2.0
info:
  title: AI Governance - AI Governance Task Management 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 AI Governance APIs are used to integrate external systems and streamline the flow of data with AI Governance in the OneTrust Platform.
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: Task Management
  description: The Task Management APIs are used to manage tasks associated with AI Governance entities.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
paths:
  /api/ai-governance/v1/tasks:
    post:
      operationId: createTaskUsingPOST_1
      summary: Create Task
      description: 'Use this API to create a new task for an entity.


        > 🗒 Things to Know

        >

        > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).

        > - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.'
      tags:
      - Task Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreateRequest'
            examples:
              Basic Task Creation:
                summary: Create a simple task with minimal details
                description: Creates a basic task with required fields only
                value:
                  parentEntityId: ea2586b9-d40a-41c8-808e-2801e33a757d
                  taskName: Review compliance documentation
                  description: <p>Review all compliance documentation for the latest model</p>
                  assigneeId: e9922cc1-b33b-4a7f-b02a-b0d3645d8e90
                  deadline: null
                  orgGroupId: 06e43366-1f49-4afd-8c51-3989f9cf98f1
                  taskTypeNameKey: datasets
                  priority: HIGH
                  collaborators: []
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskInformation'
              examples:
                Task Creation Response:
                  summary: Sample response for a successful task creation
                  description: Task Creation Response
                  value:
                    id: 7294afcc-7d18-4231-ac0f-79ed55502947
                    parentEntityId: ea2586b9-d40a-41c8-808e-2801e33a757d
                    taskName: Albania Test
                    taskType:
                      name: datasets
                      nameKey: TaskRegistry.TaskType.ModuleTask.Name.Datasets
                      module: CustomObject
                      moduleNameTranslationKey: TaskRegistry.Module.Name.CustomObject
                      id: c569969c-94a9-4e2c-869d-e8334063d2ed
                      label: null
                      icon: null
                    deadline: null
                    status: Open
                    priority: HIGH
                    description: <p>Albania Test</p>
                    orgGroupId: 06e43366-1f49-4afd-8c51-3989f9cf98f1
                    orgGroupAttribute:
                      valueKey: 06e43366-1f49-4afd-8c51-3989f9cf98f1
                      value: AIGovernance-New
                    assigneeId: e9922cc1-b33b-4a7f-b02a-b0d3645d8e90
                    isActive: true
                    sourceType: null
                    sourceId: null
                    moduleSource: null
                    taskAssignmentInformations:
                    - userInfo:
                        name: Vinod Ramachandran
                        nameWithAttributes: Vinod Ramachandran
                      assigneeId: e9922cc1-b33b-4a7f-b02a-b0d3645d8e90
                      type: USER
                      isCollaborator: false
                    presentationMode: DRAWER
                    isCollaboratorSupported: true
                    isCollaboratorGroupSupported: true
                    relativeUrl: null
                    activity: COMPLETE_TASK
                    workflowAndStageBasicInformation: null
                    workflowId: null
                    workflowStageId: null
                    stageName: null
                    stageNameKey: null
                    badgeColor: null
                    dueDateInfo: null
                    permissionsMetadata: null
                    createdBy: e9922cc1-b33b-4a7f-b02a-b0d3645d8e90
                    createdByAttribute:
                      valueKey: e9922cc1-b33b-4a7f-b02a-b0d3645d8e90
                      value: Vinod Ramachandran
                    createdDT: '2025-11-20T07:38:02.333Z'
                    modifiedBy: null
                    modifiedByAttribute: null
                    modifiedDT: null
                    completionDate: null
                    isRequired: false
                    canEditRequiredTask: null
                    pastDue: false
                    activityKey: TaskRegistry.ActivityKey.CompleteTask
        '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:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
  /api/ai-governance/v1/tasks/{taskId}:
    get:
      operationId: findTaskUsingGET_1
      summary: Get Task
      description: 'Use this API to retrieve a specific task on an entity. The response will include details such as the activity history, assignee, and deadline.


        > 🗒 Things to Know

        >

        > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).

        > - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.'
      tags:
      - Task Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters:
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          description: Task identifier
          type: string
          format: uuid
        example: d6e48f40-323c-4a3a-a313-b333fac6d61d
      - name: includePermissionsMetadata
        in: query
        description: Flag to include permissions metadata
        required: false
        schema:
          description: Flag to include permissions metadata
          type: boolean
          default: false
        example: false
      - name: excludeInactiveTasks
        in: query
        description: Flag to exclude inactive tasks
        required: false
        schema:
          description: Flag to exclude inactive tasks
          type: boolean
          default: false
        example: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskInformation'
              examples:
                Task Details Response:
                  summary: Sample response with complete task details
                  description: Task Details Response
                  value:
                    id: a1f229b1-8041-48ba-9354-ce90c03ce5b8
                    parentEntityId: 804c2939-c265-4181-9f52-fbdba80ff042
                    taskName: task_01
                    taskType:
                      name: datasets
                      nameKey: TaskRegistry.TaskType.ModuleTask.Name.Datasets
                      module: CustomObject
                      moduleNameTranslationKey: TaskRegistry.Module.Name.CustomObject
                      id: c569969c-94a9-4e2c-869d-e8334063d2ed
                      label: null
                      icon: null
                    deadline: '2025-07-01T00:00:00Z'
                    status: Open
                    priority: LOW
                    description: <p>desc</p>
                    orgGroupId: c9e5a35b-9be7-4dd6-adac-0bee7c02384f
                    orgGroupAttribute:
                      valueKey: c9e5a35b-9be7-4dd6-adac-0bee7c02384f
                      value: PLTF REP
                    assigneeId: 5689bde5-ed2e-47b4-9671-2185cdcd4d31
                    isActive: true
                    sourceType: null
                    sourceId: null
                    moduleSource: null
                    taskAssignmentInformations:
                    - userInfo:
                        name: User 1
                        nameWithAttributes: User 1
                      assigneeId: 5689bde5-ed2e-47b4-9671-2185cdcd4d31
                      type: USER
                      isCollaborator: false
                    - userInfo:
                        name: Vinod Ramachandran
                        nameWithAttributes: Arpita K
                      assigneeId: 41955b71-e581-4187-ab6c-d00d1403350c
                      type: USER
                      isCollaborator: true
                    - userInfo:
                        name: ADAN-7056_TEST
                        nameWithAttributes: null
                      assigneeId: 4265747b-ca7f-4b71-bfc0-93271214a41a
                      type: GROUP
                      isCollaborator: true
                    presentationMode: DRAWER
                    isCollaboratorSupported: true
                    isCollaboratorGroupSupported: true
                    relativeUrl: https://lkgb.1trust.app/ai-governance/datasets-type/datasets/804c2939-c265-4181-9f52-fbdba80ff042/details?context=eyJ0ZW5hbnRIYXNoIjoiJDJhJDEwJENSanpTWUJNSE1zeWk3dXE4RG1PZS5pZ3dQUm9XcFllSUFIdE1Wa0JoaGVGVVM2dmFNM0J5In0%3D&contextVersion=1
                    activity: COMPLETE_TASK
                    workflowAndStageBasicInformation: null
                    workflowId: null
                    workflowStageId: null
                    stageName: null
                    stageNameKey: null
                    badgeColor: null
                    dueDateInfo: null
                    permissionsMetadata: null
                    createdBy: 41955b71-e581-4187-ab6c-d00d1403350c
                    createdByAttribute:
                      valueKey: 41955b71-e581-4187-ab6c-d00d1403350c
                      value: Vinod Ramachandran
                    createdDT: '2025-06-12T11:59:08.581Z'
                    modifiedBy: 41955b71-e581-4187-ab6c-d00d1403350c
                    modifiedByAttribute:
                      valueKey: 41955b71-e581-4187-ab6c-d00d1403350c
                      value: Vinod Ramachandran
                    modifiedDT: '2025-06-12T12:04:06.048Z'
                    completionDate: null
                    isRequired: false
                    canEditRequiredTask: null
                    pastDue: false
                    activityKey: TaskRegistry.ActivityKey.CompleteTask
        '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:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
        - AI_GOVERNANCE_READ
    put:
      operationId: updateTaskUsingPUT_1
      summary: Update Task
      description: 'Use this API to update an existing task for an entity.


        > 🗒 Things to Know

        >

        > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).

        > - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.'
      tags:
      - Task Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters:
      - name: taskId
        in: path
        description: UUID of the Task to be updated
        required: true
        schema:
          description: Task identifier
          type: string
          format: uuid
        example: 4a99acea-0393-4710-a58c-40a68744ecf3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskUpdateRequest'
            examples:
              Update Task Status:
                summary: Update task status and progress
                description: Updates a task's status and progress information
                value:
                  taskName: task_01
                  description: <p>desc</p>
                  assigneeId: 41955b71-e581-4187-ab6c-d00d1403350c
                  deadline: '2025-06-30T00:00:00.000'
                  status: Open
                  priority: LOW
                  collaborators:
                  - collaboratorId: 41955b71-e581-4187-ab6c-d00d1403350c
                    type: USER
                  - collaboratorId: 4265747b-ca7f-4b71-bfc0-93271214a41a
                    type: GROUP
              Reassign Task:
                summary: Change task assignee and due date
                description: Reassigns a task to a different person and updates the due date
                value:
                  taskName: task_01
                  description: <p>desc</p>
                  assigneeId: 5689bde5-ed2e-47b4-9671-2185cdcd4d31
                  deadline: '2025-07-01T00:00:00.000'
                  status: Open
                  priority: LOW
                  collaborators:
                  - collaboratorId: 41955b71-e581-4187-ab6c-d00d1403350c
                    type: USER
                  - collaboratorId: 4265747b-ca7f-4b71-bfc0-93271214a41a
                    type: GROUP
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskInformation'
              examples:
                Updated Task Response:
                  summary: Sample response for a successful task update
                  description: Updated Task Response
                  value:
                    id: a1f229b1-8041-48ba-9354-ce90c03ce5b8
                    parentEntityId: 804c2939-c265-4181-9f52-fbdba80ff042
                    taskName: task_01
                    taskType:
                      name: datasets
                      nameKey: TaskRegistry.TaskType.ModuleTask.Name.Datasets
                      module: CustomObject
                      moduleNameTranslationKey: TaskRegistry.Module.Name.CustomObject
                      id: c569969c-94a9-4e2c-869d-e8334063d2ed
                      label: null
                      icon: null
                    deadline: '2025-07-01T00:00:00Z'
                    status: Open
                    priority: LOW
                    description: <p>desc</p>
                    orgGroupId: c9e5a35b-9be7-4dd6-adac-0bee7c02384f
                    orgGroupAttribute:
                      valueKey: c9e5a35b-9be7-4dd6-adac-0bee7c02384f
                      value: PLTF REP
                    assigneeId: 5689bde5-ed2e-47b4-9671-2185cdcd4d31
                    isActive: true
                    sourceType: null
                    sourceId: null
                    moduleSource: null
                    taskAssignmentInformations:
                    - userInfo:
                        name: ADAN-7056_TEST
                        nameWithAttributes: null
                      assigneeId: 4265747b-ca7f-4b71-bfc0-93271214a41a
                      type: GROUP
                      isCollaborator: true
                    - userInfo:
                        name: User 1
                        nameWithAttributes: User 1
                      assigneeId: 5689bde5-ed2e-47b4-9671-2185cdcd4d31
                      type: USER
                      isCollaborator: false
                    - userInfo:
                        name: Arpita K
                        nameWithAttributes: Arpita K
                      assigneeId: 41955b71-e581-4187-ab6c-d00d1403350c
                      type: USER
                      isCollaborator: true
                    presentationMode: DRAWER
                    isCollaboratorSupported: true
                    isCollaboratorGroupSupported: true
                    relativeUrl: null
                    activity: COMPLETE_TASK
                    workflowAndStageBasicInformation: null
                    workflowId: null
                    workflowStageId: null
                    stageName: null
                    stageNameKey: null
                    badgeColor: null
                    dueDateInfo: null
                    permissionsMetadata: null
                    createdBy: 41955b71-e581-4187-ab6c-d00d1403350c
                    createdByAttribute:
                      valueKey: 41955b71-e581-4187-ab6c-d00d1403350c
                      value: Arpita K
                    createdDT: '2025-06-12T11:59:08.581Z'
                    modifiedBy: 41955b71-e581-4187-ab6c-d00d1403350c
                    modifiedByAttribute:
                      valueKey: 41955b71-e581-4187-ab6c-d00d1403350c
                      value: Arpita K
                    modifiedDT: '2025-06-12T12:04:05.812Z'
                    completionDate: null
                    isRequired: false
                    canEditRequiredTask: null
                    pastDue: false
                    activityKey: TaskRegistry.ActivityKey.CompleteTask
        '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:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
components:
  schemas:
    AttributeValue:
      type: object
      properties:
        valueKey:
          description: Key or identifier for the attribute value
          type: string
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
          maxLength: 255
          minLength: 1
        value:
          description: The display value of the attribute
          type: string
          example: Document Review Team
          maxLength: 255
          minLength: 1
      example:
        valueKey: f47ac10b-58cc-4372-a567-0e02b2c3d479
        value: Document Review Team
      required:
      - value
      - valueKey
    TaskCreateRequest:
      type: object
      properties:
        parentEntityId:
          description: ID of the parent entity
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        taskName:
          description: Name of the task
          type: string
          example: Review document
          maxLength: 512
          minLength: 0
        description:
          description: Description of the task
          type: string
          example: Please review the attached document and provide feedback
          maxLength: 2000
        orgGroupId:
          description: Organization group ID
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        taskTypeNameKey:
          description: Key identifying the task type
          type: string
          example: REVIEW_TASK
          maxLength: 100
          minLength: 1
        assigneeId:
          description: ID of the assignee
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        assigneeEmail:
          description: Email of the assignee
          type: string
          example: user@example.com
          maxLength: 255
          minLength: 5
        collaborators:
          description: List of task collaborators
          type: array
          items:
            $ref: '#/components/schemas/TaskCollaboratorDto'
        deadline:
          description: Deadline for the task
          type: string
          format: date-time
          example: '2023-12-31T23:59:59'
        context:
          description: Context information for the task
          $ref: '#/components/schemas/TaskContextInformation'
        isActive:
          description: Flag indicating if the task is active
          type: boolean
          example: true
          default: 'false'
        sourceType:
          description: Type of source that created the task
          type: string
          example: RULES
          maxLength: 16
          minLength: 0
        sourceId:
          description: ID of the source that created the task
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        resourceId:
          description: ID of the resource
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        resourceTypeNameKey:
          description: Key identifying the resource type
          type: string
          example: ASSESSMENT
          maxLength: 100
          minLength: 1
        moduleSource:
          description: Source module
          type: string
          enum:
          - assessment
          - audit-mgmt
          - cyber-risk
          - data-mapping
          - data-governance
          - esg
          - erm
          - incident
          - issue
          - itrm
          - program-benchmarking
          - maturity-planning
          - risk
          - vendor
          - vendor-portal
          - compliance-automation
          - SpeakUp
          - EntityScoping
          - ControlObjective
          - exception
        priority:
          description: Priority level of the task
          type: string
          example: MEDIUM
          default: MEDIUM
          enum:
          - LOW
          - MEDIUM
          - HIGH
        isRequired:
          description: Flag indicating if the task is required
          type: boolean
          example: false
          default: 'false'
      example:
        parentEntityId: 123e4567-e89b-12d3-a456-426614174000
        taskName: Review document
        description: Please review the attached document and provide feedback
        orgGroupId: 123e4567-e89b-12d3-a456-426614174000
        taskTypeNameKey: REVIEW_TASK
        assigneeId: 123e4567-e89b-12d3-a456-426614174000
        deadline: '2023-12-31T23:59:59'
        priority: MEDIUM
      required:
      - orgGroupId
      - parentEntityId
      - taskName
      - taskTypeNameKey
    DueDateInfo:
      type: object
      properties:
        date:
          description: The due date timestamp
          type: string
          format: date-time
          example: '2023-12-31T23:59:59Z'
        color:
          description: Color code for displaying the due date
          type: string
          example: '#FF0000'
          maxLength: 7
          minLength: 1
        icon:
          description: Icon identifier for the due date status
          type: string
          example: clock-warning
          maxLength: 50
          minLength: 1
        textKey:
          description: Translation key for text to display with the due date
          type: string
          example: TaskRegistry.DueDate.Overdue
          maxLength: 255
          minLength: 1
        numberOfDays:
          description: Number of days until or past the due date
          type: integer
          format: int64
          example: 5
      example:
        date: '2023-12-31T23:59:59Z'
        color: '#FF0000'
        icon: clock-warning
        textKey: TaskRegistry.DueDate.Overdue
        numberOfDays: 5
      required:
      - color
      - date
      - icon
      - numberOfDays
      - textKey
    TaskContextInformation:
      type: object
      properties:
        parameters:
          description: Dynamic key-value parameters for task context
          additionalProperties:
            type: object
          example:
            taskId: 123e4567-e89b-12d3-a456-426614174000
            priority: HIGH
            assignedTo: john.doe@example.com
          type: object
      example:
        parameters:
          assignedTo: john.doe@example.com
          priority: HIGH
          taskId: 123e4567-e89b-12d3-a456-426614174000
    TaskInformation:
      type: object
      properties:
        id:
          description: Unique identifier for the task
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        parentEntityId:
          description: Identifier of the parent entity
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        taskName:
          description: Name of the task
          type: string
          example: Review Document XYZ
          maxLength: 255
          minLength: 1
        taskType:
          description: Information about the task type
          example:
            id: 123e4567-e89b-12d3-a456-426614174000
            name: Document Review
            description: Review and approve documents
          $ref: '#/components/schemas/TaskTypeInformation'
        deadline:
          description: Deadline for completing the task
          type: string
          format: date-time
          example: '2023-12-31T23:59:59Z'
        status:
          description: Current status of the task
          type: string
          example: Open
          enum:
          - Open
          - Closed
        priority:
          description: Priority level of the task
          type: string
          example: MEDIUM
          enum:
          - LOW
          - MEDIUM
          - HIGH
        description:
          description: Detailed description of the task
          type: string
          example: This task requires reviewing document X and providing feedback
          maxLength: 4000
        orgGroupId:
          description: Organization group identifier associated with the task (deprecated)
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          deprecated: true
        orgGroupAttribute:
          description: Organization name and identifier information
          example:
            value: OneTrust LLC
            valueKey: 123e4567-e89b-12d3-a456-426614174000
          $ref: '#/components/schemas/AttributeValue'
        assigneeId:
          description: ID of the task assignee
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        isActive:
          description: Indicates if the task is active
          type: boolean
          example: true
          default: 'true'
        sourceType:
          description: The source type that created the task
          type: string
          example: RULES
          maxLength: 50
        sourceId:
          description: ID of the source that created the task
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        moduleSource:
          description: Source module for the task
          type: string
          example: assessment
          enum:
          - assessment
          - audit-mgmt
          - cyber-risk
          - data-mapping
          - data-governance
          - esg
          - erm
          - incident
          - issue
          - itrm
          - program-benchmarking
          - maturity-planning
          - risk
          - vendor
          - vendor-portal
          - compliance-automation
          - SpeakUp
          - EntityScoping
          - ControlObjective
          - exception
        taskAssignmentInformations:
          description: List of assignment information for the task
          type: array
          items:
            $ref: '#/components/schemas/TaskAssignmentInformation'
          example:
          - assigneeId: 123e4567-e89b-12d3-a456-426614174000
            assigneeName: John Doe
            assignmentType: PRIMARY
        presentationMode:
          description: The presentation mode for the task
          type: string
          example: DEFAULT
          enum:
          - NAVIGATION
          - DRAWER
        isCollaboratorSupported:
          description: Indicates if collaborators are supported for this task
          type: boolean
          example: true
          default: 'false'
        isCollaboratorGroupSupported:
          description: Indicates if collaborator groups are supported for this task
          type: boolean
          example: true
          default: 'false'
        relativeUrl:
          description: Relative URL associated with the task
          type: string
          example: /tasks/review/123
          maxLength: 255
        activity:
          description: Activity type for the task
          type: string
          example: COMPLETE_TASK
          enum:
          - COMPLETE_TASK
          - REVIEW_DSARSUBTASK
          - APPROVE_RISK
          - RESPOND_TO_ASSESSMENT
          - COMPLETE_AUDIT
          - REVIEW_REQUEST
          - COURSE_COMPLETION_PENDING
          - REVIEW_ASSESSMENT
          - REVIEW_INCIDENT
          - IMPLEMENT_CONTROL
          - RISK_TREATMENT
          - REVIEW_FINDING
          - ACKNOWLEDGE_TO_ATTESTATION
          - REVIEW_INITIATIVE
          - COMPLETE_DISCLOSURE
          - COMPLETE_DISCLOSURE_ATTESTATION
          - EVIDENCE_TASK
          - COMPLETE_DISC_QUESTIONNAIRE
          - COMPLIANCE_INITIATIVE
          - REVIEW_ISSUE
          - CASE_ASSIGNED
          - SPEAK_UP_QUESTION_ASSIGNED
          - CONTROL_OBJECTIVE
          - REVIEW_EXCEPTION
        workflowAndStageBasicInformation:
          description: Basic information about workflow and current stage
          type: object
          example:
            workflowName: Document Approval Workflow
            currentStage: Review Stage
            stageOrder: 2
        workflowId:
          description: ID of the workflow associated with the task
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        workflowStageId:
          description: ID of the workflow stage associated with the task
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        stageName:
          description: Name of the current workflow stage
          type: string
          example: Review
          maxLength: 255
        stageNameKey:
          description: Translation key for the stage name
          type: string
          example: TaskRegistry.Stage.Review
          maxLength: 255
        badgeColor:
          description: Color of the badge for the current stage
          type: string
          example: '#4287f5'
          maxLength: 7
        dueDateInfo:
          description: Information about the due date including formatting details
          $ref: '#/components/schemas/DueDateInfo'
        permissionsMetadata:
          description: Metadata about permissions for this task
          type: object
          additionalProperties:
            type: boolean
        createdBy:
          description: ID of the user who created the task (deprecated)
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          deprecated: true
        createdByAttribute:
          description: Information about the user who created the task
          example:
            value: Jane Smith
            valueKey: 456e7890-e89b-12d3-a456-426614174000
          $ref: '#/components/schemas/AttributeValue'
        createdDT:
          description: Date and time when the task was created
          type: string
          format: date-time
          example: '2023-01-15T14:30:00Z'
        modifiedBy:
          description: ID of the user who last modified the task (deprecated)
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          deprecated: true
        modifiedByAttribute:
          description: Information about the user who last modified the task
          example:
            value: Jane Smith
            valueKey: 456e7890-e89b-12d3-a456-426614174000
          $ref: '#/components/schemas/AttributeValue'
        modifiedDT:
          description: Date and time when the task was last modified
          type: string
          format: date-time
          example: '2023-01-20T16:45:00Z'
        completionDate:
          description: Date and time when the task was completed
          type: string
          format: date-time
          example: '2023-01-25T09:15:00Z'
        isRequired:
          description: Indicates if the task is required
          type: boolean
          example: true
          default: 'false'
        canEditRequiredTask:
          description: Indicates if a required task can be edited
          type: boolean
          example: false
          default: 'false'
        pastDue:
          type: boolean
        activityKey:
          type: string
          deprecated: true
      example:
        id: 123e4567-e89b-12d3-a456-426614174000
        taskName: Document Review Task
        status: Open
        priority: MEDIUM
        deadline: '2023-12-31T23:59:59Z'
        description: This task requires reviewing document X and providing feedback
        assigneeId: 123e4567-e89b-12d3-a456-426614174000
        isActive: true
        taskType:
          id: type-123
          name: Document Review
          description: Review and approve documents
        moduleSource: PRIVACY_RIGHTS
        activity: COMPLETE_TASK
        presentationMode: DEFAULT
        isCollaboratorSupported: true
        relativeUrl: /tasks/review/123
        workflowId: workflow-456
        stageName: Review
        isPastDue: false
        createdDT: '2023-01-15T14:30:00Z'
        modifiedDT: '2023-01-20T16:45:00Z'
        isRequired: true
      required:
      - deadline
      - id
      - isActive
      - parentEntityId
      - priority
      - status
      - taskName
      - taskType
    TaskCollaboratorDto:
      type: object
      properties:
        collaboratorId:
          description: Unique identifier of the collaborator
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        collaboratorEmail:
          description: Email address of the collaborator
          type: string
          example: collaborator@example.com
          maxLength: 255
          minLength: 5
        type:
          description: Type of assignee (User or Group)
          type: string
          example: USER
          enum:
          - USER
          - GROUP
      example:
        collaboratorId: 123e4567-e89b-12d3-a456-426614174000
        collaboratorEmail: collaborator@example.com
        type: USER
      required:
      - type
    TaskTypeInformation:
      type: object
      properties:
        name:
          description: Name of the task type
          type: string
          example: DOCUMENT_REVIEW
          maxLength: 100
          minLength: 1
        nameKey:
          description: Translation key for the task type name
          type: string
          example: TaskRegistry.TaskType.DocumentReview
          maxLength: 255
          minLength: 1
        module:
          description: Module that this task type belongs to
          type: string
          example: ASSESSMENT
          maxLength: 100
          minLength: 1
        moduleNameTranslationKey:
          description: Translation key for the module name
          type: string
          example: TaskRegistry.Module.Assessment
          maxLength: 255
          minLength: 1
        id:
          description: Unique identifier for the task type
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        label:
          description: Display label for the task type
          type: string
          example: Document Review
          maxLength: 255
          minLength: 1
        icon:
          description: Icon identifier for the task type
          type: string
          example: document-check
          maxLength: 50
          minLength: 1
      example:
        id: 123e4567-e89b-12d3-a456-426614174000
        name: DOCUMENT_REVIEW
        nameKey: TaskRegistry.TaskType.DocumentReview
        module: ASSESSMENT
        moduleNameTranslationKey: TaskRegistry.Module.Assessment
        label: Document Review
        icon: document-check
      required:
      - id
      - label
      - module
      - moduleNameTranslationKey
      - name
      - nameKey
    TaskAssignmentInformation:
      type: object
      properties:
        userInfo:
          description: Detailed information about the assigned user
          $ref: '#/components/schemas/UserInfo'
        assigneeId:
          description: Unique identifier of the assignee (user or group)
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        type:
          description: Type of the assignee (user or group)
          type: string
          example: USER
          enum:
          - USER
          - GROUP
        isCollaborator:
          description: Indicates if this assignment is as a collaborator or primary assignee
          type: boolean
          example: false
          default: 'false'
      example:
        taskId: 123e4567-e89b-12d3-a456-426614174000
        userInfo:
          id: 123e4567-e89b-12d3-a456-426614174001
          name: John Doe
        assigneeId: 123e4567-e89b-12d3-a456-426614174000
        type: USER
        isCollaborator: false
      required:
      - assigneeId
      - isCollaborator
      - type
    TaskUpdateRequest:
      type: object
      properties:
        taskName:
          description: Name of the task
          type: string
          example: Review document
          maxLength: 512
          minLength: 1
        description:
          description: Description of the task
          type: string
          example: Please review the attached document and provide feedback
          maxLength: 2000
        assigneeId:
          description: ID of the assignee
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        assigneeEmail:
          description: Email of the assignee
          type: string
          example: user@example.com
          maxLength: 255
          minLength: 5
        collaborators:
          description: List of task collaborators
          type: array
          items:
            $ref: '#/components/schemas/TaskCollaboratorDto'
        deadline:
          description: Deadline for the task
          type: string
          format: date-time
          example: '2023-12-31T23:59:59'
        status:
          description: Status of the task
          type: string
          example: Open
          enum:
          - Open
          - Closed
        context:
          description: Context information for the task
          $ref: '#/components/schemas/TaskContextInformation'
        priority:
          description: Priority level of the task
          type: string
          example: MEDIUM
          default: MEDIUM
          enum:
          - LOW
          - MEDIUM
          - HIGH
        isRequired:
          description: Flag indicating if the task is required
          type: boolean
          example: false
          default: 'false'
        sourceType:
          description: Type of source that created the task
          type: string
          example: RULES
          maxLength: 16
          minLength: 0
        sourceId:
          description: ID of the source that created the task
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
      example:
        taskName: Review document
        description: Please review the attached document and provide feedback
        assigneeId: 123e4567-e89b-12d3-a456-426614174000
        deadline: '2023-12-31T23:59:59'
        status: Open
        priority: MEDIUM
      required:
      - taskName
    UserInfo:
      type: object
      properties:
        name:
          description: The user's name
          type: string
          example: John Doe
          maxLength: 255
          minLength: 0
        nameWithAttributes:
          description: The user's name with additional attributes
          type: string
          example: 'John Doe (Admin, Department: IT)'
          maxLength: 500
          minLength: 0
      example:
        name: John Doe
        nameWithAttributes: 'John Doe (Admin, Department: IT)'
      required:
      - name
  securitySchemes:
    OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            AI_GOVERNANCE: Grants full permissions to manage AI Governance operations for external systems
            AI_GOVERNANCE_READ: Allows read-only access to AI Governance entities
            AI_GOVERNANCE_WRITE: Grants permissions to create and modify AI Governance entities
x-onetrust:
  spec-label: OpenAPI 3.1.0
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false