Update Data Table Properties
post
/rest/v16/datatables/{tableName}
This endpoint is used to update the description, parent folder, or 'Live' status for the specified data table.
Request
Supported Media Types
- application/json
Path Parameters
-
tableName(required): string
The name of the data table to update.
Root Schema : dataTable-modifyRequest
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-createRequestCollection
-
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. -
name:
string
Title:
Data Table Name
The data table name.
Nested Schema : dataTableField-createRequestCollection
Type:
Show Source
object
-
items:
array Column List
Title:
Column List
List of columns to be created or updated
Nested Schema : folder
Type:
Show Source
object
-
variableName:
string
Title:
Folder Variable Name
The variable name for the parent folder.
Nested Schema : Column List
Type:
array
Title:
Column List
List of columns to be created or updated
Show Source
-
Array of:
object dataTableField-createRequest
Data table column create request model
Nested Schema : dataTableField-createRequest
Type:
object
Data table column create request model
Show Source
-
_proxy_id:
string
Title:
Proxy Id
The proxy Id -
description:
string
Title:
Column Description
The column description. -
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. -
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-request
-
type:
string
Title:
Column Data Type
The data type of the column. -
validation:
object validation-request
Nested Schema : relationship-request
Type:
Show Source
object
-
name:
string
Title:
Relationship Name
Name of the relationship -
refField:
object referenceField-request
-
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-request
Nested Schema : validation-request
Type:
Show Source
object
-
hierarchy:
string
Title:
Attribute Hierarchy
Attribute hierarchy -
type:
string
Title:
Validation Type
Allowed Values:[ "Config", "Commerce" ]
Type of the validation
Nested Schema : referenceField-request
Type:
Show Source
object
-
name:
string
Title:
Referencing Column
the name of the referencing column.
Nested Schema : referenceTable-request
Type:
Show Source
object
-
name:
string
Title:
Reference Table Name
Name of the referencing table
Response
Supported Media Types
- application/json
Default Response
Data table details
Root Schema : dataTable-createResponse
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. -
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 : 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 : 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 : 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
Examples
The following examples show how to update the description, parent folder, or 'Live' status for the specified data table by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/datatables/ServerComponents
Request Body Sample
{ "name": "ServerComponents", "description": "This table lists server components for the Vision Servers configuration.", "folder": { "variableName": "servers" }, "isLive": true }
Response Body Sample
{ "id": 41312686, "dateModified": "10/15/2019 2:18 PM", "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/datatables" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/datatables/ServerComponents" } ], "name": "ServerComponents", "description": "This table lists server components for the Vision Servers configuration.", "hasUndeployedChanges": false, "deployedDate": "10/15/2019 2:18 PM", "dateCreated": "06/02/2019 12:14 PM", "folder": { "name": "Servers", "variableName": "servers", "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v16/dataTableFolders/servers" } ], }, "isLive": true }