Synchronize Data Table Columns
post
/rest/v16/datatables/{tableName}/fields/actions/synchronize
This endpoint is used to create, update, or delete data table columns.
Request
Supported Media Types
- application/json
Path Parameters
-
tableName(required): string
The data table name..
Root Schema : dataTableField-synchronizeRequestCollection
Type:
Show Source
object
-
items:
array Column List
Title:
Column List
List of columns to be synchronized.
Nested Schema : Column List
Type:
array
Title:
Column List
List of columns to be synchronized.
Show Source
-
Array of:
dataTableField-synchronizeRequest
data table field Create request model
Nested Schema : dataTableField-synchronizeRequest
data table field Create request model
Match All
Show Source
-
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
Synchronized column details
Root Schema : dataTableField-collection
Type:
Show Source
object
-
items:
array Columns list
Title:
Columns list
List of columns
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
Examples
The following example shows how to synchronize data table columns 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" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields/actions/synchronize
Request Body Sample
{ "documents": { "items": [{ "name": "DateUpdated", "type": "String", "_sync_action": "create", "_proxy_id": "1" }, { "name": "Height", "description": "This field identifies the height of the component.", "_sync_action": "update", "_proxy_id": "2" }, { "name": "RelationshipColumn", "_sync_action": "delete", "_proxy_id": "3" } ] } }
Response Body Sample
{ "documents": { "items": [{ "id": 41367525, "dateModified": "10/23/2019 10:32 AM", "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields/DateUpdated" } ], "name": "DateUpdated", "dateAdded": "10/23/2019 10:32 AM", "type": "String", "order": 12, "index": false, "key": false, "_proxy_id": "1" }, { "id": 41366842, "dateModified": "10/23/2019 10:32 AM", "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields/Height" } ], "name": "Height", "description": "This field identifies the height of the component.", "dateAdded": "10/21/2019 11:15 AM", "type": "Integer", "order": 5, "index": false, "key": false, "_proxy_id": "2" } ] } }