CUcubesoftware
Connections

Start a Data Import

Changed on

This endpoint will start a data import with the given connection. The request requires a connection ID and dimension IDs necessary to start an import.

post/connections/{connection_id}/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/
    • or none

Path parameters

connection_idstring uuid required

Headers

X-Company-IDstring required

Associates request with company

Request body

dimensionsobject required
otherinteger[] required
timeobject required
scenariointeger required

Response

The import was queued and a message was sent in the metadata.

idinteger required
created_atstring date-time required
completed_atstring date-time nullable
status'CANCELLED' required
  • CANCELLED - Cancelled
status_messagestring nullable
source_import_type'USER' | 'SCHEDULED' required
  • USER - User
  • SCHEDULED - Scheduled

Changes

  • 14bc2527c11cRevision changes
    • warning

      added the new PLANNING_TABLE enum value to the ///// response property for the response status

  • 29a7569c2f46Revision changes
    • warning

      added the new HEADCOUNT enum value to the ///// response property for the response status