Overview

Retrieve virtual field

Retrieve virtual field.

GET/v2/vfields/{id}
Features

Send the token in the Authorization: Bearer API_TOKEN header. See Tokens for which token types this endpoint accepts.

Input1
Authorizationheaderrequired
Sent from your browser straight to the API — never to Docsbook, never stored.
idstring · pathrequired
(path)
Output7
datasetstring
descriptionstring
expressionstring
namestring
typestring
unitstring
idstring
Responses
200VirtualFieldWithId
Example input
curl 'https://api.axiom.co/v2/vfields/{id}' \
  -H 'Authorization: Bearer API_TOKEN'
Example output
{
  "dataset": "string",
  "description": "string",
  "expression": "string",
  "name": "string",
  "type": "string",
  "unit": "string",
  "id": "string"
}

Updated

Was this page helpful?