Data Table REST APIs

Overview

Oracle CPQ Data Table REST APIs allow administrators to access and support Oracle CPQ Data Tables. The Data Table REST APIs support functions for data table folders, properties, columns, records, imports, exports, and searches.

Refer to the Task REST APIs for the following task-related functions: Get List of Tasks, Get Task, Cancel Task, Delete Task, Delete Tasks, Get Task File List, and Download a Task File.

Authentication

Oracle CPQ uses HTTP Basic authentication to authenticate REST calls from third-party systems. When making a call to an Oracle CPQ REST API, the third-party system’s REST client must have encrypted Oracle CPQ login credentials in the Header and an Accept Header that both adhere to HTTP Basic authentication standards. The Accept Header must be set to application/schema+json to see the detailed schema of the resource. For more information see the topic Supported REST Headers.

Administration

Data Tables

The data table endpoints retrieve data table properties and perform actions to create, delete, deploy, export, import, move, and update data tables.

Note: The following data table REST APIs are only available for admin users.

Get List of Data Tables

Get List of Data Tables
Description	This endpoint returns a list of data tables visible to the current user.
URI Endpoint	/rest/v17/datatables
Endpoint Parameters	expand	This endpoint supports the optional 'expand' query string parameter to expand and include child collections in response results.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains a collection of data tables accessible to the current user.

Get Data Table Properties

Get Data Table Properties
Description	This endpoint is used to retrieve properties for the specified data table. The following properties are returned: Id, name, description, parent folder, 'Live' status, does data table have undeployed changes, last deploy date, last modification date, and creation date.
URI Endpoint	/rest/v17/datatables/{tableName}
Endpoint Parameters	tableName	The data table name.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	id	The unique identifier of the data table.
dateModified	The date of the last data table modification.
links	Links to the related objects.
name	The name of the data table.
description	The data table description.
hasUndeployedChanges	This Boolean attribute is "true" if the data table has undeployed changes.
deployedDate	The date of the last data table deployment.
dateCreated	The date the data table was created.
folder	This object contains the parent folder name, variable name, and a link to the parent folder.
isLive	This Boolean attribute is "true" for 'Live' data tables.

Create Data Table

Create Data Table
Description	This endpoint is used to create a new data table.
URI Endpoint	/rest/v17/datatables
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	The name for the new data table (required)
description	The description for the new data table.
folder	This object contains the parent folder variable name. If this value is not specified, the new data table will be created in the "_default" folder.
isLive	This Boolean attribute is set to "true" to enable 'Live' data tables. The default value is "false".
Response Body Parameters	id	The unique identifier of the data table.
dateModified	The date of the last data table modification.
links	Links to the related objects.
name	The name of the data table.
description	The data table description.
hasUndeployedChanges	This Boolean attribute is "true" if the data table has undeployed changes.
deployedDate	The date of the last data table deployment.
dateCreated	The date the data table was created.
folder	This object contains the parent folder name, variable name, and links to related objects.
isLive	This Boolean attribute is "true" for 'Live' data tables.

Delete Data Table

Delete Data Table
Description	This endpoint is used to delete the specified data table.
URI Endpoint	/rest/v17/datatables{tableName}
Endpoint Parameters	tableName	The name of the data table to delete.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	None

Delete Data Tables

Delete Data Tables
Description	This endpoint is used to delete multiple data tables.
URI Endpoint	/rest/v17/datatables/actions/deleteTables
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	selections	An array of data table names to delete (required).
Response Body Parameters	None

Deploy Data Tables

Deploy Data Tables
Description	This endpoint deploys the specified data tables.
URI Endpoint	/rest/v17/datatables/actions/deploy
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	selections	An array of data table names to deploy (required).
autoPullFKTables	This Boolean attribute is set to "true" to automatically retrieve interdependent tables that are not specified in `selections`. When deploying a data table with relationships, all tables defined in a relationship must be included in `selections` if `autoPullFKTables` is not defined or set to "false".
Response Body Parameters	taskIds	The status log task Ids the associated with the deploy action.

Export Data Tables

