selectedStateEntryId | string When executing a Flow that has the allowJumping property set to 'true', the user can move to any Map Element regardless of navigation or outcomes.
+ Request Body schema: The details of the Flow with a username and password to authenticate with.
+ id | | versionId | | developerName | | | Array of objects (EngineValueAPI) | username | | password | |
Request samples Content type No sample Response samples Content type {"culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "stateId": "string", "parentStateId": "string", "stateToken": "string", "alertEmail": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "currentStreamId": "string", "invokeType": "string", "annotations": {"property1": "string", "property2": "string" }, "mapElementInvokeResponses": [{"mapElementId": "string", "developerName": "string", "label": "string", "pageResponse": {"label": "string", "pageContainerResponses": [{"id": "string", "containerType": "string", "developerName": "string", "label": "string", "pageContainerResponses": [], "order": 0, "attributes": {"property1": "string", "property2": "string" } } ], "pageComponentResponses": [{"pageContainerDeveloperName": "string", "pageContainerId": "string", "id": "string", "developerName": "string", "componentType": "string", "contentType": "string", "label": "string", "columns": [{"developerName": "string", "typeElementPropertyId": "string", "contentFormat": "string", "contentType": "string", "label": "string", "isDisplayValue": true, "isEditable": true, "order": 0, "typeElementPropertyToDisplayId": "string", "componentType": "string" } ], "size": 0, "maxSize": 0, "height": 0, "width": 0, "hintValue": "string", "helpInfo": "string", "order": 0, "isMultiSelect": true, "isSearchable": true, "hasEvents": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "row": 0, "column": 0, "rowSpan": 0, "colSpan": 0 } ], "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ] } ], "pageContainerDataResponses": [], "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "attributes": {"property1": "string", "property2": "string" }, "order": 0 }, "outcomeResponses": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "rootFaults": {"property1": "string", "property2": "string" } } ], "preCommitStateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "stateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outputs": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "frames": [{"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d", "mapElementId": "e181eea5-224a-46ff-9a23-0fd2213ec8f6", "mapElementDeveloperName": "string" } ], "statusCode": "string", "runFlowUri": "string", "joinFlowUri": "string", "authorizationContext": {}, "navigationElementReferences": [], "isHistoricalNavigationEnabled": true, "waitExpiresAt": "2019-08-24T14:15:22Z" } Invoke Flow State Used to invoke a flow state
+ path ParametersstateId required | string The unique identifier of the Flow state.
+ |
Request Body schema: | | stateId | string The unique identifier for the initialized flow state. The state identifier is needed throughout the execution of the flow as it is the pointer that points the engine to the correct running instance of a flow.
+ | stateToken | string The unique identifier for the token response from the state. The state token identifier changes with every cycle of request/response. The token is needed as it tells the engine how in-sync your request is with the current service side state.
+ | currentMapElementId | string The unique identifier for the map element the user is currently executing against.
+ | navigationElementId | string The unique identifier for the navigation element that's being used to drive the navigation scheme.
+ | selectedNavigationItemId | string When executing using an InvokeType of 'NAVIGATE', this is the selected navigation item the user wishes to move to in the Flow.
+ | selectedMapElementId | string When executing a Flow that has the allowJumping property set to 'true', the user can move to any Map Element in the Flow regardless of navigation or outcomes. This is the unique identifier of the Map Element the user wishes to navigate to and must be used with an InvokeType of 'NAVIGATE'.
+ | selectedStateEntryId | string When executing a Flow that has the allowJumping property set to 'true', the user can move to any Map Element regardless of navigation or outcomes.
This is the Id of the State Entry that the user wishes to navigate to and must be used with an InvokeType of 'NAVIGATE'.
The engine will calculate the Map Element from the previous State Entry and execute a jump to it.
This is an alternative to using 'selectedMapElementId' jumping, with this method offering an added capability to navigate between different flows.
- | invokeType | string The way you want to invoke the engine as part of this request. The user may be navigating forward, or you may be wanting to perform a sync operation to update the UI due to another user making a change.
- | | object Key value pairs you wish to annotate to the flow. Annotations take the form of {"mykey":"myvalue"}. Any annotations added to the state will be persisted for the duration of the flow. Annotations are passed to the executing player and also through to plugin services. Annotations can be changed at any time through the execution of the flow.
- | | | | object (MapElementInvokeRequestAPI) | mode | string The mode you wish to run the flow in. The mode is mainly useful for debugging purposes as you can step through the flow and also view state information to check everything is working as expected.
- |
/api/run/1/state/{stateId} Request samples Content typeapplication/json-patch+json application/json text/json application/*+json No sample Response samples Content typeapplication/json text/json {"culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "stateId": "string", "parentStateId": "string", "stateToken": "string", "alertEmail": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "currentStreamId": "string", "invokeType": "string", "annotations": {"property1": "string", "property2": "string" }, "mapElementInvokeResponses": [{"mapElementId": "string", "developerName": "string", "label": "string", "pageResponse": {"label": "string", "pageContainerResponses": [{"id": "string", "containerType": "string", "developerName": "string", "label": "string", "pageContainerResponses": [], "order": 0, "attributes": {"property1": "string", "property2": "string" } } ], "pageComponentResponses": [{"pageContainerDeveloperName": "string", "pageContainerId": "string", "id": "string", "developerName": "string", "componentType": "string", "contentType": "string", "label": "string", "columns": [{"developerName": "string", "typeElementPropertyId": "string", "contentFormat": "string", "contentType": "string", "label": "string", "isDisplayValue": true, "isEditable": true, "order": 0, "typeElementPropertyToDisplayId": "string", "componentType": "string" } ], "size": 0, "maxSize": 0, "height": 0, "width": 0, "hintValue": "string", "helpInfo": "string", "order": 0, "isMultiSelect": true, "isSearchable": true, "hasEvents": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "row": 0, "column": 0, "rowSpan": 0, "colSpan": 0 } ], "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ] } ], "pageContainerDataResponses": [], "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "attributes": {"property1": "string", "property2": "string" }, "order": 0 }, "outcomeResponses": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "rootFaults": {"property1": "string", "property2": "string" } } ], "preCommitStateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "stateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outputs": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "frames": [{"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d", "mapElementId": "e181eea5-224a-46ff-9a23-0fd2213ec8f6", "mapElementDeveloperName": "string" } ], "statusCode": "string", "runFlowUri": "string", "joinFlowUri": "string", "authorizationContext": {}, "navigationElementReferences": [], "isHistoricalNavigationEnabled": true } Join Flow State Used to join the state provided
- path ParametersstateId required | string The unique identifier of the Flow state.
- |
query Parametersmode | string The mode in which to join the state.
- |
/api/run/1/state/{stateId} Response samples Content typeapplication/json text/json {"culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "stateId": "string", "parentStateId": "string", "stateToken": "string", "alertEmail": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "currentStreamId": "string", "invokeType": "string", "annotations": {"property1": "string", "property2": "string" }, "mapElementInvokeResponses": [{"mapElementId": "string", "developerName": "string", "label": "string", "pageResponse": {"label": "string", "pageContainerResponses": [{"id": "string", "containerType": "string", "developerName": "string", "label": "string", "pageContainerResponses": [], "order": 0, "attributes": {"property1": "string", "property2": "string" } } ], "pageComponentResponses": [{"pageContainerDeveloperName": "string", "pageContainerId": "string", "id": "string", "developerName": "string", "componentType": "string", "contentType": "string", "label": "string", "columns": [{"developerName": "string", "typeElementPropertyId": "string", "contentFormat": "string", "contentType": "string", "label": "string", "isDisplayValue": true, "isEditable": true, "order": 0, "typeElementPropertyToDisplayId": "string", "componentType": "string" } ], "size": 0, "maxSize": 0, "height": 0, "width": 0, "hintValue": "string", "helpInfo": "string", "order": 0, "isMultiSelect": true, "isSearchable": true, "hasEvents": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "row": 0, "column": 0, "rowSpan": 0, "colSpan": 0 } ], "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ] } ], "pageContainerDataResponses": [], "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "attributes": {"property1": "string", "property2": "string" }, "order": 0 }, "outcomeResponses": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "rootFaults": {"property1": "string", "property2": "string" } } ], "preCommitStateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "stateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outputs": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "frames": [{"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d", "mapElementId": "e181eea5-224a-46ff-9a23-0fd2213ec8f6", "mapElementDeveloperName": "string" } ], "statusCode": "string", "runFlowUri": "string", "joinFlowUri": "string", "authorizationContext": {}, "navigationElementReferences": [], "isHistoricalNavigationEnabled": true } Response From Service Used to get the invoke type of the service response provided
- Request Body schema: application/json-patch+json application/json text/json application/*+json invokeType | string Tells the engine what this service would like it to do. At the moment, there are really only
+ | invokeType | string The way you want to invoke the engine as part of this request. The user may be navigating forward, or you may be wanting to perform a sync operation to update the UI due to another user making a change.
+ | | object Key value pairs you wish to annotate to the flow. Annotations take the form of {"mykey":"myvalue"}. Any annotations added to the state will be persisted for the duration of the flow. Annotations are passed to the executing player and also through to plugin services. Annotations can be changed at any time through the execution of the flow.
+ | | | | object (MapElementInvokeRequestAPI) | mode | string The mode you wish to run the flow in. The mode is mainly useful for debugging purposes as you can step through the flow and also view state information to check everything is working as expected.
+ |
/api/run/1/state/{stateId} Request samples Content type No sample Response samples Content type {"culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "stateId": "string", "parentStateId": "string", "stateToken": "string", "alertEmail": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "currentStreamId": "string", "invokeType": "string", "annotations": {"property1": "string", "property2": "string" }, "mapElementInvokeResponses": [{"mapElementId": "string", "developerName": "string", "label": "string", "pageResponse": {"label": "string", "pageContainerResponses": [{"id": "string", "containerType": "string", "developerName": "string", "label": "string", "pageContainerResponses": [], "order": 0, "attributes": {"property1": "string", "property2": "string" } } ], "pageComponentResponses": [{"pageContainerDeveloperName": "string", "pageContainerId": "string", "id": "string", "developerName": "string", "componentType": "string", "contentType": "string", "label": "string", "columns": [{"developerName": "string", "typeElementPropertyId": "string", "contentFormat": "string", "contentType": "string", "label": "string", "isDisplayValue": true, "isEditable": true, "order": 0, "typeElementPropertyToDisplayId": "string", "componentType": "string" } ], "size": 0, "maxSize": 0, "height": 0, "width": 0, "hintValue": "string", "helpInfo": "string", "order": 0, "isMultiSelect": true, "isSearchable": true, "hasEvents": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "row": 0, "column": 0, "rowSpan": 0, "colSpan": 0 } ], "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ] } ], "pageContainerDataResponses": [], "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "attributes": {"property1": "string", "property2": "string" }, "order": 0 }, "outcomeResponses": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "rootFaults": {"property1": "string", "property2": "string" } } ], "preCommitStateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "stateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outputs": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "frames": [{"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d", "mapElementId": "e181eea5-224a-46ff-9a23-0fd2213ec8f6", "mapElementDeveloperName": "string" } ], "statusCode": "string", "runFlowUri": "string", "joinFlowUri": "string", "authorizationContext": {}, "navigationElementReferences": [], "isHistoricalNavigationEnabled": true, "waitExpiresAt": "2019-08-24T14:15:22Z" } Join Flow State Used to join the state provided
+ path ParametersstateId required | string The unique identifier of the Flow state.
+ |
query Parametersmode | string The mode in which to join the state.
+ |
/api/run/1/state/{stateId} Response samples Content type {"culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "stateId": "string", "parentStateId": "string", "stateToken": "string", "alertEmail": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "currentStreamId": "string", "invokeType": "string", "annotations": {"property1": "string", "property2": "string" }, "mapElementInvokeResponses": [{"mapElementId": "string", "developerName": "string", "label": "string", "pageResponse": {"label": "string", "pageContainerResponses": [{"id": "string", "containerType": "string", "developerName": "string", "label": "string", "pageContainerResponses": [], "order": 0, "attributes": {"property1": "string", "property2": "string" } } ], "pageComponentResponses": [{"pageContainerDeveloperName": "string", "pageContainerId": "string", "id": "string", "developerName": "string", "componentType": "string", "contentType": "string", "label": "string", "columns": [{"developerName": "string", "typeElementPropertyId": "string", "contentFormat": "string", "contentType": "string", "label": "string", "isDisplayValue": true, "isEditable": true, "order": 0, "typeElementPropertyToDisplayId": "string", "componentType": "string" } ], "size": 0, "maxSize": 0, "height": 0, "width": 0, "hintValue": "string", "helpInfo": "string", "order": 0, "isMultiSelect": true, "isSearchable": true, "hasEvents": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "row": 0, "column": 0, "rowSpan": 0, "colSpan": 0 } ], "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", } ] } ], "pageContainerDataResponses": [], "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "attributes": {"property1": "string", "property2": "string" }, "order": 0 }, "outcomeResponses": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "rootFaults": {"property1": "string", "property2": "string" } } ], "preCommitStateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "stateValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outputs": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "frames": [{"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d", "mapElementId": "e181eea5-224a-46ff-9a23-0fd2213ec8f6", "mapElementDeveloperName": "string" } ], "statusCode": "string", "runFlowUri": "string", "joinFlowUri": "string", "authorizationContext": {}, "navigationElementReferences": [], "isHistoricalNavigationEnabled": true, "waitExpiresAt": "2019-08-24T14:15:22Z" } Invoke Flow State Used to invoke a flow state
+ path ParametersstateId required | string The unique identifier of the Flow state.
+ |
Request Body schema: | | stateId | string The unique identifier for the initialized flow state. The state identifier is needed throughout the execution of the flow as it is the pointer that points the engine to the correct running instance of a flow.
+ | stateToken | string The unique identifier for the token response from the state. The state token identifier changes with every cycle of request/response. The token is needed as it tells the engine how in-sync your request is with the current service side state.
+ | currentMapElementId | string The unique identifier for the map element the user is currently executing against.
+ | navigationElementId | string The unique identifier for the navigation element that's being used to drive the navigation scheme.
+ | selectedNavigationItemId | string When executing using an InvokeType of 'NAVIGATE', this is the selected navigation item the user wishes to move to in the Flow.
+ | selectedMapElementId | string When executing a Flow that has the allowJumping property set to 'true', the user can move to any Map Element in the Flow regardless of navigation or outcomes. This is the unique identifier of the Map Element the user wishes to navigate to and must be used with an InvokeType of 'NAVIGATE'.
+ | selectedStateEntryId | string When executing a Flow that has the allowJumping property set to 'true', the user can move to any Map Element regardless of navigation or outcomes.
+This is the Id of the State Entry that the user wishes to navigate to and must be used with an InvokeType of 'NAVIGATE'.
+The engine will calculate the Map Element from the previous State Entry and execute a jump to it.
+This is an alternative to using 'selectedMapElementId' jumping, with this method offering an added capability to navigate between different flows.
+ | invokeType | string The way you want to invoke the engine as part of this request. The user may be navigating forward, or you may be wanting to perform a sync operation to update the UI due to another user making a change.
+ | | object Key value pairs you wish to annotate to the flow. Annotations take the form of {"mykey":"myvalue"}. Any annotations added to the state will be persisted for the duration of the flow. Annotations are passed to the executing player and also through to plugin services. Annotations can be changed at any time through the execution of the flow.
+ | | | | object (MapElementInvokeRequestAPI) | mode | string The mode you wish to run the flow in. The mode is mainly useful for debugging purposes as you can step through the flow and also view state information to check everything is working as expected.
+ |
/api/run/2/state/{stateId} Request samples Content type No sample Response samples Content type {"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0", "rootElement": {"children": [{"id": "string", "pageContainerId": "string", "type": "string", "developerName": "string", "label": "string", "order": 0, "attributes": {"property1": "string", "property2": "string" }, "isEnabled": true, "isEditable": true, "isVisible": true, "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outcomes": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ] } ], "id": "string", "pageContainerId": "string", "type": "string", "developerName": "string", "label": "string", "order": 0, "attributes": {"property1": "string", "property2": "string" }, "isEnabled": true, "isEditable": true, "isVisible": true, "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outcomes": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ] }, "outcomes": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "stateId": "string", "stateToken": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "invokeType": "string", "statusCode": "string", "joinFlowUri": "string", "authorizationContext": {}, "waitExpiresAt": "2019-08-24T14:15:22Z", "rootFaults": {"property1": "string", "property2": "string" }, "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ] } ], "pageContainerDataResponses": [] } /api/run/2/state/{stateId} /api/run/2/state/{stateId} Response samples Content type {"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0", "rootElement": {"children": [{"id": "string", "pageContainerId": "string", "type": "string", "developerName": "string", "label": "string", "order": 0, "attributes": {"property1": "string", "property2": "string" }, "isEnabled": true, "isEditable": true, "isVisible": true, "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outcomes": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ] } ], "id": "string", "pageContainerId": "string", "type": "string", "developerName": "string", "label": "string", "order": 0, "attributes": {"property1": "string", "property2": "string" }, "isEnabled": true, "isEditable": true, "isVisible": true, "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "outcomes": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ] }, "outcomes": [{"pageActionBindingType": "string", "pageActionType": "string", "isBulkAction": true, "pageObjectBindingId": "string", "isOut": true, "attributes": {"property1": "string", "property2": "string" }, "className": "string", "id": "string", "developerName": "string", "label": "string", "order": 0 } ], "stateId": "string", "stateToken": "string", "waitMessage": "string", "notAuthorizedMessage": "string", "flowId": "string", "flowName": "string", "flowVersion": "string", "currentMapElementId": "string", "invokeType": "string", "statusCode": "string", "joinFlowUri": "string", "authorizationContext": {}, "waitExpiresAt": "2019-08-24T14:15:22Z", "rootFaults": {"property1": "string", "property2": "string" }, "pageComponentDataResponses": [{"pageComponentId": "string", "isEnabled": true, "isEditable": true, "isRequired": true, "isVisible": true, "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ], "fileDataRequest": {"stateId": "string", "serviceElementId": "string", "token": "string", "configurationValues": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ], "culture": {"id": "string", "developerName": "string", "developerSummary": "string", "brand": "string", "language": "string", "country": "string", "variant": "string" }, "resourcePath": "string", "resourceFile": "string", "listFilter": {"orderByPropertyDeveloperName": "string", "orderByDirectionType": "string", "limit": 0, "offset": 0, "search": "string" } }, "contentValue": "string", "content": "string", "imageUri": "string", "isValid": true, "validationMessage": "string", "tags": [{"valueElementId": "string", "typeElementId": "string", "typeElementPropertyId": "string", "developerName": "string", "typeElementDeveloperName": "string", "typeElementPropertyDeveloperName": "string", "contentValue": "string", "contentType": "string", "objectData": [{"internalId": "string", "externalId": "string", "developerName": "string", "typeElementId": "string", "order": 0, "properties": [{"typeElementPropertyId": "string", "developerName": "string", "contentValue": "string", "contentType": "string", "contentFormat": "string", "typeElementId": "string" } ], "typeElementBindingDeveloperName": "string", "isSelected": true } ] } ] } ], "pageContainerDataResponses": [] } Response From Service Used to get the invoke type of the service response provided
+ Request Body schema: invokeType | string Tells the engine what this service would like it to do. At the moment, there are really only
two possible commands: WAIT (to tell the engine to wait for a completed response) or DONE (to
tell the engine that it has completed its work.
- | waitMessage | string The "wait" message that should be provided to users waiting for the Service to complete its tasks.
- | | Array of objects (EngineValueAPI) [ items ] The output values from the Service being sent back to the Flow State. Outputs will be applied to the Flow State even if the InvokeType is set to WAIT.
- | selectedOutcomeId | string The Outcome the Service would like the Flow to follow. If the Outcome has Rules, the Service request for this outcome will be ignored unless the Rules are also satisfied.
- | | object Any faults that have happened in the Service that should be reported up to the Flow State.
- | | Array of objects (ValueFaultAPI) [ items ] Any faults that are directly attributed to an input value provided in the ServiceRequest. If a ValueFault is specified, ManyWho will attempt to match this error with any input fields that are bound to that Value.
- | mode | string The mode which the Service would like the Flow State to execute under.
- | token | string The execution token needed for any callback responses from the Service.
- | tenantId | string The unique identifier for the tenant that made the request to the Service.
- | | | | object Any runtime annotations that were provided to the State plus any additional annotations the Service may be providing.
- |
Request samples Content typeapplication/json-patch+json application/json text/json application/*+json No sample Response samples Content typeapplication/json text/json Event Used to get the invoke type of the service event provided
- Request Body schema: application/json-patch+json application/json text/json application/*+json | | token | string The execution token needed for any callback responses from the Service.
- | tenantId | string The unique identifier for the tenant that made the request to the Service.
- | | | | object Any runtime annotations that were provided to the State plus any additional annotations the Service may be providing.
- |
Request samples Content typeapplication/json-patch+json application/json text/json application/*+json No sample Response samples Content typeapplication/json text/json Add Listener Used to add a listener to the state stateId from the details in the request body
- Request Body schema: application/json-patch+json application/json text/json application/*+json The details of the state listener used to set up the new listener
- listenType | | stateId | | callbackUri | | | |
/api/run/1/state/{stateId}/listener Request samples Content typeapplication/json-patch+json application/json text/json application/*+json No sample Response samples Content typeapplication/json text/json {"id": "string", "listenType": "string", "stateId": "string", "callbackUri": "string", "annotations": {"property1": "string", "property2": "string" } } Remove Listener Used to remove the listener on the state stateId with the id listenerId
- path ParametersstateId required | string The unique identifier of the Flow state.
- | listenerId required | string The unique identifier of the listener.
- |
/api/run/1/state/{stateId}/listener/{listenerId} Import State Used to import a state into the tenant from JSON
- Request Body schema: application/json-patch+json application/json text/json application/*+json The JSON of the state to be imported.
- string The JSON of the state to be imported.
- Request samples Content typeapplication/json-patch+json application/json text/json application/*+json No sample Export State Used to export a state from the tenant into JSON.
+ |