{"openapi":"3.1.1","info":{"title":"Pipeline Observability API","version":"0.1.0-draft","description":"API reference for pipeline summaries and runs, monitoring policies, execution-failure settings, data reliability automations, tag associations, asset lineage, and alerts.\n\nAuthentication requires both accessKey and secretKey headers. Replace the example server URL with your Acceldata instance base URL. All example names and identifiers are illustrative.\n\nThis draft documents request structures. Response status codes and bodies, query-parameter and request-body requiredness, and complete validation rules are not yet specified. Example values are not exhaustive lists of supported values. Only path parameters are marked required."},"servers":[{"url":"https://api.example.com","description":"Replace with your Acceldata instance base URL, without an API path."}],"tags":[{"name":"Pipelines","description":"Retrieve pipeline summaries, runs, spans, and run graphs."},{"name":"Bulk Monitoring","description":"Create, update, and activate bulk monitoring configurations."},{"name":"Pipeline Policies","description":"Manage monitoring policies and execution-failure settings."},{"name":"Automations","description":"Create pipeline automations and retrieve their execution information."},{"name":"Tags","description":"Manage pipeline tag associations."},{"name":"Lineage","description":"Retrieve pipeline lineage associated with assets."},{"name":"Alerts","description":"Retrieve and resolve pipeline alerts."}],"security":[{"AccessKey":[],"SecretKey":[]}],"paths":{"/torch-pipeline/api/pipelines/summary":{"get":{"operationId":"listPipelineSummaries","tags":["Pipelines"],"summary":"List pipeline summaries","description":"Retrieves pipeline summaries with filters for pipeline name, pipeline source, data source, run result, and tags.","parameters":[{"name":"name","in":"query","description":"Filter by pipeline name.","schema":{"type":"string"},"example":"daily_sales_pipeline"},{"name":"pipelineSource","in":"query","description":"Filter by pipeline source.","schema":{"type":"string"},"example":"DBT"},{"name":"dataSource","in":"query","description":"Filter by data source name.","schema":{"type":"string"},"example":"sales_source"},{"name":"runResult","in":"query","description":"Filter by pipeline run results, separated by commas.","schema":{"type":"string"},"example":"FAILURE,SUCCESS"},{"name":"tagKeyValueIds","in":"query","description":"Filter by tag key-value IDs.","schema":{"type":"string"},"example":"3002"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/{pipelineId}/runs":{"get":{"operationId":"listPipelineRuns","tags":["Pipelines"],"summary":"List pipeline runs","description":"Retrieves runs for the specified pipeline.","parameters":[{"$ref":"#/components/parameters/PipelineId"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/runs/{runId}/spans":{"get":{"operationId":"getPipelineRunSpans","tags":["Pipelines"],"summary":"Get pipeline run spans","description":"Retrieves spans for the specified pipeline run.","parameters":[{"$ref":"#/components/parameters/RunId"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/{pipelineId}/graph":{"get":{"operationId":"getPipelineRunGraph","tags":["Pipelines"],"summary":"Get a pipeline run graph","description":"Retrieves the lineage graph, including functional and asset nodes, for a pipeline run.","parameters":[{"$ref":"#/components/parameters/PipelineId"},{"name":"versionId","in":"query","description":"Version identifier used to retrieve the graph.","schema":{"type":"integer"},"example":9001},{"name":"runId","in":"query","description":"ID of the pipeline run.","schema":{"type":"integer"},"example":8001}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/v2/bulk-monitoring-policy":{"post":{"operationId":"createBulkMonitoringConfiguration","tags":["Bulk Monitoring"],"summary":"Create a bulk monitoring configuration","description":"Creates monitoring policies or execution-failure settings for pipelines. Use type POLICY with policies for duration monitoring, or type EXECUTION_FAILURE with failureConfigs for execution-failure settings.","requestBody":{"description":"Bulk monitoring or execution-failure configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkMonitoringCreateRequest"},"examples":{"monitoringPolicies":{"summary":"Create duration monitoring policies","value":{"type":"POLICY","name":"pipeline_duration_monitoring","description":"","policies":[{"name":"daily_sales_duration","pipelineId":1001,"enabled":true,"baseMetric":"TIME","baseMeasurementType":"DURATION","comparisonEntity":{"type":"USER_THRESHOLD","compare":{"operator":"LESS_THAN","units":"TIME","threshold":"01:00:00"}},"severity":"CRITICAL","notificationChannels":[],"processingType":"POST_PROCESSING","backingEntity":[{"entityType":"PIPELINE","entityUid":"sales_source.daily_sales_pipeline"}]},{"name":"inventory_duration","pipelineId":1002,"enabled":true,"baseMetric":"TIME","baseMeasurementType":"DURATION","comparisonEntity":{"type":"USER_THRESHOLD","compare":{"operator":"LESS_THAN","units":"TIME","threshold":"01:00:00"}},"severity":"CRITICAL","notificationChannels":[],"processingType":"POST_PROCESSING","backingEntity":[{"entityType":"PIPELINE","entityUid":"inventory_source.inventory_pipeline"}]}],"healthNotifications":[{"enabled":false,"cron":"","severity":"CRITICAL","notificationChannels":[],"onlyFailed":false,"notifyWhenHealthy":true}],"appliedToAll":false,"action":"SAVE_AS_DRAFT"}},"executionFailureSettings":{"summary":"Create execution-failure settings","value":{"type":"EXECUTION_FAILURE","name":"pipeline_failure_settings","description":"","appliedToAll":false,"failureConfigs":[{"pipelineId":1001,"raiseIncident":true,"incidentName":"Daily sales pipeline execution failed","severity":"CRITICAL","notificationChannels":[6001]}],"healthNotifications":[{"enabled":true,"cron":"","severity":"CRITICAL","notificationChannels":[],"onlyFailed":false,"notifyWhenHealthy":true}],"action":"SAVE_AND_ACTIVATE"}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/v2/bulk-monitoring-policy/{bulkMonitorPolicyId}":{"put":{"operationId":"updateBulkMonitoringPolicy","tags":["Bulk Monitoring"],"summary":"Update a bulk monitoring policy","description":"Updates the specified bulk monitoring policy using the submitted configuration.","parameters":[{"$ref":"#/components/parameters/BulkMonitorPolicyId"}],"requestBody":{"description":"Updated bulk monitoring policy settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkMonitoringUpdateRequest"},"examples":{"updateMonitoringPolicy":{"summary":"Update and activate a monitoring policy","value":{"type":"POLICY","name":"pipeline_duration_monitoring","description":"","policies":[{"name":"inventory_duration","pipelineId":1002,"enabled":true,"baseMetric":"TIME","baseMeasurementType":"DURATION","comparisonEntity":{"type":"USER_THRESHOLD","compare":{"operator":"LESS_THAN","units":"TIME","threshold":"01:00:00"}},"severity":"CRITICAL","notificationChannels":[],"processingType":"REAL_TIME_PROCESSING","backingEntity":[{"id":5001,"entityType":"PIPELINE","entityUid":"inventory_source.inventory_pipeline","policyId":2001}],"timeZone":"UTC","id":2001,"bulkMonitoringPolicyId":4001}],"healthNotifications":[{"enabled":false,"cron":"","severity":"CRITICAL","notificationChannels":[],"onlyFailed":false,"notifyWhenHealthy":true}],"appliedToAll":false,"action":"SAVE_AND_ACTIVATE"}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/v2/bulk-monitoring-policy/{bulkMonitorPolicyId}/activate":{"post":{"operationId":"activateBulkMonitoringConfiguration","tags":["Bulk Monitoring"],"summary":"Activate a bulk monitoring configuration","description":"Activates a bulk monitoring policy or execution-failure configuration.","parameters":[{"$ref":"#/components/parameters/BulkMonitorPolicyId"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/policy/monitoring":{"post":{"operationId":"createPipelineMonitoringPolicies","tags":["Pipeline Policies"],"summary":"Create pipeline monitoring policies","description":"Creates one or more monitoring policies. Include one entry in policies for each policy to create.","requestBody":{"description":"Monitoring policies to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringPoliciesCreateRequest"},"examples":{"monitoringPolicies":{"summary":"Create two pipeline monitoring policies","value":{"policies":[{"name":"daily_sales_duration","pipelineId":1001,"enabled":true,"baseMetric":"TIME","baseMeasurementType":"DURATION","comparisonEntity":{"type":"USER_THRESHOLD","compare":{"operator":"LESS_THAN","units":"TIME","threshold":"00:00:09"}},"severity":"CRITICAL","notificationChannels":[],"backingEntity":[{"entityType":"PIPELINE","entityUid":"sales_source.daily_sales_pipeline"}]},{"name":"inventory_duration","pipelineId":1002,"enabled":true,"baseMetric":"TIME","baseMeasurementType":"DURATION","comparisonEntity":{"type":"USER_THRESHOLD","compare":{"operator":"GREATER_THAN","units":"TIME","threshold":"00:00:01"}},"severity":"CRITICAL","notificationChannels":[],"backingEntity":[{"entityType":"PIPELINE","entityUid":"inventory_source.inventory_pipeline"}]}]}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/policy/execution-failure":{"put":{"operationId":"updatePipelineFailureSettings","tags":["Pipeline Policies"],"summary":"Edit Pipeline Settings","description":"Updates execution-failure incident and notification settings for the pipeline identified by pipelineId in the request body.","requestBody":{"description":"Updated execution-failure settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionFailureSettings"},"examples":{"failureSettings":{"summary":"Update execution-failure settings","value":{"incidentName":"Daily sales pipeline execution failed","notificationChannels":[],"pipelineId":1001,"raiseIncident":true,"severity":"HIGH"}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/policy/monitoring/{monitoringPolicyId}/detach-bulk-monitoring-policy":{"put":{"operationId":"detachMonitoringPolicyFromBulkConfiguration","tags":["Pipeline Policies"],"summary":"Detach a monitoring policy from bulk monitoring","description":"Detaches the specified monitoring policy from its bulk monitoring configuration.","parameters":[{"$ref":"#/components/parameters/MonitoringPolicyId"}],"requestBody":{"description":"Empty JSON request object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachBulkMonitoringRequest"},"examples":{"detach":{"summary":"Detach a monitoring policy","value":{}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/{pipelineId}/automations":{"post":{"operationId":"createPipelineAutomation","tags":["Automations"],"summary":"Create a pipeline automation","description":"Creates a data reliability automation for the specified pipeline. The documented request configures a full data quality policy execution triggered by a successful pipeline run.","parameters":[{"$ref":"#/components/parameters/PipelineId"}],"requestBody":{"description":"Pipeline automation settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutomationRequest"},"examples":{"dataQualityAutomation":{"summary":"Create a data quality automation","value":{"automation":{"associatedItemId":7001,"associatedItemType":"POLICY","automationType":"DATA_QUALITY","executionType":"FULL","triggerEvent":"SUCCESS","triggerType":"PIPELINE_RUN","triggerValue":"","delayMinutes":0}}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/runs/{runId}/automations/policy-info":{"get":{"operationId":"getPolicyAutomationExecutionStatus","tags":["Automations"],"summary":"Get policy automation execution status","description":"Retrieves policy automation execution information for the specified pipeline run.","parameters":[{"$ref":"#/components/parameters/RunId"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/runs/{runId}/automations/profiling-info":{"get":{"operationId":"getProfilingAutomationExecutionStatus","tags":["Automations"],"summary":"Get profiling automation execution status","description":"Retrieves profiling automation execution information for the specified pipeline run.","parameters":[{"$ref":"#/components/parameters/RunId"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/{pipelineId}":{"put":{"operationId":"updatePipelineTags","tags":["Tags"],"summary":"Update pipeline tags","description":"Updates tag associations for the specified pipeline.","parameters":[{"$ref":"#/components/parameters/PipelineId"}],"requestBody":{"description":"Pipeline details and tag associations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePipelineTagsRequest"},"examples":{"pipelineTags":{"summary":"Update pipeline tag associations","value":{"tagWriteMode":"ASSOCIATIONS","pipeline":{"id":1001,"name":"daily_sales_pipeline","uid":"sales_source.daily_sales_pipeline","tagAssociations":[{"keyId":"3001","keyValueId":3002}]}}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/tag-associations/bulk":{"post":{"operationId":"attachTagsToPipelines","tags":["Tags"],"summary":"Attach tags to multiple pipelines","description":"Attaches the specified tag key-value entries to the pipelines identified by entityIds.","requestBody":{"description":"Pipeline IDs and tag key-value IDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTagAssociationRequest"},"examples":{"bulkTags":{"summary":"Attach a tag to two pipelines","value":{"entityIds":[1001,1002],"entityType":"PIPELINE","keyValueIds":[3002]}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/assets/{assetId}/lineage":{"get":{"operationId":"getAssetPipelineLineage","tags":["Lineage"],"summary":"Get asset pipeline lineage","description":"Retrieves pipeline lineage associated with the specified asset.","parameters":[{"$ref":"#/components/parameters/AssetId"},{"name":"sublevellineage","in":"query","description":"Whether to include sublevel lineage.","schema":{"type":"boolean"},"example":false}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/torch-pipeline/api/pipelines/incidents/{incidentId}/list":{"get":{"operationId":"listPipelineAlerts","tags":["Alerts"],"summary":"List pipeline alerts","description":"Retrieves pipeline alerts with pagination, pipeline-run filtering, and state filtering.","parameters":[{"$ref":"#/components/parameters/IncidentListPathId"},{"name":"page","in":"query","description":"Page number to retrieve.","schema":{"type":"integer"},"example":0},{"name":"size","in":"query","description":"Number of results per page.","schema":{"type":"integer"},"example":20},{"name":"run_id","in":"query","description":"ID of the pipeline run to filter by.","schema":{"type":"integer"},"example":8001},{"name":"state","in":"query","description":"Incident state filter.","schema":{"type":"string"},"example":"ALL"}],"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}},"/api/incidents/api/v1/{namespaceId}/incidents/bulk/actions":{"put":{"operationId":"resolvePipelineAlerts","tags":["Alerts"],"summary":"Resolve pipeline alerts","description":"Resolves the incidents listed in the request body by setting status to RESOLVED.","parameters":[{"$ref":"#/components/parameters/IncidentActionPathId"}],"requestBody":{"description":"Incident IDs and resolution details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveIncidentsRequest"},"examples":{"resolveIncidents":{"summary":"Resolve an incident","value":{"id":[11002],"status":"RESOLVED","severity":null,"clearReason":{"type":null,"reason":"The pipeline issue has been resolved."},"updatedBy":"user@example.com"}}}}}},"responses":{"default":{"$ref":"#/components/responses/UndocumentedResponse"}}}}},"components":{"securitySchemes":{"AccessKey":{"type":"apiKey","in":"header","name":"accessKey","description":"API access key. Send together with secretKey."},"SecretKey":{"type":"apiKey","in":"header","name":"secretKey","description":"API secret key. Send together with accessKey."}},"parameters":{"PipelineId":{"name":"pipelineId","in":"path","description":"ID of the pipeline.","required":true,"schema":{"type":"integer"},"example":1001},"RunId":{"name":"runId","in":"path","description":"ID of the pipeline run.","required":true,"schema":{"type":"integer"},"example":8001},"BulkMonitorPolicyId":{"name":"bulkMonitorPolicyId","in":"path","description":"ID of the bulk monitoring or execution-failure configuration.","required":true,"schema":{"type":"integer"},"example":4001},"MonitoringPolicyId":{"name":"monitoringPolicyId","in":"path","description":"ID of the individual monitoring policy.","required":true,"schema":{"type":"integer"},"example":2001},"AssetId":{"name":"assetId","in":"path","description":"ID of the asset.","required":true,"schema":{"type":"integer"},"example":10001},"IncidentListPathId":{"name":"incidentId","in":"path","description":"Identifier used in the incident-list path.","required":true,"schema":{"type":"integer"},"example":11001},"IncidentActionPathId":{"name":"incidentId","in":"path","description":"Identifier used in the bulk incident-action path.","required":true,"schema":{"type":"integer"},"example":11001}},"responses":{"UndocumentedResponse":{"description":"Response status codes and bodies are not documented in this draft."}},"schemas":{"NotificationChannelIds":{"type":"array","description":"IDs of the notification channels associated with the configuration.","items":{"type":"integer"},"examples":[[],[6001]]},"Severity":{"type":"string","description":"Severity associated with the policy, notification, or incident.","examples":["CRITICAL","HIGH"]},"ThresholdComparison":{"type":"object","description":"Comparison settings for a duration-based policy.","properties":{"operator":{"type":"string","description":"Comparison operator.","examples":["LESS_THAN","GREATER_THAN"]},"units":{"type":"string","description":"Measurement units used by the comparison.","examples":["TIME"]},"threshold":{"type":"string","description":"Duration threshold expressed as a string, for example 01:00:00.","examples":["01:00:00","00:00:09","00:00:01"]}}},"ComparisonEntity":{"type":"object","description":"The comparison configuration for a monitoring policy.","properties":{"type":{"type":"string","description":"Comparison configuration type.","examples":["USER_THRESHOLD"]},"compare":{"$ref":"#/components/schemas/ThresholdComparison"}}},"PipelineEntityReference":{"type":"object","description":"Reference to the pipeline monitored by a policy.","properties":{"entityType":{"type":"string","description":"Type of entity associated with the policy.","examples":["PIPELINE"]},"entityUid":{"type":"string","description":"Unique identifier of the pipeline entity.","examples":["sales_source.daily_sales_pipeline"]}}},"PipelineEntityUpdateReference":{"type":"object","description":"Existing pipeline association included when updating a monitoring policy.","properties":{"id":{"type":"integer","description":"ID of the existing policy-to-entity association.","examples":[5001]},"entityType":{"type":"string","description":"Type of entity associated with the policy.","examples":["PIPELINE"]},"entityUid":{"type":"string","description":"Unique identifier of the pipeline entity.","examples":["sales_source.daily_sales_pipeline"]},"policyId":{"type":"integer","description":"ID of the monitoring policy associated with the entity.","examples":[2001]}}},"MonitoringPolicyInput":{"type":"object","description":"Settings for an individual pipeline monitoring policy.","properties":{"name":{"type":"string","description":"Name of the monitoring policy.","examples":["daily_sales_duration"]},"pipelineId":{"type":"integer","description":"ID of the pipeline to monitor.","examples":[1001]},"enabled":{"type":"boolean","description":"Whether the monitoring policy is enabled.","examples":[true]},"baseMetric":{"type":"string","description":"Metric used by the policy.","examples":["TIME"]},"baseMeasurementType":{"type":"string","description":"Measurement type used by the policy.","examples":["DURATION"]},"comparisonEntity":{"$ref":"#/components/schemas/ComparisonEntity"},"severity":{"$ref":"#/components/schemas/Severity"},"notificationChannels":{"$ref":"#/components/schemas/NotificationChannelIds"},"backingEntity":{"type":"array","description":"Pipeline entities associated with the monitoring policy.","items":{"$ref":"#/components/schemas/PipelineEntityReference"}}}},"BulkMonitoringPolicyInput":{"type":"object","description":"Monitoring policy settings within a bulk configuration.","properties":{"name":{"type":"string","description":"Name of the monitoring policy.","examples":["daily_sales_duration"]},"pipelineId":{"type":"integer","description":"ID of the pipeline to monitor.","examples":[1001]},"enabled":{"type":"boolean","description":"Whether the monitoring policy is enabled.","examples":[true]},"baseMetric":{"type":"string","description":"Metric used by the policy.","examples":["TIME"]},"baseMeasurementType":{"type":"string","description":"Measurement type used by the policy.","examples":["DURATION"]},"comparisonEntity":{"$ref":"#/components/schemas/ComparisonEntity"},"severity":{"$ref":"#/components/schemas/Severity"},"notificationChannels":{"$ref":"#/components/schemas/NotificationChannelIds"},"backingEntity":{"type":"array","description":"Pipeline entities associated with the monitoring policy.","items":{"$ref":"#/components/schemas/PipelineEntityReference"}},"processingType":{"type":"string","description":"Processing mode for the monitoring policy.","examples":["POST_PROCESSING","REAL_TIME_PROCESSING"]}}},"BulkMonitoringPolicyUpdateInput":{"type":"object","description":"Updated settings for an existing policy within a bulk monitoring configuration.","properties":{"name":{"type":"string","description":"Name of the monitoring policy.","examples":["daily_sales_duration"]},"pipelineId":{"type":"integer","description":"ID of the pipeline to monitor.","examples":[1001]},"enabled":{"type":"boolean","description":"Whether the monitoring policy is enabled.","examples":[true]},"baseMetric":{"type":"string","description":"Metric used by the policy.","examples":["TIME"]},"baseMeasurementType":{"type":"string","description":"Measurement type used by the policy.","examples":["DURATION"]},"comparisonEntity":{"$ref":"#/components/schemas/ComparisonEntity"},"severity":{"$ref":"#/components/schemas/Severity"},"notificationChannels":{"$ref":"#/components/schemas/NotificationChannelIds"},"backingEntity":{"type":"array","description":"Existing pipeline associations for the monitoring policy.","items":{"$ref":"#/components/schemas/PipelineEntityUpdateReference"}},"processingType":{"type":"string","description":"Processing mode for the monitoring policy.","examples":["POST_PROCESSING","REAL_TIME_PROCESSING"]},"timeZone":{"type":"string","description":"Time zone associated with the monitoring policy.","examples":["UTC"]},"id":{"type":"integer","description":"ID of the existing monitoring policy.","examples":[2001]},"bulkMonitoringPolicyId":{"type":"integer","description":"ID of the bulk monitoring configuration containing the policy.","examples":[4001]}}},"HealthNotificationSettings":{"type":"object","description":"Settings for pipeline health notifications.","properties":{"enabled":{"type":"boolean","description":"Whether health notifications are enabled.","examples":[false]},"cron":{"type":"string","description":"Scheduling expression for health notifications.","examples":[""]},"severity":{"$ref":"#/components/schemas/Severity"},"notificationChannels":{"$ref":"#/components/schemas/NotificationChannelIds"},"onlyFailed":{"type":"boolean","description":"Whether health notifications are restricted to failures.","examples":[false]},"notifyWhenHealthy":{"type":"boolean","description":"Whether notifications are sent when healthy.","examples":[true]}}},"ExecutionFailureSettings":{"type":"object","description":"Incident and notification settings for pipeline execution failures.","properties":{"pipelineId":{"type":"integer","description":"ID of the pipeline.","examples":[1001]},"raiseIncident":{"type":"boolean","description":"Whether to raise an incident for an execution failure.","examples":[true]},"incidentName":{"type":"string","description":"Name used for the execution-failure incident.","examples":["Daily sales pipeline execution failed"]},"severity":{"$ref":"#/components/schemas/Severity"},"notificationChannels":{"$ref":"#/components/schemas/NotificationChannelIds"}}},"BulkMonitoringCreateRequest":{"type":"object","description":"Create a bulk monitoring policy or bulk execution-failure settings. The request examples show the two configuration types.","properties":{"type":{"type":"string","description":"Configuration type. Use POLICY with policies, or EXECUTION_FAILURE with failureConfigs.","examples":["POLICY","EXECUTION_FAILURE"]},"name":{"type":"string","description":"Name of the bulk configuration.","examples":["pipeline_duration_monitoring"]},"description":{"type":"string","description":"Description of the bulk configuration.","examples":[""]},"policies":{"type":"array","description":"Monitoring policy settings for a POLICY configuration.","items":{"$ref":"#/components/schemas/BulkMonitoringPolicyInput"}},"failureConfigs":{"type":"array","description":"Execution-failure settings for an EXECUTION_FAILURE configuration.","items":{"$ref":"#/components/schemas/ExecutionFailureSettings"}},"healthNotifications":{"type":"array","description":"Pipeline health notification settings.","items":{"$ref":"#/components/schemas/HealthNotificationSettings"}},"appliedToAll":{"type":"boolean","description":"Whether the configuration applies to all pipelines.","examples":[false]},"action":{"type":"string","description":"Action to take when saving the configuration.","examples":["SAVE_AS_DRAFT","SAVE_AND_ACTIVATE"]}}},"BulkMonitoringUpdateRequest":{"type":"object","description":"Update an existing bulk monitoring policy.","properties":{"type":{"type":"string","description":"Configuration type for this monitoring-policy update.","examples":["POLICY"]},"name":{"type":"string","description":"Name of the bulk configuration.","examples":["pipeline_duration_monitoring"]},"description":{"type":"string","description":"Description of the bulk configuration.","examples":[""]},"policies":{"type":"array","description":"Updated monitoring policy settings.","items":{"$ref":"#/components/schemas/BulkMonitoringPolicyUpdateInput"}},"healthNotifications":{"type":"array","description":"Pipeline health notification settings.","items":{"$ref":"#/components/schemas/HealthNotificationSettings"}},"appliedToAll":{"type":"boolean","description":"Whether the configuration applies to all pipelines.","examples":[false]},"action":{"type":"string","description":"Action to take when saving the configuration.","examples":["SAVE_AS_DRAFT","SAVE_AND_ACTIVATE"]}}},"MonitoringPoliciesCreateRequest":{"type":"object","description":"Create one or more monitoring policies.","properties":{"policies":{"type":"array","description":"Monitoring policies to create.","items":{"$ref":"#/components/schemas/MonitoringPolicyInput"}}}},"DataReliabilityAutomation":{"type":"object","description":"Automation settings. The documented example configures a data quality policy execution.","properties":{"associatedItemId":{"type":"integer","description":"ID of the item associated with the automation. For the data quality example, this is a policy ID.","examples":[7001]},"associatedItemType":{"type":"string","description":"Type of item associated with the automation.","examples":["POLICY"]},"automationType":{"type":"string","description":"Type of data reliability automation.","examples":["DATA_QUALITY"]},"executionType":{"type":"string","description":"Execution mode for the automation.","examples":["FULL"]},"triggerEvent":{"type":"string","description":"Event that triggers the automation.","examples":["SUCCESS"]},"triggerType":{"type":"string","description":"Type of trigger used by the automation.","examples":["PIPELINE_RUN"]},"triggerValue":{"type":"string","description":"Value associated with the trigger.","examples":[""]},"delayMinutes":{"type":"integer","description":"Delay before automation execution, in minutes.","examples":[0]}}},"CreateAutomationRequest":{"type":"object","description":"Request to create a pipeline automation.","properties":{"automation":{"$ref":"#/components/schemas/DataReliabilityAutomation"}}},"TagAssociation":{"type":"object","description":"Association between a tag key and a tag key-value entry.","properties":{"keyId":{"type":"string","description":"ID of the tag key, represented as a string.","examples":["3001"]},"keyValueId":{"type":"integer","description":"ID of the tag key-value entry.","examples":[3002]}}},"PipelineTagUpdate":{"type":"object","description":"Pipeline details and tag associations to update.","properties":{"id":{"type":"integer","description":"ID of the pipeline.","examples":[1001]},"name":{"type":"string","description":"Name of the pipeline.","examples":["daily_sales_pipeline"]},"uid":{"type":"string","description":"Unique identifier of the pipeline.","examples":["sales_source.daily_sales_pipeline"]},"tagAssociations":{"type":"array","description":"Tag associations for the pipeline.","items":{"$ref":"#/components/schemas/TagAssociation"}}}},"UpdatePipelineTagsRequest":{"type":"object","description":"Request to update a pipeline through tag associations.","properties":{"tagWriteMode":{"type":"string","description":"Mode used to write tags.","examples":["ASSOCIATIONS"]},"pipeline":{"$ref":"#/components/schemas/PipelineTagUpdate"}}},"BulkTagAssociationRequest":{"type":"object","description":"Request to attach tag key-value entries to multiple pipelines.","properties":{"entityIds":{"type":"array","description":"IDs of the pipelines to tag.","items":{"type":"integer"}},"entityType":{"type":"string","description":"Type of entities to tag.","examples":["PIPELINE"]},"keyValueIds":{"type":"array","description":"IDs of the tag key-value entries to attach.","items":{"type":"integer"}}}},"IncidentClearReason":{"type":"object","description":"Resolution reason included with an incident action.","properties":{"type":{"description":"Resolution-reason type.","examples":[null]},"reason":{"type":"string","description":"Explanation for resolving the incident.","examples":["The pipeline issue has been resolved."]}}},"ResolveIncidentsRequest":{"type":"object","description":"Request to resolve the incidents identified in id.","properties":{"id":{"type":"array","description":"IDs of the incidents to resolve.","items":{"type":"integer"}},"status":{"type":"string","description":"Status to assign to the incidents.","examples":["RESOLVED"]},"severity":{"description":"Severity value included with the action.","examples":[null]},"clearReason":{"$ref":"#/components/schemas/IncidentClearReason"},"updatedBy":{"type":"string","description":"User identifier included with the update.","examples":["user@example.com"]}}},"DetachBulkMonitoringRequest":{"type":"object","description":"Empty JSON object used for the detach request.","examples":[{}]}}}}