Data Tables Actions

https://api.losant.com/applications/APPLICATION_ID/data-tables

Below are the various requests that can be performed against the Data Tables resource, as well as the expected parameters and the potential responses.

Get

Returns the data tables for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/data-tables

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTables.*, or dataTables.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*table

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/data-tables

Successful Responses

Code	Type	Description
200	Data Tables	Collection of data tables

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Post

Create a new data table for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/data-tables

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, dataTables.*, or dataTables.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Data Table Post schema. For example, the following would be a valid body for this request:

{
  "name": "My Data Table",
  "columns": [
    {
      "name": "myColumn1",
      "dataType": "string",
      "constraint": "unique"
    },
    {
      "name": "myColumn2",
      "dataType": "number",
      "constraint": "optional"
    }
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My Data Table","columns":[{"name":"myColumn1","dataType":"string","constraint":"unique"},{"name":"myColumn2","dataType":"number","constraint":"optional"}]}' \
    https://api.losant.com/applications/APPLICATION_ID/data-tables

Successful Responses

Code	Type	Description
201	Data Table	Successfully created data table

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Schemas

Data Table

Schema for a single Data Table

Data Table Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
id:{} 2 keys
▶
dataTableId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
columns:{} 3 keys

Data Table Example

▶
root:{} 7 keys
id:"596e6ce831761df4231708f1"
dataTableId:"596e6ce831761df4231708f1"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Data Table"
▶
columns:[] 2 items

Data Table Post

Schema for the body of a Data Table creation request

Data Table Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
columns:{} 3 keys
▶
required:[] 1 item
additionalProperties:false

Data Table Post Example

▶
root:{} 2 keys
name:"My Data Table"
▶
columns:[] 2 items

Data Tables

Schema for a collection of Data Tables

Data Tables Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys

Data Tables Example

▶
root:{} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"