CUcubesoftware
Data Table Uploads

Create a Data Table Upload

Create an upload object for a given data table to track overall upload status and corresponding parts.

post/data-tables/{data_table_id}/upload

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

data_table_idstring uuid required

The ID of the data table the upload is associated with

Headers

X-Company-IDstring required

Associates request with company

Request body

idstring uuid required
source_data_tablestring uuid required
source'USER_UPLOAD' | 'EMAIL' | 'API' | 'THIRD_PARTY_API'
  • USER_UPLOAD - User Upload
  • EMAIL - Email
  • API - API
  • THIRD_PARTY_API - Third Party API
messagestring nullable
status'PROCESSING' | 'IMPORTED' | 'ERROR' | 'PENDING'
  • PROCESSING - Processing
  • IMPORTED - Imported
  • ERROR - Error
  • PENDING - Pending
data_importinteger nullable
upload_type'REPLACE' | 'TIME_BASED_REPLACE' | 'APPEND' | 'DELETE'
  • REPLACE - Remove all existing records and replace with this uploaded data
  • TIME_BASED_REPLACE - Remove and replace existing records between the time periods specified in this uploaded data
  • APPEND - Update existing records and add new records
  • DELETE - Remove all existing records
status_messagestring nullable
created_atstring date-time required
currencyinteger nullable
data_can_be_downloadedboolean required

Response

The upload object to start uploading parts for

idstring uuid required
source_data_tablestring uuid required
source'USER_UPLOAD' | 'EMAIL' | 'API' | 'THIRD_PARTY_API'
  • USER_UPLOAD - User Upload
  • EMAIL - Email
  • API - API
  • THIRD_PARTY_API - Third Party API
messagestring nullable
status'PROCESSING' | 'IMPORTED' | 'ERROR' | 'PENDING'
  • PROCESSING - Processing
  • IMPORTED - Imported
  • ERROR - Error
  • PENDING - Pending
data_importinteger nullable
upload_type'REPLACE' | 'TIME_BASED_REPLACE' | 'APPEND' | 'DELETE'
  • REPLACE - Remove all existing records and replace with this uploaded data
  • TIME_BASED_REPLACE - Remove and replace existing records between the time periods specified in this uploaded data
  • APPEND - Update existing records and add new records
  • DELETE - Remove all existing records
status_messagestring nullable
created_atstring date-time required
currencyinteger nullable
data_can_be_downloadedboolean required

Changes

No operation changes recorded.