Draft Form

Getting Draft Form Schema Fields

Changed on

Identical to the same request for the published Form, but will return the fields related to the current Draft version.

get/v1/projects/{projectId}/forms/{xmlFormId}/draft/fields

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/draft/fields
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Query parameters

odataboolean

If set to true, will sanitize field names.

Response

OK

namestring required
pathstring required
typestring required
binaryboolean

Example response

[
  {
    "name": "meta",
    "path": "/meta",
    "type": "structure"
  },
  {
    "name": "instanceID",
    "path": "/meta/instanceID",
    "type": "string"
  },
  {
    "name": "name",
    "path": "/name",
    "type": "string"
  },
  {
    "name": "age",
    "path": "/age",
    "type": "int"
  },
  {
    "name": "photo",
    "path": "/photo",
    "type": "binary",
    "binary": true
  }
]

Changes