Schedules a PipelineVersion.

post

https://Use API Lookup for a base URL/v2/pipelines/{pipelineId}/versions/{versionId}/operations/activate

This endpoint updates the state of a PipelineVersion to Scheduled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pipelineId

string

required

System generated identifier for the Pipeline.

versionId

string

required

System generated identifier for the PipelineVersion.

Body Params

Optional CatalogVersions to use when running the pipeline; when CatalogVersions is passed the Version Resolver library will not be used. This becomes a one-time, 'run-now' scenario. If the ScheduledConfiguration of this Pipeline Version was 'version_resolver', this is automatically reset (to empty) to indicate the one-time, 'run-now' scenario and match the fact that CatalogVersions was passed in. The Pipeline Version will be automatically deactivated after this run attempt (whether the run is successful or not) so that this Pipeline Version will not be run automatically again in the future. The JobCatalogVersions (whether passed, or calculated by the Version Resolver) will be stored in the resulting Job record, which will be available via the 'List Jobs' API - after the job starts running on the Spark / Flink cluster.

Common options for an operation.

highAvailability

boolean

Defines if the pipeline is highly available using a standby master

inputCatalogs

object

Versions of the input catalogs the Job processes, identified by symbolic catalog name.

outputCatalog

object

runAsId

string

RunAsId Id to run the pipeline

snapshotId

uuid

Optional snapshot id to activate pipeline with

useLatestCheckpoint

boolean

True if the latest available checkpoint should be used to activate this pipeline. Activation will fail if no checkpoint is found (e.g., the checkpoint has expired).

Headers

X-Request-ID

string

Identifier for a specific http request. If not present, one will be generated.

X-Correlation-ID

string

Common identifier for multiple http requests to indicate they are associated in some way. If not present, one will be generated.

Responses

202The PipelineVersion has been scheduled.

307To activate the PipelineVersion, please follow the redirect or use URL in the Location header.

404Pipeline id or PipelineVersion id provided was not found.

500Internal error while scheduling the PipelineVersion.