Workflows

<b>BETA:</b> Start a workflow instance.

post/sites/{site-identifier}/workflows/instances/start

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/start
  • 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: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

Query parameters

FundIdentifierstring

The Fund identifier.

Request body

TemplateCodestring
FundIdentifierstring
MemberIdentifierstring

Example request

{
  "TemplateCode": "Setup_New_Fund",
  "FundIdentifier": "FUND001",
  "MemberIdentifier": "e0c21331-6e4d-d18f-8a14-3a410c693640",
  "Parameters": [
    {
      "Name": "EffectiveDate",
      "Value": "2023-10-25"
    }
  ]
}

Response

Accepted

WorkflowInstanceIDnumber

Example response

{
  "WorkflowInstanceID": 333
}

Changes

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