...
Path | Method | Description |
---|
/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 Info |
---|
For security reasons, executing adhoc pipelines is by default restricted to admin, support and developer users in DEV stage only. For production stage you should always consider to use persisted pipelines instead. |
|
/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 requests will become the body of the command.Request params of or requests will become the params to the command.
See here for a full list of available commands: https://pipeforce.github.io/api |
For more details see the API Documentation.
Execute a command via Rest API
Every command can also be executed via Rest API. The URL format for calling such a command looks like this:
Code Block |
---|
https://hub-{instance-name}/api/v3/command:{name} |
Whereas {instance-name}
must be replaced by your own instance name and {name}
must be replaced by the name of the command to be called.
Every command can be called via HTTP GET or HTTP POST. The request parameters will become the parameters to the command. In case of a HTTP POST request, the body of the POST request will become the body of the command.
Info |
---|
Since Status |
---|
colour | Blue |
---|
title | VERSION 10 |
---|
| this default behaviour of passing parameters can be changed by |
...
setting the optional request parameter ?params=body along with the command call. In this case the input to the command will be set to null . And the request body can contain a JSON or YAML which will be passed as command parameters. |
See here for a full list of available commands:
https://pipeforce.github.io/api
For more details see the API Documentation.
...
Info |
---|
Note: It is possible to restrict the permission by users, roles and groups who is allowed to call commands. See Groups, Roles and Permissions for more details. |
Execute adhoc pipeline via Rest API
Info |
---|
For security reasons, executing adhoc pipelines is by default restricted to admin, support and developer users in DEV stage only. For production stage you should always consider to use persisted pipelines instead. |
...
Note that the pipeline has the part name pipeline
and one or more files must all have the name file
.
Execute
...
persisted pipeline via Rest API
A persisted pipeline is one which is stored in the property store.
...