Change Incident Status

Change an incident’s status by applying a transition to its task. The incident ID is the task ID.

The Python examples on this page use the original client (metadata.ingestion.ometa.ometa_api.OpenMetadata) because SDK 2.0 (metadata.sdk) doesn’t include incident operations. For more information, see Which Python SDK Should I Use?.

POST /v1/tasks/{id}/resolve

string

required

UUID of the incident task.

Body Parameters

The request body accepts these fields:

string

The transition to apply: ack, assign, reassign, new, or resolve. Read the incident’s availableTransitions to see which are valid right now.

string

Required when you resolve. Use Completed.

string

Comment to add. Required for resolve.

object

Data the transition needs. See the examples that follow.

You must send at least transitionId or resolutionType. Collate rejects an empty body.

Acknowledge an Incident

To acknowledge an incident, send the ack transition.

POST /v1/tasks/{id}/resolve

curl -X POST "https://your-company.getcollate.io/api/v1/tasks/$INCIDENT_ID/resolve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "transitionId": "ack" }'

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 ResolveTaskRequest

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

metadata.resolve_task(incident_id, ResolveTaskRequest(transitionId="ack"))

Assign or Reassign an Incident

Use assign when the incident isn’t yet assigned, and reassign when its stage is already assigned. Pass the new assignees in payload.assignees as entity references.

{
  "transitionId": "assign",
  "payload": {
    "assignees": [
      {
        "id": "2b8d6f1a-0000-4000-8000-000000000020",
        "type": "user",
        "name": "jdoe",
        "fullyQualifiedName": "jdoe",
        "displayName": "Jane Doe"
      }
    ]
  }
}

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 ResolveTaskRequest

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

metadata.resolve_task(
    incident_id,
    ResolveTaskRequest(
        transitionId="assign",
        payload={
            "assignees": [
                {"id": user_id, "type": "user", "name": "jdoe", "fullyQualifiedName": "jdoe"}
            ]
        },
    ),
)

Resolve an Incident

Resolving requires a comment and a failure reason in payload.testCaseFailureReason: FalsePositive, MissingData, Duplicates, OutOfBounds, or Other.

{
  "transitionId": "resolve",
  "resolutionType": "Completed",
  "comment": "Upstream load was delayed. Re-ran successfully.",
  "payload": { "testCaseFailureReason": "MissingData" }
}

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 ResolveTaskRequest, TaskResolutionType

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

metadata.resolve_task(
    incident_id,
    ResolveTaskRequest(
        transitionId="resolve",
        resolutionType=TaskResolutionType.Completed,
        comment="Upstream load was delayed. Re-ran successfully.",
        payload={"testCaseFailureReason": "MissingData"},
    ),
)

Reopen an Incident

A resolved incident has no available transitions. To reopen it, post an Ack or Assigned status to the test case incident status endpoint. Collate reopens the same incident task. POST /v1/dataQuality/testCases/testCaseIncidentStatus

{
  "testCaseReference": "svc.db.schema.orders.row_count_between",
  "testCaseResolutionStatusType": "Ack"
}

To start a fresh incident in the new stage instead, as the Incident Manager does, create a task for the test case with POST /v1/tasks:

{
  "name": "Incident: row_count_between",
  "category": "Incident",
  "type": "TestCaseResolution",
  "about": "<#E::testCase::svc.db.schema.orders.row_count_between>"
}

Add Comments, Change Severity, and Close an Incident

Comments: POST /v1/tasks/{id}/comments adds a comment to the incident.
Severity: PATCH /v1/dataQuality/testCases/testCaseIncidentStatus/{id} updates severity (Severity1 to Severity5) on a status record. Collate accepts patches only to severity, updatedAt, and updatedBy.
Close without resolving: POST /v1/tasks/{id}/close cancels the task. Only the creator or an assignee can close it. For incidents, use resolve instead.

Change Status With the Legacy Endpoint

Status changes through POST /v1/dataQuality/testCases/testCaseIncidentStatus still work. Collate applies each write to the incident task, so existing clients keep working. Ack maps to the ack transition, Assigned to assign or reassign, and Resolved to resolve.

{
  "testCaseReference": "svc.db.schema.orders.row_count_between",
  "testCaseResolutionStatusType": "Resolved",
  "testCaseResolutionStatusDetails": {
    "testCaseFailureReason": "FalsePositive",
    "testCaseFailureComment": "Threshold was too strict."
  }
}

The Python SDK supports this form through create_test_case_resolution. For new code, prefer the task transitions.

Change Many Incidents at Once

Use PUT /v1/dataQuality/testCases/testCaseIncidentStatus/bulk to change the status, the severity, or both for up to 100 incidents in one request. The Incident Manager uses it when you change the status or severity of the incidents in selected groups. Send an array of status changes. Each item has the same fields as a single POST to the test case incident status endpoint:

string

required

Fully qualified name of the test case whose incident you want to change.

string

required

The status to set: New, Ack, Assigned, or Resolved.

object

The assignee, or the failure reason and comment, as for a single status change.

string

Severity to set: Severity1 to Severity5.

[
  {
    "testCaseReference": "svc.db.schema.orders.row_count_between",
    "testCaseResolutionStatusType": "Ack",
    "severity": "Severity2"
  },
  {
    "testCaseReference": "svc.db.schema.customers.email_not_null",
    "testCaseResolutionStatusType": "Ack"
  }
]

Collate validates and authorizes each item separately, as it does for a single status change, so one failing item doesn’t stop the others. A request with more than 100 items returns a 400 error. The response is a bulk operation result. status is success when every item succeeded, partialSuccess when some failed, and failure when none succeeded. The numberOfRowsProcessed, numberOfRowsPassed, and numberOfRowsFailed fields hold the counts, and successRequest and failedRequest list each item. Each failed item has a message and a status code: 403 when the caller can’t edit the test case, and 400 for any other reason. An item fails for reasons such as these:

The incident already has that status and no new severity. If the status is the same but the severity is different, Collate updates the severity.
The incident is open and the item moves it back to New.
The test case doesn’t exist.

Errors

The endpoint can return these errors:

Status	Cause
`400`	The body is empty, or the request doesn’t meet the transition’s requirements, such as a missing comment or failure reason.
`403`	The caller can’t edit the test case.
`404`	No task exists with that ID.

​Change Incident Status

​Body Parameters

​Acknowledge an Incident

​Assign or Reassign an Incident

​Resolve an Incident

​Reopen an Incident

​Add Comments, Change Severity, and Close an Incident

​Change Status With the Legacy Endpoint

​Change Many Incidents at Once

​Errors

Change Incident Status

Body Parameters

Acknowledge an Incident

Assign or Reassign an Incident

Resolve an Incident

Reopen an Incident

Add Comments, Change Severity, and Close an Incident

Change Status With the Legacy Endpoint

Change Many Incidents at Once

Errors