REST API Services for Oracle CPQ

Get List of Data Tables

get

/rest/v16/datatables

This endpoint returns a list of data tables visible to the current user.

Request

Query Parameters

expand: string

The optional expand query string parameter can be used to to include expanded child collections in response results.

Response

Supported Media Types

application/json

Default Response

List of the data tables accessible to the current user

Root Schema : dataTable-collection

Type: object

Show Source

items: array Data Tables List

Title: Data Tables List

A collection of data tables accessible to the current user.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"A collection of data tables accessible to the current user.",
            "title":"Data Tables List",
            "items":{
                "$ref":"#/definitions/dataTable-getResponse"
            }
        }
    }
}

Nested Schema : Data Tables List

Type: array

Title: Data Tables List

A collection of data tables accessible to the current user.

Show Source

Array of: object dataTable-getResponse

{
    "type":"array",
    "description":"A collection of data tables accessible to the current user.",
    "title":"Data Tables List",
    "items":{
        "$ref":"#/definitions/dataTable-getResponse"
    }
}

Nested Schema : dataTable-getResponse

Type: object

Show Source

dateCreated: string

Title: Date Created

The date the data table was created.
dateModified: string

Title: Date Last Modified

The date of the last data table modification.
deployedDate: string

Title: Deployed Date

The date of the last data table deployment.
description: string

Title: Data Table Description

The data table description.
fields: object dataTableField-collection
folder: object folder
hasUndeployedChanges: boolean

Title: Has Undeployed Changes

This attribute is 'true' if the data table has undeployed changes.
id: integer(int64)

Title: Data Table Id

The unique identifier of the data table.
isLive: boolean

Title: Data Table Is Live

This attribute is 'true' for 'Live' data tables.
links: array Links

Title: Links

Links to the related objects.
name: string

Title: Data Table Name

The data table name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the data table.",
            "title":"Data Table Id"
        },
        "name":{
            "type":"string",
            "description":"The data table name.",
            "title":"Data Table Name"
        },
        "description":{
            "type":"string",
            "description":"The data table description.",
            "title":"Data Table Description"
        },
        "hasUndeployedChanges":{
            "type":"boolean",
            "description":"This attribute is 'true' if the data table has undeployed changes.",
            "title":"Has Undeployed Changes"
        },
        "dateModified":{
            "type":"string",
            "description":"The date of the last data table modification.",
            "title":"Date Last Modified"
        },
        "dateCreated":{
            "type":"string",
            "description":"The date the data table was created.",
            "title":"Date Created"
        },
        "deployedDate":{
            "type":"string",
            "description":"The date of the last data table deployment.",
            "title":"Deployed Date"
        },
        "isLive":{
            "type":"boolean",
            "description":"This attribute is 'true' for 'Live' data tables.",
            "title":"Data Table Is Live"
        },
        "folder":{
            "type":"object",
            "properties":{
                "variableName":{
                    "type":"string",
                    "description":"The variable name for the parent folder.",
                    "title":"Folder Variable Name"
                },
                "links":{
                    "type":"array",
                    "description":"Links to the related objects.",
                    "title":"Links",
                    "items":{
                        "$ref":"#/definitions/links"
                    }
                }
            }
        },
        "fields":{
            "$ref":"#/definitions/dataTableField-collection"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    }
}

Nested Schema : dataTableField-collection

Type: object

Show Source

items: array Columns list

Title: Columns list

List of columns

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of columns",
            "title":"Columns list",
            "items":{
                "$ref":"#/definitions/dataTableField"
            }
        }
    }
}

Nested Schema : folder

Type: object

Show Source

links: array Links

Title: Links

Links to the related objects.
variableName: string

Title: Folder Variable Name

The variable name for the parent folder.

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"The variable name for the parent folder.",
            "title":"Folder Variable Name"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Nested Schema : Columns list

Type: array

Title: Columns list

List of columns

Show Source

Array of: object dataTableField

Data table column model

{
    "type":"array",
    "description":"List of columns",
    "title":"Columns list",
    "items":{
        "$ref":"#/definitions/dataTableField"
    }
}

Nested Schema : dataTableField

Type: object

