​

List and Retrieve Incidents

​

List Incidents as 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

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

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

​

Search Incident History

• 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},
)

​

Group Open Incidents

• groupBy, id, name, displayName, and fullyQualifiedName: the table, test definition, or owner that the group represents.
• incidentCount: the number of distinct open incidents in the group.
• severity: the most critical severity in the group. Severity1 is the most critical. The field is absent when no incident in the group has a severity.
• status: the most actionable status in the group, ranked Assigned, then Ack, then New.
• statusCounts: the number of open incidents in each status, most actionable first.
• assignees, assigneeReferences, and assigneeCount: the distinct current assignees.
• firstSeen and lastSeen: when the earliest open incident in the group was opened, and the most recent status change across the group.
• trend and trendDirection: the number of incidents opened in each of eight equal time buckets between firstSeen and lastSeen, and a direction of Rising, Falling, or Steady.
• tables, tableCount, testDefinitions, and testDefinitionCount: the related tables and test definitions, with the most open incidents first. The lists are capped, and the count fields hold the full number.

curl "https://your-company.getcollate.io/api/v1/dataQuality/testCases/testCaseIncidentStatus/incidentGroups?groupBy=table&status=New&status=Assigned&sortField=severity&limit=25" \
  -H "Authorization: Bearer $TOKEN"

{
  "data": [
    {
      "groupBy": "table",
      "name": "orders",
      "fullyQualifiedName": "svc.db.schema.orders",
      "incidentCount": 4,
      "severity": "Severity2",
      "status": "Assigned",
      "statusCounts": [
        { "status": "Assigned", "count": 2 },
        { "status": "New", "count": 2 }
      ],
      "assigneeCount": 1,
      "trend": [0, 0, 1, 0, 0, 1, 1, 1],
      "trendDirection": "Rising"
    }
  ],
  "paging": { "total": 1 }
}

• Test definition: testDefinition, by name or fully qualified name.
• Test case owner: owner, the name of a user or team that directly owns the test case. Use unowned=true for the test cases that nobody owns. Don’t combine unowned with owner.
• Table: originEntityFQN, the fully qualified name of the table.

​

Keep an External Tracker in Sync

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