Export Data Tables
Description	This endpoint is used to export data tables.
URI Endpoint	/rest/v17/datatables/actions/export
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	filterCriteriaForSelections	An array of filtered data table records.
selections	An array of data table names to export (required).
Response Body Parameters	taskId	The task Id the associated with the export.

Import Data Tables

Import Data Tables
Description	This endpoint is used to import data tables.
URI Endpoint	/rest/v17/datatables/actions/import
Endpoint Parameters	None
HTTP Method	POST
Request Header	Content-Type: multipart/form-data
Request Body For Data Parameters	file	The file to be imported (required).
columnDelimiter	The column delimiter.
rowDelimiter	The row delimiter.
dataHasDelimiter	This Boolean attribute is set to "true" to indicate that the imported data table has content with delimiters (e.g. numeric values like 1,000)
folderVariableName	The variable name of the parent data table folder. If this value is not specified, the new data tables will be imported into the "_default" folder.
Response Body Parameters	taskId	The status log task Id the associated with the import.

Move Data Tables

Move Data Tables
Description	This endpoint is used to move data tables from one folder to another folder.
URI Endpoint	/rest/v17/datatables/actions/moveTables
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	selections	An array of data table names to move (required).
folderVariableName	The variable name of the target data table folder (required).
Response Body Parameters	None

Update Data Table Properties

Update Data Table Properties
Description	This endpoint is used to update the description, parent folder, or 'Live' status for the specified data table.
URI Endpoint	/rest/v17/datatables/{tableName}
Endpoint Parameters	tableName	The data table name.
HTTP Method	POST
Request Body Parameters	description	The description for the data table.
folder	This object contains the parent folder variable name.
isLive	This Boolean attribute is set to "true" to enable 'Live' data tables.
Response Body Parameters	id	The unique identifier of the data table.
dateModified	The date of the last data table modification.
links	Links to the related objects.
name	The name of the data table.
description	The data table description.
hasUndeployedChanges	This Boolean attribute is "true" if the data table has undeployed changes.
deployedDate	The date of the last data table deployment.
dateCreated	The date the data table was created.
folder	This object contains the parent folder name, variable name, and a link to the parent folder.
isLive	This Boolean attribute is "true" for 'Live' data tables.

Data Table Columns

The data table column endpoints retrieve data table column information and perform actions to create, delete, synchronize, and update data table columns.

Note: The data table column REST APIs are only available for admin users.

Get List of Data Table Columns

Get List of Data Table Columns
Description	This endpoint returns all data table column properties for the specified data table.
URI Endpoint	/rest/v17/datatables/{tableName}/fields
Endpoint Parameters	tableName	The data table name.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains a collection of data table columns.

Get Data Table Column Properties

Get Data Table Column Properties
Description	This endpoint returns properties for the specified data table column.
URI Endpoint	/rest/v17/datatables/{tableName}/fields/{fieldName}
Endpoint Parameters	tableName	The data table name.
fieldName	The name of the data table column to retrieve.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	id	The unique identifier of the column.
name	The name of the data table column.
description	The column description.
type	The data type of the column.
order	Order of the column within the table.
index	This Boolean attribute identifies if the column is indexed.
key	This Boolean attribute identifies if this is a key column. A key, also known as a 'Natural Key' can be a single column or a combination of several columns that produce a unique identifier for each record (row) for faster access to the data.
dateModified	The date of the last column modification.
dateCreated	The date the column was created.
validation	When a column has validation, this object contains the validation attribute type (commerce or config), name, id, and hierarchy.
relationship	When a column has a relationship, this object contains the target table (`refTable`), target column (`refField`), and delete behavior.
_proxy_id	The proxy Id.
links	Links to the related objects.

Create or Update Data Table Column

