Workflows
<b>BETA:</b> Return a workflow instance.
get/sites/{site-identifier}/workflows/instances/{workflow-instance-ID}
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}
- 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.
Response
Success
Example response
{
"WorkflowInstanceID": 33,
"WorkflowTemplateID": 10,
"WorkflowTemplateCode": "Setup_New_Fund",
"WorkflowTemplateName": "Setup New Fund",
"WorkflowTemplateVersionID": 1,
"FundCode": "000001",
"FundGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
"FundName": "First Fund",
"CreateDateTime": "2023-03-24T15:55:52.679+07:00",
"ExpectedEndDateTime": "2023-04-24T15:55:52.679+07:00",
"StartDateTime": "2023-03-24T16:55:52.679+07:00",
"EndDateTime": "2023-04-23T15:55:52.679+07:00",
"CurrentNodeID": 433,
"OwnerUserCode": "John Citizen",
"OwnerUserName": "John Citizen",
"EntityGUID": "e0c21331-6e4d-d18f-8a14-3a410c693640",
"Documents": [
{
"DocumentGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640"
}
],
"Parameters": [
{
"Name": "FinancialYear",
"Value": "2023"
}
],
"Nodes": [
{
"WorkflowInstanceNodeID": 344,
"WorkflowTemplateNodeID": 144,
"NodeCode": "906",
"NodeName": "Start",
"StartDateTime": "2023-03-24T16:55:52.679+07:00",
"EndDateTime": "2023-04-23T15:55:52.679+07:00",
"ExpectedEndDateTime": "2023-04-24T15:55:52.679+07:00",
"OwnerUserCode": "John.Citizen",
"OwnerUserName": "John Citizen",
"OwnerUserGroupCode": "BUSINESS",
"OwnerUserGroupName": "Business",
"OwnerRoleCode": "TL",
"OwnerRoleName": "Team Leader",
"WorkflowInstanceID": 33,
"NodeSequence": 1,
"IndentLevel": 1,
"NodeAnswerValue": "Yes|Maybe",
"SchedulerJobGUID": "s0c21331-6e4d-d18f-8a14-3a410c693640",
"SubWorkflowInstanceID": 53,
"IterationNumber": 1,
"NoteText": "Comment note for the task",
"NoteUserCode": "hh",
"NoteDateTime": "2025-02-11T17:31:32.638+07:00",
"Permissions": [
"complete",
"redo"
]
}
],
"Arcs": [
{
"SourceWorkflowInstanceNodeID": 314,
"TargetWorkflowInstanceNodeID": 414
}
],
"Dependencies": [
{
"WorkflowInstanceNodeID": 314,
"DependsOnWorkflowInstanceNodeID": 414
}
],
"SubWorkflowInstances": [
{
"WorkflowInstanceID": 33,
"WorkflowTemplateID": 11,
"WorkflowTemplateCode": "Setup_New_Fund",
"WorkflowTemplateName": "Setup New Fund",
"WorkflowTemplateVersionID": 1,
"FundCode": "000001",
"FundGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
"FundName": "First Fund",
"CreateDateTime": "2023-03-24T15:55:52.679+07:00",
"ExpectedEndDateTime": "2023-04-24T15:55:52.679+07:00",
"StartDateTime": "2023-03-24T16:55:52.679+07:00",
"EndDateTime": "2023-04-23T15:55:52.679+07:00",
"CurrentNodeID": 433,
"OwnerUserCode": "John Citizen",
"OwnerUserName": "John Citizen",
"EntityGUID": "e0c21331-6e4d-d18f-8a14-3a410c693640",
"Parameters": [
{
"Name": "FinancialYear",
"Value": "2023"
}
]
}
],
"Context": [
{
"ContextName": "FundCode",
"ContextType": "CHARACTER",
"ContextValue": "SMSF"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.