Skip to main content
POST
/
v3
/
orgs
/
{org_id}
/
data-capture
/
forms
/
{form_id}
/
schemas
Create a new form schema
curl --request POST \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/data-capture/forms/{form_id}/schemas \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "model": {},
      "view": {
        "title": {
          "submit": [
            {
              "language": "<string>",
              "value": "<string>"
            }
          ],
          "view": [
            {
              "language": "<string>",
              "value": "<string>"
            }
          ]
        },
        "sections": [
          {
            "title": {
              "view": [
                {
                  "language": "<string>",
                  "value": "<string>"
                }
              ]
            },
            "description": {
              "view": [
                {
                  "language": "<string>",
                  "value": "<string>"
                }
              ]
            },
            "rows": [
              {
                "title": {},
                "description": {},
                "span": 6,
                "columns": [
                  {
                    "span": 6,
                    "order": 1,
                    "title": {},
                    "description": {},
                    "blocks": [
                      {}
                    ]
                  }
                ],
                "order": 1
              }
            ],
            "order": 1
          }
        ]
      }
    },
    "relationships": {
      "organisation": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "form": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "author": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "latest": "<string>"
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "model": {},
      "view": {
        "title": "<string>",
        "sections": [
          {
            "title": "<string>",
            "description": "<string>",
            "rows": [
              {
                "title": "<string>",
                "description": "<string>",
                "span": 6,
                "columns": [
                  {
                    "span": 6,
                    "order": 1,
                    "blocks": [
                      {}
                    ],
                    "title": "<string>",
                    "description": "<string>"
                  }
                ],
                "order": 1
              }
            ],
            "order": 1,
            "conditions": {}
          }
        ]
      },
      "version": "<string>"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "latest": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": "<string>"
      }
    },
    "relationships": {
      "form": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

form_id
string<uuid>
required

The unique identifier for the form.

Body

application/vnd.api+json

The form schema to create.

data
object
required

Response

Create a form schema.

JSON API response object

data
object
required

A form schema

jsonapi
object
required