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 not state otherwise in the command description: 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 not state otherwise in the command description: 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).

apidoc.pipeforce v1


Returns the OpenAPI documentation of all default PIPEFORCE hub endpoints as YAML.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- apidoc.pipeforce:
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.pipeforce?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

app.config.find v1


Returns the configuration of an app or a list of apps the currently logged-in user is allowed to see.

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. If not found, empty JSON is 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.config.find:
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.find?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.find 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 not state otherwise in the command description: 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.

Pipeline example:

pipeline:  
- app.uninstall:
appKey: <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/app.uninstall?appKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command app.uninstall appKey=<value> id=<value> if=<value> onError=<value> eval=<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 and to be compared with the actual value.
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 not state otherwise in the command description: 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 not state otherwise in the command description: 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.peek v1


Sets the most recent entry of the bodyStack as body. Doesn't remove it from the stack.

Try online.

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

NameTypeRequiredDefaultDescription
varStringfalsebodyStackThe name of the variable to peek from.
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.peek:
var: <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.peek?var=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

body.pop v1


Removes the most recent entry of the bodyStack and sets it to the body. (pops from stack and sets to body), If no entry is left in body stack, null is set to body.

Try online.

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

NameTypeRequiredDefaultDescription
varStringfalsebodyStackThe name of the variable to pop from.
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.pop:
var: <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.pop?var=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

body.push v1


Sets the current value of the body to a location defined by a PEL. This is handy in case you would like to simply save the body before next command overwrites it.If target is given, it is a PEL which will be executed in order to store the body value to this location. In case the target parameter is missing, the body will be pushed to a variable of name bodyStack. If this variable exists, it is assumed to be a list where the body value can be added at its end. if this variable doesn't exist, it will be created as a stack (list).

Try online.

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

NameTypeRequiredDefaultDescription
varStringfalsebodyStackThe name of the variable to create the body stack under and push the value to. If a list under this variable doesn't exist yet, it 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:  
- body.push:
var: <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.push?var=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command body.push var=<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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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.find 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- config.find:
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.find?group=<value>&key=<value>&includePermission=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command config.find 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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.
iterateBooleanfalsenullIn 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.
outputTypeStringfalsenullBy default the type of the output element is detected automatically: If input is an object then output is also an object. If input is an array and iterate is set to true, then output is also an array. But sometimes it is necessary to map from an array to a final object, then you can set this to object. In this case, no new entry is created on output for each iteration. Instead it can be mapped to the same object.
contextualizeBooleanfalsefalseIf true, the input is wrapped into an mapping context model providing more context information.

This model will be provided to any mapping rule and contains these fields: <ul> <li>headers = The pipeline headers.</li> <li>vars = The pipeline variables.</li> <li>body = The pipeline body.</li> <li>item = The current item from the input for the mapping rule. If iteration is true, this will change on each iteration loop to the next element.</li> </ul>

ignoreEmptyItems | String | false | false | In case iterate is set to true and an iteration item is an empty JSON, should it be ignored in the output? id | String | false | null | The optional id of this command, unique within the pipeline. if | String | false | null | Is 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. onError | String | false | null | Defines 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. eval | String | false | null | An expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations. input | String | false | null | Defines where to read the input from as PEL. If this param is missing, the input will be read from the body. output | String | false | null | Defines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- data.mapping:
rules: <value>
iterate: <value>
outputType: <value>
contextualize: <value>
ignoreEmptyItems: <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>&outputType=<value>&contextualize=<value>&ignoreEmptyItems=<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> outputType=<value> contextualize=<value> ignoreEmptyItems=<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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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 not state otherwise in the command description: 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. Can be a single pel string or a list of expression strings.
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 not state otherwise in the command description: 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.backend.cache.clear:
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/function.backend.cache.clear?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command function.backend.cache.clear id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

function.backend.status v1


Returns the status 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.backend.status:
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/function.backend.status?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command function.backend.status id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

function.delete v1


Undeploys a function from the FaaS backend.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the function to undeploy.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.delete:
name: <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/function.delete?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command function.delete name=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

function.get v1


Returns all deployed functions or a specific one.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the function to return. If null or empty, all deployed functions will be 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.get:
name: <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/function.get?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command function.get name=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

function.put v1


Deploys a new function to the FaaS backend. Expects the function code in the body or input of the command.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the function to deploy.
codeStringfalsenullThe code of the function to deploy. Can also be a custom uri starting with $uri:... . In this case the function code will be loaded from this uri and then deployed.
languageStringfalsepythonThe language of the function (currently only python is supported).
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.put:
name: <value>
code: <value>
language: <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/function.put?name=<value>&code=<value>&language=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command function.put name=<value> code=<value> language=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

function.run v1


Executes a function given by name on the FaaS backend.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the function to run.
argsStringfalsenullThe arguments to be passed to the function. Must be serializable to JSON. Can also be a custom uri starting with $uri: pointing to a document which is a JSON document or can be converted to a JSON.
evalArgsStringfalsetrueSearch the args param value recursively for PEL expressions and parse them?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- function.run:
name: <value>
args: <value>
evalArgs: <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/function.run?name=<value>&args=<value>&evalArgs=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command function.run name=<value> args=<value> evalArgs=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

gateway.endpoint.delete v1


Deletes an endpoint configuration.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringtruenullThe uuid of the endpoint 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- gateway.endpoint.delete:
uuid: <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/gateway.endpoint.delete?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command gateway.endpoint.delete uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

gateway.endpoint.get v1


Returns an endpoint configuration.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringtruenullThe uuid of the endpoint to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- gateway.endpoint.get:
uuid: <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/gateway.endpoint.get?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command gateway.endpoint.get uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

gateway.endpoint.list v1


Lists all existing endpoint configurations.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- gateway.endpoint.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/gateway.endpoint.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

gateway.endpoint.put v1


