Entity Management

Entities Geodata

Changed on

This endpoint returns the geometry-interpretable value of the geometry attribute of Entities of an entity dataset, in GeoJSON format. No particular ordering is implied.

You can use an OData-style $filter query to filter the entities.

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

Request

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

Path parameters

projectIdnumber required

The numeric ID of the Project

namestring required

Name of the Dataset

Query parameters

limitnumber

Impose a limit on the number of entities to extract geoinformation from.

$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

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.

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

object required

Value of the geometry attribute (if geometry-interpretable) of Entities of an entity dataset, in GeoJSON format.

Each entity is represented as a GeoJSON feature.

Changes

  • d4f5ba77f644Revision changes
    • info

      added the new optional query request parameter viewAs

  • 213e7cfed966Revision changes
    • info

      added the new optional query request parameter $filter

    • info

      added the new optional query request parameter $search

    • info

      added the new optional query request parameter limit