Sign in
Dataset Management

Download Dataset

Datasets (collections of Entities) can be used as Attachments in other Forms, but they can also be downloaded directly as a CSV file.

The CSV format closely matches the OData Dataset Service format, with columns for system properties such as __id (the Entity UUID), __createdAt, __creatorName, etc., the Entity Label label, and the Dataset/Entity Properties themselves. If any Property for an given Entity is blank (e.g. it was not captured by that Form or was left blank), that field of the CSV is blank.

The $filter querystring parameter can be used to filter on system-level properties, similar to how filtering in the OData Dataset Service works.

The $search querystring parameter can be used to search entity data (user-defined properties) and the label field, using the same search behavior as the OData Dataset Service.

This endpoint supports ETag header, which can be used to avoid downloading the same content more than once. When an API consumer calls this endpoint, the endpoint returns a value in the ETag header. If you pass that value in the If-None-Match header of a subsequent request, then if the Dataset has not been changed since the previous request, you will receive 304 Not Modified response; otherwise you'll get the new data.

get/v1/projects/{projectId}/datasets/{name}/entities.csv

Path parameters

projectIdnumber required

The numeric ID of the Project

namestring required

Name of the Dataset

Query parameters

$filterstring

If provided, will filter responses to those matching the query. Only system-level Entity fields are available to reference. The operators lt, le, eq, neq, ge, gt, not, and, and or are supported, and the built-in functions now, year, month, day, hour, minute, second.

$searchstring

If provided, will search entity data (user-defined properties) and the label field.

viewAsnumber

If provided, filters the response to only the Entities that the specified Actor would be able to see, based on the Dataset's access filter (ownerOnly or property rules). The value must be a numeric Actor ID.

This is intended for previewing what a particular App User or Public Link would receive when downloading the Dataset via a linked Form Attachment.

Response

OK

Changes

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