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

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

# TaskSearchResponseModel

Represents the details of the task, including exceptions, data, and schema.

## 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:
    TaskMappedDocument:
      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
        createdDate:
          type: string
          format: date-time
          description: Timestamp when the document was created.
    LinkedTask:
      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
        reason:
          type: string
          description: Reason for linking the task.
          example: Identified By BPM
    TaskSearchResponseModel:
      description: Represents the details of the task, including exceptions, data, and
        schema.
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the task instance
          example: TA000000000302
        caseId:
          type: string
          description: Identifier for the case related to the task
          example: CA0000005579
        policyNumber:
          type: string
          description: policyNumber for the case related to the task
          example: "7680002791"
        source:
          type: string
          description: Source of the task instance
          example: BPM.Redemption
        externalId:
          type: string
          description: External task identifier
          example: "9755818"
        templateId:
          type: string
          description: Identifier for the template used
          example: aedb60fb-48b1-4b87-a7a2-57593c39cbb1
        process:
          type: string
          description: Process associated with the task
          example: New Business
        carrier:
          type: string
          description: Carrier associated with the task
          example: Carrier_1
        taskType:
          type: string
          description: Type of the task
          example: Suitability
        taskName:
          type: string
          description: Name of the task
          example: Suitability Review
        taskDetails:
          type: string
          description: Details of the task
          example: Important task details..
        status:
          type: string
          description: Current status of the task
          example: NEW
          enum:
            - NEW
            - INPROGRESS
            - SCHEDULED
            - CANCELLED
            - COMPLETED
        data:
          type: object
          additionalProperties: true
          description: Additional data related to the task
          example: {}
        mappedExceptions:
          type: array
          description: Exceptions linked to the task
          items:
            type: string
          example:
            - EX000000000188
        mappedDocuments:
          type: array
          description: Documents linked to the task
          items:
            $ref: "#/components/schemas/TaskMappedDocument"
        linkedTasks:
          type: array
          description: tasks linked to the task
          items:
            $ref: "#/components/schemas/LinkedTask"
        parties:
          type: array
          description: A list of parties associated with the case.
          items:
            type: object
            properties:
              partyRole:
                type: string
                description: The role of the party in the case.
                enum:
                  - Annuitant / Insured, Primary
                  - Owner, Primary
                  - Beneficiary, Primary
                  - Servicing Agent
                  - Agent
                example: Owner, Primary
              partyType:
                type: string
                description: The type of the party.
                example: Individual
              firstName:
                type: string
                description: The first name of the party.
                example: Utkarsh
              middleName:
                type: string
                description: The middle name of the party.
                example: Kr
              lastName:
                type: string
                description: The last name of the party.
                example: Jain
              fullName:
                type: string
                description: The full name of the party.
                example: Utkarsh Kr Jain
              prefix:
                type: string
                description: The prefix for the party's name.
                example: Mr.
              suffix:
                type: string
                description: The suffix for the party's name.
                example: "1"
              gender:
                type: string
                description: The gender of the party.
                example: M
              ssn:
                type: string
                description: The ssn of the party.
                example: "123456789"
              percent:
                type: string
                description: The percentage associated with the party's role in the case.
                example: "100"
              externalId:
                type: string
                description: The externalId of the agent.
                example: "399823932"
        queue:
          type: string
          description: Queue to which the task is assigned
          example: queue_withdrawal
        scheduledReason:
          type: string
          description: Reason why the task is scheduled to later time
          example: ""
        scheduledDate:
          type: string
          format: date
          description: Date for which the task is scheduled
          example: 2024-04-02
        cancellationReason:
          type: string
          description: Reason for task cancellation
          example: ""
        slaDue:
          type: string
          format: date-time
          description: SLA date of the case
        priority:
          type: string
          description: Priority level of the task
          example: HIGH
        escalated:
          type: boolean
          description: Whether the task is escalated
          default: false
          example: false
        assigneeFirstName:
          type: string
          description: First Name of the User assigned to the task
          example: Great
        assigneeLastName:
          type: string
          description: Last Name of the User assigned to the task
          example: Gatsby
        assignee:
          type: string
          description: Email Id of the User assigned to the task
          example: Great.Gatsby@zinnia.com
        assigneePartyId:
          type: string
          description: Party Id of the User assigned to the task
          example: 53dfb347558f42cfb79a0ef3a1147acb
        assignedAt:
          type: string
          format: date-time
          description: Timestamp when the task was assigned to the User
        preferredAssignee:
          type: string
          description: Preferred user for task assignment
          example: username@se2.com
        createdBy:
          type: string
          description: Email Id of the User who created the task
          example: username@se2.com
        createdByPartyId:
          type: string
          description: Party Id of the User who created the task
          example: 8170b3a1353848d589399254210772ae
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the task was created
        updatedBy:
          type: string
          description: Email Id of the User who last updated the task
          example: Satyam.Srivastava@zinnia.com
        updatedByPartyId:
          type: string
          description: Party Id of the User who last updated the task
          example: 53dfb347558f42cfb79a0ef3a1147acb
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the task was last updated
```
