CUcubesoftware
Data Tables

Retrieve a Data Table

Changed on

Retrieve a single data table for a company.

Data Tables are a generic way to organize the source dimensions, mappings, uploads, and imports from an outside source into Cube (source system connections, imported flat files and employee rosters, etc).

get/data-tables/{data_table_id}

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

Headers

X-Company-IDstring required

Associates request with company

Response

The data table object

idstring uuid required
namestring required
activeboolean required
settingsobject required
created_atstring date-time required
type'AD_HOC' | 'ERP_CONNECTION' | 'GENERIC' | 'EMPLOYEE_ROSTER' | 'HRIS' | 'HEADCOUNT' | 'PLANNING_TABLE' required
  • AD_HOC - Ad Hoc
  • ERP_CONNECTION - ERP Connection
  • GENERIC - Generic
  • EMPLOYEE_ROSTER - Employee Roster
  • HRIS - HRIS Connection
  • HEADCOUNT - Headcount Model
  • PLANNING_TABLE - Planning Table
type_friendlystring required
last_importobject required
last_successful_importobject required
source_typestring required

Returns the human-friendly category of the connection's Integration, if the table has a connection. Otherwise, returns 'Data Table'.

Returns: The human-friendly source category

mapping_dataobject required
descriptionstring

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