Create or Update Data Table Column
Description	This endpoint is used to create or update a data table column.
URI Endpoint	/rest/v17/datatables/{tableName}/fields
Endpoint Parameters	tableName	The name for the data table.
HTTP Method	POST
Request Body Parameters	id	The unique identifier of the data table column. Columns can be identified using `id` or `name` for Update actions.
name	The data table column name.
description	The description for the column.
index	This Boolean attribute is set to "true" to index the column.
key	This Boolean attribute is set to "true" for key columns.
order	The order of the column within the table.
Response Body Parameters	id	The unique identifier of the data table column.
dateModified	The date of the last data table column modification.
links	Links to the related objects.
name	The name of the data table column.
description	The data table column description.
dateAdded	The date the data table column was created.
type	The data type of the column.
order	The order of the column within the table.
index	This Boolean attribute is set to "true" to index the column.
key	This Boolean attribute is set to "true" for key columns.

Delete Data Table Column

Delete Data Table Column
Description	This endpoint is used to delete the specified data table column.
URI Endpoint	/rest/v17/datatables{tableName}/fields/{fieldName}
Endpoint Parameters	tableName	The data table name.
fieldName	The name for the data table column to delete.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	None

Delete Data Table Columns

Delete Data Table Columns
Description	This endpoint is used to delete multiple data table columns.
URI Endpoint	/rest/v17/datatables/{tableName}/fields/actions/deleteFields
Endpoint Parameters	tableName	The data table name.
HTTP Method	POST
Request Body Parameters	selections	An array of data table columns to delete (required).
Response Body Parameters	None

Synchronize Data Table Columns

Synchronize Data Table Columns
Description	This endpoint is used to create, update, or delete data table columns.
URI Endpoint	/rest/v17/datatables/{tableName}/fields/actions/synchronize
	None
Endpoint Parameters	tableName	The name for the data table.
HTTP Method	POST
Request Body Parameters	The request body "documents" includes an array of column items to synchronize. Each item includes: column data, the _sync_action, and a _proxy_id (optional). To create a new column the `name` is required, `description`, `index`, `key`, and `order` are optional. To update a column the `id` or `name` must be provided, `description`, `index`, `key`, and `order` can be updated. To delete a column the `id` or `name` must be provided.
_sync_action	The synchronization action for the column (create, update, or delete)
_proxy_id	This endpoint supports optional proxy Ids if provided by the client.
Response Body Parameters	The data for the new and updated data table columns.
_proxy_id	The response will include the proxy Id if provided in the request.

Update Data Table Column Properties

Update Data Table Column Properties
Description	This endpoint is used to update the properties for the specified data table column.
URI Endpoint	/rest/v17/datatables/{tableName}/fields/{fieldName}
Endpoint Parameters	tableName	The data table name.
fieldName	The name of the data table column to update.
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	id	The unique identifier of the column.
name	The name of the data table column.
description	The column description.
type	The data type of the column.
order	Order of the column within the table.
index	This Boolean attribute identifies if the column is indexed.
key	This Boolean attribute identifies if this is a key column. A key, also known as a 'Natural Key' can be a single column or a combination of several columns that produce a unique identifier for each record (row) for faster access to the data.
dateModified	The date of the last column modification.
dateCreated	The date the column was created.
validation	When a column has validation, this object contains the validation attribute type (commerce or config), name, id, and hierarchy.
relationship	When a column has a relationship, this object contains the target table (`refTable`), target column (`refField`), and delete behavior.
_proxy_id	The proxy Id.
links	Links to the related objects.

Data Table Data

These endpoints retrieve data table data (i.e. rows or records) and perform actions to clear, create, delete, and update data table rows.

Note: The data table data REST APIs are only available for admin users.

Get Data Table Data (Includes Search Data Table Option)

Get Data Table Data
Description	This endpoint returns all rows for the specified data table.
URI Endpoint	/rest/v17/adminCustom{tableName}
Endpoint Parameters	tableName	The data table name.
q	Query specifications can be used to search for specific data within the named data table. Query specifications that follow Oracle CPQ query and pagination parameters syntax, and query specifications that follow a subset of MongoDB syntax can be used. For more information, refer to the following resources: Querying Oracle CPQ REST APIs: Manage Collections. MongoDB syntax: MongoDB’s Query Documents.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains a collection of data table rows.

Get Data Table Row

