Link an external incident to a data quality monitor

Link an existing JIRA issue or ServiceNow incident to an Alation data quality monitor by creating an incident record in the incident management service. This enables tracking of data quality issues through your existing incident management workflow.

The endpoint fetches the issue details from the specified provider, creates an incident record linked to the specified monitor, and optionally associates specific check and anomaly UUIDs.

Idempotent behavior: If the same monitor_id, issue_key, and provider combination already exists, the existing incident is returned. If new check_ids or anomaly_ids are provided, the existing incident metadata is updated.

Required roles: Server Admin, Catalog Admin, Source Admin, or Steward.

Body Params
integer
required
≥ 1

The ID of the data quality monitor to link the incident to.

string
required

The external issue key or ID to link (e.g., "PROJ-123" for JIRA, "INC0010001" for ServiceNow).

string
enum
Defaults to jira

The incident management provider. Defaults to "jira" if not specified.

Allowed:
check_ids
array of uuids

Optional list of data quality failed check UUIDs to associate with this incident.

check_ids
anomaly_ids
array of uuids

Optional list of failed anomaly UUIDs to associate with this incident.

anomaly_ids
errored_check_ids
array of uuids

Optional list of errored check UUIDs to associate with this incident.

errored_check_ids
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json