Dataset Management

Listing Datasets

Changed on

The Dataset listing endpoint returns all published Datasets in a Project. If a Draft Form defines a new Dataset, that Dataset will not be included in this list until the Form is published.

The query ?deleted=true can be added to list deleted Datasets with their numeric IDs, which can be used to download a deleted Dataset's Entity data.

get/v1/projects/{projectId}/datasets

Request

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

Path parameters

projectIdnumber required

The numeric ID of the Project

Query parameters

deletedboolean

If set to true, will return only deleted Datasets and their numeric IDs

Response

OK

namestring required

The name of the Dataset

createdAtstring required

ISO date format.

projectIdnumber required

The numerical ID of the Project that the Dataset belongs to.

approvalRequiredboolean

Control whether a Submission should be approved before an Entity is created from it.

ownerOnlyboolean

Legacy flag. If ownerOnly is true, and an Actor only has access to the Dataset CSV file via linked Form Attachments, then only Entities created by the Actor will be downloaded to the OpenRosa client. Superseded by accessFilter when set.

Example response

[
  {
    "name": "people",
    "createdAt": "2018-01-19T23:58:03.395Z",
    "projectId": 1,
    "approvalRequired": true,
    "accessFilter": {
      "type": "property",
      "rules": [
        {
          "datasetProperty": "state",
          "actorProperty": "region"
        }
      ]
    }
  }
]

Changes

  • 2ff2c2a4dfc7Revision changes
    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property ///// to the response with the status (media type: application/json; extended)

  • 2aed27d9e013Revision changes
    • info

      added the new optional query request parameter deleted