Related Datasets

Draft Form Dataset Diff

Changed on

This endpoint reflects the change to a Dataset that will go into effect once the form is Published. Like the endpoint above, it lists the Dataset name and Properties, but it also includes the isNew flag on both the Dataset, and on each individual property. This flag is true only if the Dataset/Property is new and is going to be created by publishing the Draft Form.

get/v1/projects/{projectId}/forms/{xmlFormId}/draft/dataset-diff

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

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

This is the standard response

namestring required

The name of the Dataset.

isNewboolean required

Whether or not this Dataset is new (will be created by publishing the Draft Form).

Example response

[
  {
    "name": "people",
    "isNew": true
  }
]

Changes