Skip to main content

Commands Reference

Example 1: Execute a command via HTTP

In case you would like to execute a single command, you could run it like this:

curl -u 'username:password' \
'https://hub-<your-domain>/api/v3/command/message.send?key=slack&payload=HELLO'

This example simply sends a new message to the message broker with key slack and with message payload HELLO.

Example 2: Execute a pipeline via HTTP

In case you would like to execute multiple commands, embedded in a pipeline YAML script, you can run this:

curl -u 'username:password' \
-X POST "https://hub-<your-domain>/api/v3/pipeline" \
-H "Content-Type: application/yaml" \
--data-binary @- << EOF
pipeline:
- drive.read:
path: /my.pdf
- pdf.stamp:
text: "Hello World!"
- drive.save:
path: /my-stamped.pdf
EOF

Common Parameters

All commands do have these optional parameters in common:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of the command. Must be unique within the pipeline. Can be used for example in testing in order to mock certain commands and to refer to them afterwards.
ifBooleanfalsetrueThis parameter can disable (false) / enable (true) the execution of the command. Can be a static boolean value or a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped in a pipeline. By default it is set to true = command is enabled and will be executed.
evalStringfalsenullThis parameter defines an optional Pipeline Expression to be evaluated after the command execution has been finished. This is handy for cleanup-tasks, validity checks or data transformations.
onErrorString, JSONfalseTHROWDefines the action in case an error happens when executing this command. Default is THROW: Stops execution and reports the error to the caller. This parameter can also be set for all commands in the header. If set additionally as header, the parameter value has precedence over the header value. Other possibilities are: IGNORE, LOG, RETRY and ROLLBACK. For more information see Error Handling for Commands and Pipelines.

apidoc.commands v1


Returns the OpenAPI documentation of commands.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- apidoc.commands:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/apidoc.commands?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command apidoc.commands id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

apidoc.pel.utils v1


Returns the OpenAPI documentation of PEL utils.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- apidoc.pel.utils:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/apidoc.pel.utils?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command apidoc.pel.utils id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

app.config.get v1


Returns the configuration of an app or a list of apps.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
appStringfalsenullThe name of the app to load the config from. If null or empty, the config of all apps will be returned instead.
githubStringfalsenullA GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branchStringfalsenullThe GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTestsBooleanfalsefalseRun the tests of the app after installation?
asyncBooleanfalsetrueRun the installation async?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.
secretStringfalsenullRefers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
- app.config.get:
app: <value>
github: <value>
branch: <value>
runTests: <value>
async: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.config.get?app=<value>&github=<value>&branch=<value>&runTests=<value>&async=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command app.config.get app=<value> github=<value> branch=<value> runTests=<value> async=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

app.install v1


Installs an app into the property store. The app can be located on GitHub or can be provided as zip file content in the body. If app is located in a private GitHub repo, the param secret must be set or the default secret github-default-readonly must exist which will be used as fallback in case no secret is set as param here.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
overwriteBooleanfalsefalseWhat to do if app with this key already exists? If true, the existing app will be uninstalled and replaced by this new version. Otherwise, an attempt to install an existing app will cause an error.
githubStringfalsenullA GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branchStringfalsenullThe GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTestsBooleanfalsefalseRun the tests of the app after installation?
asyncBooleanfalsetrueRun the installation async?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.
secretStringfalsenullRefers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
- app.install:
overwrite: <value>
github: <value>
branch: <value>
runTests: <value>
async: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.install?overwrite=<value>&github=<value>&branch=<value>&runTests=<value>&async=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command app.install overwrite=<value> github=<value> branch=<value> runTests=<value> async=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

app.marketplace.search v1


Searches the marketplace for apps ready to be installed.
Note: This command is limited to max. 10 calls per minute.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
sortStringfalseSorts the results by author-date or committer-date or (best-match). If null or empty, best-match will be used as default.
orderStringfalsedescOrders the result desc or asc.
resultsStringfalse30Max. number of results per page.
pageStringfalse1The 1-based page number to return.
licenseStringfalsenullLimit the search to app repos with given exact license keyword only.
searchStringStringfalsenullThe text to search for.
searchInNameBooleanfalsetrueSearch for searchString in the app repo name?
searchInDescBooleanfalsetrueSearch for searchString in the app repo description?
searchInReadmeBooleanfalsetrueSearch for searchString in the app repo README file?
searchInTopicsBooleanfalsetrueSearch for searchString in the repo topics?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
secretStringfalsenullRefers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
- app.marketplace.search:
sort: <value>
order: <value>
results: <value>
page: <value>
license: <value>
searchString: <value>
searchInName: <value>
searchInDesc: <value>
searchInReadme: <value>
searchInTopics: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>
secret: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.marketplace.search?sort=<value>&order=<value>&results=<value>&page=<value>&license=<value>&searchString=<value>&searchInName=<value>&searchInDesc=<value>&searchInReadme=<value>&searchInTopics=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command app.marketplace.search sort=<value> order=<value> results=<value> page=<value> license=<value> searchString=<value> searchInName=<value> searchInDesc=<value> searchInReadme=<value> searchInTopics=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

app.name.list v1


Returns the names of all installed global apps. This command is optimized for best performance. So prefer to use it instead of reading properties or property paths with pattern matching.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
githubStringfalsenullA GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branchStringfalsenullThe GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTestsBooleanfalsefalseRun the tests of the app after installation?
asyncBooleanfalsetrueRun the installation async?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.
secretStringfalsenullRefers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
- app.name.list:
github: <value>
branch: <value>
runTests: <value>
async: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.name.list?github=<value>&branch=<value>&runTests=<value>&async=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command app.name.list github=<value> branch=<value> runTests=<value> async=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

app.resource.get v1