Get Data Table Row
Description	This endpoint returns the specified data table row.
URI Endpoint	/rest/v17/adminCustom{tableName}/{rowId}
Endpoint Parameters	tableName	The data table name.
rowId	The data table row Id.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains the data table data for the specified row.

Clear Data Table Data

Clear Data Table Data
Description	This endpoint deletes all rows from the specified data table.
URI Endpoint	/rest/v17/adminCustom{tableName}/actions/clearData
Endpoint Parameters	tableName	The data table name.
HTTP Method	POST
Request Body Parameters	q	Beginning in Oracle CPQ 22B, query parameters can be used to filter data table records to be cleared. Query specifications that follow Oracle CPQ query parameters syntax, and query specifications that follow a subset of MongoDB syntax can be used. For more information, refer to: MongoDB’s Query Documents.
Response Body Parameters	The response contains the data for the specified row.

Create Data Table Row

Create Data Table Row
Description	This endpoint is used to create a new row for the specified data table.
URI Endpoint	/rest/v17/adminCustom{tableName}
Endpoint Parameters	tableName	The data table name.
HTTP Method	POST
Request Body Parameters	The data for the new data table row
Response Body Parameters	The data for the data table row

Delete Data Table Row

Delete Data Table Row
Description	This endpoint is used to delete the specified data table row.
URI Endpoint	/rest/v17/adminCustom{tableName}/{rowId}
Endpoint Parameters	tableName	The name for the data table.
rowId	The data table row Id.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	None

Delete Data Table Rows

Delete Data Table Rows
Description	This endpoint is used to delete multiple data table rows.
URI Endpoint	/rest/v17/adminCustom{tableName}/actions/deleteRows
Endpoint Parameters	tableName	The name for the data table.
HTTP Method	POST
Request Body Parameters	selections	An array of data table rows ids to delete (required).
Response Body Parameters	None

Search Data Tables

Search Data Tables
Description	This endpoint is used to search for data across multiple data tables.
URI Endpoint	/rest/v17/datatables/actions/getQueryStatistics
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	selections	An array of data table names to search (required). All data tables are queried if data table names are not specified in the request selections.
keyword	The content to search for (required).
Response Body Parameters	items	An array of data tables matching the search keyword.
matchingRowCount	Number of rows with content that matched the search string.
rowsLink	The URL to retrieve rows with content that matched the search string.

Synchronize Data Table Rows

Synchronize Data Table Rows
Description	This endpoint is used to create, update, or delete data table rows.
URI Endpoint	/rest/v17/adminCustom{tableName}/actions/synchronize
Endpoint Parameters	tableName	The data table name.
HTTP Method	POST
Request Body Parameters	The request body "documents" includes an array of row items to synchronize. Each item includes: row data, the `_sync_action`, and a `_proxy_id` (optional) create The new row data The only allowed value for the id property is "-1" If the data table has a natural key, the key should be included in the request. If the data table does not have a natural key, every record is created without validation. update To update a row the id or natural key must be provided. The updated row data delete - To update a row the id or natural key must be provided.
_sync_action	The synchronization action for the row (create, update, or delete)
_proxy_id	This endpoint supports optional proxy Ids if provided by the client.
Response Body Parameters	The data for the new and updated data table rows.
_proxy_id	The response will include the proxy Id if provided in the request.

Update Data Table Row

Update Data Table Row
Description	This endpoint is used to update the specified data table row.
URI Endpoint	/rest/v17/adminCustom{tableName}/{rowId}
Endpoint Parameters	tableName	The data table name.
HTTP Method	POST
Request Body Parameters	The data for the new data table row
Response Body Parameters	The data for the data table row

Data Table Folders

The data table folder endpoints retrieve data table folder properties and perform actions to create, update, and delete data table folders.

Note: The data table folder REST APIs are only available for admin users.

Get Data Table Folders

Get Data Table Folders
Description	This endpoint returns a list of data table folders visible to the current user.
URI Endpoint	/rest/v17/dataTableFolders
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	items	A collection of data table folders.
_state	This object describes the folder permissions for the current user. `allowUpdate` - Identifies if the current user is allowed to create and update data table folders. `allowDelete` - Identifies if the current user is allowed to delete data table folders. The `_state` object will be present on the collection level acting a global value for all the folders. Any folder whose state differs will have its own state object.