Adds a new endpoint configuration. Expects the config as JSON in the input. In case no uuid is given, a new entry is created.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringfalsenullThe uuid of the endpoint to update. This will overwrite the value of the input JSON if there is any or create a new entry if missing.
methodsStringfalse*A list of HTTP methods to allow. If this list contains *, all methods are allowed. This will overwrite the value of the input JSON if there is any.
enabledStringfalsetrueEnables or disables this endpoint temporarily. This will overwrite the value of the input JSON if there is any.
pollingStringfalsefalseIn case this endpoints is an async target, should a polling redirect be applied to the request so it polls for the result until has been processed or timed out?
mockedStringfalsenullIf given, mocks this endpoint for testing (= doesn't forward to real endpoint). This will overwrite the value of the input JSON if there is any.
weightStringfalse0The weighting of this entry. In case a path matches two entries, the one with higher wight value will win.
patternStringtruenullThe wildcard pattern, the incoming request path must match in order to get called. This will overwrite the value of the input JSON if there is any.
targetStringtruenullThe target uri to be executed in case the request matches. This will overwrite the value of the input JSON if there is any.
authenticateStringfalsefalseIs authentication needed for this endpoint? In this case, the Authorization header must exist and must contain a valid authentication token or credentials. This will overwrite the value of the input JSON if there is any.
rolesStringfalsenullThe authenticated user must be assigned to at least one of the roles from this list. If null or empty, no authorization check is done after successful authentication. Authentication is mandatory to be enabled for this. This will overwrite the value of the input JSON if there is any.
groupsStringfalsenullThe authenticated user must be member to at least one of the groups from this list. If null or empty, no authorization check is done after successful authentication. Authentication is mandatory to be enabled for this. This will overwrite the value of the input JSON if there is any.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- gateway.endpoint.put:
uuid: <value>
methods: <value>
enabled: <value>
polling: <value>
mocked: <value>
weight: <value>
pattern: <value>
target: <value>
authenticate: <value>
roles: <value>
groups: <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/gateway.endpoint.put?uuid=<value>&methods=<value>&enabled=<value>&polling=<value>&mocked=<value>&weight=<value>&pattern=<value>&target=<value>&authenticate=<value>&roles=<value>&groups=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command gateway.endpoint.put uuid=<value> methods=<value> enabled=<value> polling=<value> mocked=<value> weight=<value> pattern=<value> target=<value> authenticate=<value> roles=<value> groups=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

gateway.group.list v1


Lists all groups allowed to be assigned to endpoints.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- gateway.group.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/gateway.group.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

gateway.role.list v1


Lists all roles allowed to be assigned to endpoints.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- gateway.role.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/gateway.role.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

header.set v1


DEPRECATED. Use the set command instead. Sets any parameter value as header. For example header.set?key1=value1&key2=value2 would become the headers: key1: value1 and key2: value2

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:  
- header.set:
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/header.set?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

htmlunit.website.form.find v1


Searches for a form on the page and sets is as vars.form model in PEL. If param 'select' is given, uses this PEL to find the form object. Otherwise tries to detect the form automatically by searching the page and using the first form found. Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
selectStringfalsenullA PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
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:  
- htmlunit.website.form.find:
select: <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/htmlunit.website.form.find?select=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.form.find select=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

htmlunit.website.form.input v1


Searches for an input element with given name and sets the given value on it. Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
valueStringfalsenullThe value to be set on the selected input field.
selectStringfalsenullA PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
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:  
- htmlunit.website.form.input:
value: <value>
select: <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/htmlunit.website.form.input?value=<value>&select=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.form.input value=<value> select=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

htmlunit.website.form.submit v1


Searches for a submit button and clicks it. Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
selectStringfalsenullA PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
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:  
- htmlunit.website.form.submit:
select: <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/htmlunit.website.form.submit?select=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.form.submit select=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

htmlunit.website.link.click v1


Searches for a link on current page and clicks it. Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
selectStringfalsenullA PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
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:  
- htmlunit.website.link.click:
select: <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/htmlunit.website.link.click?select=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.link.click select=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

htmlunit.website.open v1


Opens a website and sets it as 'vars.page' in PEL. Additionally sets the current browser instance as 'vars.browser'. Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
urlStringtruenullThe url of the web page to open.
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:  
- htmlunit.website.open:
url: <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/htmlunit.website.open?url=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.open url=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

htmlunit.website.scrap v1


Scraps data from the current website and returns the result in the body.Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
xpathStringtruenullExecutes the given xpath expression on the current page and puts the result in the body. In case the xpath returns more than one results, adds an array to the body. Otherwise the body only contains the single result value.
selectStringfalsenullA PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
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:  
- htmlunit.website.scrap:
xpath: <value>
select: <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/htmlunit.website.scrap?xpath=<value>&select=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.scrap xpath=<value> select=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

http.delete v1


Executes a DELETE HTTP call to the given url.Returns the result from the server in the message body.

Try online.

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

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
serviceStringfalsenullThe name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headersStringfalsenullA list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
bodyStringfalsenullThe value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
forceContentTypeStringfalseapplication/json;type=responseIf this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
includeResponseStringfalsefalseIf true, writes the HTTP response including headers and status code as JSON in the output.
includeRequestStringfalsefalseIf true, includes the HTTP request as JSON in the output.
ignoreErrorStatusStringfalsefalseIf true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
passthruStringfalsefalseIf true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.
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:  
- http.delete:
url: <value>
service: <value>
headers: <value>
body: <value>
forceContentType: <value>
includeResponse: <value>
includeRequest: <value>
ignoreErrorStatus: <value>
passthru: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <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/http.delete?url=<value>&service=<value>&headers=<value>&body=<value>&forceContentType=<value>&includeResponse=<value>&includeRequest=<value>&ignoreErrorStatus=<value>&passthru=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command http.delete url=<value> service=<value> headers=<value> body=<value> forceContentType=<value> includeResponse=<value> includeRequest=<value> ignoreErrorStatus=<value> passthru=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

http.get v1


Executes a GET HTTP call to the given url.Returns the result from the server in the message body or wrapped in the response JSON format depending on its configuration.

Try online.

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

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
serviceStringfalsenullThe name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headersStringfalsenullA list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
bodyStringfalsenullThe value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
forceContentTypeStringfalseapplication/json;type=responseIf this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
includeResponseStringfalsefalseIf true, writes the HTTP response including headers and status code as JSON in the output.
includeRequestStringfalsefalseIf true, includes the HTTP request as JSON in the output.
ignoreErrorStatusStringfalsefalseIf true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
passthruStringfalsefalseIf true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.
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:  
- http.get:
url: <value>
service: <value>
headers: <value>
body: <value>
forceContentType: <value>
includeResponse: <value>
includeRequest: <value>
ignoreErrorStatus: <value>
passthru: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <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/http.get?url=<value>&service=<value>&headers=<value>&body=<value>&forceContentType=<value>&includeResponse=<value>&includeRequest=<value>&ignoreErrorStatus=<value>&passthru=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command http.get url=<value> service=<value> headers=<value> body=<value> forceContentType=<value> includeResponse=<value> includeRequest=<value> ignoreErrorStatus=<value> passthru=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

http.patch v1


Executes a PATCH HTTP call to the given url.Returns the result from the server in the message body.

Try online.

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

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
serviceStringfalsenullThe name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headersStringfalsenullA list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
bodyStringfalsenullThe value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
forceContentTypeStringfalseapplication/json;type=responseIf this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
includeResponseStringfalsefalseIf true, writes the HTTP response including headers and status code as JSON in the output.
includeRequestStringfalsefalseIf true, includes the HTTP request as JSON in the output.
ignoreErrorStatusStringfalsefalseIf true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
passthruStringfalsefalseIf true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.
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:  
- http.patch:
url: <value>
service: <value>
headers: <value>
body: <value>
forceContentType: <value>
includeResponse: <value>
includeRequest: <value>
ignoreErrorStatus: <value>
passthru: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <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/http.patch?url=<value>&service=<value>&headers=<value>&body=<value>&forceContentType=<value>&includeResponse=<value>&includeRequest=<value>&ignoreErrorStatus=<value>&passthru=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command http.patch url=<value> service=<value> headers=<value> body=<value> forceContentType=<value> includeResponse=<value> includeRequest=<value> ignoreErrorStatus=<value> passthru=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

http.post v1


Executes a POST HTTP call to the given url.Returns the result from the server in the message body.

Try online.

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

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
serviceStringfalsenullThe name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headersStringfalsenullA list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
bodyStringfalsenullThe value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
forceContentTypeStringfalseapplication/json;type=responseIf this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
includeResponseStringfalsefalseIf true, writes the HTTP response including headers and status code as JSON in the output.
includeRequestStringfalsefalseIf true, includes the HTTP request as JSON in the output.
ignoreErrorStatusStringfalsefalseIf true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
passthruStringfalsefalseIf true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.
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:  
- http.post:
url: <value>
service: <value>
headers: <value>
body: <value>
forceContentType: <value>
includeResponse: <value>
includeRequest: <value>
ignoreErrorStatus: <value>
passthru: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <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/http.post?url=<value>&service=<value>&headers=<value>&body=<value>&forceContentType=<value>&includeResponse=<value>&includeRequest=<value>&ignoreErrorStatus=<value>&passthru=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command http.post url=<value> service=<value> headers=<value> body=<value> forceContentType=<value> includeResponse=<value> includeRequest=<value> ignoreErrorStatus=<value> passthru=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

http.put v1


Executes a PUT HTTP call to the given url.Returns the result from the server in the message body.

Try online.

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

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
serviceStringfalsenullThe name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headersStringfalsenullA list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
bodyStringfalsenullThe value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
forceContentTypeStringfalseapplication/json;type=responseIf this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
includeResponseStringfalsefalseIf true, writes the HTTP response including headers and status code as JSON in the output.
includeRequestStringfalsefalseIf true, includes the HTTP request as JSON in the output.
ignoreErrorStatusStringfalsefalseIf true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
passthruStringfalsefalseIf true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.
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:  
- http.put:
url: <value>
service: <value>
headers: <value>
body: <value>
forceContentType: <value>
includeResponse: <value>
includeRequest: <value>
ignoreErrorStatus: <value>
passthru: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <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/http.put?url=<value>&service=<value>&headers=<value>&body=<value>&forceContentType=<value>&includeResponse=<value>&includeRequest=<value>&ignoreErrorStatus=<value>&passthru=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>&credentials=<value>&secret=<value>  

Command Line Interface (CLI) example:

pi command http.put url=<value> service=<value> headers=<value> body=<value> forceContentType=<value> includeResponse=<value> includeRequest=<value> ignoreErrorStatus=<value> passthru=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value> credentials=<value> secret=<value>  

Learn more: Command Line Interface (CLI).

http.response.set v1


Prepares the HTTP response in case this pipeline is executed in an HTTP request context. In case the pipeline is not running inside an HTTP request context, nothing happens in executing this command. Note: In case the pipeline was initiated by an HTTP request, you can access the request headers using the headers scope: headers.request.

Try online.

Alias: command:http.response:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
statusCodeStringfalsenullThe HTTP status code to be set on the HTTP response.
headersStringfalsenullThe HTTP headers to be add as JSON or name-value pairs.
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:  
- http.response.set:
statusCode: <value>
headers: <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/http.response.set?statusCode=<value>&headers=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command http.response.set statusCode=<value> headers=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

i18n.messages v1


Returns the i18n messages of given app, context and locale.

Try online.

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

NameTypeRequiredDefaultDescription
appStringfalseio.pipeforce.commonThe app which contains the i18n messages.
contextStringfalsedefaultThe context of the i18n messages.
localeStringfalseenThe locale of the i18n message. For example: en, de, fr and so on.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- i18n.messages:
app: <value>
context: <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/i18n.messages?app=<value>&context=<value>&locale=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command i18n.messages app=<value> context=<value> locale=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.apitoken v1


Obtains the apitoken (= offline token) in exchange for user credentials provided and writes it into the output.

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringtruenullThe user name.
passwordStringtruenullThe user password.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.apitoken:
username: <value>
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/iam.apitoken?username=<value>&password=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.apitoken username=<value> password=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.authinfo v1


Adds header 'authUserId' - name of an user authenticated as a sender of the pipe message.

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:  
- iam.authinfo:
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/iam.authinfo?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command iam.authinfo id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

iam.authorize v1


Authorizes pipeline execution and overwrites any existing authentication by this new, successful authentication. Additionally puts the successful authentication token on an internal stack. See iam.logout to pop from stack.Subsequent commands will be executed only if authorization was successful. Tries each existing parameter for authentication in this order. If multiple params are given, first existing one is used from this list: accessToken, refreshToken, basic, username+password. Throws exception and exits pipeline execution on first not matching login try.

Try online.

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

NameTypeRequiredDefaultDescription
accessTokenStringfalsenullThe accessToken (bearer token) to be used for authentication.
refreshTokenStringfalsenullThe refreshToken to be used for authentication.
basicStringfalsenullThe basic authentication string to be used for authentication.
usernameStringfalsenullThe username to be used for authentication.
passwordStringfalsenullThe password to be used for authentication.
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:  
- iam.authorize:
accessToken: <value>
refreshToken: <value>
basic: <value>
username: <value>
password: <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/iam.authorize?accessToken=<value>&refreshToken=<value>&basic=<value>&username=<value>&password=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command iam.authorize accessToken=<value> refreshToken=<value> basic=<value> username=<value> password=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

iam.bruteforce.release v1


Releases any bruteforce lock for the given user. If user is not locked, nothing happens.

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringfalsenullThe name of the user to unlock. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the user to unlock. If set, the param username 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.bruteforce.release:
username: <value>
uuid: <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/iam.bruteforce.release?username=<value>&uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.bruteforce.release username=<value> uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.bruteforce.status v1


Returns the bruteforce status for a single user

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringfalsenullThe name of the user to return the status for. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the user to return the status for. If set, the param username 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.bruteforce.status:
username: <value>
uuid: <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/iam.bruteforce.status?username=<value>&uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.bruteforce.status username=<value> uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.cache.clear v1


Clears the security objects (and reloads roles where required). Note: Since this can be a heavy task and slow down the system, use it only in case really required!

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:  
- iam.cache.clear:
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/iam.cache.clear?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

iam.group.add.roles v1


Adds roles to a given group. Roles must exist beforehand.

Try online.

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

NameTypeRequiredDefaultDescription
groupUuidStringtruenullThe unique group uuid.
roleNamesStringtruenullThe role names to join. Can be a comma separated list or a PEL pointing to a list.
groupNameStringtruenullThe unique group name.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.add.roles:
groupUuid: <value>
roleNames: <value>
groupName: <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/iam.group.add.roles?groupUuid=<value>&roleNames=<value>&groupName=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.add.roles groupUuid=<value> roleNames=<value> groupName=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.group.create v1


Creates a new group and puts its uuid in the body under key groupUuid. Throws exception if group already exists.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe unique group name.
roleNamesStringfalsenullA list of roles to be assigned to this group on creation.
attributesMapfalsenullA map which holds optional attributes to be added to this group.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.create:
name: <value>
roleNames: <value>
attributes: <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/iam.group.create?name=<value>&roleNames=<value>&attributes=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.create name=<value> roleNames=<value> attributes=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.group.delete v1


Deletes the group with given uuid.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringtruenullThe uuid of the group 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.delete:
uuid: <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/iam.group.delete?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.delete uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.group.list v1


Lists all groups. By default, the response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_grouprepresentation

Try online.

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

NameTypeRequiredDefaultDescription
filterStringfalsenullIf set, applies the given filter to the search for groups.
sortByNameStringfalsenullIf set, groups are returned as collection with the group name as key.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.list:
filter: <value>
sortByName: <value>
max: <value>
offset: <value>
filter: <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/iam.group.list?filter=<value>&sortByName=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.list filter=<value> sortByName=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.group.list.names v1


Lists all group names. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_grouprepresentation

Try online.

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

NameTypeRequiredDefaultDescription
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.list.names:
max: <value>
offset: <value>
filter: <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/iam.group.list.names?max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.list.names max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.group.members v1


Lists all users which are member of any of the given groups. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the group. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the group. If set, the param name is ignored.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.members:
name: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <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/iam.group.members?name=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.members name=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.group.roles v1


Lists all effective role names, the given group is assigned to.

Try online.

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

NameTypeRequiredDefaultDescription
groupNameStringfalsenullThe name of the group. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the group. If set, the param username is ignored.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.roles:
groupName: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <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/iam.group.roles?groupName=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.roles groupName=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.realm.create v1


Creates a new realm. Sets the uuid in the body under key realmUuid. Throws exception if realm already exists. Expects a JSON in the body of this structure: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_realmrepresentation

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.realm.create:
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/iam.realm.create?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.realm.create id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.role.add.composites v1


Adds existing composite roles to an existing role.

Try online.

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

NameTypeRequiredDefaultDescription
roleNameStringtruenullThe unique role name to be loaded.
compositesStringtruenullThe composite role names to join. Can be a comma separated list or a PEL pointing to a list.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.role.add.composites:
roleName: <value>
composites: <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/iam.role.add.composites?roleName=<value>&composites=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.role.add.composites roleName=<value> composites=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.role.create v1


Creates a new role and puts its role uuid in the body under key roleUuid. Throws exception if role already exists.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe unique role name.
compositesStringfalsenullA PEL list of roles names to add to this role as children. Makes this role a composite.
attributesMapfalsenullA map which holds optional attributes to be added to this role.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.role.create:
name: <value>
composites: <value>
attributes: <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/iam.role.create?name=<value>&composites=<value>&attributes=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.role.create name=<value> composites=<value> attributes=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.role.members v1


Lists all users which are member of the given role. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

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

NameTypeRequiredDefaultDescription
roleNameStringfalsenullThe name of the role.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.role.members:
roleName: <value>
max: <value>
offset: <value>
filter: <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/iam.role.members?roleName=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.role.members roleName=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.run.as v1


Executes the subsequent pipeline as different user if following two conditions are met. 1. currently logged-in user has permission CAN_RUN_AS_SOURCE 2. requested user has permission CAN_RUN_AS_TARGET

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringtruenullThe username, subsequent pipe commands must be executed as. This user must has RUN_AS_SOURCE role assigned.
cachingStringfalseyesShould the IAM cache used (= much faster)?
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:  
- iam.run.as:
username: <value>
caching: <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/iam.run.as?username=<value>&caching=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command iam.run.as username=<value> caching=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

iam.search v1


Searches for specific entity in the IAM service matching the given filter. Returns the JSON representation of the given type as JSON array. See here for the representation types: https://www.keycloak.org/docs-api/11.0/rest-api/ .For example the type 'USER' would return a list of 'UserRepresentation'.

Try online.

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

NameTypeRequiredDefaultDescription
typeStringtruenullThe entity type to search for. Supported values are: ROLE, USER, GROUP, REALM.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.search:
type: <value>
max: <value>
offset: <value>
filter: <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/iam.search?type=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.search type=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.token v1


Obtains the full offline token response JSON in exchange for user credentials provided and writes into the output.

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringtruenullThe user name.
passwordStringtruenullThe user password.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.token:
username: <value>
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/iam.token?username=<value>&password=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.token username=<value> password=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.token.logout v1


Logs out keycloak session associated with refreshToken and removes any refresh and access tokens from headers.

Try online.

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

NameTypeRequiredDefaultDescription
refreshTokenStringtruenullThe refresh token.
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:  
- iam.token.logout:
refreshToken: <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/iam.token.logout?refreshToken=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command iam.token.logout refreshToken=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

iam.token.refresh v1


Enrich headers with accessToken obtained from authorization server using refreshToken and returns the tokenResponse in the body.

Try online.

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

NameTypeRequiredDefaultDescription
refreshTokenStringtruenullThe refresh token.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.token.refresh:
refreshToken: <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/iam.token.refresh?refreshToken=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.token.refresh refreshToken=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.add.groups v1


Adds groups to a user by group id or name and returns the group ids added.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringtruenullThe unique username as uuid.
groupNamesStringfalsenullThe group names to join. If not given, groupIds is required.
groupIdsStringfalsenullThe group ids to join. If not given, groupNames is required.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.add.groups:
uuid: <value>
groupNames: <value>
groupIds: <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/iam.user.add.groups?uuid=<value>&groupNames=<value>&groupIds=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.add.groups uuid=<value> groupNames=<value> groupIds=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.add.roles v1


Adds roles to a given user. Roles must exist beforehand.

Try online.

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

NameTypeRequiredDefaultDescription
userUuidStringtruenullThe unique username as uuid.
usernameStringtruenullThe unique username as uuid.
roleNamesStringtruenullThe role names to join. Can be a comma separated list or a PEL pointing to a list.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.add.roles:
userUuid: <value>
username: <value>
roleNames: <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/iam.user.add.roles?userUuid=<value>&username=<value>&roleNames=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.add.roles userUuid=<value> username=<value> roleNames=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.create v1


Creates a new user and returns its uuid in the body. Throws exception if user already exists.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe unique username.
emailStringtruenullThe unique email.
firstNameStringfalsenullThe optional first name.
lastNameStringfalsenullThe optional last name.
groupNamesStringfalsenullThe optional groups the user joins.
roleNamesStringfalsenullThe optional roles (permissions) the user must join.
passwordStringfalsenullThe password to be set for this user or null in order to let the user choose one on login.
attributesMapfalsenullA map which holds optional attributes to be added to this user.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.create:
name: <value>
email: <value>
firstName: <value>
lastName: <value>
groupNames: <value>
roleNames: <value>
password: <value>
attributes: <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/iam.user.create?name=<value>&email=<value>&firstName=<value>&lastName=<value>&groupNames=<value>&roleNames=<value>&password=<value>&attributes=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.create name=<value> email=<value> firstName=<value> lastName=<value> groupNames=<value> roleNames=<value> password=<value> attributes=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.delete v1


Deletes the user with given uuid.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringtruenullThe uuid of the user 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.delete:
uuid: <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/iam.user.delete?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.delete uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.get v1


Looks up a user returns it in the body if exists. The response is a JSON array of these entities: https://www.keycloak.org/docs-api/15.0/rest-api/#_userrepresentation

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringfalsenullThe name of the user. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the user. If set, the param username 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.get:
username: <value>
uuid: <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/iam.user.get?username=<value>&uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.get username=<value> uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.groups v1


Lists all groups, the given user is member of. By default, the response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_grouprepresentation

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringfalsenullThe name of the user. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the user. If set, the param username is ignored.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.groups:
username: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <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/iam.user.groups?username=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.groups username=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.list v1


Lists all users. The response is a JSON array of these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

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

NameTypeRequiredDefaultDescription
includeGroupsBooleanfalsenullInclude all groups, for each user he is member of? Note: If true, the command execution becomes significantly slower!
includeRolesBooleanfalsenullInclude all realm roles, for each user he is member of? Note: If true, the command execution becomes significantly slower!
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.list:
includeGroups: <value>
includeRoles: <value>
max: <value>
offset: <value>
filter: <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/iam.user.list?includeGroups=<value>&includeRoles=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.list includeGroups=<value> includeRoles=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

iam.user.roles v1


Lists all effective role names, the given user is member of.

Try online.

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

NameTypeRequiredDefaultDescription
usernameStringfalsenullThe name of the user. If not set, param uuid must be set.
uuidStringfalsenullThe uuid of the user. If set, the param username is ignored.
maxIntegerfalse100The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offsetIntegerfalse0The offset to start return entries.
filterStringfalsenullThe filter query to additionally filter the result. Not applied if null
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.roles:
username: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <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/iam.user.roles?username=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.roles username=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

if v1


Executes the subsequent pipeline only if given condition evaluates to true. Otherwise, jumps to the end of this block given by the if.end command.

Try online.

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

NameTypeRequiredDefaultDescription
trueStringfalsenullThe expression which must evaluate to true in order to execute the if block. Otherwise execution flow jumps to the if.end command.
endStringfalsenullDeprecated. Use command if.end instead. Defines the end of of the if command block.
elseStringfalsenullDeprecated. Use the command if.else instead. Defines the else part of the if statement. If value of if evaluates to false, the section right after this else statement is executed until the if.end command.
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:  
- if:
true: <value>
end: <value>
else: <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/if?true=<value>&end=<value>&else=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command if true=<value> end=<value> else=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

if.else v1


Executes all commands below this command up to the if.end command in case initial if command did not execute its containing command 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:  
- if.else:
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/if.else?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command if.else id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

if.end v1


Defines the end of an if command.

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:  
- if.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/if.end?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

imap.delete v1


Deletes the selected mails by the given filter parameters, e.g. delete mails for the filters unreadOnly, folder, sender.

Try online.

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

NameTypeRequiredDefaultDescription
folderStringfalseINBOXOptional filter parameter, Folder from where we want to delete the mails. Default value is INBOX.
fromStringfalsenullOptional filter parameter, filter mails by provided sender.
unreadOnlyBooleanfalsefalseOptional filter parameter, true to get unread mails only. Default value will be false.
hostStringtruenullHost for the mailbox. E.g. outlook.office365.com
secretStringtruenullSecret, which contains the imap credentials and config json.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- imap.delete:
folder: <value>
from: <value>
unreadOnly: <value>
host: <value>
secret: <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/imap.delete?folder=<value>&from=<value>&unreadOnly=<value>&host=<value>&secret=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command imap.delete folder=<value> from=<value> unreadOnly=<value> host=<value> secret=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

imap.get v1


Searches the mails and returns all the mails retrieved using the given criteria.

Try online.

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

NameTypeRequiredDefaultDescription
folderStringfalseINBOXOptional filter parameter, search mails from particular given folder. Default value will be INBOX.
fromStringfalsenullOptional filter parameter, filter mails by provided sender.
unreadOnlyBooleanfalsefalseOptional filter parameter, true to get unread mails only. Default value will be false.
hostStringtruenullHost for the mailbox. E.g. outlook.office365.com
secretStringtruenullSecret, which contains the imap credentials and config json.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- imap.get:
folder: <value>
from: <value>
unreadOnly: <value>
host: <value>
secret: <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/imap.get?folder=<value>&from=<value>&unreadOnly=<value>&host=<value>&secret=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command imap.get folder=<value> from=<value> unreadOnly=<value> host=<value> secret=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

imap.mkdir v1


Creates the folder as a sibling of INBOX or inside INBOX or any other folder and returns the status.

Try online.

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

NameTypeRequiredDefaultDescription
destinationFolderStringfalseINBOXOptional filter parameter, creates a folder inside the given folder. Default value is INBOX.
folderNameStringtruenullFolder name to create a folder inside a destination folder.
hostStringtruenullHost for the mailbox. E.g. outlook.office365.com
secretStringtruenullSecret, which contains the imap credentials and config json.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- imap.mkdir:
destinationFolder: <value>
folderName: <value>
host: <value>
secret: <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/imap.mkdir?destinationFolder=<value>&folderName=<value>&host=<value>&secret=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command imap.mkdir destinationFolder=<value> folderName=<value> host=<value> secret=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

imap.move v1


Moves the selected mails by the given filter parameters to the provided mailbox folder.

Try online.

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

NameTypeRequiredDefaultDescription
sourceFolderStringfalseINBOXOptional filter parameter, Source folder from where we want to move the mails. Default value is INBOX.
destinationFolderStringtruenullTargeted folder for the mails to move.
fromStringfalsenullOptional filter parameter, filter mails by provided sender.
unreadOnlyBooleanfalsefalseOptional filter parameter, true to get unread mails only. Default value will be false.
hostStringtruenullHost for the mailbox. E.g. outlook.office365.com
secretStringtruenullSecret, which contains the imap credentials and config json.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- imap.move:
sourceFolder: <value>
destinationFolder: <value>
from: <value>
unreadOnly: <value>
host: <value>
secret: <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/imap.move?sourceFolder=<value>&destinationFolder=<value>&from=<value>&unreadOnly=<value>&host=<value>&secret=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command imap.move sourceFolder=<value> destinationFolder=<value> from=<value> unreadOnly=<value> host=<value> secret=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

job v1


Schedules any subsequent commands of the current pipeline and executes it at the scheduled times.

Try online.

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

NameTypeRequiredDefaultDescription
scheduleStringtruenullA schedule string which configures the execution of the job. Can be one of: EVERY_5_MIN, EVERY_15_MIN, EVERY_30_MIN, EVERY_45_MIN, HOURLY, DAILY, WEEKLY, MONTHLY. Furthermore in development stage also EVERY_1_MIN is allowed. Throws an exception in production stage.
stopStringfalsenullDeprecated. Use the command job.stop instead. If this param is set, all other params are ignored. It contains the id of the job to be canceled.
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:  
- job:
schedule: <value>
stop: <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/job?schedule=<value>&stop=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command job schedule=<value> stop=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

job.list v1


Lists all scheduled pipeline jobs.

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:  
- job.list:
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/job.list?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

job.status v1


Returns the status of a given job or null in case the job doesnt exist.

Try online.

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

NameTypeRequiredDefaultDescription
pipelineKeyStringtruenullThe pipelineKey of the job those status to return
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:  
- job.status:
pipelineKey: <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/job.status?pipelineKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command job.status pipelineKey=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

job.stop v1


Stops the job with given id. Note: Usually it is not required to use this command. In order to stop and unregister a job, simply remove it from the pipeline or delete the pipeline.

Try online.

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

NameTypeRequiredDefaultDescription
pipelineKeyStringtruenullThe pipeline key of the job to be cancelled.
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:  
- job.stop:
pipelineKey: <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/job.stop?pipelineKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command job.stop pipelineKey=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

jpa.query v1


Executes a JPA query and returns the result as JSON in the body. NOTE: This pipe is primarily meant for support to monitor the system. Its not accessible by default accounts! This can change at any time without notice!

Try online.

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

NameTypeRequiredDefaultDescription
queryStringfalsenullThe JPA query 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- jpa.query:
query: <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/jpa.query?query=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

log v1


Logs the given input message without changing it.

Try online.

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

NameTypeRequiredDefaultDescription
messageStringtruenullThe message to log. Can be a string or a pipeline expression. If null or empty, the current pipeline message will be logged.
levelStringfalseINFOThe log level. Can be one of DEBUG, TRACE, INFO, WARN, ERROR.

If null or empty, INFO will be used.

suffix | String | false | true | Suffix log message with path of persisted pipeline path if any. This simplifies searching in logs later. id | String | false | null | The optional id of this command, unique within the pipeline. if | String | false | null | Is 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. onError | String | false | null | Defines 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. eval | String | false | null | An 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:  
- log:
message: <value>
level: <value>
suffix: <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/log?message=<value>&level=<value>&suffix=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command log message=<value> level=<value> suffix=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

log.list v1


Returns the given number of log lines from specified service.

Try online.

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

NameTypeRequiredDefaultDescription
serviceStringfalsehubThe service to print logs for. If null or empty, the 'hub' will be used.
linesIntegerfalse100The number of lines to print in case format is text. 100 is printed when not specified.
formatStringfalsetextThe format to be returned. One of: text, json
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.list:
service: <value>
lines: <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/log.list?service=<value>&lines=<value>&format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.list service=<value> lines=<value> format=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

log.list.email v1


Returns the email audit log properties. Only available for developers, system or support users.

Try online.

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

NameTypeRequiredDefaultDescription
auditIdStringfalsenullThe audit id (uuid) of the logged email to return. If null or empty, all emails will be returned matching the given parameters.
createdAfterStringfalseReturns only those emails created after this date in ISO-8601 format. If null or empty, no after filter will be set.
createdBeforeStringfalseReturns only those emails created before this date in ISO-8601 format. If null or empty, no before filter will be set.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.list.email:
auditId: <value>
createdAfter: <value>
createdBefore: <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/log.list.email?auditId=<value>&createdAfter=<value>&createdBefore=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.list.email auditId=<value> createdAfter=<value> createdBefore=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

log.list.environment v1


Logs the current environment properties. Only available for developers, system or support users.

Try online.

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

NameTypeRequiredDefaultDescription
interpolateStringfalsetrueReturn all properties with values interpolated? (= ${some.var} is resolved).
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.list.environment:
interpolate: <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/log.list.environment?interpolate=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.list.environment interpolate=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

log.search v1


Searches the cloud logs and returns the last 30 entries per request. Supports pagination toscroll thru the entries. Does not return log.search log entries in order to not repeat itself.

Try online.

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

NameTypeRequiredDefaultDescription
serviceStringfalsehubThe service to search for log entries. Can be a list or comma separated service names. If null or empty, 'hub' will be used as default.
severityStringfalsenullThe severity to search inside: DEBUG, INFO, WARNING, ERROR. Can be a list or comma separated text. If null or empty, searches in all severities.
messageFilterStringfalsenullMessage search string to filter the result by matching this string. Can be null or empty to return any entry.
typeFilterStringfalsenullA list of types of message logs to show. Possible values are: command, pipeline, security_audit, event_fired, webhook. If not set, all logs will be shown.
startDateTimeStringfalsenullAn ISO8601 date-time string to start the search at. If null or empty, the date-time string from 24h before will be used.
endDateTimeStringfalsenullAn ISO8601 date-time string to end the search at. If null or empty, all results up to now will be returned.
nextPageTokenStringfalsenullIf this value is given, the next page of results of a previous search is loaded.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.search:
service: <value>
severity: <value>
messageFilter: <value>
typeFilter: <value>
startDateTime: <value>
endDateTime: <value>
nextPageToken: <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/log.search?service=<value>&severity=<value>&messageFilter=<value>&typeFilter=<value>&startDateTime=<value>&endDateTime=<value>&nextPageToken=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.search service=<value> severity=<value> messageFilter=<value> typeFilter=<value> startDateTime=<value> endDateTime=<value> nextPageToken=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

log.services v1


Returns all PIPEFORCE services for those logging is allowed / enabled.

Try online.

Alias: command:log.service.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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.services:
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/log.services?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

log.severities v1


Returns all severities (for example, DEBUG, INFO,...), supported by the logging system.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.severities:
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/log.severities?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

macro v1


Defines a custom macro inside a pipeline. Such a macro can then be re-used by calling the command macro.run.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe optional name of the macro. If given, the macro will be registered under this name an can be re-called using the command macro.run.
argsStringfalsenullThe args to the macro as name-value pairs. If this macro will be re-called, these args will be default args which can be overwritten by the caller.
flowStringfalsenullIf set to true, the macro will be called by the pipeline flow even if name parameter is set.
doStringfalsenullThe macro body to be executed as PEL.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- macro:
name: <value>
args: <value>
flow: <value>
do: <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/macro?name=<value>&args=<value>&flow=<value>&do=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command macro name=<value> args=<value> flow=<value> do=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

macro.run v1


Calls a defined macro by its name.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the macro to call.
argsStringfalsenullThe optional args to the macro as name-value pairs.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- macro.run:
name: <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/macro.run?name=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command macro.run name=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

mail.dump v1


Fetches new emails from given mail inbox and uploads them into a drive folder. Note: This command is for demo purposes only and not intended for production use.

Try online.

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

NameTypeRequiredDefaultDescription
protocolStringfalseimapThe email protocol. One of 'imap' or 'pop3'.
hostStringtruenullThe email host.
portIntegertruenullThe port of the email host.
inboxUsernameStringtruenullThe username of the email inbox.
inboxPasswordStringtruenullThe password of the email inbox.
driveUsernameStringtruenullThe username of the drive account to upload to.
drivePasswordStringtruenullThe password of the drive account to upload to.
pathStringfalsenullThe remote folder path in drive where to upload the emails into. For each new email a new sub folder will be created inside this path. If null or empty, uploads to the root folder of the logged in user.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- mail.dump:
protocol: <value>
host: <value>
port: <value>
inboxUsername: <value>
inboxPassword: <value>
driveUsername: <value>
drivePassword: <value>
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/mail.dump?protocol=<value>&host=<value>&port=<value>&inboxUsername=<value>&inboxPassword=<value>&driveUsername=<value>&drivePassword=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command mail.dump protocol=<value> host=<value> port=<value> inboxUsername=<value> inboxPassword=<value> driveUsername=<value> drivePassword=<value> path=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

mail.fetch v1


Fetches new emails from given mail inbox and returns them as JSON in the output. Note: This command is for demo purposes only and not intended for production use.

Try online.

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

NameTypeRequiredDefaultDescription
protocolStringfalseimapThe email protocol. One of 'imap' or 'pop3'.
hostStringtruenullThe email host.
portIntegertruenullThe port of the email host.
inboxUsernameStringtruenullThe username of the email inbox.
inboxPasswordStringtruenullThe password of the email inbox.
newMailsOnlyStringfalsefalseDownload only new mails since last processing? If true, the state of last fetch will be kept in property store. Any new fetch will be checked with this state and email will be downloaded only if not processed yet.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- mail.fetch:
protocol: <value>
host: <value>
port: <value>
inboxUsername: <value>
inboxPassword: <value>
newMailsOnly: <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/mail.fetch?protocol=<value>&host=<value>&port=<value>&inboxUsername=<value>&inboxPassword=<value>&newMailsOnly=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command mail.fetch protocol=<value> host=<value> port=<value> inboxUsername=<value> inboxPassword=<value> newMailsOnly=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

mail.send v1


Sends the given message as email. The message's subject and body will be used in the email accordingly.

Try online.

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

NameTypeRequiredDefaultDescription
toStringtruenullComma separated list of to email addresses. Never null. If this is an expression and points to comma separated list, an array or a collection, will send an email to any of the entries.
fromStringfalseSystems default FROM setting.The from email.
fromNameStringfalseSystems default FROM name setting.The from name.
subjectStringfalseSystems default subject setting.The subject.
messageStringfalsenullBy default, the body is used as email message. If this param is set, it will be used as message instead. Can also be a PE which points to a value to be used as the mail message.
replyToStringfalsenullReply-To email address is used when email receiver uses its mail client's 'reply' function. If not used,the from address is used automatically.
attachmentsStringfalsenullCan be a comma separated list of URI Strings (e.g.: uri:drive:file1, uri:property:global/file2, uri:drive:file1, uri:classpath:pipeforce/file3). Also can point via PEL to a content object or a content collection. If the PEL points to an object differently to an uri or content object, serializes the value to string and attaches this as a text file.
modelStringfalsenullThe model to be placed into the template scope. If null, the message is used as model so you can access vars and body the same way as you would do in the pipeline.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- mail.send:
to: <value>
from: <value>
fromName: <value>
subject: <value>
message: <value>
replyTo: <value>
attachments: <value>
model: <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/mail.send?to=<value>&from=<value>&fromName=<value>&subject=<value>&message=<value>&replyTo=<value>&attachments=<value>&model=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command mail.send to=<value> from=<value> fromName=<value> subject=<value> message=<value> replyTo=<value> attachments=<value> model=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

mail.verify v1


Protects any subsequent pipe commands: Pipeline is only executed
in case the caller has verified that he is the owner of given
email address. To do so, a magic link (verification link) is sent
to his email account. Only if the user clicks on this link within
a certain amount of time (default is 10min), the subsequent pipe
commands are executed. From a technical point of view this is done
by putting the current state of the message into a cache which deletes
any entries older than 10min. Then, the email with the key to this
cache entry (=challenge) is send to the user. If the user clicks on
this link, the message is loaded from the cache using the challenge as
the key. If the user clicked within 10min, the entry is here, can be
loaded and the message execution can be resumed. Otherwise if the user
clicks after 10min on the link, no more entry in it. Execution fails.
User has to re-request the link. Note: This command is for demo purposes only and not intended for production use.

Try online.

Alias: command:email.verify:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
emailStringtruenullThe email address to send the challenge to.
email.whitelistStringfalsenullA comma separated list of allowed email addresses. Also supports wildcards . Example: @domain.com, my@email.com
email.blacklistStringfalsenullA comma separated list of blocked email addresses. Also supports wildcards . Example: @domain.com, my@email.com
challengeStringfalsenullThe challenge which will become part of the link in the email when redirecting back.
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:  
- mail.verify:
email: <value>
email.whitelist: <value>
email.blacklist: <value>
challenge: <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/mail.verify?email=<value>&email.whitelist=<value>&email.blacklist=<value>&challenge=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command mail.verify email=<value> email.whitelist=<value> email.blacklist=<value> challenge=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

map v1


DEPRECATED. Use the set command instead. Maps, calculates and converts data from fields of the input message to fields of the output message.

Try online.

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

NameTypeRequiredDefaultDescription
reverseBooleanfalsefalseReverses the left and right expressions. This is a workaround if for some reason the left sidefor example may not contain special characters.
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:  
- map:
reverse: <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/map?reverse=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command map reverse=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

memory.info v1


Shows the current system info like memory consumption. Available for system, support and developer users only.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- memory.info:
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/memory.info?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

message.ack v1


Acks message for pipeline initiated by message.receive with autoack=false.

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:  
- message.ack:
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/message.ack?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.ack id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.binding.delete v1


Deletes a binding.

Try online.

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

NameTypeRequiredDefaultDescription
destinationNameStringtruenullThe name of the destination of the binding to remove.
destinationTypeStringfalsenullThe type of the destination of the binding to remove. One of queue or exchange.
exchangeStringfalsenullThe exchange involved in this binding to remove.
routingKeyStringfalsenullThe routing key to be used for the binding to remove.
argsStringfalsenullCustom args to be passed to the binding to remove.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- message.binding.delete:
destinationName: <value>
destinationType: <value>
exchange: <value>
routingKey: <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/message.binding.delete?destinationName=<value>&destinationType=<value>&exchange=<value>&routingKey=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command message.binding.delete destinationName=<value> destinationType=<value> exchange=<value> routingKey=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

message.binding.put v1


Creates a new binding. Returns the binding info as JSON.

Try online.

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

NameTypeRequiredDefaultDescription
destinationNameStringtruenullThe name of the destination of the binding.
destinationTypeStringfalsequeueThe type of the destination of the binding. One of queue or exchange.
exchangeStringfalsepipeforce.default.topicThe exchange involved in this binding.
routingKeyStringtruenullThe routing key to be used for the binding
argsStringfalsenullCustom args to be passed to the binding creation.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- message.binding.put:
destinationName: <value>
destinationType: <value>
exchange: <value>
routingKey: <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/message.binding.put?destinationName=<value>&destinationType=<value>&exchange=<value>&routingKey=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command message.binding.put destinationName=<value> destinationType=<value> exchange=<value> routingKey=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

message.drop v1


Drops message without redelivery for pipeline initiated by message.receive with autoack=false.

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:  
- message.drop:
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/message.drop?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.drop id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.exchange.delete v1


Deletes an exchange.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the exchange 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- message.exchange.delete:
name: <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/message.exchange.delete?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command message.exchange.delete name=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

message.exchange.put v1


Creates an exchange.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the exchange to create.
typeStringfalsetopicThe type of the exchange like topic, fanout, direct, headers, system or a custom one starting with x-
durableStringfalsetrueIf true, exchange will survive server restart
autodeleteStringfalsefalseDelete the exchange if now longer in use?
argsStringfalsenullOptional args to the exchange.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- message.exchange.put:
name: <value>
type: <value>
durable: <value>
autodelete: <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/message.exchange.put?name=<value>&type=<value>&durable=<value>&autodelete=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command message.exchange.put name=<value> type=<value> durable=<value> autodelete=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

message.list v1


Returns all messages of a given queue.

Try online.

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

NameTypeRequiredDefaultDescription
countStringfalse10Number of messages to return in list. Max is 100.
truncateStringfalse10000Truncate returned messages this number of bytes. If empty or negative, all bytes are returned.
encodingStringfalseautoThe encoding to be used. One of auto or base64.
ackmodeStringfalsereject_requeue_trueThe ack mode to be used. One of: ack_requeue_true, reject_requeue_true, ack_requeue_false, reject_requeue_false
queueStringtruenullThe name of the queue to return messages from.
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:  
- message.list:
count: <value>
truncate: <value>
encoding: <value>
ackmode: <value>
queue: <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/message.list?count=<value>&truncate=<value>&encoding=<value>&ackmode=<value>&queue=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.list count=<value> truncate=<value> encoding=<value> ackmode=<value> queue=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.nack v1


Nacks message with redelivery for pipeline initiated by message.receive with autoack=false.

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:  
- message.nack:
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/message.nack?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.nack id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.queue.delete v1


Deletes a queue.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the queue to delete.
unusedStringfalsefalseDelete only if not is use?
emptyStringfalsefalseDelete only if empty?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- message.queue.delete:
name: <value>
unused: <value>
empty: <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/message.queue.delete?name=<value>&unused=<value>&empty=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command message.queue.delete name=<value> unused=<value> empty=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

message.queue.find v1


Returns details for all message queues matching the given search filter.

Try online.

Alias: command:message.admin.queue.find:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
includeBindingsStringfalsefalseInclude the bindings for each queue?
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:  
- message.queue.find:
includeBindings: <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/message.queue.find?includeBindings=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.queue.find includeBindings=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.queue.get v1


Returns details about a message queue.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the queue to return.
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:  
- message.queue.get:
name: <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/message.queue.get?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.queue.get name=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.queue.purge v1


Purges the given queue.

Try online.

Alias: command:message.admin.queue.purge:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the queue to purge.
vhostStringfalse/The vhost of the queue.
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:  
- message.queue.purge:
name: <value>
vhost: <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/message.queue.purge?name=<value>&vhost=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.queue.purge name=<value> vhost=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.queue.put v1


Creates or updates a queue. Returns the queue info as JSON.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the queue.
durableStringfalsetrueShould the queue be in durable mode?
durableStringfalsefalseIs it an exclusive queue?
autodeleteStringfalsefalseShould the server delete the queue if it is no longer in use?
argsStringfalsenullCustom args to be passed to the queue creation.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- message.queue.put:
name: <value>
durable: <value>
durable: <value>
autodelete: <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/message.queue.put?name=<value>&durable=<value>&durable=<value>&autodelete=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command message.queue.put name=<value> durable=<value> durable=<value> autodelete=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

message.receive v1


Listens for cluster internal messages matching the given criteria. If matched, executes the pipeline commands below this command.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe routing key pattern to listen for.
exchangeStringfalsenullThe exchange to be used. If null, the default exchange will be used.
queueStringfalsenullThe name of the queue to receive messages from. If null, the default queue name will be used.
deleteQueueStringfalsefalseDEPRECATED. Use parameter managed instead. Delete the queue if this receive listener got removed or changed? Note: If this value is set to false, you have to track and cleanup queues manually, those are no longer in use!
manageQueueStringfalsecreateAuto-manage queue. Possible values are: false = Queue must be created and deleted manually. create = Queue will be created if not exists (default). delete = Queue will be deleted automatically if this command get removed or changed. create,delete = Combines create and delete.
managedStringfalsenullDEPRECATED. Use param manageQueue instead.
maxBatchSizeStringfalsenullCollects messages up to the given maxBatchSize in bytes and then processes this pipeline with all collected messages at once. All batched messages will be provided as array into the event body. If this parameter is null, empty or negative, no batching is used at all: Processes each message as single call. Maximum value can be 200KB (204800). If this parameter is used together with maxBatchItems the one which matches first is considered.
maxBatchItemsStringfalsenullCollects the amount of messages up to the given number of maxBatchItems and then processes this pipeline with all collected messages at once. All batched messages will be provided as array into the event body. If this parameter is null, empty or negative, no batching is used at all: Processes each message as single call. If this parameter is used together with maxBatchSize the one which matches first is considered.
autoackStringfalsetrueThe acknowledge mode to be used. If false, pipes message.ack, message.nack and/or message.drop are expected in pipeline. I pipeline does not aknowledge by its own, message.ack is called after successful pipeline execution, or message.nack on any errors. manual mode can be used only when none of maxBatchSize and maxBatchItems are 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:  
- message.receive:
key: <value>
exchange: <value>
queue: <value>
deleteQueue: <value>
manageQueue: <value>
managed: <value>
maxBatchSize: <value>
maxBatchItems: <value>
autoack: <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/message.receive?key=<value>&exchange=<value>&queue=<value>&deleteQueue=<value>&manageQueue=<value>&managed=<value>&maxBatchSize=<value>&maxBatchItems=<value>&autoack=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.receive key=<value> exchange=<value> queue=<value> deleteQueue=<value> manageQueue=<value> managed=<value> maxBatchSize=<value> maxBatchItems=<value> autoack=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

message.send v1


Sends a new message to the message service. Uses the pipeline message body as payload.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe routing key to send the message as.
exchangeStringfalsenullThe exchange to be used. If null, the default exchange will be used.
payloadStringfalsenullThe payload to be send in the message. If parameter is missing, the message body will be used as payload.
evalPayloadStringfalsetrueSearch the payload param value recursively for PEL expressions and parse them?
headersStringfalsenullThe headers to be send with the message. Values in here will overwrite any already existing header values.
encodingStringfalseUTF-8The encoding of the message payload.
contentTypeStringfalseapplication/jsonSets the content type of the message payload.
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:  
- message.send:
key: <value>
exchange: <value>
payload: <value>
evalPayload: <value>
headers: <value>
encoding: <value>
contentType: <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/message.send?key=<value>&exchange=<value>&payload=<value>&evalPayload=<value>&headers=<value>&encoding=<value>&contentType=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command message.send key=<value> exchange=<value> payload=<value> evalPayload=<value> headers=<value> encoding=<value> contentType=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

microsoft.teams.send v1


Sends a message to a Microsoft Teams channel.Note: This command needs an additional license + plugin. This is here only for documentation purposes. Ask support@pipeforce.io for more information.

Try online.

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

NameTypeRequiredDefaultDescription
urlStringtruenullThe Teams webhook url to post the message to.
messageStringtruenullThe text message to be send to Teams.
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:  
- microsoft.teams.send:
url: <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/microsoft.teams.send?url=<value>&message=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command microsoft.teams.send url=<value> message=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

mock.command v1


Mocks a given command of the current pipeline.

Try online.

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

NameTypeRequiredDefaultDescription
enabledStringfalsetrueIs the mock active? Can be a boolean or a PEL returning a boolean
commandStringtruenullThe name of the command to mock
whenStringfalse#{true}The mock expression: When this evaluates to true, the mock will be applied.
thenSetBodyStringfalsenullThe value to be returned in the body when this mock applies. If not defined, the current body will not be changed.
thenSetVarStringfalsenullDefines a map which will be set as vars.
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:  
- mock.command:
enabled: <value>
command: <value>
when: <value>
thenSetBody: <value>
thenSetVar: <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/mock.command?enabled=<value>&command=<value>&when=<value>&thenSetBody=<value>&thenSetVar=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command mock.command enabled=<value> command=<value> when=<value> thenSetBody=<value> thenSetVar=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

pdf.create v1


Creates a new PDF with blank pages.

Try online.

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

NameTypeRequiredDefaultDescription
pagesStringfalse1The number of pages to create. May not be 0 or negative.
formatStringfalseA4The format of the pages to create. One of: A0, A1, A2, A3, A4, A5, A6, LEGAL, LETTER
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.create:
pages: <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/pdf.create?pages=<value>&format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.create pages=<value> format=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.from.doc v1


This command is used to convert Word (.doc) to PDF.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.from.doc:
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/pdf.from.doc?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.from.doc id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.from.docx v1


This command is used to convert Word(.docx) to PDF.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.from.docx:
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/pdf.from.docx?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.from.docx id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.from.png v1


This command is used to convert PNG to PDF.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.from.png:
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/pdf.from.png?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.from.png id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.merge v1


Takes collection of pdfs that is expected in the body (as pipeline resource) and converts it into single pdf document.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of resulting document content.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.merge:
name: <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/pdf.merge?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.merge name=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.merge v2


This command is used to merge PDFs.

Try online.

Version: v2
Input body type: Raw
Output body type: Raw
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.merge::v2
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command pdf.merge id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.stamp v1


Writes both text or images to a pdf file under a specific layer. It expects the word pdf file as a pipeline resource in the body and transforms the result back also as a pipeline resource in the body.

Try online.

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

NameTypeRequiredDefaultDescription
textStringfalsenullThe text to write on the PDF file. It is required to either enter text or image.
textSizeStringfalse18The size of the font.
textColorStringfalseBLUEThe color of the font like GREEN, RED. YELLOW, aso.
imageStringfalsenullThe image to write on the pdf file. One of param text or image is required. The image must be a content uri an existing content object in the message or a built-in stamp name like APPROVED for example.
pagesStringfalse0The pages to put the stamp on or use 'ALL' for all pages.
positionStringfalseTOP_RIGHTThe x,y coordinates of the overlay to write. Must be 2 comma separated float values, e.g.: 123,123. Note: Top right corner within an A4 page is 612,792. Alternatively, relative positioning is possible by using one of: CENTER, TOP_RIGHT, TOP_LEFT aso.Alternatively, value PARAGRAPH activate paragraph positioning. All PARAGRAPH positioned stamps will not overlap each other.
layerStringfalsenullThe name of the layer to be created for the stamp. If null or empty, no layer is created. The stamp is added then directly to the page without any layer.
opacityFloatfalsenullAmount of opacity that should be applied (Must be a value between >= 0.0 and <= 1.0, 0.0 means no opacity, 1.0 means invisible.)
degreeFloatfalsenullSpecifies how many degress the element should be rotated. Negative degree means rotated below x-axis, positive degree means above. Must be a value between >= -180.0 and <= 180.0
marginCollectionfalse20Considers page margin when applying stamp. Can be a single value or a comma separated list of 4 entries forsetting margin in this order: [top, right, down, left]
lineNoIntegerfalse0Enforces that text is written at a specific line
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.stamp:
text: <value>
textSize: <value>
textColor: <value>
image: <value>
pages: <value>
position: <value>
layer: <value>
opacity: <value>
degree: <value>
margin: <value>
lineNo: <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/pdf.stamp?text=<value>&textSize=<value>&textColor=<value>&image=<value>&pages=<value>&position=<value>&layer=<value>&opacity=<value>&degree=<value>&margin=<value>&lineNo=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.stamp text=<value> textSize=<value> textColor=<value> image=<value> pages=<value> position=<value> layer=<value> opacity=<value> degree=<value> margin=<value> lineNo=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.stamp v2


Writes both text or images to a pdf file under a specific layer. It expects the pdf file as a pipeline resource in the body and transforms the result back also as a pipeline resource in the body.

Try online.

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

NameTypeRequiredDefaultDescription
textStringfalsenullThe text to write on the PDF file. It is required to either enter text or image.
fontSizeStringfalse18The size of the font.
fontColorStringfalse#FF0000/BLUEThe hex code color of the font like #FF0000, #0000FF
imageStringfalsenullThe image to write on the pdf file. One of param text or image is required. The image must be a content uri an existing content object in the message or a built-in stamp name like APPROVED for example.
opacityFloatfalsenullAmount of opacity that should be applied (Must be a value between >= 0.0 and <= 1.0, 0.0 means no opacity, 1.0 means invisible.)
rotationIntegerfalsenullSpecifies how many degrees the element should be rotated. Negative degree means rotated below x-axis, positive degree means above. Must be a value between >= -180.0 and <= 180.0
top_marginCollectionfalse20Considers page top margin when applying stamp
bottom_marginCollectionfalse20Considers page bottom margin when applying stamp.
left_marginCollectionfalse20Considers page left margin when applying stamp.
right_marginCollectionfalse20Considers page right margin when applying stamp.
font_familyCollectionfalse20Considers font style that we can apply to stamp.
widthCollectionfalse50Considers width of the text when applying stamp.
heightCollectionfalse50Considers height of the text when applying stamp.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.stamp::v2
text: <value>
fontSize: <value>
fontColor: <value>
image: <value>
opacity: <value>
rotation: <value>
top_margin: <value>
bottom_margin: <value>
left_margin: <value>
right_margin: <value>
font_family: <value>
width: <value>
height: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
input: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pdf.stamp?text=<value>&fontSize=<value>&fontColor=<value>&image=<value>&opacity=<value>&rotation=<value>&top_margin=<value>&bottom_margin=<value>&left_margin=<value>&right_margin=<value>&font_family=<value>&width=<value>&height=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.stamp text=<value> fontSize=<value> fontColor=<value> image=<value> opacity=<value> rotation=<value> top_margin=<value> bottom_margin=<value> left_margin=<value> right_margin=<value> font_family=<value> width=<value> height=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pdf.to.png v1


This command is used to convert PDF to PNG.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.to.png:
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/pdf.to.png?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pdf.to.png id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pinboard.item.delete v1


Deletes a pinboard item of currently logged-in user.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringfalsenullThe uuid of the pinboard item to delete.
valueStringfalsenullThe value of the pinboard item 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pinboard.item.delete:
uuid: <value>
value: <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/pinboard.item.delete?uuid=<value>&value=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pinboard.item.delete uuid=<value> value=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pinboard.item.get v1


Lists all pinboard items or returns a concrete one by uuid.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringfalsenullThe uuid of the pinboard item to return. If not given, all pinboard items of currently logged-in user will be returned, ordered by order 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pinboard.item.get:
uuid: <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/pinboard.item.get?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pinboard.item.get uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pinboard.item.put v1


Creates a new pinboard item or updates an existing one.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringfalsenullThe uuid of the pinboard item to update. If not given, a new one will be created.
valueStringtruenullThe pinboard value.
orderStringfalsenullThe order of the item in the pinboard as int value. ASC.
nameStringtruenullThe name of the pinboard item.
iconStringfalsenullThe icon of the pinboard item. If null, a default icon will be used.
colorStringfalsenullThe color of the icon. If null, the default color 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pinboard.item.put:
uuid: <value>
value: <value>
order: <value>
name: <value>
icon: <value>
color: <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/pinboard.item.put?uuid=<value>&value=<value>&order=<value>&name=<value>&icon=<value>&color=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pinboard.item.put uuid=<value> value=<value> order=<value> name=<value> icon=<value> color=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pipeline.debug.status v1


Returns the status of a running debugging session.

Try online.

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

NameTypeRequiredDefaultDescription
sessionIdStringfalsenullThe debug session id. If null or empty, a new debugging session is created.
pipelineKeyStringfalsenull(Deprecated, use pipelinePath instead) The property key of the pipeline to monitor. Required only on first call. Ignored if sessionId is set.
pipelinePathStringfalsenullThe property path of the pipeline to monitor. Required only on first call. Ignored if sessionId is set.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.debug.status:
sessionId: <value>
pipelineKey: <value>
pipelinePath: <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/pipeline.debug.status?sessionId=<value>&pipelineKey=<value>&pipelinePath=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pipeline.debug.status sessionId=<value> pipelineKey=<value> pipelinePath=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pipeline.delete v1


Deletes a persisted pipeline.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe exact name of the pipeline 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:  
- pipeline.delete:
name: <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/pipeline.delete?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

pipeline.get v1


Returns all persisted pipelines matching the given name.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the pipeline to search for. Supports wildcard * matching. If null or empty, returns all entries.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.get:
name: <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/pipeline.get?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

pipeline.put v1


Persists a new pipeline to the system or updates an existing one. The pipeline yaml is expected in the body. Can be null. Returns the updated property in the output.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe unique name of this pipeline within this namespace.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.put:
name: <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/pipeline.put?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

pipeline.run v1


Loads and executes the persisted pipeline and returns its result in the output.

Try online.

Alias: command:pipeline.start:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the pipeline in the property store to load and executed. Can be relative inside current namespace or qualified.
pathStringtruenullThe path of the pipeline in the property store to load and executed. Can be relative inside current namespace or qualified.
nameStringfalsenullDEPRECATED. Use param key instead. The key of the pipeline in the property store to load and executed. Can be relative inside current namespace or qualified.
varsStringfalsenullA variables map to be put on this pipeline. Note: Any var in this map will overwrite the var in the target pipeline vars scope.
headersStringfalsenullA headers map to be put on this pipeline. Note: Any header in this map will overwrite the header in the target pipeline headers scope.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.run:
key: <value>
path: <value>
name: <value>
vars: <value>
headers: <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/pipeline.run?key=<value>&path=<value>&name=<value>&vars=<value>&headers=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pipeline.run key=<value> path=<value> name=<value> vars=<value> headers=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

pipeline.schema.get v1


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

Try online.

Alias: command:schema.pipeline: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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.schema.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/pipeline.schema.get?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

property.app.config v1


Returns all config resources from apps the current user has access to (role CANAPP is assigned) as a list into the output.

Try online.

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

NameTypeRequiredDefaultDescription
appNamesStringfalsenullA comma separated list of app names those config must be returned. If null or empty, all configs of all apps are returned, the currently logged in user is assigned to. If there is an app name given which doesnt exist or the current user has no access to, nothing happens for security reasons.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.app.config:
appNames: <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/property.app.config?appNames=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.app.config appNames=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.checksum v1


Calculates and verifies the checksum of a property attachment. Calculating the checksum of an attachment using this command also means closing it, so that no more chunks can be added. The checksum of an attachment is calculated by concatenating the MD5 of all chunks into a single MD5 digest.

Try online.

Version: v1
Input body type: Byte[]
Output body type: Void
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDepreacted. Use path instead. The key of the property containing the attachments.
pathStringfalsenullThe path of the property containing the attachments.
uuidStringfalsenullThe uuid of the property containing the attachments. If this is given, path param is ignored.
nameStringfalsenullThe name of the attachment to be checked.
checksumStringfalsenullThe checksum to be used for verification. If not given, no verification is done, but checksum of attachment is calculated and stored anyhow.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.checksum:
key: <value>
path: <value>
uuid: <value>
name: <value>
checksum: <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/property.attachment.checksum?key=<value>&path=<value>&uuid=<value>&name=<value>&checksum=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.checksum key=<value> path=<value> uuid=<value> name=<value> checksum=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.chunk.content v1


Returns the content (data) of a chunk of an attachment in the output as input stream. Returns empty body if chunk was not found.

Try online.

Version: v1
Input body type: Void
Output body type: Byte[]
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullDeprecated. Use path instead. The key of the property this attachment belongs to.
pathStringtruenullThe path of the property this attachment belongs to.
nameStringtruenullThe name of the attachment this chunk belongs to.
indexStringfalse0The index of the chunk to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.chunk.content:
key: <value>
path: <value>
name: <value>
index: <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/property.attachment.chunk.content?key=<value>&path=<value>&name=<value>&index=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.chunk.content key=<value> path=<value> name=<value> index=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.chunk.get v1


Returns the metadata of an chunk of an attachment. Throws error in case property or attachment doesn't exist. Return null in case no chunk exists at given index.

Try online.

Version: v1
Input body type: Void
Output body type: Byte[]
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property this attachment belongs to.
pathStringtruenullThe path of the property this attachment belongs to.
nameStringtruenullThe name of the attachment this chunk belongs to.
indexStringfalse0The index of the chunk to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.chunk.get:
key: <value>
path: <value>
name: <value>
index: <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/property.attachment.chunk.get?key=<value>&path=<value>&name=<value>&index=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.chunk.get key=<value> path=<value> name=<value> index=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.chunk.put v1


Adds a chunk of data to the given attachment. Note: A chunk may not be bigger than 10MB. Otherwise, it gets rejected from the backend.

Try online.

Version: v1
Input body type: Void
Output body type: Byte[]
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property this attachment belongs to.
pathStringtruenullThe path of the property this attachment belongs to.
nameStringtruenullThe name of the attachment this chunk belongs to.
indexStringfalsenullThe index of the chunk. If given, the content of the chunk at given index is replaced with the new content. If null or empty, a new chunk is added to the attachment.
contentStringfalsenullThe content to be added to the chunk. If this parameter is null or empty, the body will be used as content instead.
storageIdStringfalsedatabaseThe id of the storage to be used in the backend to store the binary data of the attachment. Possible values: database, drive.
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:  
- property.attachment.chunk.put:
key: <value>
path: <value>
name: <value>
index: <value>
content: <value>
storageId: <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/property.attachment.chunk.put?key=<value>&path=<value>&name=<value>&index=<value>&content=<value>&storageId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.chunk.put key=<value> path=<value> name=<value> index=<value> content=<value> storageId=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.content v1


Returns the content of an property attachment as a byte stream content object into the output.

Try online.

Version: v1
Input body type: Void
Output body type: Byte[]
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property this attachment belongs to.
pathStringtruenullThe path of the property this attachment belongs to.
nameStringfalsenullThe name of the attachment.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.content:
key: <value>
path: <value>
name: <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/property.attachment.content?key=<value>&path=<value>&name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.content key=<value> path=<value> name=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.delete v1


Removes an attachment and its content from a property.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property containing the attachment.
pathStringtruenullThe path of the property containing the attachment.
nameStringtruenullThe name of the attachment to be deleted.
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:  
- property.attachment.delete:
key: <value>
path: <value>
name: <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/property.attachment.delete?key=<value>&path=<value>&name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.delete key=<value> path=<value> name=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.get v1


Returns an attachment of a property (without content).

Try online.

Version: v1
Input body type: Void
Output body type: Byte[]
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property this attachment belongs to.
pathStringtruenullThe path of the property this attachment belongs to.
nameStringfalsenullThe name of the attachment to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.get:
key: <value>
path: <value>
name: <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/property.attachment.get?key=<value>&path=<value>&name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.get key=<value> path=<value> name=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.list v1


Lists all attachments of a given property. The content is not part of this list. Use property.attachment.chunk.get in order to retrieve the content data.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property to list its attachments for.
pathStringtruenullThe path of the property to list its attachments for.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.list:
key: <value>
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/property.attachment.list?key=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.list key=<value> path=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.put v1


Creates and adds attachments to a property. Optionally with binary payload data. Overwrites / updates any existing attachments with same name. The attachments can be added in three ways: A) A single content object or a collection of content objects is given in input, then its payload and metadata is used to create the attachment(s). B) Data different to a content object is given in the input. Then this data will be used as the payload for the attachment. C) Input is null or empty. Then an empty attachment without any payload will be created. In case B) and C) the additional parameters name, contentType and length are mandatory. In case A) The parameters name, contentType and length are optional and will be used as fallback value in case a content object is them missing.

