Related Datasets

Published Form Related Datasets

Changed on

This endpoint lists the name and Properties of a Dataset that are affected by a Form. The list of Properties includes all published Properties on that Dataset, but each property has the inForm flag to note whether or not it will be filled in by that form.

get/v1/projects/{projectId}/forms/{xmlFormId}/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}/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.

Example response

[
  {
    "name": "people"
  }
]

Changes

  • 022694254f0dRevision changes
    • info

      api operation id Published Form Related Datasets removed and replaced with publishedFormRelatedDatasets

  • e8c2858fd4ebRevision changes
    • info

      api operation id publishedFormRelatedDatasets removed and replaced with Published Form Related Datasets