GET /v1/tasks

curl "https://your-company.getcollate.io/api/v1/tasks?category=Incident&type=TestCaseResolution&statusGroup=open&fields=assignees,about,payload&limit=50" \
  -H "Authorization: Bearer $TOKEN"

from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
    OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
    OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.task_models import TaskCategory

server_config = OpenMetadataConnection(
    hostPort="https://your-company.getcollate.io/api",
    authProvider="openmetadata",
    securityConfig=OpenMetadataJWTClientConfig(jwtToken="<YOUR-JWT-TOKEN>"),
)
metadata = OpenMetadata(server_config)

incidents = metadata.list_tasks(
    category=TaskCategory.Incident,
    status_group="open",
    fields=["assignees", "about", "payload"],
    limit=50,
)
for task in incidents.entities:
    print(task.name, task.status)

{
  "id": "<string>",
  "taskId": "<string>",
  "name": "<string>",
  "status": "<string>",
  "workflowStageId": "<string>",
  "availableTransitions": [
    {}
  ],
  "assignees": [
    {}
  ],
  "about": {},
  "resolution": {}
}

GET

tasks

GET /v1/tasks

curl "https://your-company.getcollate.io/api/v1/tasks?category=Incident&type=TestCaseResolution&statusGroup=open&fields=assignees,about,payload&limit=50" \
  -H "Authorization: Bearer $TOKEN"

from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
    OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
    OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.task_models import TaskCategory

server_config = OpenMetadataConnection(
    hostPort="https://your-company.getcollate.io/api",
    authProvider="openmetadata",
    securityConfig=OpenMetadataJWTClientConfig(jwtToken="<YOUR-JWT-TOKEN>"),
)
metadata = OpenMetadata(server_config)

incidents = metadata.list_tasks(
    category=TaskCategory.Incident,
    status_group="open",
    fields=["assignees", "about", "payload"],
    limit=50,
)
for task in incidents.entities:
    print(task.name, task.status)

{
  "id": "<string>",
  "taskId": "<string>",
  "name": "<string>",
  "status": "<string>",
  "workflowStageId": "<string>",
  "availableTransitions": [
    {}
  ],
  "assignees": [
    {}
  ],
  "about": {},
  "resolution": {}
}

List and Retrieve Incidents

List incidents, read one incident, and search the incident status history.

List Incidents as Tasks

List incidents with GET /v1/tasks. Set category=Incident to return only incidents.

string

Set to Incident.

string

Set to TestCaseResolution to return only data quality incidents.

string

Task status, for example Open, InProgress, or Completed.

string

open or closed. Use this instead of status to get all open or all closed incidents.

string

Name of the assigned user or team.

string

Fully qualified name of the test case the incident is about.

string

Domain of the incident.

string

Critical, High, Medium, or Low.

integer

Return incidents created at or after this Unix epoch timestamp in milliseconds.

integer

Return incidents created at or before this Unix epoch timestamp in milliseconds.

string

Comma-separated fields to include, for example payload,assignees,about.

integer

default:"10"

Number of results per page. Use before and after for paging.

GET /v1/tasks

curl "https://your-company.getcollate.io/api/v1/tasks?category=Incident&type=TestCaseResolution&statusGroup=open&fields=assignees,about,payload&limit=50" \
  -H "Authorization: Bearer $TOKEN"

from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
    OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
    OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.task_models import TaskCategory

server_config = OpenMetadataConnection(
    hostPort="https://your-company.getcollate.io/api",
    authProvider="openmetadata",
    securityConfig=OpenMetadataJWTClientConfig(jwtToken="<YOUR-JWT-TOKEN>"),
)
metadata = OpenMetadata(server_config)

incidents = metadata.list_tasks(
    category=TaskCategory.Incident,
    status_group="open",
    fields=["assignees", "about", "payload"],
    limit=50,
)
for task in incidents.entities:
    print(task.name, task.status)

Retrieve One Incident

Retrieve one incident by ID or by task number.

By ID: GET /v1/tasks/{id}
By task number: GET /v1/tasks/name/{taskId}, for example TASK-00001

Both accept fields and include.

from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
    OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
    OpenMetadataJWTClientConfig,
)

