Content Comparison

/api/v3/pipeline

Execute adhoc
pipeline YAML or JSON given in the body. The pipeline is not stored.

• The request body will become the body of the pipeline.

• Request params will be set in vars scope of the pipeline.

• Request and response can be accessed via ${request} and ${response} object in the pipeline.

See: https://pipeforce.github.io/api#/Pipeline%20API

/api/v3/pipeline:{path}

Store
the pipeline YAML given in the body in the property store at {path}. Overwrite any existing one.

See: https://pipeforce.github.io/api#/Pipeline%20API

/api/v3/pipeline:{path}

Load and execute
the persisted pipeline at {path} from the property store:

• The request body will become the body of the pipeline.

• Request params will be set in vars scope of the pipeline.

• Request and response can be accessed via ${request} and ${response} object in the pipeline.

See: https://pipeforce.github.io/api#/Pipeline%20API

/api/v3/pipeline:{path}

Return
the pipeline source persisted at {path} from the property store.

See: https://pipeforce.github.io/api#/Pipeline%20API

/api/v3/pipeline:{path}

Delete
the persisted pipeline at {path} from the property store.

See: https://pipeforce.github.io/api#/Pipeline%20API

/api/v3/property:{path}

Create, read, update and delete persisted JSON documents, attachments and other data types in the persistence DB, called the Property Store.

See: https://pipeforce.github.io/api#/Property%20API

/api/v3/command:{name}

Execute
a single command given by name {name}.

• The request body in

  Status
  colour Green title POST

  requests will become the body of the command.

• Request params of

  Status
  colour Green title POST

  or

  Status
  colour Blue title GET

  requests will become the params to the command.

• In case parameters must be send in body instead of request parameters, use

  Status
  colour Green title POST

  , set the request parameter ?params=body and place the command parameters as JSON in the body.

See here for a full list of available commands:
https://pipeforce.github.io/api