Execute a workflow for the given service profile

POST

Execute a workflow for the given service profile.

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-BackgroundintegerOptional

If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.

X-Frankie-UsernamestringOptional

Username provided by API caller

Query parameters

levelenumOptionalDefaults to meta

Determines what level of detail to return in the response

  • id: Return just an id
  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and data in base64 format
Allowed values: idmetabase64

Request

This endpoint expects an object.
commentobjectOptional

Response

Execution request completed

workflowResultobjectOptional
serviceProfileobjectOptional
individualobjectOptional
requestIdstringOptional

The unique request ID for the API call made.

Get a list of executions and their results
Built with