Defining/Updating the Schema of a Table

Overview

Description	Defining the schema of a table, or updating the existing schema of a table.
Resource Path	`/analytics/tables/{tableName}/schema`
HTTP Method	POST
Request/Response Format	application/json
Authentication	Basic

Parameter description

Parameter	Description
{tableName}	The name of the table for which the schema is defined.

Sample cURL command

POST https://localhost:9443/analytics/tables/testtable/schema{  
   "columns":{  
      "house_id":{  
         "type":"INTEGER",
         "isScoreParam":false,
         "isIndex":false
      },
      "metro_area":{  
         "type":"STRING",
         "isScoreParam":false,
         "isIndex":false
      },
      "state":{  
         "type":"STRING",
         "isScoreParam":false,
         "isIndex":false
      },
      "device_id":{  
         "type":"INTEGER",
         "isScoreParam":false,
         "isIndex":false
      },
      "power_reading":{  
         "type":"FLOAT",
         "isScoreParam":false,
         "isIndex":false
      },
      "is_peak":{  
         "type":"BOOLEAN",
         "isScoreParam":false,
         "isIndex":false
      }
   },
   "primaryKeys":[  
      "house_id",
      "device_id"
   ]
}

Example

https://localhost:9443/analytics/tables/testtable/schema

Sample output

{  
   "status":"success",
   "message":   Successfully set table schema for table:testtable"
}

REST API response

HTTP status code

200, 404

For descriptions of the HTTP status codes, see HTTP Status Codes.