server_config = OpenMetadataConnection(
    hostPort="https://your-company.getcollate.io/api",
    authProvider="openmetadata",
    securityConfig=OpenMetadataJWTClientConfig(jwtToken="<YOUR-JWT-TOKEN>"),
)
metadata = OpenMetadata(server_config)

task = metadata.get_task("c4f7e2b0-0000-4000-8000-000000000010", fields=["assignees", "about"])

Response

The task response includes these fields:

string

UUID of the incident task. This is also the incident stateId.

string

Human-readable task number, for example TASK-00001.

string

Incident name, in the form Incident: <test case name>.

string

Task status: Open, InProgress, or Completed.

string

Current stage: new, ack, assigned, or resolved.

array

Transitions that apply now. Each item has id, label, targetStageId, targetTaskStatus, and requiresComment.

array

Users or teams the incident is assigned to.

object

Reference to the test case.

object

Present after the incident is resolved. Includes type, resolvedBy, resolvedAt, comment, and payload (which contains testCaseFailureReason).

Search Incident History

Use the test case incident status endpoints to search incidents by test case or time and to read the full status history.

Endpoint	Returns
`GET /v1/dataQuality/testCases/testCaseIncidentStatus`	Status records. Filters: `testCaseId`, `testCaseFQN`, `originEntityFQN`, `testCaseResolutionStatusType` (`New`, `Ack`, `Assigned`, `Resolved`), `assignee`, `domain`, `startTs`, `endTs`, `latest`, `limit`, `offset`. Set `latest=true` to return only the current status of each incident.
`GET /v1/dataQuality/testCases/testCaseIncidentStatus/search/list`	The same filters, plus `sortField`, `sortType`, and `dateField`. The Incident Manager list uses this endpoint.
`GET /v1/dataQuality/testCases/testCaseIncidentStatus/stateId/{stateId}`	Every status record for one incident, in order. Use the incident (task) ID as `stateId`.
`GET /v1/dataQuality/testCases/testCaseIncidentStatus/{id}`	One status record.

Each status record includes these fields:

id, stateId, and timestamp
testCaseResolutionStatusType
testCaseResolutionStatusDetails: the assignee, or the failure reason and comment
updatedBy and updatedAt
testCaseReference and severity
metrics: timeToResponse and timeToResolution, in milliseconds

curl "https://your-company.getcollate.io/api/v1/dataQuality/testCases/testCaseIncidentStatus?latest=true&testCaseResolutionStatusType=New&limit=50" \
  -H "Authorization: Bearer $TOKEN"

from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
    OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
    OpenMetadataJWTClientConfig,
)

server_config = OpenMetadataConnection(
    hostPort="https://your-company.getcollate.io/api",
    authProvider="openmetadata",
    securityConfig=OpenMetadataJWTClientConfig(jwtToken="<YOUR-JWT-TOKEN>"),
)
metadata = OpenMetadata(server_config)

# The Python client has no list method for incident history, so call the path directly
response = metadata.client.get(
    "/dataQuality/testCases/testCaseIncidentStatus",
    {"latest": "true", "limit": 50},
)

Keep an External Tracker in Sync

Collate doesn’t include a built-in Jira integration. Task responses have an externalReference field for storing a Jira key, but Collate doesn’t sync it for you. To mirror incidents in a tracker such as Jira:

Create a Notification alert on the task source with a webhook destination. See Alert for Incident Events.
In your receiver, deduplicate on the event id. Read entityType and the parsed entity.
Ignore events that aren’t incidents (entity.category isn’t Incident).
Use the incident ID (entityId) as the key that links the Jira issue and the incident, and store it on the issue.
On each event, read entity.workflowStageId and update the issue.
To close the loop, call Change Incident Status when the issue changes in the tracker.
Run a periodic GET /v1/tasks?category=Incident&statusGroup=open as a safety net, because Collate doesn’t automatically resend a webhook that failed.

​List and Retrieve Incidents

​List Incidents as Tasks

​Retrieve One Incident

​Response

​Search Incident History

​Keep an External Tracker in Sync

List and Retrieve Incidents

List Incidents as Tasks

Retrieve One Incident

Response

Search Incident History

Keep an External Tracker in Sync