Entity Management

Entities Metadata

Changed on

This endpoint returns a list of the Entities of a Dataset. Please note that this endpoint only returns metadata of the entities not the data. If you want to get the data of all entities then please refer to OData Dataset Service You can provide ?deleted=true to get only deleted entities.

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

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

Path parameters

projectIdnumber required

The numeric ID of the Project

namestring required

Name of the Dataset

Query parameters

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

uuidstring

The uuid of the Entity that uniquely identifies the Entity.

createdAtstring

ISO date format. The time that the server received the Entity.

updatedAtstring

Timestamp of the last update in ISO date format. null when there is only one version of the Entity.

deletedAtstring

Timestamp of the deletion in ISO date format. null if the Entity is not deleted.

creatorIdnumber

The ID of the Actor (App User, User, or Public Link) that originally created the Entity.

conflict'soft' | 'hard'

Type of the conflict.

hard: baseVersion conflicts and multiple versions update the same property

soft: baseVersion conflicts but data updates are independent

Example response

[
  {
    "uuid": "uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44",
    "createdAt": "2018-04-18T23:42:11.406Z",
    "updatedAt": "2018-04-18T23:42:11.406Z",
    "deletedAt": "2018-04-18T23:42:11.406Z",
    "creatorId": 1,
    "currentVersion": {
      "label": "John (88)",
      "current": true,
      "creatorId": 1,
      "userAgent": "Enketo/3.0.4",
      "version": 2,
      "baseVersion": 1,
      "branchId": "b0e927b6-958a-42f6-8344-1deb37ee9672",
      "trunkVersion": 1,
      "branchBaseVersion": 1
    }
  }
]

Changes