/getRecordState

get

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

Return the state of a record along with history data

Headers

process-keys

string

The BPM Profile key(s) of the relevant BPM Process (separate using commas)

bpm-record-ids

string

The Record Id(s) of the record(s) that were registered with Agilit-e (separate using commas)

step-names

string

Return results based on these step name(s) (separate using commas)

responsible-users

string

Return results based on these responsible user(s) (separate using commas)

relevant-users

string

Return results based on these relevant users(s) (separate using commas)

include-history

boolean

Defaults to true

Include history data in the result

include-step-options

boolean

Defaults to true

Include Step Options in the result

include-visible-objects

boolean

Defaults to true

Include Visible Objects in the result

page

string

For pagination. Default to null. When using paging, Use 0 for Page 1, 1 for Page 2, etc.

page-limit

string

For pagination. Default to null. Limit the amount of records to be returned

Responses

200200