Get a dataset item

client.datasetItems.retrieve(, ?, ?): DatasetItem { id, content_hash, created_at, 7 more }

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.

ParametersExpand Collapse

datasetItemID: string

query: DatasetItemRetrieveParams { version }

version?: number

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

ReturnsExpand Collapse

DatasetItem { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

data: Record<string, unknown>

updated_at: string

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

formatdate-time

archived_at?: string

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

formatdate-time

dataset_id?: string

files?: Record<string, string>

object?: "dataset.item"

Get a dataset item

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const datasetItem = await client.datasetItems.retrieve('dataset_item_id');

console.log(datasetItem.id);

{
  "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"
}