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.

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|create
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

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

Response

Created virtual field.

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
idstring required

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status