Create dataset fields
Send a field name and JSON Schema, or a fields array for several fields. Returns the created field or fields. Names and schemas cannot be changed through this API.
Authorizations
Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.
Path Parameters
Dataset ID with prefix ds..
^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Body
Response
Created field, or created fields when the request listed several
- Option 1
- Option 2
A field of a dataset.
Time the field was created, as an ISO 8601 timestamp.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Description of the field, or null when none is set.
Dataset field ID with prefix df..
^df\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$True when this field is excluded from pipeline input bindings. The field is still included in dataset field responses.
JSON Schema that values in this field must satisfy.
Name of the dataset field.
Operations currently writing to this field. A split or slice that reads the field is rejected while a blocking operation runs.
A background operation writing into a dataset field.
- Option 1
- Option 2
- Option 3
Set when this is a split field: each row's value names its part.