Data Manager API
POST Create Table
This request creates a new Data Manager table, defines column names and types (the column names you define must match those found in your data), and defines table and column permissions. A table must be created prior to uploading data.
TIP
Although not a requirement, lowercase column names are recommended. Otherwise, you may encounter errors related to field names when referenced in other requests.
Resource URL
Resource Information
Response Formats | JSON, XML |
Authentication | Yes (Requires Key) |
Rate Limited | Yes |
Request Parameters
Request Parameter | Description | Required |
---|---|---|
key String | A unique key to authorize use of the API. | Yes |
inFormat String | Specifies the format of the json/xml parameter. Must be one of the following, if supplied:
json | No |
outFormat String | Specifies the format of the response. Must be one of the following, if supplied:
json | No |
Body Parameters
Name | Description | Required |
---|---|---|
clientId String | This is the ClientID associated with the API Key. | Yes |
password String | This is the registry password associated with the API Key. | Yes |
tableName String | This is the complete name of the table. Table names for legacy users must be prefixed with mqap.[CLIENT_ID] Table names for new users must be prefixed with mqap.[APPLICATION_KEY] | Yes |
notes String | Optional notes about the table, to be stored in Data Manager. | No |
friendlyName String | Optional 'friendly,' easy-to-read name that does not include the ClientID or mqap prefix. | No |
isPublic Boolean | This determines if the table is publicly accessible; either true or false .The default value is false . | No |
columns[] String[] | This parameter specifies the columns in the table. A column name and type are required for each column in the table;isPublic (permissions) setting is optional. | Yes |
Example Request
POST https://www.mapquestapi.com/datamanager/v2/create-table?key=KEY&inFormat=json
Example Request Body
JSON
{
"clientId": "CLIENT_ID",
"password": "REGISTRY_PASSWORD",
"tableName": "mqap.TABLENAME",
"friendlyName": "friendly_name",
"notes": "notes",
"columns": [
{
"name": "NAME",
"type": "TYPE",
"isPublic": false
}
...
],
"isPublic": false
}
XML
<datamanager>
<clientId>CLIENT_ID</clientId>
<password>REGISTRY_PASSWORD</password>
<tableName>TABLENAME</tableName>
<friendlyName>friendly_name</friendlyName>
<notes>notes</notes>
<columns>
<column>
<name>NAME</name>
<type>TYPE</type>
<isPublic>false</isPublic>
</column>
...
</columns>
<isPublic>false</isPublic>
</datamanager>
Example Response
JSON
{
"tableName": "mqap.TABLENAME",
"columns": [
{
"name": "...",
"type": "...",
"isPublic": "..."
}
],
"isPublic": "..."
}
XML
<tableName>mqap.TABLENAME</tableName>
<columns>
<column>
<name>...</name>
<type>...</type>
<isPublic>...</isPublic>
</column>
</columns>
<isPublic> ... </isPublic>