Returns resources from inside a given app resource folder of the property store.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
appStringtruenullThe name of the app to load the resource from
pathStringtruenullThe path relative to the app's resource folder of the resource to be returned.
githubStringfalsenullA GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branchStringfalsenullThe GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTestsBooleanfalsefalseRun the tests of the app after installation?
asyncBooleanfalsetrueRun the installation async?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.
secretStringfalsenullRefers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
- app.resource.get:
app: <value>
path: <value>
github: <value>
branch: <value>
runTests: <value>
async: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.resource.get?app=<value>&path=<value>&github=<value>&branch=<value>&runTests=<value>&async=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command app.resource.get app=<value> path=<value> github=<value> branch=<value> runTests=<value> async=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

app.uninstall v1


Uninstalls the given app.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
appKeyStringfalsenullThe key of the app to uninstall. For example: global/app/myapp.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.

Pipeline example:

pipeline:  
- app.uninstall:
appKey: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.uninstall?appKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command app.uninstall appKey=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

app.update v1


Deprecated. Use app.install with param update:true instead. Updates the given apps.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
githubStringfalsenullA GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branchStringfalsenullThe GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTestsBooleanfalsefalseRun the tests of the app after installation?
asyncBooleanfalsetrueRun the installation async?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.
secretStringfalsenullRefers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
- app.update:
github: <value>
branch: <value>
runTests: <value>
async: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.update?github=<value>&branch=<value>&runTests=<value>&async=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command app.update github=<value> branch=<value> runTests=<value> async=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

assert v1


Evaluates a given PEL conditions and throws an error in case a condition is invalid.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
trueStringfalsenullA PE which must evaluate to true.
expectStringfalsenullThe value to be expected.
actualStringfalsenullThe actual value to be compared with the expect value. If both values do not match, the assert fails.
falseStringfalsenullA PE which must evaluate to false.
body.equalsStringfalsenullThe value of this param is compared to the body. If different, exception is thrown. Can be a PE.
equalsStringfalsenullCompares the result of param value with this. If not equal, throws exception. Can be a PE.
valueStringfalsenullThe value to be used for comparision. Can be a PE.
messageStringfalsenullAn optional message to be used in case of invalid condition. Can be a PE.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- assert:
true: <value>
expect: <value>
actual: <value>
false: <value>
body.equals: <value>
equals: <value>
value: <value>
message: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/assert?true=<value>&expect=<value>&actual=<value>&false=<value>&body.equals=<value>&equals=<value>&value=<value>&message=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command assert true=<value> expect=<value> actual=<value> false=<value> body.equals=<value> equals=<value> value=<value> message=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

workflow.assert v1


Applies asserts for a given workflow in the workflow service.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
hasPassedStringfalsenullA comma separated list of task names to check whether they have been passed.
hasNotPassedStringfalsenullA comma separated list of task names to check whether they have not yet passed.
processFinishedStringfalsenullIf true, checks whether the process with given id has been finished.
throwExceptionStringfalsetrueIf true, throws exception when assert is false. Otherwise returns the status in the body.
processInstanceIdStringtruenullThe id of the process instance the task to check belongs to.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- workflow.assert:
hasPassed: <value>
hasNotPassed: <value>
processFinished: <value>
throwException: <value>
processInstanceId: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/workflow.assert?hasPassed=<value>&hasNotPassed=<value>&processFinished=<value>&throwException=<value>&processInstanceId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command workflow.assert hasPassed=<value> hasNotPassed=<value> processFinished=<value> throwException=<value> processInstanceId=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

audit.log v1


Logs an audit step. Audit logs are treated differently since they need to be archived in some cases for compliance reasons.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
messageStringtruenullThe message to log. Can be a string or a pipe expression. If null or empty, the full pipe message will be logged.
principalStringfalsenullThe optional information about the principal (user, system, account, ...) who initiated this. If null or empty, the info of the currently logged-in principal is used instead.
levelStringfalseINFOBy default all audit log entries are created with INFO level. For very sensitive or problematic actions, this can be increased to WARN or ERROR.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- audit.log:
message: <value>
principal: <value>
level: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/audit.log?message=<value>&principal=<value>&level=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command audit.log message=<value> principal=<value> level=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

barcode.create v1


Creates a barcode from a dynamic format.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
textStringfalsenullThe text value to be transformed to a barcode.
widthStringfalsenullThe width of the barcode. If empty, the default size is used.
heightStringfalsenullThe height of the barcode. If empty, the default size is used.
formatStringfalsePDF_417The dynamic format of the barcode to be created. One of: AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, PDF_417, QR_CODE, UPC_A, UPC_E
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- barcode.create:
text: <value>
width: <value>
height: <value>
format: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/barcode.create?text=<value>&width=<value>&height=<value>&format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command barcode.create text=<value> width=<value> height=<value> format=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

barcode.read v1


Reads a barcode from a dynamic PNG format. Expects the barcode image as content object in the body. Detects the barcode type automatically. By default returns the text extracted from the barcode in the body.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- barcode.read:
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/barcode.read?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command barcode.read id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

body.delete v1


Sets the value in the body to null. Deletes any existing value in the body.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- body.delete:
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/body.delete?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command body.delete id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

body.filter v1


DEPRECATED. Converts the input body to JSON and then filters the input body and removes any properties not matching the given filter. Throws exception if input body cannot be converted to JSON.Does nothing, if input body is null or empty. If the first level of the body is a list, appliesthe filter to each element inside the list. This command can be used for example to filter outsensitive information or to shrink a big result set for performance reasons.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
propertiesStringfalsenullA comma separated list of first-level properties to be shown. If set, only those properties of the first level will be returned, those are listed here. All other properties will be omitted. For example to filter a user entity in the body with filter: id,username would return only the id and the username of the user. If not set, the body will not be converted and filtered at all and returned unchanged.
removeKeyBooleanfalsefalseCan only be applied, if the result is a list and contains elements with a single property each. For example: [{name: foo}, {name: bar}]. If set to true, removes the key from the property and converts the result to a simple list like: [foo, bar]. If the result is not a list or elements in the list contain more than one property, this param is ignored.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- body.filter:
properties: <value>
removeKey: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/body.filter?properties=<value>&removeKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command body.filter properties=<value> removeKey=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

