Individual Form

Restoring a Form

Changed on

(introduced: version 1.4)

Deleted forms can now be restored (as long as they have been in the Trash less than 30 days and have not been purged). However, a deleted Form with the same xmlFormId as an active Form cannot be restored while that other Form is active.

A Form also cannot be restored if a related Dataset has been deleted or if a Dataset property that the Form wrote to has been deleted since the Form was deleted. In that case, a 409 is returned.

This /restore URL uses the numeric ID of the Form (now returned by the /forms?deleted=true endpoint) rather than the xmlFormId to unambigously restore. Note that the numeric ID of a Form is not returned by default on the Form list and is only returned when listing deleted Forms.

post/v1/projects/{projectId}/forms/{id}/restore

Request

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

Path parameters

projectIdnumber required

The numeric ID of the Project

idstring required

The ID (not xmlFormId) of the Form

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes