Jump to

• Request
• Response
• Examples

Get Data Table Column Properties

get

/rest/v16/datatables/{tableName}/fields/{fieldName}

This endpoint returns properties for the specified data table column.

Request

Path Parameters

• fieldName(required): string
  The name of the data table column to retrieve.
• tableName(required): string
  The data table name.

Back to Top

Response

Default Response

Column details

Body ()

Root 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"
    }
}

Back to Top

Examples

The following examples show how to retrieve properties for the specified data table column 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/Rack_Domain/fields/Type

Response Body Sample

 {
  "id": 41361422,
  "dateModified": "10/08/2019 12:48 PM",
  "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/Type"
    }
  ],
  "name": "Type",
  "dateAdded": "10/08/2019 12:48 PM",
  "type": "String",
  "order": 1,
  "index": true,
  "key": false
}

Column with Relationship Example

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields/RelationshipColumn

Response Body Sample

 {
  "id": 41366882,
  "dateModified": "10/21/2019 11:28 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/RelationshipColumn"
    }
  ],
  "name": "RelationshipColumn",
  "dateAdded": "10/21/2019 11:15 AM",
  "type": "String",
  "order": 11,
  "relationship": {
    "name": "RelationshipExample",
    "refTable": {
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Shipping_Options"
        }
      ],
      "name": "Shipping_Options"
    },
    "refField": {
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/datatables/Shipping_Options/fields/Service_Level"
        }
      ],
      "name": "Service_Level"
    },
    "refOnDelete": "On Delete No Action"
  },
  "index": true,
  "key": false
}

Column with Validation Example

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/datatables/Rack_Domain/fields/ValidationColumn

Request Body Sample

 {
  "id": 41366878,
  "dateModified": "10/21/2019 11:17 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/ValidationColumn"
    }
  ],
  "name": "ValidationColumn",
  "dateAdded": "10/21/2019 11:15 AM",
  "type": "String",
  "order": 10,
  "validation": {
    "type": "Config",
    "attribute": {
      "name": "Component Type",
      "id": 41320861
    },
    "hierarchy": "All Products:aCMERacks:equipmentRacks:componentType"
  },
  "index": false,
  "key": false
}

Back to Top