Data table column model

Show Source

_proxy_id: string

Title: Proxy Id

Proxy Id
dateAdded: string

Title: Date Created

The date the column was created.
dateModified: string

Title: Date Last Modified

The date of the last column modification.
description: string

Title: Column Description

The column description.
id: integer(int64)

Title: Column Id

The unique identifier of the column.
index: boolean

Title: Index

This attribute identifies if the column is indexed.
key: boolean

Title: Key

This 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.
links: array Links

Title: Links

Links to the related objects
name: string

Title: Column Name

The name of the data table column.
order: integer

Title: Column Display Order

Order of the column within the table.
relationship: object relationship-response
type: string

Title: Column Data Type

The data type of the column.
validation: object validation-response

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the column.",
            "title":"Column Id"
        },
        "name":{
            "type":"string",
            "description":"The name of the data table column.",
            "title":"Column Name"
        },
        "description":{
            "type":"string",
            "description":"The column description.",
            "title":"Column Description"
        },
        "type":{
            "type":"string",
            "description":"The data type of the  column.",
            "title":"Column Data Type"
        },
        "order":{
            "type":"integer",
            "description":"Order of the column within the table.",
            "title":"Column Display Order"
        },
        "index":{
            "type":"boolean",
            "description":"This attribute identifies if the column is indexed.",
            "title":"Index"
        },
        "key":{
            "type":"boolean",
            "description":"This 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.",
            "title":"Key"
        },
        "dateModified":{
            "type":"string",
            "description":"The date of the last column modification.",
            "title":"Date Last Modified"
        },
        "dateAdded":{
            "type":"string",
            "description":"The date the column was created.",
            "title":"Date Created"
        },
        "validation":{
            "$ref":"#/definitions/validation-response"
        },
        "relationship":{
            "$ref":"#/definitions/relationship-response"
        },
        "_proxy_id":{
            "type":"string",
            "description":"Proxy Id",
            "title":"Proxy Id"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    },
    "description":"Data table column model"
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Nested Schema : relationship-response

Type: object

Show Source

name: string

Title: Relationship Name

Name of the relationship
refField: object referenceField-response
refOnDelete: string

Title: Reference On Delete

Allowed Values: [ "On Delete No Action", "On Delete Cascade", "On Delete Set Null" ]

On delete behavior for the relationship
refTable: object referenceTable-response

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the relationship",
            "title":"Relationship Name"
        },
        "refTable":{
            "$ref":"#/definitions/referenceTable-response"
        },
        "refField":{
            "$ref":"#/definitions/referenceField-response"
        },
        "refOnDelete":{
            "type":"string",
            "description":"On delete behavior for the relationship",
            "title":"Reference On Delete",
            "enum":[
                "On Delete No Action",
                "On Delete Cascade",
                "On Delete Set Null"
            ]
        }
    }
}

Nested Schema : validation-response

Type: object

Show Source

attribute: string

Title: Attribute Name

The name of the attribute the column is mapped to.
hierarchy: string

Title: Attribute Hierarchy

Attribute hierarchy
links: array Links

Title: Links

Links to the related objects.
type: string

Title: Validation Type

Allowed Values: [ "Config", "Commerce" ]

Type of the validation.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type of the validation.",
            "title":"Validation Type",
            "enum":[
                "Config",
                "Commerce"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The name of the attribute the column is mapped to.",
            "title":"Attribute Name"
        },
        "hierarchy":{
            "type":"string",
            "description":"Attribute hierarchy",
            "title":"Attribute Hierarchy"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

href: string

Title: href

URL to the related object
rel: string

Title: Link

Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : referenceField-response

Type: object

Show Source

links: array Links

Title: Links

Links to the related objects.
name: string

Title: Referencing Column

the name of the referencing column.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"the name of the referencing column.",
            "title":"Referencing Column"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    }
}

Nested Schema : referenceTable-response

Type: object

Show Source

links: array Links

Title: Links

Links to the related objects.
name: string

Title: Reference Table Name

Name of the referencing table

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the referencing table",
            "title":"Reference Table Name"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/links"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/links"
    }
}

Examples

The following example shows how to get a list of data tables by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/datatables