body.set v1


Sets a value in the body. Overwrites any existing value in the body. The value to be set can be a constant or an expression.

Try online.

Alias: command:set.body:v1,command:body:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
valueStringfalsenullA string or an expression to be used as the value to be set. If missing, null is set.
formatStringfalseautoConverts a string value to the given target format if possible. If set to 'auto' tries to detect the target format by inspecting the value string. If set to 'none' doesnt apply any conversion.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- body.set:
value: <value>
format: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/body.set?value=<value>&format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command body.set value=<value> format=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

bot.prompt v1


Sends a prompt to a bot endpoint and returns the answer.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
maxTokensIntegerfalse500The maximum number of tokens to return in the response.
secretStringfalsebot-apitokenThe name of the secret which contains the token to connect to the bot backend. If not given as parameter will lookup in the secret store using the default name.
engineStringfalsenullThe backend Bot implementation and model to be used. If not given, the default engine will be used.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- bot.prompt:
maxTokens: <value>
secret: <value>
engine: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/bot.prompt?maxTokens=<value>&secret=<value>&engine=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command bot.prompt maxTokens=<value> secret=<value> engine=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

cache.clear v1


Clears the underlying central cache and removes any entry those time to live has been expired. Can also be used to remove a single entry from the cache.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullThe key to load the value from the cache to remove. If empty or null, all entries in the cache will be inspected and those time to live has been expired will be removed.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- cache.clear:
key: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.clear?key=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command cache.clear key=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

cache.get v1


Reads a value with given key from the cache and writes it into the output.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullThe key to load the value from the cache.
removeBooleanfalsefalseIf true, removes the entry after it was successfully returned.
exitBooleanfalsefalseIf true, exits the pipeline if cache entry exists.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- cache.get:
key: <value>
remove: <value>
exit: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.get?key=<value>&remove=<value>&exit=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command cache.get key=<value> remove=<value> exit=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

cache.has v1


Checks if cache has given entry

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullChecks, if cache has entry with given key. If yes, puts true in the output. Otherwise false.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- cache.has:
key: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.has?key=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command cache.has key=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

cache.info v1


Returns information about the current state of the cache. Available for system and support users only.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullReturns the info for a given cache entry. If null or empty, the overall cache info is returned.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- cache.info:
key: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.info?key=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command cache.info key=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

cache.list v1


Lists ALL entries of the cache. Use with care!

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- cache.list:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command cache.list id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

cache.put v1


Saves the given value under given key into a central cache.
If no value param is given, uses the body as cache value.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
timeToLiveIntegerfalse10000The min. time to live for this cache entry in millis.
keyStringtruenullThe unique key for the cache entry.
valueStringfalsenullThe value for the cache entry. If not set, null is used.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- cache.put:
timeToLive: <value>
key: <value>
value: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.put?timeToLive=<value>&key=<value>&value=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command cache.put timeToLive=<value> key=<value> value=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

call v1


Calls a pipeline script and returns with the result in the body. Note: Since version 9.0, JavaScript calls are no longer supported.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
uriStringtruenullThe uri to be called.
argsObjectfalsenullName value pair of arguments to be passed to the script. If the script is a pipeline, the arguments are set as vars overwriting any existing vars.If the script is a remote HTTP URL, the arguments are passed as request parameters, each.If the script is a script in classpath or property store, the arguments are passed via implicit variable: pi.args.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- call:
uri: <value>
args: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/call?uri=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command call uri=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

capture v1


