---
title: "TaskRequest"
url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/TaskRequest"
---

> Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md

# TaskRequest

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Case Management API
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io/
    description: Dev Environment
  - url: https://qa.api.zinnia.io/
    description: QA Environment
  - url: https://uat.api.zinnia.io/
    description: UAT Environment
  - url: https://api.zinnia.io/
    description: PROD Environment
components:
  schemas:
    TaskMappedRequestDocument:
      type: object
      description: Metadata for a document mapped to a specific task in the system.
      properties:
        documentId:
          type: string
          description: A unique identifier for the document.
          example: abc12345
        documentName:
          type: string
          description: The name of the document.
          example: Report_Q1_2024.pdf
        documentSource:
          type: string
          description: The origin or source of the document, such as a system name or
            module.
          example: Zinnia.OnBase
        fileType:
          type: string
          description: Type of document, like pdf or an image.
          example: pdf
        displayName:
          type: string
          description: Display name of the document.
          example: Replacement of Life Insurance or Annuities
        operationType:
          type: string
          description: Specifies the type of operation to be performed on the document.
          enum:
            - REMOVE
            - ADD
          example: REMOVE
        createdDate:
          type: string
          format: date-time
          description: Timestamp when the document was created.
    RequestLinkedTask:
      type: object
      description: Metadata for a linked tasks to a specific task in the system.
      properties:
        taskId:
          type: string
          description: Task Instance Id.
          example: TA000000014642
        externalId:
          type: string
          description: The identifier how an external system understand it for example
            used to map onbase taskId.
          example: 23bfac3e-e082-47ef-8619-97e96b17695d
        reason:
          type: string
          description: Reason for linking the task.
          example: Identified By BPM
    TaskRequest:
      type: object
      properties:
        id:
          type: string
          nullable: true
          example: 36be3d51-2246-4158-9feb-a29fe5bd0183
        source:
          type: string
          example: Zinnia.OnBase
        taskType:
          type: string
          example: Suitability
        status:
          type: string
          example: NEW
        scheduledReason:
          type: string
          example: DOCUMENT_MISSING
        scheduledDate:
          type: string
          format: date-time
        cancellationReason:
          type: string
          example: CASE_CANCELATION
        mappedExceptions:
          type: array
          description: Exceptions to be linked the task
          items:
            type: string
          example:
            - EX000000000188
        mappedDocuments:
          type: array
          description: Documents to be linked with the task
          items:
            $ref: "#/components/schemas/TaskMappedRequestDocument"
        data:
          type: object
          example: {}
        linkedTasks:
          type: array
          description: tasks to be linked with the task
          items:
            $ref: "#/components/schemas/RequestLinkedTask"
```