Get Data Table Properties
get
/rest/v16/datatables/{tableName}
This endpoint is used to retrieve properties for the specified data table. The following properties are returned: the Id, name, description, parent folder, 'Live' status, if the data table has changes that are not deployed, last deploy date, last modification date, and creation date.
Request
Path Parameters
-
tableName(required): string
The data table name.
Query Parameters
-
expand: string
The expand query string parameter can be used to include expanded child collections in the results.
Response
Default Response
Datatable details
Root Schema : dataTable-getResponse
Type:
Show Source
object
-
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.
Nested Schema : dataTableField-collection
Type:
Show Source
object
-
items:
array Columns list
Title:
Columns list
List of columns
Nested Schema : folder
Type:
Show Source
object
-
links:
array Links
Title:
Links
Links to the related objects. -
variableName:
string
Title:
Folder Variable Name
The variable name for the parent folder.
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
Nested Schema : Columns list
Type:
array
Title:
Columns list
List of columns
Show Source
-
Array of:
object dataTableField
Data table column model
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
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
Nested Schema : relationship-response
Type:
Show Source
object
-
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
Nested Schema : validation-response
Type:
Show Source
object
-
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.
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
Nested Schema : referenceField-response
Type:
Show Source
object
-
links:
array Links
Title:
Links
Links to the related objects. -
name:
string
Title:
Referencing Column
the name of the referencing column.
Nested Schema : referenceTable-response
Type:
Show Source
object
-
links:
array Links
Title:
Links
Links to the related objects. -
name:
string
Title:
Reference Table Name
Name of the referencing table
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
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
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
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
Examples
The following examples show how to retrieve properties for the specified data table 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 "Content-type: application/json" https://sitename.oracle.com/rest/v16/datatables/Status
Response Body Sample
{ "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 }