Documentation | Dataset Items › List Dataset Items

Dataset Items

dataset_items

Methods

Batch Create Dataset Items -> { items, object }

post/v5/dataset-items/batch

Batch Create Dataset Items

Get Dataset Item ->

DatasetItem

get/v5/dataset-items/{dataset_item_id}

Get Dataset Item

Delete Dataset Item -> { id, deleted, object }

delete/v5/dataset-items/{dataset_item_id}

Delete Dataset Item

Update Dataset Item ->

DatasetItem

patch/v5/dataset-items/{dataset_item_id}

Update Dataset Item

List Dataset Items -> CursorPage<

DatasetItem

get/v5/dataset-items

List Dataset Items

query Parameters

dataset_id: string

Optional

Optional dataset identifier. Must be provided if a specific version is requested.

ending_before: string

Optional

include_archived: boolean

Optional

limit: number

Optional

(maximum: 1000, minimum: 1, default: 100)

sort_by: string

Optional

sort_order:

Optional

(default: "asc")

"asc"

"desc"

starting_after: string

Optional

version: number

Optional

Optional dataset version. When unset, returns the latest version. Requires a valid dataset_id when set.

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

DatasetItem

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

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

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "content_hash": "content_hash",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "data": {},
      "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"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Domain types

DatasetItem = { id, content_hash, created_at, 7 more... }