Documentation | Dataset Items

API Reference

Dataset Items

DatasetItemsResource

Methods

client.dataset_items.batch_create() ->

DatasetItemBatchCreateResponse

post/v5/dataset-items/batch

Batch Create Dataset Items

client.dataset_items.delete() ->

DatasetItemDeleteResponse

delete/v5/dataset-items/{dataset_item_id}

Delete Dataset Item

client.dataset_items.list() -> SyncCursorPage[

DatasetItem

]

get/v5/dataset-items

List Dataset Items

Parameters

dataset_id: Optional[str]

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

ending_before: Optional[str]

include_archived: Optional[

bool

]

limit: Optional[int]

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

sort_order: Optional[Literal["asc", "desc"]]

(default: "asc")

"asc"

"desc"

starting_after: Optional[str]

version: Optional[int]

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

Returns

DatasetItem

id: str

content_hash: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

data:

object

updated_at:

datetime

(format: date-time)

archived_at: Optional[datetime]

(format: date-time)

dataset_id: Optional[str]

object: Optional[Literal["dataset.item"]]

(default: "dataset.item")

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
page = client.dataset_items.list()
page = page.items[0]
print(page.id)

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",
      "object": "dataset.item"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.dataset_items.retrieve(, ) ->

DatasetItem

get/v5/dataset-items/{dataset_item_id}

Get Dataset Item

client.dataset_items.update(, ) ->

DatasetItem

patch/v5/dataset-items/{dataset_item_id}

Update Dataset Item

Domain types

class DatasetItem: ...