Workflows

<b>BETA:</b> Return a workflow template detail

get/sites/{site-identifier}/workflows/templates/{workflow-template-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/templates/{workflow-template-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

Query parameters

workflow-template-idstring

Workflow template identifier

Response

Success

TemplateGUIDstring guid
TemplateCodestring
TemplateNamestring
EntityType'ACCOUNT' | 'ADVISER' | 'BANK' | 'BUSINESS' | 'EMPLOYER' | 'FUND' | 'FUND-LIST' | 'FUND-MEMBER' | 'IDENTITY' | 'MASTER' | 'PORTFOLIO' | 'PORTFOLIO-MEMBER'
DefaultOwnershipType'CREATOR' | 'FUND-ACCOUNTANT' | 'FUND-CSM' | 'FUND-CSM-TL' | 'FUND-OWNER' | 'FUND-QUEUE' | 'GROUP' | 'ROLE' | 'SYSTEM' | 'USER'
Launchableboolean
LatestWorkflowTemplateVersionIDnumber
LatestReleasedWorkflowTemplateVersionIDnumber
SystemDefinedboolean
ParameterTypestring

Example response

{
  "TemplateGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
  "TemplateCode": "End_of_Year_Close",
  "TemplateName": "End of Year Close",
  "Launchable": true,
  "LatestWorkflowTemplateVersionID": 33,
  "LatestReleasedWorkflowTemplateVersionID": 30,
  "SystemDefined": true,
  "ParameterType": "EffectiveDate",
  "Versions": [
    {
      "TemplateVersionID": 12,
      "VersionNumber": 1,
      "Released": true,
      "CreatedDateTime": "2020-03-24T15:55:52.679+07:00"
    }
  ]
}

Changes

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