Tables API

For tables you are configuring and deploying independently from Config.zip, use the following endpoints to create, update, or delete tables. All of the APIs mentioned below require you to be logged in as an administrator.

Endpoint Index

ActionEndpoint
Upload tablesPUT /tables/
Get table by locatorGET /tables/{locator}
Get table by name as of timestampGET /tables/
Delete tableDELETE /tables/{locator}

Details

Upload tables
PUT /tables/
  • If the tableName and effectiveTimestamp precisely match an existing table with an effective date, that table will be replaced with the new file. The tableName match is case sensitive. The effectiveTimestamp match compares the two timestamps, both of which are scoped to the hour.

  • The effectiveTimestamp property specifies the effective date as a specific hour timestamp in unix epoch format. If minutes, seconds, and/or milliseconds are non-zero, the system will round to the next hour.

  • The effectiveTimestamp property is optional. The default effectiveTimestamp is the hour after the call is made. For example, if the current date and time is October 1st, 2022 11:30:15am PST, the effectiveTimestamp will be set to October 1st, 2022 noon PST (in unix epoch format).

  • If you deploy a .zip file, the name of each .csv file included in the .zip file will be used for the table name. Ensure file names match previous values if you intend to update existing tables using a bulk upload.

See the Independent Table Configuration topic for more information about configuring and deploying tables independently from Config.zip.

TableRequest
required
file string

optional
effectiveTimestamp timestamp
tableName string
Get table by locator
GET /tables/{locator}
    Request:
    NamePositionTypeRequired
    locatorpathstringrequired
    Response: TableResponse
Get table by name as of timestamp
GET /tables/
GroupTableResponse
required
failedTables ErrorTableResponse
successfulTables TableResponse
TableResponse
required
locator string
effectiveTimestamp timestamp
urlExpirationTimestamp timestamp
tableName string
url string
ErrorTableResponse
required
effectiveTimestamp timestamp
errorDetails string
tableName string
Delete table
DELETE /tables/{locator}
    Request:
    NamePositionTypeRequired
    locatorpathstringrequired
    Response: [TableResponse]