Update virtual field

PUT/v2/vfields/{id}

Replaces all fields of a virtual field. Omitted optional fields are cleared. The ID doesn't change, even if you change name or dataset.

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`	ID of the virtual field in the form `<dataset>.<name>`

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 PUT 'https://api.axiom.co/v2/vfields/ID' \
  -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 Requiredid pathRequiredRequest body application/json

Response

200Updated 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 update virtual fields on the current or new dataset.

404Virtual field not found.