UnifiedViews Method - Import Pipeline

Abstract

Description
This API call lets you import a pipeline.

URL: http://{server}/master/api/1/pipelines/import

Note

The idea behind implementing a pipeline import is to enable automatic testing and deployment.

Content Type

multipart/form-data

Request

Supported Method
POST

HTTP Parameters

Parameter	Type	Required	Description
file		true	ZIP file with pipeline to import.
asUser	string	true	User who is marked as pipeline author.
importUserData	string	false	Indicates if user data should be imported. Allowed values: `true/false`
importSchedule	boolean	false	Defines if an existing schedule for that pipeline should be imported.
userExternalId	string	false	Indicates if schedule information should be imported. Allowed values: `true/false`

Example Request

Content-Disposition:form-data; name="file"; filename="zipperPipeline.zip"
 
Content-Disposition:form-data; name="importUserData"
true
 
Content-Disposition: form-data; name="importSchedule"
true
  
Content-Disposition: form-data; name="asUser"
admin

ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attribute	Type	Required	Description
id	number	true	The ID of the imported pipeline in this UV instance.
name	string	true	Name of the pipeline.
asUser	string	true	User who is marked as pipeline author.
userActorExternalId	string	false	Indicates if additional users have permission to edit or execute this pipeline. Possible values: 'null' or an existing username.

Example Response

{
    "id": 60,
    "name": "The pipeline",
    "description": "The description",
    "asUser": "admin",
    "userActorExternalId": null
}

In this section: