Get a list of executions and their results

GET

Get a list of entity results. Always sorted in reverse chrono order

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

serviceNamestringRequired

The unique name of the service profile

workflowNamestringRequired

The unique name of the workflow

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional

Username provided by API caller

Query parameters

limitintegerOptional>=1Defaults to 20

Limit the number of items that will be returned as part of the request

pageintegerOptional

The page number that you want to retrieve for the list query

sortenumOptional

Order of the sort fields will be sorted upon

Allowed values: ascdesc
sortFieldsstringOptional

List of fields that the Process Results will be filtered with Available values : createdAt, updatedAt

workflowResultsenumOptionalDefaults to UNCHECKED

list of workflow execution result values to filter results on

workflowExecutionStatesenumOptional

List of workflow execution state values to filter with

startedAtBeforedatetimeOptional

Filter on the startedAt field, results returned are based on being before the value (inclusive)

startedAtAfterdatetimeOptional

Filter on the startedAt field, results returned are based on being before the value (inclusive)

endedAtAfterdatetimeOptional

Filter on the endedAt field, results returned are based on being before the value (inclusive)

endedAtBeforedatetimeOptional

Filter on the endedAt field, results returned are based on being before the value (inclusive)

Response

OK

requestIdstringOptional

The unique request ID for the API call made.

workflowResultslist of objectsOptional
Built with