Workflows

<b>BETA:</b> Return milestones for a workflow.

get/sites/{site-identifier}/workflows/instances/{workflow-instance-ID}/milestones

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/workflows/instances/{workflow-instance-ID}/milestones
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

workflow-instance-IDnumber required

The identity that identifies a workflow instance.

Query parameters

tracker-codestring required
Example:ViewSuper_EOY_Close_WIP

The workflow tracker code.

Response

Success

WorkflowInstanceIDinteger
WorkflowInstanceStatus'INCOMPLETE' | 'COMPLETE' | 'CANCELLED'
TrackerCodestring
TrackerNamestring

Example response

{
  "WorkflowInstanceID": 1964,
  "TrackerCode": "ViewSuper_EOY_Close_WIP",
  "TrackerName": "ViewSuper End of Year Close - Work in Progress",
  "Milestones": [
    {
      "Name": "Started",
      "Order": 1,
      "MilestoneDateTime": "2025-02-17T19:12:02.849+07:00",
      "WorkflowInstanceNodeID": 19918
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.