Create virtual field

POST/v2/vfields

Creates a virtual field on a dataset. Axiom sets its ID to <dataset>.<name>, so the name must be unique within the dataset. expression must be a valid APL expression.

Body

application/json

Property	Type	Description
`dataset`	`string`Required
`description`	`string`
`expression`	`string`Required
`name`	`string`Required	Name of the virtual field. Use letters, digits, underscores, and hyphens, starting and ending with a letter or digit.
`type`	`string`
`unit`	`string`

Request

curl -X POST 'https://api.axiom.co/v2/vfields' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"dataset":"string","description":"string","expression":"string","name":"string","type":"string","unit":"string"}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token RequiredRequest body application/json

Response

200Created virtual field.

application/json

400Missing `dataset`, `name`, or `expression`, an invalid `name`, or an expression that doesn't parse.

403You don't have permission to create virtual fields on the dataset.

404You can't read the dataset.

409A virtual field with this name already exists on the dataset.