Get Data Table Folder

Get Data Table Folder
Description	This endpoint returns the properties for the specified data table folder.
URI Endpoint	/rest/v17/dataTableFolders/{folderVarName}
Endpoint Parameters	folderVarName	The variable name for the data table folder.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	id	The unique identifier of the data table folder.
dateModified	The date of the last data table folder modification.
links	Links to the related objects.
name	The name of the data table folder.
variableName	The variable name of the data table folder
dateAdded	The date the data table folder was created.
_state	This object describes the folder permissions for the current user. `allowUpdate` - Identifies if the current user is allowed to update the data folder. `allowDelete` - Identifies if the current user is allowed to delete the data folder.

Create Data Table Folder

Create Data Table Folder
Description	This endpoint is used to create a new data table folder.
URI Endpoint	/rest/v17/dataTableFolders
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	The name for the new data table folder (required).
variableName	The variable name for the new data table folder (required).
Response Body Parameters	id	The unique identifier of the data table folder.
dateModified	The date of the last data table folder modification.
links	Links to the related objects.
name	The name of the data table folder.
variableName	The variable name of the data table folder
dateAdded	The date the data table folder was created.
_state	This object describes the folder permissions for the current user. `allowUpdate` - Identifies if the current user is allowed to update the data folder. `allowDelete` - Identifies if the current user is allowed to delete the data folder.

Delete Data Table Folder

Delete Data Table Folder
Description	This endpoint is used to delete the specified data table folder. Only empty data table folders can be deleted.
URI Endpoint	/rest/v17/dataTableFolders/{folderVarName}
Endpoint Parameters	folderVarName	The variable name for the data table folder.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	None

Update Data Table Folder

Update Data Table Folder
Description	This endpoint is used to update the name for the specified data table folder
URI Endpoint	/rest/v17/dataTableFolders/{folderVarName}
Endpoint Parameters	folderVarName	The variable name for the data table folder.
HTTP Method	POST
Request Body Parameters	name	The new name for the data table folder (required) The request body can have dateAdded and dateModifed properties along with the mandatory name property. However the date values cannot be changed. An error will be generated if the date values do not match the existing values.
Response Body Parameters	id	The unique identifier of the data table folder.
dateModified	The date of the last data table folder modification.
links	Links to the related objects.
name	The name of the data table folder.
variableName	The variable name of the data table folder
dateAdded	The date the data table folder was created.
_state	This object describes the folder permissions for the current user. `allowUpdate` - Identifies if the current user is allowed to update the data folder. `allowDelete` - Identifies if the current user is allowed to delete the data folder.

Deployed Data Tables

These endpoints allow an external system to access deployed data in Oracle CPQ Data Tables. When executed correctly, the external system will receive the Oracle CPQ Data Table’s deployed data in the REST response body.

Currently only Read operations are supported when interacting with the custom{DataTable} API.

Get Deployed Data Table

Get Deployed Data Table
Description	Returns the deployed data of an Oracle CPQ Data Table.
URI Endpoint	/rest/v17/custom{DataTable}
Endpoint Parameters	DataTable	The name of the Oracle CPQ Data Table (first character must be capitalized).
Query	Optional, query specifications to organize or filter Data Table return data. Query specifications that follow Oracle CPQ query and pagination parameters syntax, and query specifications that follow a subset of MongoDB syntax can be used. For more information on querying Oracle CPQ REST APIs, log in to Oracle CPQ as a FullAccess user and see the Query Specification Syntax topic in the Online Help. For more information on MongoDB syntax, see MongoDB’s Query Documents documentation.
HTTP Method	GET
Success Response	204 – Success The Data Table’s deployed data will be in the response body.
Failure Responses	400 – Bad request The name of the Data Table was invalid or the Data Table had not been deployed. 401 – Unauthorized Valid Oracle CPQ FullAccess credentials were not provided in the header.

Get Deployed Data Table Record