Skip to main content
PUT
/
datasets
Create new Dataset
curl --request PUT \
  --url https://api.serial.io/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "TEXT",
  "name": "<string>",
  "process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "usl": 123,
  "lsl": 123,
  "unit": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data_type": "PARAMETRIC_QUANTITATIVE",
  "created_at": "2023-11-07T05:31:56Z",
  "process_revision": 123,
  "order": 123,
  "lsl": 123,
  "usl": 123,
  "unit": "<string>",
  "child_component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_value": true,
  "is_active": true,
  "values": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Body

application/json
​
type
enum<string>
required

Indicates what type of dataset you would like to create.

Available options:
TEXT,
NUMERICAL,
BOOLEAN,
FILE,
IMAGE,
DATETIME
​
name
string
required

User-facing name for the dataset.

​
process_id
string<uuid>
required

Process id that the dataset will be associated with.

​
usl
number

FOR NUMERICAL DATA. Upper spec limit for the dataset

​
lsl
number

FOR NUMERICAL DATA. Lower spec limit for the dataset

​
unit
string

FOR NUMERICAL DATA. Unit that should be displayed for the dataset

Response

OK

​
id
string<uuid>
required

Database id for the dataset

​
name
string
required

User facing name for the dataset

​
process_id
string<uuid>
required

Process id associated with the dataset

​
data_type
enum<string>
required
Available options:
PARAMETRIC_QUANTITATIVE,
PARAMETRIC_QUALITATIVE,
CHECKBOX,
LINK,
IMAGE,
FILE,
UID
​
created_at
string<date-time>
required
​
process_revision
number
required
​
order
number

Order in which the dataset shows up relative to others

​
lsl
number<float>
​
usl
number<float>
​
unit
string
​
child_component_id
string<uuid>
​
expected_value
any
Available options:
,
​
is_active
boolean
​
values
string[]

Used for property datasets, is a LRU cache of used values