CUcubesoftware
Planning Table

Start an import for a connected planning table

Changed on

Enqueue a background import that pulls the latest source data into this table. Returns 409 with code TABLE_IMPORT_IN_PROGRESS when an import is already running. Failed imports expose error_code on the import run.

post/tables/{table_pk}/imports

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    OAuth 2
    Authorization code: https://portal.cubesoftware.com/o/authorize/
    Token URL: https://api.cubesoftware.com/o/token/

Path parameters

table_pkstring required

Headers

X-Company-IDstring required

Associates request with company

Request body

idinteger required
planning_table_idinteger required
status'ERROR' | 'IMPORTED' | 'PROCESSING' | 'CANCELLED' required
  • ERROR - Error
  • IMPORTED - Imported
  • PROCESSING - Processing
  • CANCELLED - Cancelled
status_messagestring nullable required
scenario_summaryunknown required
created_atstring date-time required
completed_atstring date-time nullable required
source_import_type'USER' | 'SCHEDULED' required
  • USER - User
  • SCHEDULED - Scheduled

Response

idinteger required
planning_table_idinteger required
status'ERROR' | 'IMPORTED' | 'PROCESSING' | 'CANCELLED' required
  • ERROR - Error
  • IMPORTED - Imported
  • PROCESSING - Processing
  • CANCELLED - Cancelled
status_messagestring nullable required
scenario_summaryunknown required
created_atstring date-time required
completed_atstring date-time nullable required
source_import_type'USER' | 'SCHEDULED' required
  • USER - User
  • SCHEDULED - Scheduled

Changes