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

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

# StageInstance

## 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:
    StepInstance:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the step instance.
        label:
          type: string
          description: Business Friendly label for the step instance.
        stepStatus:
          type: string
          description: Current status of the step instance.
          enum:
            - IN_PROGRESS
            - EXCEPTION
            - COMPLETED
            - NOT_STARTED
        stepResult:
          type: string
          description: Step level decision outcome
        eventRef:
          type: array
          description: List of event references associated with this step.
          items:
            type: string
        mappedTasks:
          type: array
          description: List of identifiers for tasks mapped to this step.
          items:
            type: string
        mappedExceptions:
          type: array
          description: List of exception mapped to this step.
          items:
            type: string
        mappedDocuments:
          type: array
          description: List of document id mapped to this step.
          items:
            type: string
        mappedCases:
          type: array
          description: List of Case id mapped to this step.
          items:
            type: string
        mappedNotes:
          type: array
          description: List of identifiers for notes mapped to this step (RESERVED FOR
            FUTURE SCOPE).
          items:
            type: string
        multiInstance:
          type: boolean
          description: Indicates whether step is multiple instance or not.
          default: false
        instanceInfo:
          type: object
          description: Contains information about the multi instance step
          properties:
            identifier:
              type: string
              description: A unique identifier for the multi instance step.
            label:
              type: string
              description: The label of the multi instance step.
            object:
              type: string
              description: The object of the multi instance step.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the step instance was created.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the step instance was last updated.
    StageInstance:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the stage instance.
        label:
          type: string
          description: Business Friendly label for the stage instance.
        stageStatus:
          type: string
          description: Current status of the stage instance.
          enum:
            - IN_PROGRESS
            - EXCEPTION
            - COMPLETED
            - NOT_STARTED
        mappedTasks:
          type: array
          description: List of identifiers for tasks mapped to this stage (RESERVED FOR
            FUTURE SCOPE).
          items:
            type: string
        mappedNotes:
          type: array
          description: List of identifiers for notes mapped to this stage (RESERVED FOR
            FUTURE SCOPE).
          items:
            type: string
        steps:
          type: array
          description: List of step instances that make up this stage.
          items:
            $ref: "#/components/schemas/StepInstance"
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the stage instance was created.
```