Try online.

Version: v1
Input body type: Byte[]
Output body type: Void
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property containing the attachments.
pathStringfalsenullThe path of the property containing the attachments.
uuidStringfalsenullThe uuid of the property containing the attachments. If this is given, path param is ignored.
nameStringfalsenullThe name of the attachment to be created. If an attachment with this name already exists, updates the existing one. This parameter is not required in case the input is a content object or a content collection.
contentStringfalsenullThe content to add. If null, the data in the body will be added. In case you would like to explicitly set no content at all (also not from the body), set this value to: false.
contentTypeStringfalsenullThe content type to be used for the attachment. This parameter is optional in case the input is a content object or a content collection.
lengthStringfalsenullThe length of the attachment. This parameter is not required in case the input is a content object or content collection.
storageIdStringfalsedatabaseThe id of the storage to be used in the backend to store the binary data of the attachment. Possible values: database, drive.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.put:
key: <value>
path: <value>
uuid: <value>
name: <value>
content: <value>
contentType: <value>
length: <value>
storageId: <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/property.attachment.put?key=<value>&path=<value>&uuid=<value>&name=<value>&content=<value>&contentType=<value>&length=<value>&storageId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.put key=<value> path=<value> uuid=<value> name=<value> content=<value> contentType=<value> length=<value> storageId=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.attachment.put.uri v1


