Tables API

For tables which 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

Action	Endpoint
Upload tables	PUT /tables/
Get table by locator	GET /tables/{locator}
Get tables	GET /tables/
Delete table	DELETE /tables/{locator}

Details

Upload tables

PUT /tables/

Request:

Name	Position	Type	Required
TableRequest	body	TableRequest	required

Response: GroupTableResponse

• 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 the tableName and effectiveTimestamp precisely match an existing table with an effective date, and the table contents has changed, 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.

• 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.

• If the TableRequest includes an exact duplicate of a previously uploaded table, the application will continue using the existing table rather than recreating it. A table is considered an exact duplicate if all of the following are unchanged:

  • Table name

  • Effective date

  • Content

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:

Name	Position	Type	Required
locator	path	string	required

Response: TableResponse

Get tables

GET /tables/

Request:

Name	Position	Type	Required
effectiveTimestamp	formdata	timestamp	optional
matchMode	formdata	string startsWith | contains | equals | all	optional
tableName	formdata	string	optional

Response: [TableResponse]

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:

Name	Position	Type	Required
locator	path	string	required

Response: [TableResponse]