Sign in
Draft Form

Getting Draft Form Schema Fields

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

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

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Getting Draft Form Schema Fields removed and replaced with getDraftFormSchemaFields

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id getDraftFormSchemaFields removed and replaced with Getting Draft Form Schema Fields

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog