Ingestion Pipelines

Add pipeline status

Add pipeline status of ingestion pipeline.

put/v1/services/ingestionPipelines/{fqn}/pipelineStatus

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/services/ingestionPipelines/{fqn}/pipelineStatus
  • Auth: HTTP bearer

Path parameters

fqnstring required

Fully qualified name of the ingestion pipeline

Request body

runIdstring
pipelineState'queued' | 'success' | 'failed' | 'running' | 'partialSuccess' | 'stopped'
startDateinteger
timestampinteger
endDateinteger
configobject
metadataobject

Response

Successfully updated the PipelineStatus.

idstring uuid
namestring required
displayNamestring
descriptionstring
pipelineType'metadata' | 'usage' | 'lineage' | 'profiler' | 'autoClassification' | 'TestSuite' | 'dataInsight' | 'elasticSearchReindex' | 'dbt' | 'application' | 'policyAgent' required
fullyQualifiedNamestring
loggerLevel'DEBUG' | 'INFO' | 'WARN' | 'ERROR'
raiseOnErrorboolean
deployedboolean
enabledboolean
enableStreamableLogsboolean
hrefstring uri
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
deletedboolean
provider'system' | 'user' | 'automation'
applicationTypestring
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.