Skip to main content

Commands API Reference

Reference documentation of all built-in Commands.

Download pipeline and commands schema: pipeline-schema.json
Also see: Pipeline Guide | Command Guide

Example usage of chained commands in a pipeline with PEL to access the body:

pipeline:  
- datetime:
format: "dd/MM/yyyy"
- log:
message: "The current date is: #{body}"

apidoc.commands


Returns the OpenAPI documentation of commands.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

apidoc.pel.utils


Returns the OpenAPI documentation of PEL utils.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

app.install


Installs the given app into the property store.

Try online.

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 repo is expected to be a public one.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
credentialsStringfalsenullRefers to the name of a stored credentials 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:
github: <value>
id: <value>
if: <value>
credentials: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.install?github=<value>&id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command app.install github=<value> id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

assert


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
trueStringfalsenullA PE which must evaluate to true.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- assert:
true: <value>
false: <value>
body.equals: <value>
equals: <value>
value: <value>
message: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command assert true=<value> false=<value> body.equals=<value> equals=<value> value=<value> message=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

workflow.assert


Applies asserts for a given workflow in the workflow service.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

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>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

barcode.create


Creates a barcode from a dynamic format.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

barcode.read


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

bean


Executes a method on a Spring bean. Is only available for support users.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
nameStringfalsenullThe name of the bean.
methodStringfalsenullThe method name of the bean to be executed.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- bean:
name: <value>
method: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/bean?name=<value>&method=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command bean name=<value> method=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

body.delete


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

body.filter


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.clear


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.get


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.info


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.list


Lists ALL entries of the cache. Use with care!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.put


Saves the given value under given key into a central cache. If no value param is given, uses the body as cache value. The max time to live of each entry is 120 min. The min time to live is 5 min. Default is 5 min.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
timeToLiveIntegerfalse5The min. time to live for this cache entry in minutes. If not set or negative, will be set to default = 5 min. If value is bigger than 120, will be limited to 120 (2 hours). If value is smaller than 5, will be extended to 5.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

call


Calls a script and returns with the result in the body.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

capture


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pipe.schema


Returns the JSON schema for all built-in pipes.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
pipeStringfalsenullThe specific pipe name to fetch schema from. If set, only the schema for this specific pipe is returned.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipe.schema:
pipe: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command pipe.schema pipe=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

pipe.schema.v7


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipe.schema.v7:
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command pipe.schema.v7 id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

config.get


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

content.get


Reads content from provided uri and puts the result back to body.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

credentials.delete


Deletes a credentials entry.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- credentials.delete:
name: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/credentials.delete?name=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command credentials.delete name=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

credentials.get


Lists the metadata of all available credentials entries.

Try online.

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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- credentials.get:
name: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/credentials.get?name=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command credentials.get name=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

credentials.put


Creates a new credentials entry.

