Jump to

• Request
• Response

Retrieve a Task

get

/bpm/api/4.0/tasks/{id}

Retrieves a task by task ID (The task number).

Request

Path Parameters

• id(required): string
  Task ID (Internally known as the task number)

Query Parameters

• expand(required): string
  Value of all fields that are to be expanded (detailed) - All, comments, attachments, history, payload. If not specified Links to each of the fields is returned.

  Default Value:
• metadataFlag(required): boolean
  Metadata - true or false

  Default Value: false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Task

Type: object

Show Source

• artifacts: array artifacts
• contextId: string
• final: boolean
  Indicates whether the task update is the final update.
• history: array history
• id: string
• kind: string
  Default Value: task
• metadata: object metadata
  Additional Properties Allowed: true
• status: object TaskStatus

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contextId":{
            "type":"string"
        },
        "status":{
            "$ref":"#/components/schemas/TaskStatus"
        },
        "artifacts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Artifact"
            }
        },
        "history":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Message"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"task"
        },
        "final":{
            "type":"boolean",
            "description":"Indicates whether the task update is the final update."
        }
    }
}

Nested Schema : artifacts

Type: array

Show Source

• Array of: object Artifact

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Artifact"
    }
}

Nested Schema : history

Type: array

Show Source

• Array of: object Message

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Message"
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : TaskStatus

Type: object

Show Source

• message: object Message
• state: string
  Allowed Values: [ "submitted", "working", "input-required", "completed", "canceled", "failed", "unknown" ]
• timestamp: string
  UTC timestamp string.

{
    "type":"object",
    "properties":{
        "state":{
            "$ref":"#/components/schemas/TaskState"
        },
        "message":{
            "$ref":"#/components/schemas/Message"
        },
        "timestamp":{
            "type":"string",
            "description":"UTC timestamp string."
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• append: boolean
• artifactId: string
• description: string
• lastChunk: boolean
• metadata: object metadata
  Additional Properties Allowed: true
• name: string
• parts: array parts

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "append":{
            "type":"boolean"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "lastChunk":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TextPart"
    }
}

Nested Schema : TextPart

Type: object

Show Source

• kind: string
  Default Value: text
• metadata: object metadata
  Additional Properties Allowed: true
• text: string
  Text content.
• type: string
  Part type.

  Example: text

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Part type.",
            "example":"text"
        },
        "text":{
            "type":"string",
            "description":"Text content."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"text"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : Message

Type: object

Show Source

• contextId: string
  Conversation identifier. For `message/stream`, this must be nested under `params.message`.
• kind: string
  Default Value: message
• messageId: string
• metadata: object metadata
  Additional Properties Allowed: true
• parts: array parts
• role: string
  Allowed Values: [ "user", "agent" ]
• taskId: string
  Optional task identifier used for resumed or task-associated message flows.

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "enum":[
                "user",
                "agent"
            ]
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "messageId":{
            "type":"string"
        },
        "contextId":{
            "type":"string",
            "description":"Conversation identifier. For `message/stream`, this must be nested under `params.message`."
        },
        "taskId":{
            "type":"string",
            "description":"Optional task identifier used for resumed or task-associated message flows."
        },
        "kind":{
            "type":"string",
            "default":"message"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TextPart"
    }
}

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task not found for given ID.

500 Response

Internal Server Error

Back to Top