Response Body Sample

{
  "items": [{
      "id": 36263638,
      "dateModified": "08/10/2017 11:17 AM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Status"
        }
      ],
      "name": "Status",
      "description": "The list of all possible values for transaction and transaction line status attributes.",
      "hasUndeployedChanges": false,
      "deployedDate": "08/10/2017 11:17 AM",
      "dateCreated": "07/02/2014 10:08 AM",
      "folder": {
        "name": "[Default]",
        "variableName": "_default",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/_default"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36593152,
      "dateModified": "05/06/2019 4:11 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Oracle_BomAttrDef"
        }
      ],
      "name": "Oracle_BomAttrDef",
      "hasUndeployedChanges": false,
      "deployedDate": "05/06/2019 4:11 PM",
      "dateCreated": "11/09/2017 8:02 AM",
      "folder": {
        "name": "BOM Tables",
        "variableName": "bOMTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/bOMTables"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36593103,
      "dateModified": "05/07/2019 11:20 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Oracle_BomAttrMap"
        }
      ],
      "name": "Oracle_BomAttrMap",
      "hasUndeployedChanges": false,
      "deployedDate": "05/07/2019 11:20 PM",
      "dateCreated": "11/09/2017 8:01 AM",
      "folder": {
        "name": "BOM Tables",
        "variableName": "bOMTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/bOMTables"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36734142,
      "dateModified": "05/07/2019 11:51 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Oracle_BomItemDef"
        }
      ],
      "name": "Oracle_BomItemDef",
      "hasUndeployedChanges": false,
      "deployedDate": "05/07/2019 11:51 PM",
      "dateCreated": "11/10/2018 2:05 PM",
      "folder": {
        "name": "BOM Tables",
        "variableName": "bOMTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/bOMTables"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36873364,
      "dateModified": "05/06/2019 4:11 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Oracle_BomItemDefAlt"
        }
      ],
      "name": "Oracle_BomItemDefAlt",
      "hasUndeployedChanges": false,
      "deployedDate": "05/06/2019 4:11 PM",
      "dateCreated": "05/06/2019 4:11 PM",
      "folder": {
        "name": "BOM Tables",
        "variableName": "bOMTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/bOMTables"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36592890,
      "dateModified": "05/07/2019 11:47 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Oracle_BomItemMap"
        }
      ],
      "name": "Oracle_BomItemMap",
      "hasUndeployedChanges": false,
      "deployedDate": "05/07/2019 11:47 PM",
      "dateCreated": "11/09/2017 8:00 AM",
      "folder": {
        "name": "BOM Tables",
        "variableName": "bOMTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/bOMTables"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36872950,
      "dateModified": "05/06/2019 4:10 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/MultiNaturalKeys"
        }
      ],
      "name": "MultiNaturalKeys",
      "hasUndeployedChanges": false,
      "deployedDate": "05/06/2019 4:10 PM",
      "dateCreated": "05/06/2019 4:10 PM",
      "folder": {
        "name": "Data Tables",
        "variableName": "dataTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/dataTables"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 38089465,
      "dateModified": "07/30/2019 4:05 PM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/AccountMappings"
        }
      ],
      "name": "AccountMappings",
      "hasUndeployedChanges": false,
      "deployedDate": "07/30/2019 4:05 PM",
      "dateCreated": "07/30/2019 4:05 PM",
      "folder": {
        "name": "Integration",
        "variableName": "integration",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/integration"
          }
        ],
      },
      "isLive": false
    }, {
      "id": 36831052,
      "dateModified": "05/06/2019 12:00 AM",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/datatables"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/ORCL_PRC_ADJUSTMENTS"
        }
      ],
      "name": "ORCL_PRC_ADJUSTMENTS",
      "hasUndeployedChanges": false,
      "deployedDate": "05/06/2019 12:00 AM",
      "dateCreated": "05/02/2019 8:35 AM",
      "folder": {
        "name": "Oracle Pricing Tables",
        "variableName": "oraclePricingTables",
        "links": [{
            "rel": "related",
            "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/oraclePricingTables"
          }
        ],
      },
      "isLive": true
      }
    }
  ]
}