vfields

PUT /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.

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
ScopesvirtualFields|update
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/vfields/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

ID of the virtual field in the form <dataset>.<name>

datasetstring required

descriptionstring

expressionstring required

namestring required

Name of the virtual field. Use letters, digits, underscores, and hyphens, starting and ending with a letter or digit.

typestring

unitstring

Updated virtual field.