Global

Create a form definition structure for the query template.

post/sites/{site-identifier}/query-templates/{query-template-guid}/form

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/query-templates/{query-template-guid}/form
  • 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-template-guidstring required
Example:e3c76443-8126-05b6-9914-c88c1ce84725

The GUID that identifies a specified query template

Request body

versioninteger required

Version of the form configuration

titlestring

Title of the form

descriptionstring

Description of the form

Example request

{
  "version": 1,
  "sections": [
    {
      "order": 1,
      "elements": [
        {
          "elementType": "message",
          "severity": "warning",
          "content": "This is a warning message that we might want to display for some reason."
        }
      ]
    }
  ]
}

Response

Success

Changes

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