Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Data Tables

Update Mappings for a Data Table

Lists all of the dimension mappings from a data table's dimensions to a company's dimensions in Cube. These mappings are used when running an import against source data.

post/data-tables/{data_table_id}/mappings

Path parameters

data_table_idstring uuid required

The ID of the data table the mappings are for

Headers

X-Company-IDstring required

Associates request with company

Request body

automappedboolean
created_atstring date-time required
modified_atstring date-time required
sign_flipboolean

Response

The results from updating the mappings for the data table. Mapping updates are handled in a partial manner meaning successful mapping changes will be updated accordingly and failed ones will report back why they failed. Furthermore, altered vs deleted mappings will also be shown in the response.

Mappings can either be done in realtime or backgrounded depending on how much data needs to be moved for the mapping update.

`errors` - A list of error strings for any mappings that failed.

`altered` - A list of any mappings that were altered with this update.

`code` - Will be `MAPPING_BACKGROUNDED` or `MAPPING_COMPLETED` depending on if the update is being handled via a background worker task.
dimension_idinteger nullable required
source_dimension_idinteger required
automappedboolean
created_atstring date-time required
modified_atstring date-time required