FOfonoa
Onboarding

Get custom document template render data schema

Returns the JSON Schema describing the DocumentTemplateRenderDataV1 Handlebars context object. Used to power template editor autocomplete and field validation. Response is cacheable.

get/onboarding/v2/templates/schema

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Response

Ok - custom document template schema metadata returned in the standard API envelope.

messagestring
statusstring

Example response

{
  "data": {
    "root_type": "DocumentTemplateRenderDataV1",
    "schema_version": "document_template_render_data_v1"
  },
  "errors": [
    {
      "type": "validation"
    }
  ],
  "status": "success"
}

Changes

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