PipelinesResource

A RESTful resource for managing pipelines.

The following resources are applicable:

/pipelines

Mount Point: /pipelines

GET

Gets the list of all pipelines on the system.

Response Body

element: (custom)
media types: application/xml
text/xml
application/json

The list of pipelines

POST

Creates a pipeline.

Request Body

element: pipeline
media types: application/xml
text/xml
application/json

The pipeline to create.

Response Body

element: pipeline
media types: application/xml
text/xml
application/json

The newly created pipeline

/pipelines/{id}

Mount Point: /pipelines/{id}

The following operations are supported on this resource:

GET

Gets the pipeline identified by the given ID.

Parameters

name description type default
id The pipeline ID to search for path

Response Body

element: pipeline
media types: application/xml
text/xml
application/json

True if the pipeline is found

PUT

Updates a pipeline with a given ID.

Parameters

name description type default
id The id of the pipeline to update path

Request Body

element: pipeline
media types: application/xml
text/xml
application/json

The pipeline to update

DELETE

Deletes a pipeline with a given ID.

Parameters

name description type default
id The ID of the pipeline to delete path

/pipelines/name/{name}

Mount Point: /pipelines/name/{name}

GET

Gets the pipeline identified by the given name.

Parameters

name description type default
name The pipeline name to search for path

Response Body

element: pipeline
media types: application/xml
text/xml
application/json

True if the pipeline is found