Share via

Pipeline - Create Pipeline Run

  • Reference
Service:
Synapse
API Version:
2020-12-01

Creates a run of a pipeline.

POST {endpoint}/pipelines/{pipelineName}/createRun?api-version=2020-12-01
With optional parameters: 
POST {endpoint}/pipelines/{pipelineName}/createRun?api-version=2020-12-01&referencePipelineRunId={referencePipelineRunId}&isRecovery={isRecovery}&startActivityName={startActivityName}

URI Parameters

Name In Required Type Description
endpoint
 path True

string

uri

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
pipelineName
 path True

string

The pipeline name.

Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
api-version
 query True

string

The Synapse client API Version.
isRecovery
 query

boolean

Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.
referencePipelineRunId
 query

string

The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.
startActivityName
 query

string

In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

Request Body

Name Type Description
parameters

ParameterValueSpecification

Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

Responses

Name Type Description
202 Accepted

CreateRunResponse

Accepted.
Other Status Codes

CloudError

An error response received from the Azure Synapse service.

Examples

Pipelines_CreateRun

Sample request

POST exampleWorkspace.dev.azuresynapse.net/pipelines/examplePipeline/createRun?api-version=2020-12-01&referencePipelineRunId=

{
  "OutputBlobNameList": [
    "exampleoutput.csv"
  ]
}

Sample response

Status code:
202 
Date: Sat, 16 Jun 2018 00:37:48 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1190
x-ms-request-id: 5c2b442b-d360-43ec-9268-f923f88f31fd
x-ms-correlation-request-id: 5c2b442b-d360-43ec-9268-f923f88f31fd
{
  "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"
}

Definitions

Name Description
CloudError

The object that defines the structure of an Azure Synapse error response.
CreateRunResponse

Response body with a run identifier.

CloudError

The object that defines the structure of an Azure Synapse error response.

Name Type Description
error.code

string

Error code.
error.details

CloudError[]

Array with additional error details.
error.message

string

Error message.
error.target

string

Property name/path in request associated with error.

CreateRunResponse

Response body with a run identifier.

Name Type Description
runId

string

Identifier of a run.