Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Entity Management

Getting Entity Details

This returns the metadata and current data of an Entity.

The data and label of an Entity are found in the currentVersion object under data and label respectively. The currentVersion object also contains version-specific metadata fields such as version, baseVersion, details about conflicts that version introduced, etc. See the versions endpoint for more details.

The Entity also contains top-level system metadata such as uuid, createdAt and updatedAt timestamps, and creatorId (or full creator if extended metadata is requested).

Conflicts

An Entity's metadata also has a conflict field, which indicates the current conflict status of the Entity. The value of a conflict can either be:

  • null. The Entity does not have conflicting versions.
  • soft. The Entity has a version that was based on a version other than the version immediately prior to it. (The specified baseVerson was not the latest version on the server.)
  • hard. The Entity has a version that was based on a version other than the version immediately prior to it. Further, that version updated the same property as another update.

If an Entity has a conflict, it can be marked as resolved. After that, the conflict field will be null until a new conflicting version is received.

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

Path parameters

projectIdnumber required

The numeric ID of the Project

namestring required

Name of the Dataset

uuidstring required

UUID of the Entity

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,
      "data": {
        "firstName": "John",
        "age": "88"
      },
      "dataReceived": {
        "firstName": "John",
        "age": "88",
        "label": "John (88)"
      }
    }
  }
]