Data Table Actions

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

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

Add Column

Adds a new column to this data table

Method And Url

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

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, dataTable.*, or dataTable.addColumn.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
DATATABLEID ID associated with the data table 575ed78e7ae143cd83dc4aab

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 Column schema. For example, the following would be a valid body for this request:

{
  "name": "myColumn3",
  "dataType": "string",
  "constraint": "optional",
  "defaultValue": "aDefault"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"myColumn3","dataType":"string","constraint":"optional","defaultValue":"aDefault"}' \
    https://api.losant.com/applications/APPLICATION_ID/data-tables/DATA_TABLE_ID/column

Successful Responses

Code Type Description
200 Data Table Updated data table information

Error Responses

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

Delete

Deletes a data table

Method And Url

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

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, dataTable.*, or dataTable.delete.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
DATATABLEID ID associated with the data table 575ed78e7ae143cd83dc4aab

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 DELETE \
    https://api.losant.com/applications/APPLICATION_ID/data-tables/DATA_TABLE_ID

Successful Responses

Code Type Description
200 Success If data table was successfully deleted

Error Responses

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

Get

Retrieves information on a data table

Method And Url

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

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, dataTable.*, or dataTable.get.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
DATATABLEID ID associated with the data table 575ed78e7ae143cd83dc4aab

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/DATA_TABLE_ID

Successful Responses

Code Type Description
200 Data Table Data table information

Error Responses

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

Patch

Updates information about a data table

Method And Url

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

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, dataTable.*, or dataTable.patch.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
DATATABLEID ID associated with the data table 575ed78e7ae143cd83dc4aab

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 Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Data Table"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Data Table"}' \
    https://api.losant.com/applications/APPLICATION_ID/data-tables/DATA_TABLE_ID

Successful Responses

Code Type Description
200 Data Table Updated data table information

Error Responses

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

Remove Column

Removes a column from this data table

Method And Url

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

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, dataTable.*, or dataTable.removeColumn.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
DATATABLEID ID associated with the data table 575ed78e7ae143cd83dc4aab

Request Query Parameters

Name Required Description Default Example
columnName Y Name of the column to remove columnName=myColumnName

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 DELETE \
    https://api.losant.com/applications/APPLICATION_ID/data-tables/DATA_TABLE_ID/column?columnName=myColumnName

Successful Responses

Code Type Description
200 Data Table Updated data table information

Error Responses

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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.