Tasks

Return the form that's attached to the query.

get/sites/{site-identifier}/queries/{query-identifier}/form

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/queries/{query-identifier}/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: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

query-identifierstring required

The GUID that identifies a specific Task Query

Response

Success

versioninteger required

Version of the form configuration

titlestring

Title of the form

descriptionstring

Description of the form

Example response

{
  "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."
        }
      ]
    }
  ]
}

Changes

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