/getRecordState

get

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

Return the state of a BPM Record based on various options defined

Body Params

Body Data

json

The body data is optional if the header prop has been specified. Otherwise you can choose to only use the body prop by leaving out the header prop and including the body prop.

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)

relevant-roles

string

Return results based on these relevant roles (separate using commas)

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 history keywords

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

event-stamps

string

Return results based on the event stamps provided (comma separated)

event-start-date

string

Return results based on the event start date

event-end-date

string

Return results based on the event end date

sort-by

string

Defaults to createdAt

Sorts results based certain properties (Specify multiple fields by separating them with spaces. e.g "createdAt modifiedAt")

iso-language

string

Return results based on the specified ISO Language

log-profile-key

string

Profile Key of the Batch Logging Profile configured for logging

due-in-minutes

string

Specify if which records should be returned based on when they are due. 0 can be provided for overdue records only, any other number checks records that are due in the number of minutes specified.

Responses

200200

400400