Draft Form

Publishing a Draft Form

Changed on

This will publish your current Draft Form and make it the active Form definition (and attachments).

If your Draft version conflicts with an older version of the Form, you will get an error.

If you wish for the version to be set on your behalf as part of the publish operation, you can provide the new version string as a querystring parameter ?version.

Once the Draft is published, there will no longer be a Draft version of the form.

Starting with Version 2022.3, publishing a Draft Form that defines a Dataset schema will also publish the Dataset. It will generate dataset.create event in Audit logs and make the Dataset available in Datasets APIs. If the Dataset is already published and the Form adds new properties then dataset.update event will be generated.

post/v1/projects/{projectId}/forms/{xmlFormId}/draft/publish

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/publish
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Query parameters

versionstring

The version to be associated with the Draft once it's published.

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes