Variable

Base definition

{
	"kind": "variable",
	"uri": string,
	"url": string,
	"name": string,
	"type": string("boolean","integer","float","string","date","dateTime","geography"),
}

List definition

In addition to the base definition, any variable resource returned by a list request will contain the following properties:

{
    ...variable.base,
    "isFileId": bool,
    "index": integer,
    "label": string,
}

Get definition

In addition to the list definition, any variable resource returned by a get request will contain the following properties:

{
    ...variable.list
    "description": string,
    "valueLabels": [
        { "value": string, "label": string },
        ...
    ],
}

Documentation

Fields
Base
kind	string The resource type. Will always be "variable".
uri	string The fully qualified reference to this variable, for use in generating calls to this API. For example, /tables/imathews.example:123.test:456/variables/var1
url	string The variable's discoverable url through a web browser interface.
name	string The variable's name. Will always be unique to the variable's table.
type	string The variable's type. Will be one of: "boolean","integer","float","string","date","dateTime"
List
isFileId	boolean Whether the variable contains file_ids, which can be used to uniquely reference and download a File.
index	integer A zero based counter for the variable's ordinality for its table.
label	string A user-provided label for the variable. May be null.
Get
description	string A user-provided description for the variable, typically longer than the label. May be null.
valueLabels	array<object> An array of value labels. Value labels are used to provide mappings between the data content of a cell and human-readable meaning of that content.
valueLabels.value	string The value associated with a given valueLabel
valueLabels.label	string The human-readable label for the associated value.