/execute

post

https://api.agilite.io/bpm/execute

Execute a BPM Record that has been registered or that is in an Active Step

Body Params

RAW_BODY

json

Headers

Content-Type

string

required

Defaults to application/json

process-key

string

required

The BPM Profile Key of the relevant BPM Process

bpm-record-id

string

required

The Record Id of the record that was registered with Agilit-e

option-selected

string

required

The Step Option to execute

current-user

string

required

The Name, Email, Id of the user executing the record

current-step

string

required

The Current Step Key or Name that record is in

comments

string

Any options comments to be added to the History entry for this record

include-history

boolean

Defaults to true

Whether the successful response needs to include the history object

include-step-options

boolean

Defaults to true

Whether the successful response needs to include the step options

include-visible-objects

boolean

Defaults to true

Whether the successful response needs to include the visible objects

include-keywords

boolean

Defaults to true

Whether the successful response needs to include the keywords

iso-language

string

Defaults to en

Language to use when registering the BPM Record

log-profile-key

string

Profile Key of the Batch Logging Profile configured for logging

Responses

200200

400400