Skip to content
sgp
API Reference
Datasets

Create a dataset

POST/v5/datasets

Create a dataset and populate it with its initial items in a single call.

Use this when the dataset does not exist yet: it creates the dataset and seeds it with the items you provide. To add more items to a dataset that already exists, use POST /v5/dataset-items/batch instead. A name is required, and the request must include at least one item in data; the optional files field associates files with the created items. The provided items are inserted as dataset items as a side effect of creation, and any tags are attached to the dataset. The returned dataset is at version 1.

Body ParametersJSONExpand Collapse
data: array of map[unknown]

Items to be included in the dataset

name: string
description: optional string
files: optional array of map[string]

Files to be associated to the dataset

tags: optional array of string

The tags associated with the entity

ReturnsExpand Collapse
Dataset object { id, created_at, created_by, 6 more }
id: string

The unique identifier of the entity.

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"
current_version_num: number
name: string
tags: array of string

The tags associated with the entity

archived_at: optional string

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

formatdate-time
description: optional string
object: optional "dataset"

Create a dataset

curl https://api.egp.scale.com/v5/datasets \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "data": [
            {
              "foo": "bar"
            }
          ],
          "name": "name"
        }'
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "current_version_num": 0,
  "name": "name",
  "tags": [
    "string"
  ],
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "dataset"
}
Returns Examples
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "current_version_num": 0,
  "name": "name",
  "tags": [
    "string"
  ],
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "dataset"
}