Modal forms

Get form metadata

Note: The path is a placeholder. The actual path is determined by the configuration of the app component.

Get the metadata from the app server to render a form. <br> <br> <a href="https://d3ki9tyy5l5ruj.cloudfront.net/obj/65a45303b5fb79a69a322593627e3b9521c68ba1/ac-form-metadata.png"> <img src="https://d3ki9tyy5l5ruj.cloudfront.net/obj/65a45303b5fb79a69a322593627e3b9521c68ba1/ac-form-metadata.png" alt="App components form metadata request flow"/> </a>

get/form_metadata_url_path_placeholder

Request

  • Base URL
    {siteUrl}
  • URL
    {siteUrl}/form_metadata_url_path_placeholder
  • Auth
    none declared

Response

Successfully retrieved the metadata for a single form.

template'form_metadata_v0' required

The interface name and version of a distinct form UI layout. A template is directly associated with a particular metadata schema.

Example response

{
  "template": "form_metadata_v0",
  "metadata": {
    "title": "Create New Issue",
    "on_submit_callback": "https://www.example.com/on_submit",
    "on_change_callback": "https://www.example.com/on_change"
  }
}

Changes

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