Table

Base definition

1
{
2
"kind": "table",
3
"uri": string,
4
"referenceId": integer,
5
"url": string,
6
"qualifiedReference": string,
7
"name": string,
8
"isSample": boolean
9
}
Copied!

List definition

In addition to the base definition, any dataset resource returned by a list request will contain the following properties:
1
{
2
"createdAt": integer,
3
"updatedAt": integer,
4
"description": string,
5
"numRows": integer,
6
"numBytes": integer,
7
"uploadMergeStrategy": string("append"|"replace")
8
"variableCount": integer
9
}
10
Copied!

Get definition

In addition to the list definition, any dataset resource returned by a get request will contain the following properties:
1
{
2
"canDownload": boolean,
3
"entity": {
4
"name": string,
5
}
6
"publicAccessLevel": string("none"|"overview"|"metadata"|"data"),
7
"scopedAccessLevel": string("overview"|"metadata"|"data"),
8
"accessLevel": string("overview"|"metadata"|"data")
9
}
10
Copied!

Documentation

Fields
Base
kind
string
The resource type. Will always be "table".
uri
string
The fully qualified reference to this table, for use in generating calls to this API.
For example, /tables/imathews.ian_s_dataset:123:v1_0.test_table:3
referenceId
integer
A persistent identifier for this table. Will always be unique to a table's containing dataset or project. If the table belongs to a dataset, this identifier will be consistent across versions.
qualifiedReference
string
The fully qualified reference to this table, for use (e.g.) in a SQL query.
For example, imathews.ian_s_dataset:123:v1_0.test_table:3
url
string
The table's discoverable url.
name
string
The table's user-provided name.
isSample
boolean
Whether or not the table represents a sample of another table. Will always be false for tables that belong to a project.
uploadMergeStrategy
string
Only present on tables belonging to a dataset. Defines whether uploads in subsequent versions replace or append to the previous version's content.
Get
createdAt
integer
When the table was created. Stored as milliseconds since the epoch (1970-01-01).
updatedAt
integer
When the table was updated. Stored as milliseconds since the epoch (1970-01-01).
description
string
A user-provided description of the table. May be null.
numRows
integer
The number of rows in the table.
numBytes
integer
The number of bytes stored in the table.
variableCount
integer
The number of variables in the table.
canDownload
boolean
Whether or not the data in the table can be exported to the current client environment. Will be false if in violation of at least one export restriction, or if scopedAccessLevel < 'data'
If false, all calls that return tableRows or exports will fail with a 403 status code.
entity
object
The user provided "entity" of the table, defining what each row in the table represents. May be null.
entity.name
object
The name of the entity.
publicAccessLevel
string
The accessLevel of the table to unauthenticated users. Will be one of: "none", "overview", "metadata", "data"
scopedAccessLevel
string
The accessLevel of the table for this request, taking into account the access token being used. This will never be higher than the requesting user's access level. Will be one of: "none", "overview", "metadata", "data"
accessLevel
string
The accessLevel of the table for the current user, ignoring the access token being used. Will be one of: "none", "overview", "metadata", "data"
source
object
The source resource for this table. Will either be a project or dataset resource.
sampleSourceTable
object
If isSample is true, will contain the table from which the sample was generated. Will be a table.base resource.
Last modified 6mo ago