Resume Request API
This method sends a Resume message to a Service Flow or Data Flow that contains the specified Wait Point. The message effectively instructs the Flow to continue execution of the steps which follow the Wait Point.
The relevant Instance ID must also be specified for the API.
For more details on a using Resume Request with a Wait Point, click here.
Invoking the Method Using REST
URL Syntax and Example
http(s)://[host:port/internalPath]/version/[version]/account/[accountID]/navigation/instance/[instanceID]/resume/[Element name]
https://gointeract.io/interact/version/2/account/12345678/navigation/instance/Y8i9QSXa/resume/PackageShipped
Specific URI Fields
URI Field | Data Type | Description |
|---|---|---|
instanceID | string | Identifier for the Flow instance where the Wait Point element is located |
Element name | string | The name of the Wait Point element that is waiting for the Resume message |
HTTP Method
POST
HTTP Headers
Content-Type: application/json;charset=utf-8 Tenant-Id: <account> Application-Key: <public API service application key> Environment-Name: <environment-name>
HTTP Body
This method has no Body.
Expected Responses
Response Scenario | Status Code/Header | Example Message |
|---|---|---|
Success | 200 | — |
Invalid body parameter(s) | 400 | missing or invalid parameter <parameter> |
Invalid security headers | 401 "Unauthenticated-Reason" Header | { "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", } |
Outdated instance/session | 403 | Token expired |
Specified URI parameter does not exist | 404 | <item id or name> was not found |