Workflows
<b>BETA:</b> Return workflows instances
get/sites/{site-identifier}/workflows/instances
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
- 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
Query parameters
FundIdentifierstring
The Fund identifier.
status'INCOMPLETE' | 'COMPLETE' | 'CANCELLED'
Workflow instance status
task-status'INCOMPLETE' | 'COMPLETE' | 'CANCELLED' | 'WAITING'
Workflow Task instance status
template-codestring
Workflow template code
workflow-template-idstring
Workflow template identifier
start-datestring
The start date with format (yyyy-MM-dd)
end-datestring
The end date with format (yyyy-MM-dd)
max-resultnumber
Example:800
The maximum number of query results is limited per search. Default value is 800.
query-type'Workflow' | 'Task' | 'Queues'
Type of returned instances.
owner'ALL-TEAMS' | 'MY-TEAM' | 'MINE'
Return instances from all owner teams
entity-type'FUND' | 'PORTFOLIO'
Return instances with entity type is Fund or Portfolio or All
teamstring
Example:SM_TEAM
The query team group
date-search-type'started' | 'completed'
Example:started
Type of date to search.
list-identifierstring
Example:f40ed4cc-00dd-c798-d314-7893a8a948e6
The GUID or code of the fund list.
The json object representing the fund list definition.
Response
Success
Example response
[
{
"WorkflowInstanceID": 33,
"WorkflowTemplateID": 10,
"WorkflowTemplateCode": "Setup_New_Fund",
"WorkflowTemplateName": "Setup New Fund",
"WorkflowTemplateEntityType": "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,
"NodeStartDateTime": "2023-04-23T15:55:52.679+07:00",
"OwnerUserCode": "John Citizen",
"OwnerUserName": "John Citizen",
"EntityGUID": "e0c21331-6e4d-d18f-8a14-3a410c693640",
"NoteText": "Note text",
"ParameterDisplayString": "2019",
"Documents": [
{
"DocumentGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640"
}
]
}
]Changes
No recorded changes to this operation across all 1 revision of this API.