Get a dataset item

GET/v5/dataset-items/{dataset_item_id}

Retrieve a single dataset item by its identifier.

The lookup is scoped to the caller’s account. By default the current (latest) version of the item is returned; passing version returns the item as it existed at that dataset version, which allows reading an item that was later updated or soft-deleted.

Path ParametersExpand Collapse

dataset_item_id: string

Query ParametersExpand Collapse

version: optional number

Optional dataset version. When unset, returns the latest version.

ReturnsExpand Collapse

DatasetItem object { id, content_hash, created_at, 7 more }

id: string

The unique identifier of the entity.

content_hash: string

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

data: map[unknown]

updated_at: string

The date and time when the entity was last updated in ISO format.

formatdate-time

archived_at: optional string

The date and time when the entity was archived in ISO format.

formatdate-time

dataset_id: optional string

files: optional map[string]

object: optional "dataset.item"

Get a dataset item

curl https://api.egp.scale.com/v5/dataset-items/$DATASET_ITEM_ID \
    -H "x-api-key: $SGP_API_KEY"

{
  "id": "id",
  "content_hash": "content_hash",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "data": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "dataset_id": "dataset_id",
  "files": {
    "foo": "string"
  },
  "object": "dataset.item"
}

Returns Examples

{
  "id": "id",
  "content_hash": "content_hash",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "data": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "dataset_id": "dataset_id",
  "files": {
    "foo": "string"
  },
  "object": "dataset.item"
}