Sets property attachment to be symlink to resource referenced by uri.

Try online.

Version: v1
Input body type: Void
Output body type: Byte[]
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property this attachment belongs to.
pathStringtruenullThe path of the property this attachment belongs to.
nameStringtruenullThe name of the attachment.
uriStringtruenullThe uri of resource to point symlink 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:  
- property.attachment.put.uri:
key: <value>
path: <value>
name: <value>
uri: <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/property.attachment.put.uri?key=<value>&path=<value>&name=<value>&uri=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.put.uri key=<value> path=<value> name=<value> uri=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.copy v1


Copies a property from one key to another. If target property already exists, overwrites it. NOTE: Doesnt copy the attachments.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The origin key of the property.Otherwise a new entry is created.
pathStringfalsenullThe origin path of the property.Otherwise a new entry is created.
toStringtruenullThe target key to copy the property to. If a property with this key already exists, it will be overwritten.
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:  
- property.copy:
key: <value>
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/property.copy?key=<value>&path=<value>&to=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

property.delete v1


Deletes one or more existing properties matching the given search pattern. Use this command with care!

Try online.

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

NameTypeRequiredDefaultDescription
patternStringtruenullThe path pattern of the properties to delete. All matching properties will be deleted!
trashBinStringfalsefalseIn case this parameter is set to true, the property wont be removed but moved to the trash bin instead (= flagged with trash lock).
trashBinTimeToLiveStringfalsenullThe time in millis after the property must be removed from bin and fully deleted. If set to null or empty, the system defaults will apply for final deleting trashed properties. This is typically a value between 30 and 90 days.
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:  
- property.delete:
pattern: <value>
trashBin: <value>
trashBinTimeToLive: <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/property.delete?pattern=<value>&trashBin=<value>&trashBinTimeToLive=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.delete pattern=<value> trashBin=<value> trashBinTimeToLive=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.exists v1


Checks whether a given property exists and returns the boolean result in the body.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The path key of the property to check for.
pathStringtruenullThe path of the property to check for.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.exists:
key: <value>
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/property.exists?key=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

property.get v1


Returns the property with given key.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The relative or absolute (with namespace) property key. If uuid is given, this parameter is ignored. One of of uuid or path is mandatory.
pathStringfalsenullThe relative or absolute (with namespace) property path. If uuid is given, this parameter is ignored. One of of uuid or path is mandatory.
uuidStringfalsenullThe uuid of the property. If this parameter is given, parameter key is ignored. On of uuid or key is mandatory.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.get:
key: <value>
path: <value>
uuid: <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/property.get?key=<value>&path=<value>&uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.get key=<value> path=<value> uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.import v1


Imports properties given as JSON document in the body into the property store.

Try online.

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

NameTypeRequiredDefaultDescription
strategyStringfalseskipDefines what to do if a property with same path already exists. Possible values are: update = Update existing fields of the property from the import values. rollback = Do not import at all. Also all other properties wont be imported in this case. skip = Skip the already existing entry but log it.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.import:
strategy: <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/property.import?strategy=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.import strategy=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.list v1


Lists all properties from the store.

Try online.

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

NameTypeRequiredDefaultDescription
patternStringfalsenullThe key pattern of the properties to search for. Also supports key pattern matching whereas matches a single part inside a directory in the key and everything. For example '/pipeforce/namespace/user/' would return all properties of all users in the given namespace. Also sub levels of this key. To avoid sub-leveling use the instead: '/pipeforce/namespace/user/*'. This would return /pipeforce/namespace/user/max' but not /pipeforce/namespace/user/max/contracts'.
filterStringfalsenullThis parameter is deprecated. Use param 'pattern' instead.
includeTrashedStringfalsefalseInclude also properties moved to trash bin?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.list:
pattern: <value>
filter: <value>
includeTrashed: <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/property.list?pattern=<value>&filter=<value>&includeTrashed=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.list pattern=<value> filter=<value> includeTrashed=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.lock.put v1


Creates a lock on a given property. In case someone tries to change or delete a locked property without being part of the exclusive guild, an exception is thrown.

Try online.

Alias: command:property.lock.create:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property to lock.
pathStringtruenullThe path of the property to lock.
typeStringfalseglobalThe type of the lock for which range the lock is exclusive. One of: user, role, group, namespace, global or 'trash'. If null, empty or different from the types mentioned here, the lock will be global by default.
ttlStringfalsenullThe time-to-live of the lock in milliseconds. After this amount of time, the lock will be automatically removed or the property will be deleted if lock is of type trash. If this value is null or empty, the lock is not limited to a time-to-live and must be removed manually. Note: The lock cleanup job will run any few minutes, so if ttl of a lock has been set to a few milliseconds or seconds it can be, that it is fully removed from the metadata returned by reading a property only after some minutes. Writing to the property instead works immediately after the ttl has been expired.
uuidStringfalsenullIn case the lock is of type user, this parameter must contain the uuid of the user this lock is exclusive to. If this parameter is missing, the uuid of the currently logged-in user will be used.
nameStringfalsenullIn case the lock is of type role or group, this parameter is mandatory and defines the name of the role or group, this lock is exclusive to. In case the type of the lock is namespace, this parameter is optional. If given, this name is used as namespace to create the lock for, otherwise the current namespace of the instance is used. In case the type of the lock is global, this parameter will be ignored.
detailsStringfalsenullSome optional data to be set on the lock.
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:  
- property.lock.put:
key: <value>
path: <value>
type: <value>
ttl: <value>
uuid: <value>
name: <value>
details: <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/property.lock.put?key=<value>&path=<value>&type=<value>&ttl=<value>&uuid=<value>&name=<value>&details=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.lock.put key=<value> path=<value> type=<value> ttl=<value> uuid=<value> name=<value> details=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.lock.get v1