Try online.

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 of the credentials (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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- credentials.put:
format: <value>
name: <value>
secret: <value>
timeToLive: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/credentials.put?format=<value>&name=<value>&secret=<value>&timeToLive=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

data.mapping


Converts from one data structure into a another by applying simple mapping rules. Auto-creates nested elements if required.

Try online.

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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

data.transform


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

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>&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> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

datetime


Returns the current time at server side.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

datetime.zones


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

decrypt


Decrypts the data in the body using the defined encryption parameter. Puts the encrypted data back to the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
passwordStringtruenullThe password to decrypt the body with.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- decrypt:
password: <value>
id: <value>
if: <value>
input: <value>
output: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command decrypt password=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.attachment.add


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

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>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.create


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.delete


Deletes a given delivery.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.finalize


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.get


Returns an existing delivery.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.recipient.add


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.send


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.update


Updates an existing PIPEFORCE Secure Delivery.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

doc.api.pelutils


Returns the api doc for the available PEL utils.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

docusign


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

document.understand


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
apiKeyStringfalsenullThe alternative API key to connect to the service. If null or empty, the default one will be used, as defined by the default backend settings.
restUrlStringfalsenullThe URL to be called by the command. If null or empty, the default url will be used as defined in the backend.
filterStringfalsenullA PEL as filter to be applied to the output data before it is returned by this command. If null or empty, no filter is applied.

Pipeline example:

pipeline:  
- document.understand:
id: <value>
if: <value>
input: <value>
output: <value>
apiKey: <value>
restUrl: <value>
filter: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command document.understand id=<value> if=<value> input=<value> output=<value> apiKey=<value> restUrl=<value> filter=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.archive.save


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 into the output target.

Try online.

Input body type: Raw
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the archive folder where the file to be saved.
namingPatternStringtruenullThe pattern to be applied to generate the final archive file name. Additionally, provides these temp variables in this PEL pattern context: archiveCounter = The number of files currently stored in the archive folder. archivePath = The path to the archive as given by path param.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.copy


Copies a folder or file on Drive.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.delete


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.exists


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.list


Lists all resources from drive folder.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.mkdir


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.move


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.read


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.save


Saves the content of the body to one or more files in Drive. The content of the body can be a single pipeline resource or a pipeline resource collection.

Try online.

Input body type: Raw
Output body type: Raw
Parameters:

NameTypeRequiredDefaultDescription
pathStringtruenullThe path of the file to be saved. If multiple files are in the body, this is the path of the base folder where to store these files. Otherwise it is expected to be the full path to a single file.
namingStrategyStringfalsenullIf defined, applies the given naming strategy to the name of the resource. If null or empty, no name strategy is applied.
cleanupBodyStringfalsetrueIf true, deletes the content from the body after the content was saved to drive (default).
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.share


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.tag


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.upload.chunked


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

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>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

encrypt


Encrypts the data in the body using the defined encryption parameter and puts the encrypted datain the output.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
passwordStringtruenullThe password to encrypt the body with.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- encrypt:
password: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command encrypt password=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

eval


Executes a given pipeline expression with the message as context.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
exprStringtruenullThe pipeline expression to be executed.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

event.listen


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullThe key to listen for.
filterStringfalsenullAn optional PEL to execute the pipeline only in case the filter applies.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- event.listen:
key: <value>
filter: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command event.listen key=<value> filter=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

event.mapping.get


Returns all event key to pipeline key mappings.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

event.send


Sends a new event to inform listeners in pipelines.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

exit


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

finally


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
doStringfalsenullAn optional PE to execute finally.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- finally:
do: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

pi command finally do=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

foreach


Repeats the subsequent pipeline commands for each entry in a given list. By default the full pipeline until the end will be repeated. To repeat only a subset, place the command foreach?end where the foreach iteration should end. The current iteration item is placed in vars.loop.item.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
inStringfalsenullDefault parameter which points to a list of items to be iterated over. Each iteration item is placed by default under vars.loop.item an can be accessed as such inside the iteration loop.
itemStringfalsenullContains an optional expression which will be evaluated for each iteration. The current iteration item at vars.loop.item will be overwritten by the result of this expression.
loopNameStringfalseloopThe name of the current loop object in the vars scope. By default this is 'loop' which results in 'vars.loop.item' then for accessing the current loop item. With this attribute you can change this for example to 'iteration' so you can access the loop iterm under 'vars.iteration.item'. The loop object contains attributes for the current loop like item = the current iteration item, index = the current iteration index.
endStringfalsenullSignals the end of a for each loop.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

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

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

header.set


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- header.set:
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/header.set?id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.form.find


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- htmlunit.website.form.find:
select: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.form.find?select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.form.input


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- htmlunit.website.form.input:
value: <value>
select: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.form.input?value=<value>&select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.form.submit


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- htmlunit.website.form.submit:
select: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.form.submit?select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.link.click


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- htmlunit.website.link.click:
select: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.link.click?select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.open


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- htmlunit.website.open:
url: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.open?url=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.scrap


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- htmlunit.website.scrap:
xpath: <value>
select: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.scrap?xpath=<value>&select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

http.delete


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentialsStringfalsenullRefers to the name of a stored credentials 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>
headers: <value>
body: <value>
id: <value>
if: <value>
input: <value>
output: <value>
credentials: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.delete?url=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.delete url=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.get


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentialsStringfalsenullRefers to the name of a stored credentials 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>
headers: <value>
body: <value>
id: <value>
if: <value>
input: <value>
output: <value>
credentials: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.get?url=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.get url=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.patch


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentialsStringfalsenullRefers to the name of a stored credentials 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>
headers: <value>
body: <value>
id: <value>
if: <value>
input: <value>
output: <value>
credentials: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.patch?url=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.patch url=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.post


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentialsStringfalsenullRefers to the name of a stored credentials 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>
headers: <value>
body: <value>
id: <value>
if: <value>
input: <value>
output: <value>
credentials: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.post?url=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.post url=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.put


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
urlStringfalsenullThe url for the HTTP call.
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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
inputStringfalsenullDefines where to read the input from as PEL. If this param is missing, the input will be read from the body.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentialsStringfalsenullRefers to the name of a stored credentials 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>
headers: <value>
body: <value>
id: <value>
if: <value>
input: <value>
output: <value>
credentials: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.put?url=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.put url=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.token.refresh


Enrich headers with accessToken obtained from authorization server using refreshToken.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
refreshTokenStringtruenullThe refresh token.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- iam.token.refresh:
refreshToken: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.token.refresh?refreshToken=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.apitoken


Obtains the apitoken in exchange for user credentials provided and writes into the output.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.apitoken:
username: <value>
password: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.apitoken?username=<value>&password=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.authinfo


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- iam.authinfo:
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.authinfo?id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.authorize


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- iam.authorize:
accessToken: <value>
refreshToken: <value>
basic: <value>
username: <value>
password: <value>
id: <value>
if: <value>

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>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.bruteforce.release


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.bruteforce.release:
username: <value>
uuid: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.bruteforce.release?username=<value>&uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.bruteforce.status


Returns the bruteforce status for a single user

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.bruteforce.status:
username: <value>
uuid: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.bruteforce.status?username=<value>&uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.add.roles


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.add.roles:
groupUuid: <value>
roleNames: <value>
groupName: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.add.roles?groupUuid=<value>&roleNames=<value>&groupName=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.create


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.create:
name: <value>
roleNames: <value>
attributes: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.create?name=<value>&roleNames=<value>&attributes=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.delete


Deletes the group with given uuid.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.delete:
uuid: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.delete?uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.list


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.

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.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.list:
filter: <value>
sortByName: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.list.names


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.list.names:
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.list.names?max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.members


Lists all users which are member 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.

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.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.members:
name: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.roles


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

Try online.

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.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.group.roles:
groupName: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.realm.create


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.realm.create:
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.realm.create?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.role.add.composites


Adds existing composite roles to an existing role.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.role.add.composites:
roleName: <value>
composites: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.role.add.composites?roleName=<value>&composites=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.role.create


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.role.create:
name: <value>
composites: <value>
attributes: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.role.create?name=<value>&composites=<value>&attributes=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.role.members


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
roleNameStringfalsenullThe name of the role.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.role.members:
roleName: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

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>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.run.as


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.

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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- iam.run.as:
username: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.run.as?username=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.search


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
typeStringtruenullThe entity type to search for. Supported values are: ROLE, USER, GROUP, REALM.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.search:
type: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.search?type=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.token.logout


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
refreshTokenStringtruenullThe refresh token.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- iam.token.logout:
refreshToken: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.token.logout?refreshToken=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.add.groups


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

Try online.

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, groupIds is required.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.add.groups:
uuid: <value>
groupNames: <value>
groupIds: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.add.groups?uuid=<value>&groupNames=<value>&groupIds=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.add.roles


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.add.roles:
userUuid: <value>
username: <value>
roleNames: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.add.roles?userUuid=<value>&username=<value>&roleNames=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.create


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.create:
name: <value>
email: <value>
firstName: <value>
lastName: <value>
groupNames: <value>
roleNames: <value>
password: <value>
attributes: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.delete


Deletes the user with given uuid.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.delete:
uuid: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.delete?uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.get


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/5.0/rest-api/index.html#_userrepresentation

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.get:
username: <value>
uuid: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.get?username=<value>&uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.groups


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.

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.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.groups:
username: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.list


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.list:
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.list?max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.roles


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

Try online.

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.
maxIntegerfalse1000The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- iam.user.roles:
username: <value>
uuid: <value>
max: <value>
offset: <value>
filter: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

if


Executes the subsequent pipeline only if given condition evaluates to true. By default the full pipeline until the end will be executed. To skip the pipes inside the if definition place the pipe if?end where the if should end.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
trueStringtruenullDefault parameter which points to the expression which must evaluate to true. Only one of true or false param is allowed.
endStringfalsenullDefines the end of of the if pipe. If not set, the full pipeline till its end is executed.
elseStringfalsenullDefines 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 statement or the end of the pipeline.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- if:
true: <value>
end: <value>
else: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/if?true=<value>&end=<value>&else=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

job


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
cronStringfalsenullA cron string which configures the execution times. See here to generate a cron string: https://crontab-generator.org/. Required only in case this is a create call.
stopStringfalsenullIf this param is set, all other params are ignored. It contains the uuid of the job to be canceled.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- job:
cron: <value>
stop: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/job?cron=<value>&stop=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command job cron=<value> stop=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

jpa.query


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- jpa.query:
query: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/jpa.query?query=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

log


Logs the given input message without changing it. Sets the log message in the body in case body is empty. Doesn't overwrite any existing content in the body.

Try online.

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.
levelStringfalseINFOThe log level. Can be one of DEBUG, TRACE, INFO, WARN, ERROR. If null or empty, INFO will be used.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- log:
message: <value>
level: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log?message=<value>&level=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command log message=<value> level=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.list


Logs the given number of log lines from specified service.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.list:
service: <value>
lines: <value>
format: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.list?service=<value>&lines=<value>&format=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

log.list.email


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.list.email:
auditId: <value>
createdAfter: <value>
createdBefore: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.list.email?auditId=<value>&createdAfter=<value>&createdBefore=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

log.list.environment


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- log.list.environment:
interpolate: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.list.environment?interpolate=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.dump


Fetches new emails from given mail inbox and uploads them into a drive folder.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- mail.dump:
protocol: <value>
host: <value>
port: <value>
inboxUsername: <value>
inboxPassword: <value>
driveUsername: <value>
drivePassword: <value>
path: <value>
id: <value>
if: <value>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.fetch


Fetches new emails from given mail inbox and returns them as JSON in the output.

Try online.

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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- mail.fetch:
protocol: <value>
host: <value>
port: <value>
inboxUsername: <value>
inboxPassword: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/mail.fetch?protocol=<value>&host=<value>&port=<value>&inboxUsername=<value>&inboxPassword=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.send


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

Try online.

Alias: pipe.command.mail
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.
modelStringfalsenullThe optional model to be used in case subject and/or message point to a template.
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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- mail.send:
to: <value>
from: <value>
fromName: <value>
subject: <value>
model: <value>
message: <value>
replyTo: <value>
attachments: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/mail.send?to=<value>&from=<value>&fromName=<value>&subject=<value>&model=<value>&message=<value>&replyTo=<value>&attachments=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.verify


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.

Try online.

Alias: pipe.command.email.verify
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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- mail.verify:
email: <value>
email.whitelist: <value>
email.blacklist: <value>
challenge: <value>
id: <value>
if: <value>

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>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

map


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- map:
reverse: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/map?reverse=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

memory.info


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- memory.info:
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/memory.info?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

microsoft.teams.send


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- microsoft.teams.send:
url: <value>
message: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/microsoft.teams.send?url=<value>&message=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

mock.command


Mocks a given command of the current pipeline.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- mock.command:
enabled: <value>
command: <value>
when: <value>
thenSetBody: <value>
thenSetVar: <value>
id: <value>
if: <value>

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>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pdf.create


Creates a new PDF with blank pages.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.create:
pages: <value>
format: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pdf.create?pages=<value>&format=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pdf.merge


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pdf.merge:
name: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

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

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pdf.stamp


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- 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>
output: <value>

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>&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> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

pipeline.delete


Deletes a persisted pipeline.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- pipeline.delete:
name: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipeline.delete?name=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pipeline.get


Returns all persisted pipelines matching the given name.

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.get:
name: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipeline.get?name=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pipeline.put


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.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.put:
name: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipeline.put?name=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

pipeline.run


DEPRECATED. Use pipeline.start instead.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
nameStringtruenullThe name of the pipeline to load and execute.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- pipeline.run:
name: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipeline.run?name=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command pipeline.run name=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

pipeline.start


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

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullThe 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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- pipeline.start:
key: <value>
vars: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipeline.start?key=<value>&vars=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pipeline.start key=<value> vars=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

property.app.config


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

Try online.

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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.app.config:
appNames: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/property.app.config?appNames=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

property.attachment.chunk.get


Returns the chunk (content) of an attachment in the output. Returns empty body if chunk was not found.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the property this attachment belongs to.
nameStringfalsenullThe 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.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.chunk.get:
key: <value>
name: <value>
index: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/property.attachment.chunk.get?key=<value>&name=<value>&index=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

property.attachment.chunk.put


Adds a chunk of data to the given attachment.

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe key 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.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- property.attachment.chunk.put:
key: <value>
name: <value>
index: <value>
content: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/property.attachment.chunk.put?key=<value>&name=<value>&index=<value>&content=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command property.attachment.chunk.put key=<value> name=<value> index=<value> content=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

property.attachment.content


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

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the property this attachment belongs to.
nameStringfalsenullThe name of the attachment.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.content:
key: <value>
name: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/property.attachment.content?key=<value>&name=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

property.attachment.delete


Removes an attachment and its content from a property.

Try online.

Input body type: Void
Output body type: Void
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the property containing the attachment.
nameStringtruenullThe name of the attachment to be deleted.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.

Pipeline example:

pipeline:  
- property.attachment.delete:
key: <value>
name: <value>
id: <value>
if: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/property.attachment.delete?key=<value>&name=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

property.attachment.get


Returns an attachment of a property (without content).

Try online.

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

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the property this attachment belongs to.
nameStringfalsenullThe name of the attachment to return.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
- property.attachment.get:
key: <value>
name: <value>
id: <value>
if: <value>
output: <value>

Learn more: Pipeline.

URL example:

http://host/api/v3/command/property.attachment.get?key=<value>&name=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

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

Learn more: Command Line Interface (CLI) | CLI Reference.

property.attachment.list


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.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

NameTypeRequiredDefaultDescription
keyStringtruenullThe key of the property to list its attachments for.
idStringfalsenullThe optional id of this command, unique within the pipeline.
ifStringfalsetrueIs the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If not enabled, command will be skipped when pipeline is executed.
outputStringfalsenullDefines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example: