Provide the status of a specific recipient in a workflow.
Get
/API/Rest/Workflows/Status
workflowName
emailAddress
ViewWorkflow
No Permission
Too many API calls
Database error
Unknown error
An array of structures with the following fields:
| EnteredWorkflow | The date when the recipient entered the workflow |
| LastActivity | The date of the last node entered |
| LastNodeType | The last node the recipient passed through |
| MemberInstance | For workflows that support duplicate recipients, the instance for this recipient |
[{"EnteredWorkflow":"02-01-2019 6:35pm","LastActivity":"02-02-2019","LastNodeType":"Termination","MemberInstance":1}]
Get the status for one recipient.
using System;
using System.Net.Http;
string url = "https://example.com/API/Rest/Workflows/Status?accountName=acme&login=ApiUser&workflowName=Gift%20Cards&emailAddress=joe@example.com";
// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, url))
{
request.Headers.Add("Password", "YOUR_PASSWORD");
using (HttpResponseMessage response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
}
# encoding: utf-8
require 'rest-client'
require 'json'
url = 'https://example.com/API/Rest/Workflows/Status?accountName=acme&login=ApiUser&workflowName=Gift%20Cards&emailAddress=joe@example.com'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response
import requests
url = "https://example.com/API/Rest/Workflows/Status?accountName=acme&login=ApiUser&workflowName=Gift%20Cards&emailAddress=joe@example.com"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
print(resp.text)
https://example.com/API/Rest/Workflows/Status?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&workflowName=Gift%20Cards&emailAddress=joe@example.com