DEPREACTED (Use the cache.* commands instead). Captures the last pipe message and adds it into a list in the header under key {@link #HEADER_CAPTURED}. This is primarily for testing purposes but also can be used to create a snapshot of a certain pipeline state.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- capture:
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/capture?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command capture id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

command.schema v1


Returns the JSON schema for all built-in commands.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
commandStringfalsenullThe specific command name to fetch schema from. If set, only the schema for this specific command is returned.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- command.schema:
command: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/command.schema?command=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command command.schema command=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pipeline.schema v1


Returns the V7 compliant JSON schema for all built-in pipeline commands.

Try online.

Alias: command.pipe.schema.v7
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.schema:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipeline.schema?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pipeline.schema id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

config.get v1


Returns all admin config settings for a given group from the backend as a JSON in this format: {configKey:{value:someValue, canOverwrite:true|false}}. The attribute canOverwrite is only available if param includePermission is set.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
groupStringfalsenullThe config group to select. If null or empty, all configs will be returned if user has permission to do so.
keyStringfalsenullThe config key inside a given group. If null or empty, all configs from the selected group will be returned.
includePermissionStringfalsefalseIf true, additionally shows whether a currently logged-in user can write/change a configuration or not by adding the attribute canOverwrite:true
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- config.get:
group: <value>
key: <value>
includePermission: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/config.get?group=<value>&key=<value>&includePermission=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command config.get group=<value> key=<value> includePermission=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

container.registry.delete v1


Deletes a container registry.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url of the registry.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.

Pipeline example:

pipeline:  
- container.registry.delete:
url: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/container.registry.delete?url=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command container.registry.delete url=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

container.registry.list v1


Lists all container registries.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.

Pipeline example:

pipeline:  
- container.registry.list:
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/container.registry.list?id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command container.registry.list id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

container.registry.put v1


Adds a new container registry.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url of the registry.
usernameStringfalsenullThe username to access the registry.
passwordStringfalsenullThe password to access the registry.
emailStringfalsenullThe email for the registry.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
credentialsStringfalsenullDEPRECATED. Use param secret instead.

Pipeline example:

pipeline:  
- container.registry.put:
url: <value>
username: <value>
password: <value>
email: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/container.registry.put?url=<value>&username=<value>&password=<value>&email=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command container.registry.put url=<value> username=<value> password=<value> email=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

content.get v1


Deprecated. Use resolve command instead. Reads content from provided uri and puts the result back to body.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
uriStringtruenullThe content uri of the content to load.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- content.get:
uri: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/content.get?uri=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command content.get uri=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.decrypt v1


Decrypts the data previously encrypted using the command data.encrypt in the body using AES-256 in CBC mode by default. Puts the decrypted data into the output.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
passwordStringtruenullThe password to decrypt the body with. The PBKDF2 algorithm will be applied to this password before using it as decryption key.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.decrypt:
password: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.decrypt?password=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.decrypt password=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.encrypt v1


Encrypts the data in the body using AES-256 in CBC mode by default and puts the encrypted datainto the output.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
passwordStringtruenullThe password to encrypt the body with. The PBKDF2 algorithm will be applied to this password before using it as encryption key.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.encrypt:
password: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.encrypt?password=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.encrypt password=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.enrich v1


Enriches a given data object by applying a given PEL expression on it.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
doStringtruenullA PEL which will be executed in order to enrich a selected field of the data object from input. These variables will be provided in the PEL: headers (= the pipeline headers), vars (= the pipeline variables), body (= the pipeline body), input (= the input data)
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.enrich:
do: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.enrich?do=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.enrich do=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.list.filter v1


Iterates over a list of items given by input and removes all items matching the given criteria.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
excludeStringtruenullA PEL which will be executed on each iteration item. If the expression results in a true value, the item will be removed from the list. Additionally to the default PEL variables, the variable item (= current iteration item, default name) will be provided.
iterItemNameStringfalseitemThe name of the iteration item value, provided for exclude
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.list.filter:
exclude: <value>
iterItemName: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.list.filter?exclude=<value>&iterItemName=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.list.filter exclude=<value> iterItemName=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.list.iterate v1


Iterates over a data list (like JSON array for example) and applies the given do-action on each entry matching given where-condition. If two lists a are given, iterates over both lists whereas listA will be the outer loop and listB will be the inner loop.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
listAStringfalsenullThe main list where data must be merged into. If null or empty, the value from input parameter will be used instead. If both are given, the value from listA has precedence.
listBStringfalsenullThe seconds list where data mast be read from. For each item in listA, this list will be fully iterated.
whereStringfalsenullSelects the iteration step in listA which must be elected for the do operation. If null or empty, any iteration step will be selected. Additionally to the default PEL variables, the variables itemA (= current iteration item of listA, default name) and itemB (= current iteration item of listB) will be provided.
doStringtruenullA PEL which will be executed on each where-selected iteration item. It is also possible to apply multiple expressions in each iteration. Multiple such expressions must be separated by a semicolon ;Additionally to the default PEL variables, the variables itemA (= current iteration item of listA, default name) and itemB (= current iteration item of listB, default name) will be provided. In case therethere is only one list provided from body or input param, only one iteration item will be provided with name 'item' as default name.
iterItemNameStringfalseitemThe name of the iteration item value in case only single list has been provided via input or body.
iterItemNameAStringfalseitemAThe name of the iteration item value of listA provided in the PEL parts
iterItemNameBStringfalseitemBThe name of the iteration item value of listB provided in the PEL parts
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.list.iterate:
listA: <value>
listB: <value>
where: <value>
do: <value>
iterItemName: <value>
iterItemNameA: <value>
iterItemNameB: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.list.iterate?listA=<value>&listB=<value>&where=<value>&do=<value>&iterItemName=<value>&iterItemNameA=<value>&iterItemNameB=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.list.iterate listA=<value> listB=<value> where=<value> do=<value> iterItemName=<value> iterItemNameA=<value> iterItemNameB=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.list.limit v1


Limits a given list of data to a specific size. Removes any item from the list those index is above given maxLength - 1.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
maxLengthStringfalsenullLimits the data list from the input to the given max. length.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.list.limit:
maxLength: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.list.limit?maxLength=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.list.limit maxLength=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.mapping v1


Converts from one data structure into a another by applying simple mapping rules. Auto-creates nested elements if required. In case input is an iterable (list) and iterable is set to true then all rules will apply to each entry in the list. In case no output is given, a new target list is created to hold all newly mapped values.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
rulesStringfalsenullA list of mapping PEL rules to map from the input to the output data set. A rule has the format inputPEL1 -> outputPEL1. Multiple rules are separated by a comma directly followed by a new line.
iterateStringfalsenullIn case the input is a list and all the mappings rules must be applied on each single item in the list by iterating them, set this flag to true. If input is not iterable but this is set to true, nothing happens and the single input item will be processed instead.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.mapping:
rules: <value>
iterate: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.mapping?rules=<value>&iterate=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.mapping rules=<value> iterate=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

data.transform v1


This data transformer converts the input to an output format by applying the given template. By default the current message is provided as model inside the template context so you can access body, vars or headers similar to the default PEL approach.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
iterateStringfalsefalseIf true, the input is expected to be a list which will be iterated. The template is then applied on each iteration row and the result is added to a target list.
groupByStringfalsenullAn expression to apply on the target list in order to group the result of a row into. If the expression returns false, the row result is added to the end of the list.If null or empty, each row result creates a new entry in the target list.
engineStringfalsepelThe template engine to be used. Currently 'freemarker' and 'pel' is supported.
modelNameStringfalsenullThe name of the root model under which the input can be accessed inside the template. If null or empty, then the input defines the model names.
templateStringtruenullThe template to be used for the transformation. It can the template text itself as string or a qualified uri pointing to a template resource like this for example: $uri:property:/my/template/path
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.transform:
iterate: <value>
groupBy: <value>
engine: <value>
modelName: <value>
template: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.transform?iterate=<value>&groupBy=<value>&engine=<value>&modelName=<value>&template=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.transform iterate=<value> groupBy=<value> engine=<value> modelName=<value> template=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

datetime v1


Returns the current time at server side.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
formatStringfalsenullThe date time format pattern. If null, the system default format is used.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- datetime:
format: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/datetime?format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command datetime format=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

datetime.zones v1


Returns all official IANA time-zone names supported by this PIPEFORCE instance: http://www.iana.org/time-zones

Try online.

Alias: command:datetime.zone.list:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- datetime.zones:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/datetime.zones?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command datetime.zones id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.attachment.add v1


Adds a single attachment to an existing PIPEFORCE Secure Delivery. Note: Attachments can be added to deliveries only in state DRAFT.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of an existing delivery to be updated.
nameStringtruenullThe name of the attachment.
mimeTypeStringfalsenullThe mime type of the attachment.
lengthStringfalse0The length of the attachment in bytes.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.attachment.add:
deliveryUuid: <value>
name: <value>
mimeType: <value>
length: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.attachment.add?deliveryUuid=<value>&name=<value>&mimeType=<value>&length=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.attachment.add deliveryUuid=<value> name=<value> mimeType=<value> length=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.create v1


Creates a new PIPEFORCE Secure Delivery and sets it in the target

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
subjectStringfalsenullThe subject of the delivery. If null or empty, the default subject will be used.
messageStringfalsenullThe message of the delivery. If null or empty, the default message will be used.
privacyLevelIntegerfalse1The privacy level to send the delivery. Must be one of 1, 2, 3 or 4.
recipientsStringfalsenullA comma separated list of email recipients. Also PEL is supported here.
deleteAfterStringfalse0Delete the delivery attachments after this date and time given as unix timestamp in millis. If null, empty, 0 or negative, delivery will never be deleted.
attachmentsStringfalsenullThe list of attachment file names or a list of JSON objects to be added to this delivery.
notifySenderStringfalsetrueIf true, notifies sender when recipients have downloaded delivery.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.create:
subject: <value>
message: <value>
privacyLevel: <value>
recipients: <value>
deleteAfter: <value>
attachments: <value>
notifySender: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.create?subject=<value>&message=<value>&privacyLevel=<value>&recipients=<value>&deleteAfter=<value>&attachments=<value>&notifySender=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.create subject=<value> message=<value> privacyLevel=<value> recipients=<value> deleteAfter=<value> attachments=<value> notifySender=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.delete v1


Deletes a given delivery.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery to delete.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- delivery.delete:
deliveryUuid: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.delete?deliveryUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command delivery.delete deliveryUuid=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

delivery.finalize v1


Finalizes an existing delivery. After finalized, only recipients can be added but message and attachments of delivery can not be changed any longer.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery to finalize.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.finalize:
deliveryUuid: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.finalize?deliveryUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.finalize deliveryUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.get v1


Returns an existing delivery.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.get:
deliveryUuid: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.get?deliveryUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.get deliveryUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.inbox.details v1


Returns the details of a given inbox Delivery.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery.
recipientEmailStringfalsenullThe email of the recipient. If not specified request user email is used
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.inbox.details:
deliveryUuid: <value>
recipientEmail: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.inbox.details?deliveryUuid=<value>&recipientEmail=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.inbox.details deliveryUuid=<value> recipientEmail=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.inbox.list v1


Lists all deliveries for the currently logged-in user.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.inbox.list:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.inbox.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.inbox.list id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.migration v1


It returns migrated UUIDs in return body

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- delivery.migration:
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.migration?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command delivery.migration id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

delivery.outbox.delete v1


Deletes a delivery from the currently logged-in users outbox.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.outbox.delete:
deliveryUuid: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.outbox.delete?deliveryUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.outbox.delete deliveryUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.outbox.details v1


Returns the details of a given outbox Delivery.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.outbox.details:
deliveryUuid: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.outbox.details?deliveryUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.outbox.details deliveryUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.outbox.list v1


Lists all deliveries sent by the currently logged-in user.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.outbox.list:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.outbox.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.outbox.list id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.recipient.add v1


Adds recipients to an existing PIPEFORCE Secure Delivery. Note: Recipients can be added to deliveries only in state DRAFT or FINALIZED.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringfalsenullThe uuid of an existing delivery to be updated.
emailStringfalsenullThe email address of the recipient to be added.
localeStringfalsenullThe locale to be used for this recipient like de, en or fr for example.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.recipient.add:
deliveryUuid: <value>
email: <value>
locale: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.recipient.add?deliveryUuid=<value>&email=<value>&locale=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.recipient.add deliveryUuid=<value> email=<value> locale=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.send v1


Sends a given PIPEFORCE Secure Delivery. If delivery is in status DRAFT it will be converted to FINALIZED before send.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringtruenullThe uuid of the delivery to send.
recipientsStringfalsenullThe comma separated or PEL list of recipients to (re-)send the delivery to. The recipients must already exist in the delivery. If null or empty, the delivery message is send to all existing recipients of the delivery.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.send:
deliveryUuid: <value>
recipients: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.send?deliveryUuid=<value>&recipients=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.send deliveryUuid=<value> recipients=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

delivery.update v1


Updates an existing PIPEFORCE Secure Delivery.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
deliveryUuidStringfalsenullThe uuid of an existing delivery to be updated with values from the params. Any existing value will be overwritten by parameter set on this command. If null or empty, a new delivery will be created and initialized with values from params. Note: Deliveries can only be fully updated in DRAFT state. In FINALIZED state, only recipients can be updated.
subjectStringfalsenullThe subject of the delivery. If null or empty, this attribute wont be updated.. Overwrites any existing value.
messageStringfalsenullThe message of the delivery. If null or empty, this attribute wont be updated. Overwrites any existing value.
privacyLevelIntegerfalse1The privacy level to send the delivery. Must be one of 1, 2, 3 or 4. Overwrites any existing value. If null or empty, this attribute wont be updated.
recipientsStringfalsenullA comma separated list of email recipients. Overwrites any existing recipients. If null or empty, this attribute wont be updated.
deleteAfterStringfalse0Delete the delivery attachments after this date and time given as unix timestamp in millis. If 0 or negative, delivery will never be deleted. If null or empty, this attribute wont be updated. If set overwrites any existing value.
attachmentsStringfalsenullThe attachments to be set to this delivery. Overwrites any existing attachments. If null or empty, this attribute wont be updated.
notifySenderStringfalsetrueIf true, notifies sender when recipients have downloaded delivery. If null or empty, this attribute wont be updated.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- delivery.update:
deliveryUuid: <value>
subject: <value>
message: <value>
privacyLevel: <value>
recipients: <value>
deleteAfter: <value>
attachments: <value>
notifySender: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.update?deliveryUuid=<value>&subject=<value>&message=<value>&privacyLevel=<value>&recipients=<value>&deleteAfter=<value>&attachments=<value>&notifySender=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.update deliveryUuid=<value> subject=<value> message=<value> privacyLevel=<value> recipients=<value> deleteAfter=<value> attachments=<value> notifySender=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

dev.null v1


This command simply reads the body (if there is any) and sends its content to '/dev/null'. It is mainly for testing purposes.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- dev.null:
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/dev.null?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command dev.null id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

doc.api.pelutils v1


Returns the api doc for the available PEL utils.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- doc.api.pelutils:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/doc.api.pelutils?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command doc.api.pelutils id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

docusign v1


Requests a signature of the given document in the body
via email (remote signing) using DocuSign. See here:
https://developers.docusign.com/esign-rest-api/code-examples/code-example-request-a-signature-via-email
Expects the to be signed document in the body with json.file encoding.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
signerEmailStringtruenullThe email address of the signer.
signerNameStringfalsenullThe real name of the signer.
ccEmailStringfalsenullThe email of cc user to get informed about the signing request. If null, no cc mail is sent.
ccNameStringfalsenullThe name of cc email user to get informed about the signing request.
subjectStringfalsenullThe email subject to be send to the signer. If null or empty, the default subject will be set.
accessTokenStringfalsenullThe DocuSign access token. If null or empty, the token will be read from settings.
accountIdStringfalsenullThe docuSign account Id for REST calls. Can be obtained here: https://developers.docusign.com/esign-rest-api/guides/authentication/user-info-endpoints . If not set, the command tries to get the account ID by an additional request from DocuSign
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- docusign:
signerEmail: <value>
signerName: <value>
ccEmail: <value>
ccName: <value>
subject: <value>
accessToken: <value>
accountId: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/docusign?signerEmail=<value>&signerName=<value>&ccEmail=<value>&ccName=<value>&subject=<value>&accessToken=<value>&accountId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command docusign signerEmail=<value> signerName=<value> ccEmail=<value> ccName=<value> subject=<value> accessToken=<value> accountId=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

document.understand v1


Returns metadata for a given unstructured document like an invoice PDF for example. Expects the document to be in the body by default. Returns the result as JSON in the body (replacing any existing value in the body).

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
providerStringfalsenullThe name of the provider to process document.
configStringfalsenullThe config json to process document
secretStringfalsenullThe name of the secret in secret store.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
apiKeyStringfalsenullThe alternative API key to connect to the service. If null or empty, the default one will be used, as defined by the default backend settings.
restUrlStringfalsenullThe URL to be called by the command. If null or empty, the default url will be used as defined in the backend.
filterStringfalsenullA PEL as filter to be applied to the output data before it is returned by this command. If null or empty, no filter is applied.

Pipeline example:

pipeline:  
- document.understand:
provider: <value>
config: <value>
secret: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>
apiKey: <value>
restUrl: <value>
filter: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/document.understand?provider=<value>&config=<value>&secret=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>&apiKey=<value>&restUrl=<value>&filter=<value>  

Command Line Interface (CLI) example:

pi command document.understand provider=<value> config=<value> secret=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value> apiKey=<value> restUrl=<value> filter=<value>  

Learn more: Command Line Interface (CLI).

drive.archive.save v1


Saves the content of the body to the given archive folder in Drive. The content of the body must be a single file. Verifies the integrity of the archive on write. Returns the final archive file name / path (without archive root path) into the output target.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe root path of the archive folder where the file to be saved to.
namingPatternStringfalsenullThe PEL pattern to be applied to generate the final archive file name / path. This name / path will be relative to the given archive root path. Additionally, provides these variables in this PEL pattern context: archiveCounter = The last value used as counter as it comes from the .counter file. When not present, is initialized by counting all files in archive folder. counter = The archiveCounter increased by 1.archivePath = The path to the archive root as given by path param. basename = The base filename of the archive file, without extension (for example myfile.pdf = myfile). basenameNoId = Same as basename but without the _ID-123 part in the file name if there is any.ext = The extension of the archive file, without a period (for example myfile.pdf = pdf) filename = The full name of the archive file, with extension (for example myfile.pdf = myfile.pdf). The default pattern is this: basename_counter.ext
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- drive.archive.save:
path: <value>
namingPattern: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.archive.save?path=<value>&namingPattern=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.archive.save path=<value> namingPattern=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

drive.copy v1


Copies a folder or file on Drive.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the folder or file to be copied.
toStringtruenullThe target folder to copy the resource into.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- drive.copy:
path: <value>
to: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.copy?path=<value>&to=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command drive.copy path=<value> to=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

drive.delete v1


Deletes a file or folder on Drive. If resource doesnt exist, nothing happens.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the resource to be deleted. If it is a folder, it will be deleted recursively.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- drive.delete:
path: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.delete?path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command drive.delete path=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

drive.exists v1


Checks whether a resource in Drive exists. Puts the string true or false in the message body depending whether the resource exists.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the resource to check for existence.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- drive.exists:
path: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.exists?path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.exists path=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

drive.list v1


Lists all resources from drive folder.

Try online.

Version: v1
Input body type: JsonNode
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the folder to be listed.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- drive.list:
path: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.list?path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.list path=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

drive.mkdir v1


Creates a new dir on Drive if it not already exists.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the folder the new dir should be created within.
recurseStringfalsefalseIf set to true, any non existing folder in the path will be created.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- drive.mkdir:
path: <value>
recurse: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.mkdir?path=<value>&recurse=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command drive.mkdir path=<value> recurse=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

drive.move v1


Moves a folder or file on Drive from one location into another.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the folder or file to be moved.
toStringtruenullThe target folder to move the resource into.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- drive.move:
path: <value>
to: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.move?path=<value>&to=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command drive.move path=<value> to=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

drive.read v1


Reads a file from drive and puts its content as a pipeline resource into the body.

Try online.

Version: v1
Input body type: JsonNode
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the file to be read from Drive.
appendBooleanfalsefalseIf true, appends the files read from drive to any existing collection in the body. In case the body is no collection but a content (single file), creates a new collection and adds all to this collection (already existing file and read files). In case the body is different from collection or content, an error is thrown. If false (default), overwrites any existing body value.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- drive.read:
path: <value>
append: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.read?path=<value>&append=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.read path=<value> append=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

drive.save v1


Saves the content of the body to Drive. The content of the body can be a content object (= single file) or a content collection (= folder of files).In case the body is not a content object, it will be tried to convert it to such a content object.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
pathStringfalsenullThe path of the file to be saved in drive. If a content collection is in the body, this is the path of the base folder where to store these files recursively. Otherwise, it is expected to be the full path to a single file. If null or empty, the name of the content object is used as path. If content object has also no path set, an exception is thrown.
namingStrategyStringfalsenullIf defined, applies the given naming strategy to the name of the resource. If null or empty, no naming strategy is applied.
cleanupBodyStringfalsefalseIf true, deletes the content from the body after it was saved to drive (default). Note: In case the body content is a stream, this stream will be empty even if this was set to false since streams can be processed only once and was already processed by writing its data to drive here.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.

Pipeline example:

pipeline:  
- drive.save:
path: <value>
namingStrategy: <value>
cleanupBody: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.save?path=<value>&namingStrategy=<value>&cleanupBody=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>  

Command Line Interface (CLI) example:

pi command drive.save path=<value> namingStrategy=<value> cleanupBody=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value>  

Learn more: Command Line Interface (CLI).

drive.share v1


Shares a folder in Drive given by path to users given by recipients.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
toStringtruenullComma separated list of users, group names or email addresses. Never null. If this is an expression and points to comma separated list, an array or a collection, will create share to any of the entries. If this value is missing, a public share is created instead
typeStringfalseuserCan be either shared to 'user' or to 'group'. Defaults to 'user'
pathStringtruenullThe path to the folder to be shared.
permissionIntegerfalse1The permission for the share: 1 (read), 2 (update), 4 (create), 8 (delete), 16 (share), 31 (all). Note: Permissions can be combined by additions: For example read (1) + update (2) would be 3. For public shares defaults to 1 (read).
subjectStringfalsenullOptional subject of the share email to be send to the recipient. If type=user and at least one of subject or message parameter is set, an email will be send to the recipient after it was shared to him.
messageStringfalsenullOptional message of the share email to be send to the recipient. If type=user and at least one of subject or message parameter is set, an email will be send to the recipient after it was shared to him.
modelStringfalsenullOptional model for the share email to be send to the recipient.
expiresLongfalsenullNOT SUPPORTED YET. A timestamp in millis since 1970 when this share will expire. If -1 share will never expire.
passwordStringfalsenullNOT SUPPORTED YET. A password to protect the share.
inviteBooleanfalsenullNOT SUPPORTED YET. Send an invite email to recipients.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- drive.share:
to: <value>
type: <value>
path: <value>
permission: <value>
subject: <value>
message: <value>
model: <value>
expires: <value>
password: <value>
invite: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.share?to=<value>&type=<value>&path=<value>&permission=<value>&subject=<value>&message=<value>&model=<value>&expires=<value>&password=<value>&invite=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.share to=<value> type=<value> path=<value> permission=<value> subject=<value> message=<value> model=<value> expires=<value> password=<value> invite=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

drive.tag v1


Adds or removes a WebDAV tag to a resource on drive.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the resource to tag.
tagnameStringtruenullThe name of the tag to add.
tagvalueStringfalsenullThe value of the tag to add.
removeBooleanfalsenullIf true (or any non empty/null value), removes the given tag.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- drive.tag:
path: <value>
tagname: <value>
tagvalue: <value>
remove: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.tag?path=<value>&tagname=<value>&tagvalue=<value>&remove=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command drive.tag path=<value> tagname=<value> tagvalue=<value> remove=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

drive.upload.chunked v1


Supports chunked uploads of large files into the Drive endpoint. Expects an object in the body which can be converted to an input stream as the chunk data to be uploaded.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
actionStringtruenullDefines the action of the chunked upload. One of: create, upload, finalize, cancel
uuidStringfalsenullThe uuid to refer to the upload session as returned by the create action. Required for upload, finalize and cancel actions.
pathStringfalsenullThe target path where to copy the final file on finalize action. Mandatory for the finalize action.
indexIntegerfalsenullThe index of the chunk. Mandatory for the upload action.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- drive.upload.chunked:
action: <value>
uuid: <value>
path: <value>
index: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.upload.chunked?action=<value>&uuid=<value>&path=<value>&index=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command drive.upload.chunked action=<value> uuid=<value> path=<value> index=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

error v1


This command stops the execution of the current pipeline and returns an error to the caller.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
messageStringtruenullThe error message to return to the caller.
typeStringfalsenullThe type string to set for this exception.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- error:
message: <value>
type: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/error?message=<value>&type=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command error message=<value> type=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

eval v1


Executes a given pipeline expression with the message as context.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
exprStringtruenullThe pipeline expression to be executed.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- eval:
expr: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/eval?expr=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command eval expr=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

event.listen v1


Listening for events works like this: Add this command at the very first in your pipeline, define the event key you want to listen for and an optional filter expression. Then save this pipeline into the property store. This causes the system to automatically register this pipeline and execute it whenever an event with given key and matching filter is fired. Note: Only one event.listen command per pipeline is allowed and it needs to be the very first command in the pipeline. In the body of the pipeline the event object is provided and can be used for filtering for example.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use eventKey instead.
eventKeyStringfalsenullThe key to listen for.
filterStringfalsenullDEPRECATED: Use parameter selector instead. An optional PEL to execute the pipeline only in case the filter applies.
selectorStringfalsenullSelects the message to be passed to this listener. Can be a PEL or a selector expression. Note: For performance reasons, using the body payload for filtering is not allowed here and will throw an exception. Use headers for filtering instead. If this parameter is set, filter will be ignored.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- event.listen:
key: <value>
eventKey: <value>
filter: <value>
selector: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/event.listen?key=<value>&eventKey=<value>&filter=<value>&selector=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command event.listen key=<value> eventKey=<value> filter=<value> selector=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

event.mapping.get v1


Returns all event key to pipeline key mappings.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- event.mapping.get:
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/event.mapping.get?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command event.mapping.get id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

event.send v1


Sends a new event to inform listeners in pipelines and microservices.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullThe key under which to send this event.
traceIdStringfalsenullThe optional tracedId to be used to send this event. If not defined, a random traceId is created automatically.
payloadStringfalsenullThe payload to send with this event. May be null.
asyncStringfalsetrueSend the event in ASYNC mode? Note: ASYNC is faster but lacks transaction capability. If false, message is send in SYNC. Slower but can use the current authentication and transaction context.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- event.send:
key: <value>
traceId: <value>
payload: <value>
async: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/event.send?key=<value>&traceId=<value>&payload=<value>&async=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command event.send key=<value> traceId=<value> payload=<value> async=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

except v1


In case an exception happens in a command, the pipeline execution will go to the first except command it finds (it will skip all other commands) after it. If the conditions on this except command match, the body of the except command will be executed. This means all commands after the except command will be executed until end of the pipeline or except.end was found whatever is first.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
typeStringfalsenullThe type of the exception to match. Can be a single exception of a list of exception types.
responseStatusCodeStringfalsenullIn case this exception was raised because of a call of an external HTTP endpoint, the HTTP status code returned by this external service can be matched here.
dropStringfalsetrueShould the exception be dropped after it was processed by this command or re-thrown?
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- except:
type: <value>
responseStatusCode: <value>
drop: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/except?type=<value>&responseStatusCode=<value>&drop=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command except type=<value> responseStatusCode=<value> drop=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

except.end v1


Indicates the end of an except block.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- except.end:
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/except.end?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command except.end id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

exit v1


Exits the current pipeline flow and returns the current body state to the caller.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
ifStringfalse#{true}The PE to be evaluated. If true, the pipeline will exit.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- exit:
if: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/exit?if=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command exit if=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

finally v1


Any command placed after this finally command will be executed even if the pipeline execution was quit using the exit command or by an exception.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
doStringfalsenullAn optional PE to execute finally.
dropStringfalsefalseIf set to true, catches and drops any existing exception and does not re-throw it. This is useful in case the exceptions will be handled by the finally block or should be dropped at all.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- finally:
do: <value>
drop: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/finally?do=<value>&drop=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command finally do=<value> drop=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

foreach v1


Splits a given set of data and repeats the subsequent commands for each entry in a given list until location of foreach.end command. The current iteration item can be accessed using the path vars.[as] or vars.loop.[as].item. The current iteration index can be accessed using the path vars.loop.[as].index. In order to find out whether current iteration index is odd or even, use vars.loop.[as].even. Whereas [as] stands for the name given by the [as] parameter. Note: Even if not an error, you should prefer to set the as parameter for every foreach command. Not using it is discouraged and support for not using it will be removed in future versions.

Try online.

Alias: command:split:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
inStringfalsenullThis parameter points to a list of items to be iterated over. Each iteration item is placed under vars.loop.[as].item and vars.[as] whereas [as] will be replaced by the name given by the as parameter.
loopNameStringfalseloopDeprecated. Use parameter as instead. This parameter is only here for downwards compatibility and will be removed in one of the next releases. If as parameter is null or empty, this parameter gets checked. And if not null or empty, it will change the default loop context name in the vars scope from vars.loop to vars.[loopName], so you can access the current iteration item using vars.[loopName].item.
asStringfalsenullFor each iteration/split, puts the current iteration item into the vars scope under this name. If this parameter is null or empty, the item wont be additionally exposed to vars scope. Additionally puts the current loop context under the variable name vars.loop.NAME.item whereas NAME is the value of this as parameter. For example, if you set as to myitem, then you can access the item using the path vars.loop.myitem.item or vars.myitem.The loop context contains these objects for each iteration: item = The current iteration item. In case the iteration input is a map or a JSON, you can access the key of the item using item.key and the value using item.value.index = The current 0-based iteration index. even = A boolean value whether current iteration index is even or not. This is useful for example for layouting.
itemStringfalsenullDeprecated. Contains an optional expression which will be evaluated for each iteration to extract or prepare the iteration item. The result of this expression will be placed as iteration item.
endStringfalsenullDeprecated. Use the foreach.end command instead. Signals the end of a for each loop.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- foreach:
in: <value>
loopName: <value>
as: <value>
item: <value>
end: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/foreach?in=<value>&loopName=<value>&as=<value>&item=<value>&end=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command foreach in=<value> loopName=<value> as=<value> item=<value> end=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

foreach.end v1


Defines the end of a foreach loop.

Try online.

Alias: command:split.end:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.

Pipeline example:

pipeline:  
- foreach.end:
id: <value>
if: <value>
onError: <value>
eval: <value>

Since v1 is the default version for commands, it is not required to specify it.

Learn more: Pipeline.

URL example:

http://host/api/v3/command/foreach.end?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command foreach.end id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

function.backend.cache.clear v1


Clears the cache of the FaaS backend.

Try online.

Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsenullIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
onErrorStringfalsenullDefines the action in case an error happens. Default is 'THROW': Stops execution and throws the error to the caller. This parameter has precedence over the optional header with same name.
evalStringfalsenullAn expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.backend.cache.clear:
id: <value>
if