Sign in
Individual Form

Modifying a Form

It is currently possible to modify only one thing about a Form: its state, which governs whether it is available for download onto survey clients and whether it accepts new Submissions. See the state Attribute in the Request documentation to the right to see the possible values and their meanings.

We use PATCH rather than PUT to represent the update operation, so that you only have to supply the properties you wish to change. Anything you do not supply will remain untouched.

patch/v1/projects/{projectId}/forms/{xmlFormId}

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

OK

projectIdnumber required

The id of the project this form belongs to.

xmlFormIdstring required

The id of this form as given in its XForms XML definition

namestring

The friendly name of this form. It is given by the <title> in the XForms XML definition.

versionstring required

The version of this form as given in its XForms XML definition. If no version was specified in the Form, a blank string will be given.

enketoIdstring

If it exists, this is the survey ID of this Form on Enketo at /-. This will be the ID of the published version if it exists, otherwise it will be the draft ID. Only a cookie-authenticated user may access the preview through Enketo.

hashstring required

An MD5 sum automatically computed based on the XForms XML definition. This is required for OpenRosa compliance.

keyIdnumber

If a public encryption key is present on the form, its numeric ID as tracked by Central is given here.

state'open' | 'closing' | 'closed' required

The present lifecycle status of this form. Controls whether it is available for download on survey clients or accepts new submissions.

publishedAtstring

Indicates when a draft has most recently been published for this Form. If this value is null, this Form has never been published yet, and contains only a draft.

createdAtstring required

ISO date format

updatedAtstring

ISO date format

Changes

Changed in 5 of the 54 revisions of this API.26

  • dcd5409827e12See the full diff
    • ●

      removed the request property webformsEnabled

      request-property-removed

    • ●

      removed the optional property webformsEnabled from the response with the 200 status

      response-optional-property-removed

  • 28f47a477c022See the full diff
    • ○

      added the new optional request property webformsEnabled

      new-optional-request-property

    • ○

      added the optional property webformsEnabled to the response with the 200 status

      response-optional-property-added

  • 022694254f0d1See the full diff
    • ○

      api operation id Modifying a Form removed and replaced with modifyForm

      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 modifyForm removed and replaced with Modifying a Form

      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