Returns the lock tag for a given property. In case there is no lock for this property, null is returned.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullDeprecated. Use path instead. The key of the property to return the lock tag for.
pathStringtruenullThe path of the property to return the lock tag for.
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:  
- property.lock.get:
key: <value>
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/property.lock.get?key=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.lock.get key=<value> path=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.lock.remove v1


Removes a lock from a given property.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property to remove the lock from.
pathStringtruenullThe path of the property to remove the lock from.
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:  
- property.lock.remove:
key: <value>
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/property.lock.remove?key=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.lock.remove key=<value> path=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.move v1


Moves a property from one key to another.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullThe origin path key of the property.Otherwise a new entry is created.
pathStringtruenullDeprecated. Use path instead. The origin path key of the property.Otherwise a new entry is created.
toStringtruenullThe target key to move the property to. If a property with this key already exists, an exception is 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:  
- property.move:
key: <value>
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/property.move?key=<value>&path=<value>&to=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

property.path.children v1


Returns all property child keys for a given parent key. For any child 'folder', returns / at the very end.

Try online.

Alias: command:property.keys.children:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
patternStringtruenullThe key pattern of the parent property or properties. Can be a static suffix like my/parent/path or my/parent/path/ or a pattern like my/parent/path/. Nested patterns like my//path/* are not supported.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.path.children:
pattern: <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/property.path.children?pattern=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.path.children pattern=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.path.list v1


Returns all property paths for a given pattern.

Try online.

Alias: command:property.keys:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
patternStringtruenullThe key pattern of the properties to search for. Also supports path pattern matching whereas matches a single part inside a directory in the key and everything. For example '/pipeforce/namespace/user/' would return all properties of all users in the given namespace. Also sub levels of this path. To avoid sub-leveling use the instead: '/pipeforce/namespace/user/*'. This would return /pipeforce/namespace/user/max' but not /pipeforce/namespace/user/max/contracts'.
includeTrashedStringfalsefalseInclude also properties moved to trash bin in the search?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.path.list:
pattern: <value>
includeTrashed: <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/property.path.list?pattern=<value>&includeTrashed=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.path.list pattern=<value> includeTrashed=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.put v1


Saves the value of a property. The property schema must exist in advance (no new property will be created).

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The path key of the property to save. If property with key already exists, the existing property will be loaded and updated instead. Otherwise a new entry is created.
pathStringtruenullThe path of the property to save. If property with this path already exists, the existing property will be loaded and updated instead. Otherwise a new entry is created.
valueStringfalsenullThe value of the property. May be null or empty.
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:  
- property.put:
key: <value>
path: <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/property.put?key=<value>&path=<value>&value=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.put key=<value> path=<value> value=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.query v1


Queries the properties from the backend by using a certain query language.

Try online.

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

NameTypeRequiredDefaultDescription
dialectStringtruenullThe query language to be used.
selectStringfalsenullSelects the attributes / columns / scalars to return. If null or empty, and select all is used.
fromStringtruenullDefines the properties by key patterns to be selected for the query. Multiple patterns must be separated by comma. Additionally, each pattern must be assigned to a variable using 'has varName'. For example global/app/** as all. This variable will used in the select and where clause.
whereStringfalsenullDefines the WHERE clause in order to filter the result based on the supported filter criteria. The syntax of the criteria depends on the selected query language.
typeStringfalseapplication/jsonThe property type to query for. If null, application/json will be used as default. If set to empty string or * all types will be selected.
paramsStringfalsenullA map of parameters an their values to be used in order to execute the query as prepared stament.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.query:
dialect: <value>
select: <value>
from: <value>
where: <value>
type: <value>
params: <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/property.query?dialect=<value>&select=<value>&from=<value>&where=<value>&type=<value>&params=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.query dialect=<value> select=<value> from=<value> where=<value> type=<value> params=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.schema.delete v1


Deletes any existing property schema and its assigned value matching the given pattern or key.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullDeprecated. Use pattern instead. The exact path key of the property to delete. If property with this key doesnt exist, nothing happens.
patternStringtruenullThe path key pattern of the single property or the properties to delete. All matching properties will be deleted!
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:  
- property.schema.delete:
key: <value>
pattern: <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/property.schema.delete?key=<value>&pattern=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.schema.delete key=<value> pattern=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.schema.put v1


Creates or updates a property schema. This command is intended for provisioning, admin and service tasks. Also consider property.put instead. Returns a result JSON indicating the result of the command which usually is one of: create, update or skip.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The path key of the property to save. If property with key already exists, it will be updated. Otherwise, a new entry is created.
pathStringtruenullThe path key of the property to save. If property with key already exists, it will be updated. Otherwise a new entry is created.
defaultValueStringfalsenullThe default value of the property. May be null.
valueStringfalsenullThe value of the property as a preset. May be null.
typeStringfalseSTRINGThe type of the property. One of: STRING, BOOL, INT, LONG, DECIMAL, JSON. This param is considered only in case a new property is created.
ttlIntegerfalsenullThe time to life of this property in minutes. After this time, the property will be automatically removed from persistence. If null or empty, it wont be deleted. This param is considered only in case a new property is created.
evalValueBooleanfalsetrueIf true, the value of the property is evaluated before it is stored. Set this to false in order to store the value as it is without any interpretation.
existStrategyStringfalseupdateIn case a property with given key already exists, uses one of these strategies: update = The property is updated/overwritten by the new data. skip = The property is skipped. Nothing is changed in persistence layer. error = An error is thrown in case property already exists.
attachmentsStringfalsenullThe attachments to be added to this property. Can be a uri or a PEL. Overwrites existing ones.
tagsStringfalsenullThe initial tags to add to this property. Can be a comma separated list of name value pairs, like this name1:value1, name2:value2.
encryptedBooleanfalsefalseShould the value of this property be stored encrypted? If this is set to true, every time before the property value is saved, it will be auto-encrypted using the default access key. This way you can make sure that the sensitive value is always saved in encrypted format at database layer (at rest). This increases security, but also has some drawbacks. For example: JSON queries are no longer possible then. Auto-decryption is not done for lists. You have to decrypt an encrypted value explicitly by calling property.get. Event payloads for encrypted properties are also sent encrypted only. For example for property.updated event, the payload will be the encrypted value of origin and target.
finalActionStringfalsenullWhat should happen with this property finally when pipeline execution has been finished? Available actions: 'persist' (writes the latest state to DB), 'remove' (removes the latest state from DB), null (nothing happens = default)
retentionStrategyStringfalsenullThe retention strategy is used to decide delete property and it's data, there are two types of strategy (0,1) that decides the deletion.0 = Deletes chunks objects and data from storage if any (keeps property + attachment metadata) 1 = Deletes all (property, attachments, chunks from DB, binary data from storage if any)
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.schema.put:
key: <value>
path: <value>
defaultValue: <value>
value: <value>
type: <value>
ttl: <value>
evalValue: <value>
existStrategy: <value>
attachments: <value>
tags: <value>
encrypted: <value>
finalAction: <value>
retentionStrategy: <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/property.schema.put?key=<value>&path=<value>&defaultValue=<value>&value=<value>&type=<value>&ttl=<value>&evalValue=<value>&existStrategy=<value>&attachments=<value>&tags=<value>&encrypted=<value>&finalAction=<value>&retentionStrategy=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.schema.put key=<value> path=<value> defaultValue=<value> value=<value> type=<value> ttl=<value> evalValue=<value> existStrategy=<value> attachments=<value> tags=<value> encrypted=<value> finalAction=<value> retentionStrategy=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.search v1


Returns all properties of given search criteria.

Try online.

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

NameTypeRequiredDefaultDescription
keyFilterStringfalsenullDeprecated. USe path instead. They key pattern to pre-select the properties to search in.
pathFilterStringtruenullThey path pattern to pre-select the properties to search in.
valueFilterStringfalsenullThe search filter to search inside the value of the properties. This value is case in-sensitive.
typeFilterStringfalsenullThe type of the property. Will find any properties containing this type. This value is case in-sensitive.
offsetIntegerfalsenullThe 0-based offset of the search result to return. If not set, no offset is used.
pageIntegerfalsenullThe 1-based index of the page to return. Does the offset calculation automatically. If this param is given, offset will be ignored.
maxResultsIntegerfalse30The number of results to return. Note: The maximum is 100 results per call because of performance reasons. In case there are more results, use the offset and pagination to retrieve them. If this parameter is set to a value > 100 it will be reset to 100.
infoBooleanfalsefalseIf set to true, the result will also include information about the request. This is useful for example for pagination.
includeTrashedBooleanfalsefalseInclude the properties moved to trash bin in the search?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.search:
keyFilter: <value>
pathFilter: <value>
valueFilter: <value>
typeFilter: <value>
offset: <value>
page: <value>
maxResults: <value>
info: <value>
includeTrashed: <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/property.search?keyFilter=<value>&pathFilter=<value>&valueFilter=<value>&typeFilter=<value>&offset=<value>&page=<value>&maxResults=<value>&info=<value>&includeTrashed=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.search keyFilter=<value> pathFilter=<value> valueFilter=<value> typeFilter=<value> offset=<value> page=<value> maxResults=<value> info=<value> includeTrashed=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.send.delivery v1


Sends specified property including attachments as pipeforce delivery.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the property to send.
messageStringfalsenullBy default, the body is used as email message. If this param is set, it will be used as message instead. Can also be a PE which points to a value to be used as the mail message.
privacyLevelStringfalsenullThe privacy level to use for delivery. One of L01_URL_ONLY, L02_CREDENTIALS, L03_ENCRYPT, L04_ENCRYPT_ALL with L01_URL_ONLY as default.
modelStringfalsenullThe optional model to be used in case point to a template.
subjectStringtruenullThe subject of produced delivery.
includePropertyStringfalsenullSpecify id to add property value as additional delivery attachment.
recipientsStringtruenullThe emails of 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.send.delivery:
key: <value>
message: <value>
privacyLevel: <value>
model: <value>
subject: <value>
includeProperty: <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/property.send.delivery?key=<value>&message=<value>&privacyLevel=<value>&model=<value>&subject=<value>&includeProperty=<value>&recipients=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.send.delivery key=<value> message=<value> privacyLevel=<value> model=<value> subject=<value> includeProperty=<value> recipients=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.tag.list v1


Returns all tags for a given property in the body as JSON: {name1:value1, name2:value2}.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The path key of the property to list the tags for.
pathStringtruenullThe path of the property to list the tags for.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.tag.list:
key: <value>
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/property.tag.list?key=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.tag.list key=<value> path=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.tag.put v1


Adds a tag to an existing property. Overwrites any existing one.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The path key of the property to add the tag to.
pathStringtruenullThe path of the property to add the tag to.
tagsStringfalsenullA list of multiple tags to add to the property. Must a be a name-value pair list separated by comma. For example: name1:value1, name2:value2. If no tags are set, nothing happens.
nameStringfalsenullThe name of a single tag to add.
valueStringfalsenullThe value of a single tag to add. Only used in case tag name is not null.
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:  
- property.tag.put:
key: <value>
path: <value>
tags: <value>
name: <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/property.tag.put?key=<value>&path=<value>&tags=<value>&name=<value>&value=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.tag.put key=<value> path=<value> tags=<value> name=<value> value=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

property.value.expression v1


Executes the given expression on persisted properties and returns the matching ones. This type of search for properties is very powerful since it allows to search on any schemaless structures. But be aware it is low performing on a huge amount of properties.

Try online.

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

NameTypeRequiredDefaultDescription
selectStringfalsenullSpecifies the attributes of each entity to return in the result set. For example person.firstName here would return a list of first names in the result in case the property has an (JSON) object as value which contains such a field. Can be null or set to '*' to return all fields.
fromStringtruenullSpecifies the properties to be loaded for the search. Can be a relative or absolute property wildcard key path. For example: 'global/object/invoice/*
whereStringfalsenullSpecifies a selection filter to return only the properties those values match the given where filter. For example: invoice.amount > 50 would select only those properties having a field invoice.amount with value bigger than 50. If null, no where filter is applied and all properties values will be selected.
aggregateStringfalsenullDefines an expression to be applied on the final result. For example to count all values or to transform them. If null or empty, no aggregation will be applied.
includeTrashedStringfalsefalseShould properties moved to trash bin included in this search?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.value.expression:
select: <value>
from: <value>
where: <value>
aggregate: <value>
includeTrashed: <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/property.value.expression?select=<value>&from=<value>&where=<value>&aggregate=<value>&includeTrashed=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.value.expression select=<value> from=<value> where=<value> aggregate=<value> includeTrashed=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.value.get v1


Returns the value of a given property.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property to be returned.
pathStringtruenullThe path of the property to be returned.
decryptStringfalsetrueShould the value be auto-decrypted in case it is encrypted? Note: This is only possible, if the value was encrypted using the default encryption. In case this property was not encrypted, nothing happens by setting this to true.
includeUuidFieldStringfalsenullIf the resulting property value is a JSON object, adds the property uuid at first level of the JSON using this value as the key name. Overwrites any existing entry with same name. If this parameter is null or empty, no entry will be added (default). If property is not a JSON, ignores this parameter.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.value.get:
key: <value>
path: <value>
decrypt: <value>
includeUuidField: <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/property.value.get?key=<value>&path=<value>&decrypt=<value>&includeUuidField=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.value.get key=<value> path=<value> decrypt=<value> includeUuidField=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.value.list v1


Lists only the values of all matching properties in an array.

Try online.

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

NameTypeRequiredDefaultDescription
patternStringfalsenullThe key pattern of the properties to search for. Also supports key pattern matching whereas matches a single part inside a directory in the key and everything. For example '/pipeforce/namespace/user/' would return all properties of all users in the given namespace. Also sub levels of this key. To avoid sub-leveling use the instead: '/pipeforce/namespace/user/*'. This would return /pipeforce/namespace/user/max' but not /pipeforce/namespace/user/max/contracts'.
includeUuidFieldStringfalsenullIf the resulting property value is a JSON object, adds the property uuid at first level of the JSON using this value as the key name. Overwrites any existing entry with same name. If this parameter is null or empty, no entry will be added (default). If property is not a JSON, ignores this parameter.
includeKeyFieldStringfalsenullIf the resulting property value is a JSON object, adds the property key at first level of the JSON using this value as the key name. Overwrites any existing entry with same name. If this parameter is null or empty, no entry will be added (default). If property is not a JSON, ignores this parameter.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.value.list:
pattern: <value>
includeUuidField: <value>
includeKeyField: <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/property.value.list?pattern=<value>&includeUuidField=<value>&includeKeyField=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.value.list pattern=<value> includeUuidField=<value> includeKeyField=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.value.list.put v1


Saves a list of property values by iterating over this list and storing each value separately in the property store. Each value will be persisted in its own property. The path of this property will be calculated from baseKey/valueOf(primaryKeyField).The property schema for each key must exist in advance (no new properties will be created).

Try online.

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

NameTypeRequiredDefaultDescription
baseKeyStringtruenullDeprecated. Use basePath instead. The base key (= folder) of the properties to save. At the end of this key path, the primary key will be appended for each value in the list in order to save it in its property.
basePathStringtruenullThe base path (= folder) of the properties to save. At the end of this path, the primary path will be appended for each value in the list in order to save it in its property.
primaryKeyFieldStringfalsenullThe field name inside each value item which contains the primary key. Can be a string constant or a PEL. If it is a PEL, will be evaluated for each item in the list separately. The PEL has access to variables: headers (= headers of the pipeline), vars (= pipeline variables), body (= body of the pipeline), value (= the current iteration item value about to be saved).
iterItemNameStringfalsevalueChanges the name of the iteration item value, provided for primaryKeyField
ignoreUuidFieldStringfalsenullIf this parameter contains a non-empty value, and a property value is a JSON type, tries to remove the uuid field with given name, so it is not stored to database. If this parameter is set, but the JSON field doesn't exist or the property value is not a JSON, nothing happens.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.value.list.put:
baseKey: <value>
basePath: <value>
primaryKeyField: <value>
iterItemName: <value>
ignoreUuidField: <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/property.value.list.put?baseKey=<value>&basePath=<value>&primaryKeyField=<value>&iterItemName=<value>&ignoreUuidField=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command property.value.list.put baseKey=<value> basePath=<value> primaryKeyField=<value> iterItemName=<value> ignoreUuidField=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

property.value.put v1


Saves the value of a property. The property must exist in advance. This command does not allow to change the metadata of a property. If you need to change this, use property.put instead.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringfalsenullDeprecated. Use path instead. The key of the property to save the value to.
pathStringtruenullThe path key of the property to save the value to.
valueStringfalsenullThe value of the property to save. May be null or empty.
ignoreUuidFieldStringfalsenullIf this parameter contains a non-empty value, and the property value is a JSON type, tries to remove the uuid field with given name, so it is not stored to database. If this parameter is set but the JSON field doesn't exist or the property value is not a JSON, nothing happens.
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:  
- property.value.put:
key: <value>
path: <value>
value: <value>
ignoreUuidField: <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/property.value.put?key=<value>&path=<value>&value=<value>&ignoreUuidField=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command property.value.put key=<value> path=<value> value=<value> ignoreUuidField=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

provision v1


Executes a specific provision script targeted for a namespace.

Try online.

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

NameTypeRequiredDefaultDescription
moduleStringfalsenullLooks in the specific module for provision scripts. Using current namespaceas default value to load a namespace-specific module.
pathStringfalsenullPath of the provision script to call. If not specified, uses default path: main.pipe.yaml
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:  
- provision:
module: <value>
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/provision?module=<value>&path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command provision module=<value> path=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

publicform.definition v1


Returns the form configuration of public form given by id. The schema path in the config will be automatically resolved and contains finally the resolved schema JSON.

Try online.

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

NameTypeRequiredDefaultDescription
idStringtruenullThe public form id.
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:  
- publicform.definition:
id: <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/publicform.definition?id=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command publicform.definition id=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

publicform.submit v1


Stores submitted public form data and attachments. All Form definitions are searched for matching id. Additionally form needs to be marked with 'public: true' property.

Try online.

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

NameTypeRequiredDefaultDescription
idStringtruenullThe public form id.
valueStringtruenullThe value data of the form as JSON.
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:  
- publicform.submit:
id: <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/publicform.submit?id=<value>&value=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command publicform.submit id=<value> value=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

resolve v1


Resolves a given PIPEFORCE uri to its content and returns it. For example $uri:property:global/app/myapp/mydata will return the value of the mydata property. Also see: https://docs.pipeforce.org/docs/api/uris

Try online.

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

NameTypeRequiredDefaultDescription
uriStringtruenullThe PIPEFORCE uri of the content to resolve.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- resolve:
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/resolve?uri=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

resource v1


Loads a resource depending on its resource protocol like classpath:, property: or alike.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringfalsenullDEPRECATED. Use uri instead.
uriStringtruenullThe uri path to load the resource from. If it starts with classpath:pipeforce, a lookup in the classpath subfolder pipeforce is done (other locations are not allowed). If it starts with property: a lookup in the property store is done and the result is thevalue of the property if 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- resource:
path: <value>
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/resource?path=<value>&uri=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command resource path=<value> uri=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

resource.save v1


Expects a resource base64 encoded in the body and saves it as a resource to hub.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringtruenullThe path to save the resource 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:  
- resource.save:
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/resource.save?path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command resource.save path=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

result.complete v1


Completes a processing result. The input to the command will be set as completion value to the result. In case result with given id doesn't exist or was already completed, nothing happens. So calling this completion multiple times has no effect. First one wins. Also using this for polling (by checking for non-existing exception) will not work for performance and security reasons here.

Try online.

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

NameTypeRequiredDefaultDescription
correlationIdStringtruenullThe id of the result to be completed.
valueStringfalsenullThe optional value to be set on the result.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- result.complete:
correlationId: <value>
value: <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/result.complete?correlationId=<value>&value=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command result.complete correlationId=<value> value=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

result.delete v1


Cancels and deletes a processing result. If result doesn't exist or was already cancelled, nothing happens. Will return information about the cancelled task if there was any.

Try online.

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

NameTypeRequiredDefaultDescription
correlationIdStringtruenullThe id of the result to be cancelled.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- result.delete:
correlationId: <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/result.delete?correlationId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command result.delete correlationId=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

result.get v1


Returns a result from the cache but without the result value. If the result value is required, use polling instead.

Try online.

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

NameTypeRequiredDefaultDescription
correlationIdStringtruenullThe id of the result to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- result.get:
correlationId: <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/result.get?correlationId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command result.get correlationId=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

result.list v1


Returns all existing results (without result values) from cache.

Try online.

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

NameTypeRequiredDefaultDescription
statusStringfalsenullReturns all results matching this status. If null or empty, all results in any status will be 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- result.list:
status: <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/result.list?status=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

result.put v1


Creates a result new result and registers it in the cache.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- result.put:
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/result.put?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

rpa.website.close v1


Closes website and releases all used resources.Note: The pipe is BETA and not intended to be used in production!

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:  
- rpa.website.close:
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/rpa.website.close?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command rpa.website.close id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

rpa.website.open v1


Opens a website and sets its browser instance as 'vars.browser'. Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
urlStringtruenullThe url of the web page to open.
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:  
- rpa.website.open:
url: <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/rpa.website.open?url=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command rpa.website.open url=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

rpa.website.scrap v1


Scraps data from the current website and returns the result in the body.Note: The pipe is BETA and not intended to be used in production!

Try online.

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

NameTypeRequiredDefaultDescription
xpathStringtruenullExecutes the given xpath expression on the current page and puts the result in the body. In case the xpath returns more than one results, adds an array to the body. Otherwise the body only contains the single result 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.

Pipeline example:

pipeline:  
- rpa.website.scrap:
xpath: <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/rpa.website.scrap?xpath=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command rpa.website.scrap xpath=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

script.groovy v1


Executes a groovy script.
See: https://groovy-lang.org/documentation.html
These default variables are always available inside the script:
headers, vars, body, request, response, context.
Note: If output parameter is not defined, nothing is written to output or body.

Try online.

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

NameTypeRequiredDefaultDescription
codeStringtruenullThe Groovy script to be executed
argsStringfalsenullThe additional args map to be passed to the script as name value pairs.
    They can be accessed via args.name.

id | String | false | null | The optional id of this command, unique within the pipeline. if | String | false | null | Is 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. onError | String | false | null | Defines 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. eval | String | false | null | An expression which is evaluated finally, after this command has been executed. This can be used for cleanup-tasks or to simplify data transformations. output | String | false | null | Defines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- script.groovy:
code: <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/script.groovy?code=<value>&args=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command script.groovy code=<value> args=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

script.run v1


Removed. This command is not longer supported. Consider to use function.run instead.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- script.run:
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/script.run?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

secret.delete v1


Deletes a credentials entry.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the credentials entry 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:  
- secret.delete:
name: <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/secret.delete?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

secret.get v1


Lists the metadata (not the secret payload itself) of all available secret entries.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of a single credentials to return. If null or empty, all credentials will be returned.
includeTrashedStringfalsefalseAlso include the secret properties moved to trash bin in the list search?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secret.get:
name: <value>
includeTrashed: <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/secret.get?name=<value>&includeTrashed=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secret.get name=<value> includeTrashed=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secret.put v1


Creates a new credentials entry.

Try online.

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

NameTypeRequiredDefaultDescription
formatStringtruenullThe format of the secret to store. One of: secret-text, bearer, header, username-password.
nameStringtruenullThe unique name of the credentials.
secretStringtruenullThe secret part (for example the username:password or Bearer TOKEN).
timeToLiveStringfalsenullThe time to live in minutes. After this time, the credentials will be deleted.
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:  
- secret.put:
format: <value>
name: <value>
secret: <value>
timeToLive: <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/secret.put?format=<value>&name=<value>&secret=<value>&timeToLive=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command secret.put format=<value> name=<value> secret=<value> timeToLive=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

secretsend.inbox.auth v1


Creates and verifies a magic link download token to access a given inbox transfer.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the secret send outbox, the user needs access to.
recipientEmailStringtruenullThe email of the recipient to create the token for.
cookieTokenStringfalsenullIn order to improve security, set a cookie value in your browser (client) and make sure on second call of this command, the cookie token is read from client and put into this command. This way you can make sure, that the client which sends the magic token is the same as theone who initially requested it. This token is optional.
magicTokenStringfalsenullThe magic token, sent to the recipient (via email) after he requested it.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.inbox.auth:
outboxUuid: <value>
recipientEmail: <value>
cookieToken: <value>
magicToken: <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/secretsend.inbox.auth?outboxUuid=<value>&recipientEmail=<value>&cookieToken=<value>&magicToken=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.inbox.auth outboxUuid=<value> recipientEmail=<value> cookieToken=<value> magicToken=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.inbox.download v1


Downloads the content of an attachment or a group of attachments.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringfalsenullThe uuid of the outbox transfer to return.
inboxUuidStringfalsenullThe uuid of the inbox transfer to return.
filenamesStringfalsenullA list of one or more attachment filenames to be downloaded (comma separated or PEL list object). If this list is null or empty, all files of the inbox will be downloaded as single zip file. If only one file is defined, this file is downloaded plain. If there is more than one file defined, downloads all of these files as a single zip.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.inbox.download:
outboxUuid: <value>
inboxUuid: <value>
filenames: <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/secretsend.inbox.download?outboxUuid=<value>&inboxUuid=<value>&filenames=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.inbox.download outboxUuid=<value> inboxUuid=<value> filenames=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.inbox.get v1


Returns an inbox transfer by uuid.

Try online.

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

NameTypeRequiredDefaultDescription
inboxUuidStringtruenullThe uuid of the inbox transfer to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.inbox.get:
inboxUuid: <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/secretsend.inbox.get?inboxUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.inbox.get inboxUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.inbox.list v1


Lists all inbox transfers targeted to a given recipient.

Try online.

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

NameTypeRequiredDefaultDescription
recipientEmailStringfalsenullThe email of the recipient to list the inbox for. If this param is missing, the inboxes for the currently logged-in user will be listed. This parameter can only be set in case the logged-in user has admin, developer or support permissions. Otherwise, an exception is 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.inbox.list:
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/secretsend.inbox.list?recipientEmail=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

secretsend.outbox.attachment.chunk.put v1


Adds a chunk of data to an existing secret send attachment given by outboxUuid and name parameter.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringfalsenullThe uuid of the outbox transfer to add the chunk to.
nameStringtruenullThe name of the attachment inside the outbox this chunk belongs to.
indexStringfalsenullThe index of the chunk. If given, the content of the chunk at given index is replaced with the new content. If null or empty, a new chunk is added to the attachment.
contentStringfalsenullThe content to be added to the chunk. If this parameter is null or empty, the input will be used as content 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.

Pipeline example:

pipeline:  
- secretsend.outbox.attachment.chunk.put:
outboxUuid: <value>
name: <value>
index: <value>
content: <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/secretsend.outbox.attachment.chunk.put?outboxUuid=<value>&name=<value>&index=<value>&content=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.attachment.chunk.put outboxUuid=<value> name=<value> index=<value> content=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.attachment.delete v1


Deletes an attachment from an secret send outbox. Including its content!

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the outbox transfer to delete the attachment from.
nameStringtruenullThe name of the attachment to be deleted.
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:  
- secretsend.outbox.attachment.delete:
outboxUuid: <value>
name: <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/secretsend.outbox.attachment.delete?outboxUuid=<value>&name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.attachment.delete outboxUuid=<value> name=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.attachment.put v1


Creates a new attachment and adds it to the given secret send outbox. The content of the attachment is expected to be referenced in the content param or - if empty - in the body. It's also possible to add the content later using the command secretsend.outbox.attachment.chunk.put.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringfalsenullThe uuid of the outbox transfer to add the attachment to.If null or empty, a new one will be created.
nameStringfalsenullThe name of the attachment to be created. If an attachment with this name already exists, updates the existing one.
contentTypeStringfalsenullThe content type to be used for this attachment. In case there is a single content object, this value has precedence over the contentType of the content object, if there is any. In case there are multiple content objects, their contentType do have precedence, if set.
contentStringfalsenullThe content to add. If null, the data in the body will be added. In case you would like to explicitly set no content at all, set this value to: false.
lengthStringfalsenullThe length of the attachment.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.attachment.put:
outboxUuid: <value>
name: <value>
contentType: <value>
content: <value>
length: <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/secretsend.outbox.attachment.put?outboxUuid=<value>&name=<value>&contentType=<value>&content=<value>&length=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.attachment.put outboxUuid=<value> name=<value> contentType=<value> content=<value> length=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.delete v1


Deletes an outbox transfer.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the transfer in the outbox 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.delete:
outboxUuid: <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/secretsend.outbox.delete?outboxUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.delete outboxUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.finalize v1


Finalizes a given secret send outbox: Creates inboxes for each recipient and sends notification email to each by default.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringfalsenullThe uuid of the transfer outbox to finalize.
sendEmailsStringfalsetrueShould the notification emails to the recipients created and send on this 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.finalize:
outboxUuid: <value>
sendEmails: <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/secretsend.outbox.finalize?outboxUuid=<value>&sendEmails=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.finalize outboxUuid=<value> sendEmails=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.get v1


Returns the outbox by given uuid.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the transfer outbox to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.get:
outboxUuid: <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/secretsend.outbox.get?outboxUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.get outboxUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.list v1


Lists all outbox transfer items created 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.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/secretsend.outbox.list?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

secretsend.outbox.preview v1


Returns the preview for a given outbox, if supported by security settings.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringfalsenullThe uuid of the outbox transfer to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.preview:
outboxUuid: <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/secretsend.outbox.preview?outboxUuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.preview outboxUuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.put v1


Creates or updates a PIPEFORCE Secret Send with DRAFT status and saves it.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringfalsenullThe uuid of the transfer in the outbox to update. If null or empty, a new one will be created.
subjectStringfalsenullThe subject of the transfer or null (in order to set it later).
messageStringfalsenullThe message of the transfer or null (in order to set it later)
localeStringfalsenullThe locale to be used for this secret send system message and number formats (examples: de_DE, de, en_US, ...). If null, the system default one will be used.
recipientsStringfalsenullA comma separated list of email recipients or null (in order to add it later). Also PEL is supported here.
expiresOnStringfalsenullDelete the transfer attachments after this date and time given as unix timestamp in millis. If null, empty, 0 or negative, delivery will never be deleted.
notifySenderStringfalsetrueIf true, notifies sender when recipients have downloaded delivery.
retentionStrategyStringfalsenullThe retention strategy is used to decide delete property and it's data, there are two types of strategy (0,1) that decides the deletion.0 = Deletes chunks objects and data from storage if any (keeps property + attachment metadata) 1 = Deletes all (property, attachments, chunks from DB, binary data from storage if any)
notifySenderEmailReceiptStringfalsetrueIf true, notifies receipt email to the sender when mail has been sent 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.put:
outboxUuid: <value>
subject: <value>
message: <value>
locale: <value>
recipients: <value>
expiresOn: <value>
notifySender: <value>
retentionStrategy: <value>
notifySenderEmailReceipt: <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/secretsend.outbox.put?outboxUuid=<value>&subject=<value>&message=<value>&locale=<value>&recipients=<value>&expiresOn=<value>&notifySender=<value>&retentionStrategy=<value>&notifySenderEmailReceipt=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.put outboxUuid=<value> subject=<value> message=<value> locale=<value> recipients=<value> expiresOn=<value> notifySender=<value> retentionStrategy=<value> notifySenderEmailReceipt=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.recipient.delete v1


Removes a recipient from a given secret send outbox. Note: This is only possible in case this transfer is in status DRAFT.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the transfer outbox to add the recipient to.
recipientEmailStringtruenullThe email of the recipient to add.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.recipient.delete:
outboxUuid: <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/secretsend.outbox.recipient.delete?outboxUuid=<value>&recipientEmail=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.recipient.delete outboxUuid=<value> recipientEmail=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.recipient.email.send v1


(Re-) sends the secret send notification email to the recipient.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the outbox item.
recipientEmailStringtruenullThe email of the recipient to send the notification 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.recipient.email.send:
outboxUuid: <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/secretsend.outbox.recipient.email.send?outboxUuid=<value>&recipientEmail=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.recipient.email.send outboxUuid=<value> recipientEmail=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

secretsend.outbox.recipient.put v1


Adds a new recipient to a secret send. If a recipient with given email already exists, nothing happens. Updating an existing recipient is not yet supported.

Try online.

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

NameTypeRequiredDefaultDescription
outboxUuidStringtruenullThe uuid of the transfer outbox to add the recipient to.
recipientEmailStringtruenullThe email of the recipient to add.
recipientLocaleStringfalsenullThe locale to be used for this recipient like de, en or fr for example.
sendEmailStringfalsenullShould be an email sent to the recipient?
enabledStringfalsetrueIs the recipient enabled = can download the transfer?
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- secretsend.outbox.recipient.put:
outboxUuid: <value>
recipientEmail: <value>
recipientLocale: <value>
sendEmail: <value>
enabled: <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/secretsend.outbox.recipient.put?outboxUuid=<value>&recipientEmail=<value>&recipientLocale=<value>&sendEmail=<value>&enabled=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command secretsend.outbox.recipient.put outboxUuid=<value> recipientEmail=<value> recipientLocale=<value> sendEmail=<value> enabled=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

server.info v1


Returns information about the current server. For example the version it is running under. Returns a flat JSON with these keys: status, namespace, domain, edition, stage, tag, build, version, versionMajor, versionMinor, versionBugfix

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- server.info:
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/server.info?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

service.job.logs v1


Returns the logs of a service job in the cluster.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the service job.
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:  
- service.job.logs:
name: <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/service.job.logs?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.job.logs name=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

service.job.start v1


Starts a new service job in the cluster. The job runs async. Use service.job.status and service.job.logs to check the result of the job.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the service job.
imageStringfalsenullThe repo path of the image to be deployed. In case the image name starts with prefix 'pipeforce-registry/' the image will be loaded from the default PIPEFORCE registry for this namespace.
imagePullSecretStringfalsenullThe optional name of the registry secret to be used in case it is a private registry.
imagePullPolicyStringfalseAlwaysThe policy how to handle non existing image. Can be one of: Always (pull image always from registry, to get latest), IfNotPresent (pull image from registry if not present), Never (pull image never from registry).
envStringfalsenullEnvironment variables to be applied to the job service container. Can contain 'secret-text' secret references with value like '$uri㊙️secretTextName', '$uri:webhook:token:keyToResolve'.
commandStringfalsenullThe list of command to execute on the service job container.
argsStringfalsenullThe list of args to be passed on to the service job container.
replaceStringfalsefalseIf true, an existing job with same name will be deleted before this new one is created. If false, an exception is thrown in case a job with same name already 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.
credentialsStringfalsenullDEPRECATED. Use param secret instead.

Pipeline example:

pipeline:  
- service.job.start:
name: <value>
image: <value>
imagePullSecret: <value>
imagePullPolicy: <value>
env: <value>
command: <value>
args: <value>
replace: <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/service.job.start?name=<value>&image=<value>&imagePullSecret=<value>&imagePullPolicy=<value>&env=<value>&command=<value>&args=<value>&replace=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.job.start name=<value> image=<value> imagePullSecret=<value> imagePullPolicy=<value> env=<value> command=<value> args=<value> replace=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

service.job.status v1


Returns the status of a service job in the cluster.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the service job.
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:  
- service.job.status:
name: <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/service.job.status?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.job.status name=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

service.job.stop v1


Stops a service job in the cluster even if it is not finished yet.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the service job.
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:  
- service.job.stop:
name: <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/service.job.stop?name=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.job.stop name=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

service.start v1


Starts a new microservice in the cluster.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the service.
imageStringfalsenullThe repo path of the image to be deployed. If empty, no image will be deployed (just the service slot created). In case the image name starts with prefix 'pipeforce-registry/' the image will be loaded from the default PIPEFORCE registry for this namespace.
imagePullPolicyStringfalseAlwaysThe policy how to handle non existing image. Can be one of: Always (pull image always from registry, to get latest), IfNotPresent (pull image from registry if not present), Never (pull image never from registry).
portIntegerfalsenullThe port the running service accepts requests.
ingressBooleanfalsenullExpose the given port of the service to the internet? The service is then reachable via HTTPS using the url https://[serviceName]-[namespace].pipeforce.net.
imagePullSecretStringfalsenullThe optional name of the registry secret to be used in case it is a private registry.
envStringfalsenullMap of environment variables to be applied to the service container. Can contain 'secret-text' secret references with value like '$uri㊙️secretTextName' or webhook references like '$uri:webhook:eventKey' which will be resolved and passed to the container.
commandStringfalsenullThe list of command to execute on the service container.
argsStringfalsenullThe list of args to be passed on to the service container.
replicasStringfalse1The number of stateless replicas (= scaling instances) of this service to be started in parallel in the cluster by default.
volumesStringfalsenullThe list of paths inside the container to mount to persisted volumes. This will automatically create a persistent volume and stores the data in the given paths to this volume. By default, the volume will be kept even on stop and start of the container. See service.stop command.
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:  
- service.start:
name: <value>
image: <value>
imagePullPolicy: <value>
port: <value>
ingress: <value>
imagePullSecret: <value>
env: <value>
command: <value>
args: <value>
replicas: <value>
volumes: <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/service.start?name=<value>&image=<value>&imagePullPolicy=<value>&port=<value>&ingress=<value>&imagePullSecret=<value>&env=<value>&command=<value>&args=<value>&replicas=<value>&volumes=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.start name=<value> image=<value> imagePullPolicy=<value> port=<value> ingress=<value> imagePullSecret=<value> env=<value> command=<value> args=<value> replicas=<value> volumes=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

service.status v1


Returns the status info of the given PIPEFORCE managed service.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullName of the service. If null or empty, the status of all PIPEFORCE managed services in current namespace will be returned.
formatStringfalsenormalThe format of the status output: How much status information must be returned? Can be one of compact, normal, full.
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:  
- service.status:
name: <value>
format: <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/service.status?name=<value>&format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.status name=<value> format=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

service.stop v1


Stops a microservice from the cluster.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the microservice to be stopped.
deleteVolumesStringfalsefalseIf set to true, any volume declared on service.start will be deleted.
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:  
- service.stop:
name: <value>
deleteVolumes: <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/service.stop?name=<value>&deleteVolumes=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command service.stop name=<value> deleteVolumes=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value>  

Learn more: Command Line Interface (CLI).

set v1


Sets a value in the pipe message. The value to be set can be a constant or an expression.

Try online.

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

NameTypeRequiredDefaultDescription
valueStringtruenullA string or an expression to be used as the value to be set.
toStringfalsenullDEPRECATED. Use param output instead.
mappingStringfalsenullA list of mapping rules to be applied to the given input 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 not state otherwise in the command description: If null or empty, then the result is written to the body.
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:  
- set:
value: <value>
to: <value>
mapping: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
output: <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/set?value=<value>&to=<value>&mapping=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>&input=<value>  

Command Line Interface (CLI) example:

pi command set value=<value> to=<value> mapping=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value> input=<value>  

Learn more: Command Line Interface (CLI).

sftp.delete v1


Deletes a file or folder on the SFTP server.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringfalsenullThe path to the file or folder to delete. If path ends with / a folder is expected to be deleted.
usernameStringfalsenullThe username
passwordStringfalsenullThe password
hostStringfalsenullThe host
portStringfalsenullThe port
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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sftp.delete:
path: <value>
username: <value>
password: <value>
host: <value>
port: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <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/sftp.delete?path=<value>&username=<value>&password=<value>&host=<value>&port=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sftp.delete path=<value> username=<value> password=<value> host=<value> port=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sftp.download v1


Downloads a file from a SFTP server. The file is written as content object to output.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the file to download.
usernameStringfalsenullThe username
passwordStringfalsenullThe password
hostStringfalsenullThe host
portStringfalsenullThe port
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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sftp.download:
path: <value>
username: <value>
password: <value>
host: <value>
port: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <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/sftp.download?path=<value>&username=<value>&password=<value>&host=<value>&port=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sftp.download path=<value> username=<value> password=<value> host=<value> port=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sftp.list v1


Lists files of a given folder. If not filter parameter is used all files are returned. The result is written to output.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringfalse/The path to the folder to list.
filterStringfalsenullThe filter to apply to files list. '?' - match one character, '' - match zero o more characters, '*' to match '' in filename
usernameStringfalsenullThe username
passwordStringfalsenullThe password
hostStringfalsenullThe host
portStringfalsenullThe port
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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sftp.list:
path: <value>
filter: <value>
username: <value>
password: <value>
host: <value>
port: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <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/sftp.list?path=<value>&filter=<value>&username=<value>&password=<value>&host=<value>&port=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sftp.list path=<value> filter=<value> username=<value> password=<value> host=<value> port=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sftp.mkdir v1


Creates a new directory on the SFTP server.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringtruenullThe path where to create the folder.
usernameStringfalsenullThe username
passwordStringfalsenullThe password
hostStringfalsenullThe host
portStringfalsenullThe port
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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sftp.mkdir:
path: <value>
username: <value>
password: <value>
host: <value>
port: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <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/sftp.mkdir?path=<value>&username=<value>&password=<value>&host=<value>&port=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sftp.mkdir path=<value> username=<value> password=<value> host=<value> port=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sftp.rename v1


Renames a file or folder on the SFTP server.

Try online.

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

NameTypeRequiredDefaultDescription
fromPathStringfalsenullThe origin path to the resource to rename.
toPathStringfalsenullThe new path / name of the resource.
usernameStringfalsenullThe username
passwordStringfalsenullThe password
hostStringfalsenullThe host
portStringfalsenullThe port
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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sftp.rename:
fromPath: <value>
toPath: <value>
username: <value>
password: <value>
host: <value>
port: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <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/sftp.rename?fromPath=<value>&toPath=<value>&username=<value>&password=<value>&host=<value>&port=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sftp.rename fromPath=<value> toPath=<value> username=<value> password=<value> host=<value> port=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sftp.upload v1


Uploads a file to a SFTP server. The file is expected to be in the input.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringfalse/The path to upload to. If this ends with a slash / it is expected to be a folder name. The file name will be attached from the input file which must be a content object in this case.
usernameStringfalsenullThe username
passwordStringfalsenullThe password
hostStringfalsenullThe host
portStringfalsenullThe port
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.
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:  
- sftp.upload:
path: <value>
username: <value>
password: <value>
host: <value>
port: <value>
id: <value>
if: <value>
onError: <value>
eval: <value>
credentials: <value>
secret: <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/sftp.upload?path=<value>&username=<value>&password=<value>&host=<value>&port=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&credentials=<value>&secret=<value>&input=<value>  

Command Line Interface (CLI) example:

pi command sftp.upload path=<value> username=<value> password=<value> host=<value> port=<value> id=<value> if=<value> onError=<value> eval=<value> credentials=<value> secret=<value> input=<value>  

Learn more: Command Line Interface (CLI).

sharepoint.document.get v1


To download file from sharepoint.

Try online.

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

NameTypeRequiredDefaultDescription
secretStringfalsenullThis is the name of secret that has been setup in Secret module (the secret must contain client_id, client_secret)
siteStringfalsenullThis is the name of site in sharepoint where user want to upload file in the site folder.
pathStringfalsenullThis path contains the folder path in sharepoint site where user want to upload file
tenantIdStringfalsenullTenant Id of the sharepoint site
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sharepoint.document.get:
secret: <value>
site: <value>
path: <value>
tenantId: <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/sharepoint.document.get?secret=<value>&site=<value>&path=<value>&tenantId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sharepoint.document.get secret=<value> site=<value> path=<value> tenantId=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sharepoint.document.put v1


To upload file to sharepoint.

Try online.

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

NameTypeRequiredDefaultDescription
secretStringfalsenullThis is the name of secret that has been setup in Secret module (the secret must contain client_id, client_secret)
siteStringfalsenullThis is the name of site in sharepoint where user want to upload file in the site folder.
pathStringfalsenullThis path contains the folder path in sharepoint site where user want to upload file
tenantIdStringfalsenullTenant Id of the sharepoint site
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sharepoint.document.put:
secret: <value>
site: <value>
path: <value>
tenantId: <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/sharepoint.document.put?secret=<value>&site=<value>&path=<value>&tenantId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sharepoint.document.put secret=<value> site=<value> path=<value> tenantId=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

sharepoint.document.mkdir v1


To upload file to sharepoint.

Try online.

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

NameTypeRequiredDefaultDescription
secretStringfalsenullThis is the name of secret that has been setup in Secret module (the secret must contain client_id, client_secret)
siteStringfalsenullThis is the name of site in sharepoint where user want to upload file in the site folder.
pathStringfalsenullThis path contains the folder path in sharepoint site where user want to upload file
tenantIdStringfalsenullTenant Id of the sharepoint site
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sharepoint.document.mkdir:
secret: <value>
site: <value>
path: <value>
tenantId: <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/sharepoint.document.mkdir?secret=<value>&site=<value>&path=<value>&tenantId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sharepoint.document.mkdir secret=<value> site=<value> path=<value> tenantId=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

slack.send v1


Sends a text message via webhook url to Slack. Also see: https://api.slack.com/messaging/webhooks

Try online.

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

NameTypeRequiredDefaultDescription
urlStringtruenullThe Slack webhook url to post the message to. See here to generate one: https://api.slack.com/messaging/webhooks
textStringtruenullThe text message to be send to Slack.
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:  
- slack.send:
url: <value>
text: <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/slack.send?url=<value>&text=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command slack.send url=<value> text=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

sql.query v1


Executes a (read-only) SQL query and returns the result as JSON in the body. NOTE: This command is primarily meant for developers and admins to monitor the system. It should not be used in production workflows! It can change at any time without notice!

Try online.

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

NameTypeRequiredDefaultDescription
queryStringfalsenullThe SQL query to be executed.
datasourceStringfalsehubThe name of the datasource to be used.
columnNameStringfalseinlineHow to add the column names. Possible values are inline = with each value, none = No column names at all. Any other value will be interpreted to add the column names in a separate property having exactly this individual name.
dataFieldStringfalsedataIf given, places the data inside a separate property with this name.
columnFieldStringfalsecolumnsIf given, places the column names inside a separate property with this name.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- sql.query:
query: <value>
datasource: <value>
columnName: <value>
dataField: <value>
columnField: <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/sql.query?query=<value>&datasource=<value>&columnName=<value>&dataField=<value>&columnField=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command sql.query query=<value> datasource=<value> columnName=<value> dataField=<value> columnField=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

stats v1


Returns basic status information about the hub service.

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:  
- stats:
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/stats?id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

switch v1


Evaluates each switch statement. Takes the value part of the first match and writes it to the given output. If no output is given, writes it to the body. Any param key will be the selection expression which needs to evaluate to a boolean true or false and any value will be the selected value.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- switch:
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/switch?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command switch id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

terms.delete v1


Deletes a terms by its name.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the terms to delete.
localeStringfalsenullThe locale of the terms 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.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- terms.delete:
name: <value>
locale: <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/terms.delete?name=<value>&locale=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command terms.delete name=<value> locale=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

terms.get v1


Returns a terms by its name and locale.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the terms to return.
localeStringfalsenullThe locale of the terms to return. If this param missing, the default locale 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- terms.get:
name: <value>
locale: <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/terms.get?name=<value>&locale=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command terms.get name=<value> locale=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

terms.list v1


Returns all terms. The name and and locale, each. But not the text.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- terms.list:
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/terms.list?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

terms.put v1


Adds a new terms entry to the property store.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the terms
localeStringfalsenullThe locale of the terms
textStringfalsenullThe terms text. If this parameter is missing, the value from the body will be used.
systemStringfalsefalseIs it a system term? Attention: Cannot be deleted via commands!
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- terms.put:
name: <value>
locale: <value>
text: <value>
system: <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/terms.put?name=<value>&locale=<value>&text=<value>&system=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command terms.put name=<value> locale=<value> text=<value> system=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

terms.text.get v1


Returns the terms text by its name and locale.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the terms to return.
localeStringfalsenullThe locale of the terms to return.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- terms.text.get:
name: <value>
locale: <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/terms.text.get?name=<value>&locale=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command terms.text.get name=<value> locale=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

test.run v1


Runs all test scripts defined by given pattern asynchronously.

Try online.

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

NameTypeRequiredDefaultDescription
locationsStringfalseglobal/app/*/function/**A single or a list of location patterns, selecting all test scripts in the property store to be selected for test runs.
functionIncludePatternStringfalsefunctionName.startsWith('test_')A PE which defines the test functions to be included. The selected method name is provided as variable: functionName.
reportFormatStringfalsejsonThe format of the resulting test report. Possible values: json (default), junit
dryRunStringfalsefalseIf true, this command will return a simulated failed test report without executing real tests. This is mainly for development and integration tasks in order to make sure such integrations work as expected.
dryRunSleepStringfalsenullThe time to sleep in ms before the dryRun starts. This is mainly for testing purposes only.
functionExcludePatternStringfalsefunctionName.endsWith('IT')A PE which defines the test functions to be excluded from the list of included test functions. The function method name is provided as variable: functionName. By default all test functions, ending in IT will be ignored.
pollingRedirectEnabledStringfalsetrueShould the response contain a 503 status (redirect) in case the result is not finished yet so a long polling is possible? If true, the 503 status is returned to the caller with a target url. If caller client follows this redirect, it can long poll on the target url for the final result. The test is ALWAYS started async in the backend. So if a final result is expected, it must be retrieved always using long polling or a message listener.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- test.run:
locations: <value>
functionIncludePattern: <value>
reportFormat: <value>
dryRun: <value>
dryRunSleep: <value>
functionExcludePattern: <value>
pollingRedirectEnabled: <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/test.run?locations=<value>&functionIncludePattern=<value>&reportFormat=<value>&dryRun=<value>&dryRunSleep=<value>&functionExcludePattern=<value>&pollingRedirectEnabled=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command test.run locations=<value> functionIncludePattern=<value> reportFormat=<value> dryRun=<value> dryRunSleep=<value> functionExcludePattern=<value> pollingRedirectEnabled=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

theme v1


Returns the resources for a given theme in the body and enrich headers with appropriate Content-type. Caches the resources where applicable.

Try online.

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

NameTypeRequiredDefaultDescription
clearCacheBooleanfalsenullIf true, the current theme cache is cleared.
resourceStringtruelogoThe name of resource to be loaded. If it starts with a slash / tries to load the resource from the default location with given name. If resource is one of the default names like: background, logo, pipeforce-logo, tries to load the default resource for these names. If null or invalid value, falls back to default value.
nameStringfalsenullThe name of the theme. If not given, the default theme will be used as configured.
contentTypeStringfalsenullThe content type to be returned as fallback in case there is none defined at backend side for the requested resource. If this param is missing, it will be tried to guess the type automatically. If the type could not be guessed, returns application/octet-stream by default.
refStringfalsenullThe optional referrer id to this resource request.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- theme:
clearCache: <value>
resource: <value>
name: <value>
contentType: <value>
ref: <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/theme?clearCache=<value>&resource=<value>&name=<value>&contentType=<value>&ref=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command theme clearCache=<value> resource=<value> name=<value> contentType=<value> ref=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

tracing.operations v1


Returns a list of all operation names tracked in tracing data of a given service.

Try online.

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

NameTypeRequiredDefaultDescription
serviceStringfalsehubThe service to search for operations.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- tracing.operations:
service: <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/tracing.operations?service=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command tracing.operations service=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

tracing.search v1


Searches the distributed trace logs for matches.

Try online.

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

NameTypeRequiredDefaultDescription
serviceStringfalsehubThe service to search for distributed traces.
maxDurationStringfalsenullThe filter for max duration of traces to be returned (ms, s, m, h). Example: 12s
minDurationStringfalsenullThe filter for min duration of traces to be returned (ms, s, m, h). Example: 5ms
startStringfalsenullThe time to start tracing search in unix timestamp millis. TODO: Also support lookback times like: -2d (= 2 days before current time).
endStringfalsenullThe time to end tracing search in unix timestamp millis. TODO: Also support lookback times like: -2d (= 2 days before current time).
operationStringfalsenullThe operation to apply as filter. If null or empty, all operations will be returned.
tagsStringfalsenullThe tracing tags (attributes) to filter for as JSON / map whereas key is the tag name and value is the tag value. All tags are AND connected.
limitStringfalse20The number of traces to return per call. Maximum is 1500.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- tracing.search:
service: <value>
maxDuration: <value>
minDuration: <value>
start: <value>
end: <value>
operation: <value>
tags: <value>
limit: <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/tracing.search?service=<value>&maxDuration=<value>&minDuration=<value>&start=<value>&end=<value>&operation=<value>&tags=<value>&limit=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command tracing.search service=<value> maxDuration=<value> minDuration=<value> start=<value> end=<value> operation=<value> tags=<value> limit=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

tracing.services v1


Returns a list of all available services covered in distributed tracing.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- tracing.services:
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/tracing.services?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

transform v1


This transformer converts the input to an output format by applying the given template engine. 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
iterateStringfalsepelIf 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- 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/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 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).

transform.csv.json v1


Takes a CSV document in the body and converts it to a JSON. The CSV document must comply with the RFC4180 standard format.

Try online.

Alias: command:transform.csv2json:v1
Version: v1
Input body type: Raw
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
delimiterStringfalse,The delimiter (separator) to separate the columns of the CSV
hasHeadersLineStringfalsetrueDoes the first line of the input CSV contain the column header names?
rowsFormatStringfalsearraysThe JSON format of the rows section: arrays (= array with nested string arrays with each CSV line as such a new nested array), objects (= each CSV line will become a new JSON object in the rows array with the CSV headers as the field keys)
showColumnsCountFieldStringfalsetrueShow the number of headers (columns) in element columnsCount?
showRowsCountFieldStringfalsetrueShow the number of rows (values) in element rowsCount?
showHeadersFieldStringfalsetrueShow the column header names in extra element headers? This is only shown if hasHeaders is true. In this case, the values array doesnt contain a first headers line.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.csv.json:
delimiter: <value>
hasHeadersLine: <value>
rowsFormat: <value>
showColumnsCountField: <value>
showRowsCountField: <value>
showHeadersField: <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/transform.csv.json?delimiter=<value>&hasHeadersLine=<value>&rowsFormat=<value>&showColumnsCountField=<value>&showRowsCountField=<value>&showHeadersField=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.csv.json delimiter=<value> hasHeadersLine=<value> rowsFormat=<value> showColumnsCountField=<value> showRowsCountField=<value> showHeadersField=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.ftl v1


This transformer uses the FreeMarker template engine for its transformation.

Try online.

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

NameTypeRequiredDefaultDescription
templateStringfalsenullThe template to be used for the transformation. If null, the template is expected in the body. Otherwise this param value is used. It can be a static template string or a qualified uri or a (for example $uri:property:/my/template/path) pointing to the template. Pipeline expressions are not supported here since they would conflict with the template variables.
modelStringfalsenullThe model to be placed into the template scope. If null, the message is used as model so you can access vars and body the same way as you would do in the pipeline.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.ftl:
template: <value>
model: <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/transform.ftl?template=<value>&model=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.ftl template=<value> model=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.html2docx v1


Takes html text that is expected in the body, (as pipeline resource) and converts it back to docx document and then writes to output.

Try online.

Version: v1
Input body type: Raw
Output body type: Raw
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.html2docx:
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/transform.html2docx?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

transform.json.xml v1


Takes a JSON document or JSON string in the body and converts it to an XML document.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.json.xml:
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/transform.json.xml?id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.json.xml id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.pdf2png v1


Takes pdf that is expected in the body, (as pipeline resource) and converts it back to body (as pipeline resource) as a collection of png images.

Try online.

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

NameTypeRequiredDefaultDescription
dpiStringfalsenullDPI to use for conversion. 300 DPI is used when not specified.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.pdf2png:
dpi: <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/transform.pdf2png?dpi=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.pdf2png dpi=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.png2pdf v1


Takes collection of pngs that is expected in the body (as pipeline resource) and converts it back to body (as pipeline resource) to pdf document.

Try online.

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

NameTypeRequiredDefaultDescription
dpiStringfalsenullDPI to forcibly use for 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.png2pdf:
dpi: <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/transform.png2pdf?dpi=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.png2pdf dpi=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.word2pdf v1


DEPRECATED. Use microsoft.word.export.pdf instead. Takes a word file (.docx) that is expected in the
body and converts
it to pdf and stores it back into the body.

Try online.

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

NameTypeRequiredDefaultDescription
pathStringfalsenullProvides the URL the word document is located at. If set, it uses REST PDF conversion service instead of library.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.word2pdf:
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/transform.word2pdf?path=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.word2pdf path=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.wordtemplate v1


Transforms velocity template expressions in word files. It expects the template to be in the body or in thetemplate param, transforms it and puts the result back to the body as byte array content.

Try online.

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

NameTypeRequiredDefaultDescription
modelStringtruenullThe model to be placed into the template scope. May not be null.
templateStringfalsenullThe template to be used for the transformation. If null, the template is expected in the body. Otherwise this param is used. It can be a PE, a static string or a qualified uri (for example uri:classpath:/my/template/path.docx) pointing to the template.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.wordtemplate:
model: <value>
template: <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/transform.wordtemplate?model=<value>&template=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.wordtemplate model=<value> template=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

transform.xml.json v1


Takes an XML document or XML string in the body and converts it to a JSON. By default, the PIPEFORCE XML to JSON conversion rules will be applied (see https://pipeforce.github.io/docs/guides/transformers/xml2json).

Try online.

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

NameTypeRequiredDefaultDescription
schemeStringfalsenullThe conversion scheme to be used. If null or empty, the default PIPEFORCE rules apply. If set to 'jackson', the rules defined by XML Jackson will be applied.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- transform.xml.json:
scheme: <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/transform.xml.json?scheme=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command transform.xml.json scheme=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

translate v1


Translates the given text to the given target language. Expects the input by default in the body and writes the result by default back to the body.

Try online.

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

NameTypeRequiredDefaultDescription
textStringtruenullThe text to be translated.
secretStringfalsenullThe secret text to be used. Expects the translate service API token and url stored in the secret store under this name. The entry must be a JSON like this {'restUrl':'', 'apiKey':''}.
targetLanguageStringfalseENThe target language to transform the text to. Supported values: DE, EN, FR, IT, JA, ES, NL, PL, PT, RU, ZH
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 not state otherwise in the command description: 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:  
- translate:
text: <value>
secret: <value>
targetLanguage: <value>
id: <value>
if: <value>
onError: <value>
eval: <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/translate?text=<value>&secret=<value>&targetLanguage=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>&apiKey=<value>&restUrl=<value>&filter=<value>  

Command Line Interface (CLI) example:

pi command translate text=<value> secret=<value> targetLanguage=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value> apiKey=<value> restUrl=<value> filter=<value>  

Learn more: Command Line Interface (CLI).

unzip v1


Unzips a given zipped content from the body and puts the uncompressed content into the output. Note: Currently only files in the root level of the zip are supported.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- unzip:
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/unzip?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command unzip id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

json.validate v1


Validates the syntax of the JSON document given in the body or the input parameter. Can additionally validate the JSON using the given JSON schema. See https://json-schema.org/.

Try online.

Alias: command:validate.json:v1
Version: v1
Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
schemaStringfalsenullThe JSON schema to be used for schema validation. Can be a string, a PEL or a custom uri pointing to the location of the schema. In case no schema is defined, only a JSON syntax validation is performed.
versionStringfalseV7The version of the schema specification to be used.
throwExceptionStringfalsefalseIf true, an exception is thrown in case of an syntax or schema validation error and the pipeline execution will be stopped. If set to false, the validation result will be returned as JSON in the output having the fields status and message whereas status can be one of error or ok. In case of an validation error, all validation errors will be put into the message field.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- json.validate:
schema: <value>
version: <value>
throwException: <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/json.validate?schema=<value>&version=<value>&throwException=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command json.validate schema=<value> version=<value> throwException=<value> id=<value> if=<value> onError=<value> eval=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI).

var.set v1


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

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullA string or an expression to be used as key of the var to be set.
valueStringtruenullA string or an expression to be used as the value to be 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:  
- var.set:
key: <value>
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/var.set?key=<value>&value=<value>&format=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

vars v1


This command allows to set multiple variables in one command. It can create new variables in the vars scope or overwrite existing ones.

Try online.

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

NameTypeRequiredDefaultDescription
setStringtruenullA list of key-value pairs to be evaluated in order to set variables.
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:  
- vars:
set: <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/vars?set=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command vars set=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

wait v1


Waits a certain amount of time with next execution.

Try online.

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

NameTypeRequiredDefaultDescription
msStringfalse100The time to wait in milliseconds.
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:  
- wait:
ms: <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/wait?ms=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command wait ms=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

webhook.delete v1


Deletes an existing webhook. If no such webhook exists, nothing happens.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringtruenullId of the webhook 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:  
- webhook.delete:
uuid: <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/webhook.delete?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI).

webhook.get v1


Returns all persisted webhooks as a list.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringfalsenullId of the single webhook to return. If null or empty, all webhooks will be 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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- webhook.get:
uuid: <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/webhook.get?uuid=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command webhook.get uuid=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

webhook.put v1


Creates a new webhook or updates an existing one and returns its metadata.

Try online.

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

NameTypeRequiredDefaultDescription
eventKeyStringtruenullId of the event to be fired when hook was called.
pipelineStringfalsenullDEPRECATED: Link to pipeline via messaging instead.
uuidStringfalsenullThe id (=token) of an existing webhook. If given, tries to update this webhook. In case no such webhook exists, creates a new one with given token.
payloadTypeStringfalsebase64How to handle the payload before it gets published into the message broker? Possible values are: raw (use the payload as it is), base64 (encode it base64, = default), outbound (save the payload into a tmp cache and refer to it using an outbound url), ignore (do not send the payload into the messaging).
maxPayloadLengthStringfalse512000The max. length of the payload of this webhook in bytes. If this webhook is called with content in body bigger than this, an exception will be 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- webhook.put:
eventKey: <value>
pipeline: <value>
uuid: <value>
payloadType: <value>
maxPayloadLength: <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/webhook.put?eventKey=<value>&pipeline=<value>&uuid=<value>&payloadType=<value>&maxPayloadLength=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command webhook.put eventKey=<value> pipeline=<value> uuid=<value> payloadType=<value> maxPayloadLength=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

webhook.receive v1


Runs a webhook identified by its uuid (token). The webhook is called async. Enable redirects in your client, set pollingRedirectEnabled:true and follow the 503 redirect if you need to retrieve the final result. In case the webhook with given token doesn't exist, nothing happens for security reasons. There is no feedback whether a webhook exists or not. A status code of 200 or 503 is returned by default.

Try online.

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

NameTypeRequiredDefaultDescription
uuidStringfalsenullThe uuid of the webhook (deprecated, use token instead).
tokenStringtruenullThe unique token of the webhook. Can passed as request param or as header (recommended) to call the webhook from outside.
pollingRedirectEnabledStringfalsefalseShould the response contain a 503 status (redirect) in case the result is not finished yet so a long polling is possible? If true, the 503 status is returned to the caller with a target url. If caller client follows this redirect, it can long poll on the target url for the final result. Otherwise a 200 is returned without any result. Note: The process is ALWAYS started async in the backend. So if a final result is expected, it must be retrieved always using long polling or a message listener.
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:  
- webhook.receive:
uuid: <value>
token: <value>
pollingRedirectEnabled: <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/webhook.receive?uuid=<value>&token=<value>&pollingRedirectEnabled=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command webhook.receive uuid=<value> token=<value> pollingRedirectEnabled=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

webhook.receive.logs v1


Returns the receive logs of the given webhook. Note: This command is currently experimental and returns just dummy data.

Try online.

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

NameTypeRequiredDefaultDescription
tokenStringtruenullThe unique token of the webhook to list logs for.
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:  
- webhook.receive.logs:
token: <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/webhook.receive.logs?token=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command webhook.receive.logs token=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

workflow.definition.find v1


Returns all workflow definition properties from the property store, the currently logged-in user is allowed to see.

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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.definition.find:
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/workflow.definition.find?id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.definition.find id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.deploy v1


Deploys a given BPMN from the body or a given property into the underlying workflow engine.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name to deploy the workflow under.
appIdStringfalsenullThe appId to be used to prefix the process name with: appId_workflowname. If null or empty no prefix is appended.
propertyKeyStringfalsenullDEPRECATED. Use propertyPath instead.
propertyPathStringfalsenullThe optional path of a workflow property containing a BPMN as value. If this is given, name and appId will be extracted from this key in case these params are empty. If this param is missing, the BPMN is expected to be in the body.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.deploy:
name: <value>
appId: <value>
propertyKey: <value>
propertyPath: <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/workflow.deploy?name=<value>&appId=<value>&propertyKey=<value>&propertyPath=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.deploy name=<value> appId=<value> propertyKey=<value> propertyPath=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.deployment.find v1


Finds all deployments from the workflow engine matching given parameters and puts them into the body.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullName of the deployment. Exact match.
idStringfalsenullId of the deployment. Exact match.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.deployment.find:
name: <value>
id: <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/workflow.deployment.find?name=<value>&id=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.deployment.find name=<value> id=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.event v1


Sends an event message to a message endpoint inside
a given workflow. As payload of the event message,
the current pipe message will be used as input.

Try online.

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

NameTypeRequiredDefaultDescription
processInstanceIdStringfalsenullThe processInstanceId which refers to the process to be notified by this event. One of businessKey or processInstanceId must be given.
businessKeyStringfalsenullThe business key of the process which needs to be informed by the event. One of businessKey or processInstanceId must be given.
messageNameStringtruenullThe name of this message. It is used to find the endpoint to be triggered in the workflow.
variablesStringfalsenullThe process variables to apply on message target.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.event:
processInstanceId: <value>
businessKey: <value>
messageName: <value>
variables: <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/workflow.event?processInstanceId=<value>&businessKey=<value>&messageName=<value>&variables=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.event processInstanceId=<value> businessKey=<value> messageName=<value> variables=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.find.processinstances v1


Returns all process instances matching the given criteria.

Try online.

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

NameTypeRequiredDefaultDescription
processInstanceBusinessKeyStringfalsenullFilter tasks by businessKey.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.find.processinstances:
processInstanceBusinessKey: <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/workflow.find.processinstances?processInstanceBusinessKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.find.processinstances processInstanceBusinessKey=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.history.tasks v1


Returns all finished tasks matching the given criteria.

Try online.

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

NameTypeRequiredDefaultDescription
dueBeforeStringfalsenullShows all tasks that are due before this ISO8601 date. Optional
assigneeStringfalsenullFilter tasks by assignee.
includeVariablesStringfalsefalseShould each task also list its historic variables?
processInstanceIdStringtruenullFilter tasks by process instance id.
processInstanceBusinessKeyStringfalsenullFilter tasks by businessKey.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.history.tasks:
dueBefore: <value>
assignee: <value>
includeVariables: <value>
processInstanceId: <value>
processInstanceBusinessKey: <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/workflow.history.tasks?dueBefore=<value>&assignee=<value>&includeVariables=<value>&processInstanceId=<value>&processInstanceBusinessKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.history.tasks dueBefore=<value> assignee=<value> includeVariables=<value> processInstanceId=<value> processInstanceBusinessKey=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.member.message v1


Sends a message to the given workflow member. In case the workflow member is not already added to the workflow model, adds a new entry to a given workflow model, which is usually a data model (JSON) with a single member structure like this: workflowModel.members[someUserId] whereas in this level user, taskUrl and shareUrl will be added if required.

Try online.

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

NameTypeRequiredDefaultDescription
workflowModelStringtruenullThe workflow model where to add the new user at (inside the sub element workflowModel/members/[userId)]. Can be a PEL which points to an loaded instance or a uri which points to a workflow model instance key.
userIdStringfalsenullThe uuid of the user to add as member to the workflow model. One of userId or username is required.
usernameStringfalsenullThe username of the user to add as member to the workflow model. One of userId or username is required.
resourcePathStringfalsenullThe path to a resource or folder to create a share from for the new member. If null or empty, no share is created.
taskUrlStringfalsenullThe url of a workflow task for the new member. If null or empty, no task is shown.
subjectStringfalsenullThe subject of the invite message.
messageStringfalsenullThe invite message to be used to send an invite email to the new member. Can be a text message, a uri or content object template.
modelStringfalsenullThe model to be used in the invite message template.
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.member.message:
workflowModel: <value>
userId: <value>
username: <value>
resourcePath: <value>
taskUrl: <value>
subject: <value>
message: <value>
model: <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.member.message?workflowModel=<value>&userId=<value>&username=<value>&resourcePath=<value>&taskUrl=<value>&subject=<value>&message=<value>&model=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command workflow.member.message workflowModel=<value> userId=<value> username=<value> resourcePath=<value> taskUrl=<value> subject=<value> message=<value> model=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

workflow.model.attachment.get v1


Returns property.attachment.content from process model property attachment.

Try online.

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

NameTypeRequiredDefaultDescription
processInstanceIdStringtruenullThe process instance id.
fileNameStringtruenullThe attachment name.
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.model.attachment.get:
processInstanceId: <value>
fileName: <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.model.attachment.get?processInstanceId=<value>&fileName=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command workflow.model.attachment.get processInstanceId=<value> fileName=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

workflow.model.attachment.put v1


Does property.attachment.put to process model property attachment.

Try online.

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

NameTypeRequiredDefaultDescription
processInstanceIdStringtruenullThe process instance id.
fileNameStringtruenullThe name of the attachment to be created. If an attachment with this name already exists, updates the existing one.
contentTypeStringfalsenullThe content type to be used for this attachment.
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.model.attachment.put:
processInstanceId: <value>
fileName: <value>
contentType: <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.model.attachment.put?processInstanceId=<value>&fileName=<value>&contentType=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command workflow.model.attachment.put processInstanceId=<value> fileName=<value> contentType=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

workflow.model v1


Utility command to easier workflow model handling.

Try online.

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

NameTypeRequiredDefaultDescription
mappingsStringfalsenullA list of mapping rules to be applied to the given workflow model. See online docs for more details about such mapping rules.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.model:
mappings: <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/workflow.model?mappings=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.model mappings=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.tasks.open v1


Returns all open tasks grouped by assignee. Returned parameters are dynamically and depend on the underlying workflow engine. Default result format is [{id:taskId, name:taskName, assignee:userId, created:createdDate, due:dueDate, tenant:tenantId}, ...]. For a detailed description about all returned attributes see the default implementation: https://docs.camunda.org/manual/7.7/reference/rest/task/get-query/

Try online.

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

NameTypeRequiredDefaultDescription
dueBeforeStringfalsenullShows all tasks that are due before this ISO8601 date. Optional
assigneeStringfalsenullFilter tasks by assignee.
processInstanceIdStringfalsenullFilter tasks by process instance id.
processInstanceBusinessKeyStringfalsenullFilter tasks by businessKey.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.tasks.open:
dueBefore: <value>
assignee: <value>
processInstanceId: <value>
processInstanceBusinessKey: <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/workflow.tasks.open?dueBefore=<value>&assignee=<value>&processInstanceId=<value>&processInstanceBusinessKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.tasks.open dueBefore=<value> assignee=<value> processInstanceId=<value> processInstanceBusinessKey=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.tasks.open.reminder v1


Sends a reminder email to each assignee having open tasks matching given criteria.

Try online.

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

NameTypeRequiredDefaultDescription
dueBeforeStringfalsenullShows all tasks that are due before this ISO8601 date. Optional
assigneeStringfalsenullFilter tasks by assignee.
processInstanceIdStringfalsenullFilter tasks by process instance id.
processInstanceBusinessKeyStringfalsenullFilter tasks by businessKey.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.tasks.open.reminder:
dueBefore: <value>
assignee: <value>
processInstanceId: <value>
processInstanceBusinessKey: <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/workflow.tasks.open.reminder?dueBefore=<value>&assignee=<value>&processInstanceId=<value>&processInstanceBusinessKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.tasks.open.reminder dueBefore=<value> assignee=<value> processInstanceId=<value> processInstanceBusinessKey=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.start v1


Starts a new instance of a process in the workflow engine.
The given pipe message will be serialized to JSON and
put as variable <code>pipeJson</code> into context of the
process (process variables).
Returns the input message unchanged.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the process to start in the workflow engine.
businessKeyStringfalsenullThe business key of the process to start in the workflow engine for later references.
variablesStringfalsenullA map of variables to be send to the workflow process. If this param is missing, the full pipeline message is flattened and then send to the workflow process as variables.
workflowModelInstanceKeyStringfalsenullThe optional property key of the central process model instance to be used. Will be passed under this name to the process engine as process variable.Note: The model instance key must start with an app path followed by an object path. For example global/app/myApp/object/someObject/v1/instance/SOME_UUID.
workflowStartedByStringfalsenullThe name of the process variable which holds the uuid of the user who started this process using this command. If null or empty, the currently logged-in user willbe used 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.
outputStringfalsenullDefines a PEL where to write the result of this command. If not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.start:
key: <value>
businessKey: <value>
variables: <value>
workflowModelInstanceKey: <value>
workflowStartedBy: <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/workflow.start?key=<value>&businessKey=<value>&variables=<value>&workflowModelInstanceKey=<value>&workflowStartedBy=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.start key=<value> businessKey=<value> variables=<value> workflowModelInstanceKey=<value> workflowStartedBy=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.task.claim v1


Claims a given task to a given user.

Try online.

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

NameTypeRequiredDefaultDescription
taskIdStringtruenullThe id (not name!) of the task to claim.
usernameStringtruenullThe username of the user to claim the task for
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.task.claim:
taskId: <value>
username: <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/workflow.task.claim?taskId=<value>&username=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.task.claim taskId=<value> username=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.task.complete v1


Completes a given workflow task and puts any resulting variable from the task in the body.

Try online.

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

NameTypeRequiredDefaultDescription
taskIdStringtruenullThe id (not name!) of the task to complete.
variablesStringfalsenullA map of variables to be passed to the task. Can be null.
claimStringfalsenullA username to define if to claim task by specified user before completion. Default is null, when claim is not needed.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.task.complete:
taskId: <value>
variables: <value>
claim: <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/workflow.task.complete?taskId=<value>&variables=<value>&claim=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.task.complete taskId=<value> variables=<value> claim=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.tasks v1


Returns all tasks for a given workflow. Returned parameters are dynamically and depend on the underlying workflow engine. Default result format is [{id:taskId, name:taskName, assignee:userId, created:createdDate, due:dueDate, tenant:tenantId}, ...]. For a detailed description about all returned attributes see the default implementation: https://docs.camunda.org/manual/7.7/reference/rest/task/get-query/

Try online.

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

NameTypeRequiredDefaultDescription
dueBeforeStringfalsenullShows all tasks that are due before this ISO8601 date. Optional
assigneeStringfalsenullFilter tasks by assignee.
processInstanceIdStringfalsenullFilter tasks by process instance id.
processInstanceBusinessKeyStringfalsenullFilter tasks by businessKey.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.tasks:
dueBefore: <value>
assignee: <value>
processInstanceId: <value>
processInstanceBusinessKey: <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/workflow.tasks?dueBefore=<value>&assignee=<value>&processInstanceId=<value>&processInstanceBusinessKey=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.tasks dueBefore=<value> assignee=<value> processInstanceId=<value> processInstanceBusinessKey=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.undeploy v1


Undeploys a given BPMN from workflow engine.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the deployment to remove.
onErrorStringfalseEXITWhat to do if an error happened in this command?
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.undeploy:
name: <value>
onError: <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.undeploy?name=<value>&onError=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>  

Command Line Interface (CLI) example:

pi command workflow.undeploy name=<value> onError=<value> id=<value> if=<value> onError=<value> eval=<value>  

Learn more: Command Line Interface (CLI).

workflow.users v1


Returns all users eligible to participate in given workflow.

Try online.

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

NameTypeRequiredDefaultDescription
processDefinitionIdStringfalsenullThe id of the process definition.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.users:
processDefinitionId: <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/workflow.users?processDefinitionId=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.users processDefinitionId=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

workflow.variables.get v1


Returns the variables of a given process instance from the workflow engine as JSON whereas the name of the variable becomes the JSON attribute name and the value of the variable becomes the JSON attribute value.

Try online.

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

NameTypeRequiredDefaultDescription
processInstanceIdStringtruenullThe process instance id.
parseJsonStringStringfalsefalseTests if a workflow variable contains a JSON string and if so, converts this JSON string into a JSON object and sets it as value for the variable in the output JSON.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- workflow.variables.get:
processInstanceId: <value>
parseJsonString: <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/workflow.variables.get?processInstanceId=<value>&parseJsonString=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command workflow.variables.get processInstanceId=<value> parseJsonString=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

zip v1


Compresses a given content in the body and puts the compressed data into the output. If content is a content collection, puts all entries in the resulting zip file. Note: Currently a nested content collection is currently not supported! Any content entry must be at the root level.

Try online.

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

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the final zip file. If not given, the name will be set by this rule: If it is a single entry, uses the name of the entry + .zip. If there are multiple entries, creates a random name + .zip
levelStringfalsenullSets the compression level 0-9. If not set, the default level is used which could vary.
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 not state otherwise in the command description: If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- zip:
name: <value>
level: <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/zip?name=<value>&level=<value>&id=<value>&if=<value>&onError=<value>&eval=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command zip name=<value> level=<value> id=<value> if=<value> onError=<value> eval=<value> output=<value>  

Learn more: Command Line Interface (CLI).

Report an Issue

Your help is needed!

In case you're missing something on this page, you found an error or you have an idea for improvement, please click here to create a new issue. Another way to contribute is, to click Edit this page below and directly add your changes in GitHub. Many thanks for your contribution in order to improve PIPEFORCE!