Jump to

• Request
• Response
• Examples

Search Data Tables

post

/rest/v19/datatables/actions/getQueryStatistics

This endpoint is used to search for data across multiple data tables. All data tables are queried if data table names are not specified in the request selections.

Request

Body ()

Root Schema : queryStatistics-request

Type: object

Show Source

• keyword: string
  Title: Keyword

  Text to search
• selections: array Table Names List
  Title: Table Names List

  The list of data tables to be searched.

{
    "type":"object",
    "properties":{
        "selections":{
            "type":"array",
            "description":"The list of data tables to be searched.",
            "title":"Table Names List",
            "items":{
                "$ref":"#/definitions/selection"
            }
        },
        "keyword":{
            "type":"string",
            "description":"Text to search",
            "title":"Keyword"
        }
    }
}

Nested Schema : Table Names List

Type: array

Title: Table Names List

The list of data tables to be searched.

Show Source

• Array of: integer
  Title: The Task ID

  Task ID

{
    "type":"array",
    "description":"The list of data tables to be searched.",
    "title":"Table Names List",
    "items":{
        "$ref":"#/definitions/selection"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Query statistics

Body ()

Root Schema : queryStatistics-response

Type: object

Show Source

• items: array Table search statistics
  Title: Table search statistics

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "title":"Table search statistics",
            "items":{
                "type":"object",
                "properties":{
                    "table":{
                        "$ref":"#/definitions/dataTable-getResponse"
                    },
                    "matchingRowCount":{
                        "type":"integer",
                        "description":"Number of rows whose content matched the search string.",
                        "title":"Matched Row Count"
                    },
                    "rowsLink":{
                        "type":"string",
                        "description":"The URL to retrieve rows with content that matched the search string.",
                        "title":"Rows Link"
                    }
                }
            }
        }
    }
}

Nested Schema : Table search statistics

Type: array

Title: Table search statistics

Show Source

• Array of: object items

{
    "type":"array",
    "title":"Table search statistics",
    "items":{
        "type":"object",
        "properties":{
            "table":{
                "$ref":"#/definitions/dataTable-getResponse"
            },
            "matchingRowCount":{
                "type":"integer",
                "description":"Number of rows whose content matched the search string.",
                "title":"Matched Row Count"
            },
            "rowsLink":{
                "type":"string",
                "description":"The URL to retrieve rows with content that matched the search string.",
                "title":"Rows Link"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• matchingRowCount: integer
  Title: Matched Row Count

  Number of rows whose content matched the search string.
• rowsLink: string
  Title: Rows Link

  The URL to retrieve rows with content that matched the search string.
• table: object dataTable-getResponse

{
    "type":"object",
    "properties":{
        "table":{
            "$ref":"#/definitions/dataTable-getResponse"
        },
        "matchingRowCount":{
            "type":"integer",
            "description":"Number of rows whose content matched the search string.",
            "title":"Matched Row Count"
        },
        "rowsLink":{
            "type":"string",
            "description":"The URL to retrieve rows with content that matched the search string.",
            "title":"Rows Link"
        }
    }
}

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: array links

{
    "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: array links

{
    "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 : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

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

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "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: array 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: array 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: array 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: array links

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

Back to Top

Examples

The following examples show how to search for data across multiple data tables by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/datatables/actions/getQueryStatistics

Request Body Sample

{
   "selections": [],
   "keyword": "router"
}
    

Response Body Sample

 {
  "items": [{
      "table": {
        "id": 36877868,
        "links": [{
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v19/datatables"
          }, {
            "rel": "self",
            "href": "https://sitename.oracle.com/rest/v19/datatables/Oracle_BomItemDef"
          }
        ],
        "name": "Oracle_BomItemDef"
      },
      "matchingRowCount": 13,
      "rowsLink": "https://sitename.oracle.com/rest/v19/adminCustomOracle_BomItemDef?q={$or:[{VariableName:{$like:" % router % ",$options:" I "}},{ItemId:{$like:" % router % ",$options:" I "}},{Name:{$like:" % router % ",$options:" I "}},{ItemType:{$like:" % router % ",$options:" I "}},{PartNumber:{$like:" % router % ",$options:" I "}},{Optional:{$like:" % router % ",$options:" I "}},{SalesItem:{$like:" % router % ",$options:" I "}},{ParentVariableName:{$like:" % router % ",$options:" I "}},{RootVariableName:{$like:" % router % ",$options:" I "}},{EffectiveFrom:{$like:" % router % ",$options:" I "}},{EffectiveTo:{$like:" % router % ",$options:" I "}},{ManufacturingItem:{$like:" % router % ",$options:" I "}},{IncludedInBasePrice:{$like:" % router % ",$options:" I "}},{ModelPath:{$like:" % router % ",$options:" I "}}]}"
    }, {
      "table": {
        "id": 36732877,
        "links": [{
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v19/datatables"
          }, {
            "rel": "self",
            "href": "https://sitename.oracle.com/rest/v19/datatables/Oracle_BomItemMap"
          }
        ],
        "name": "Oracle_BomItemMap"
      },
      "matchingRowCount": 13,
      "rowsLink": "https://sitename.oracle.com/rest/v19/adminCustomOracle_BomItemMap?q={$or:[{VariableName:{$like:" % router % ",$options:" I "}},{BomItemVarName:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName:{$like:" % router % ",$options:" I "}},{ConfigAttrValue:{$like:" % router % ",$options:" I "}},{ParentBomMapVarName:{$like:" % router % ",$options:" I "}},{EffectiveFrom:{$like:" % router % ",$options:" I "}},{EffectiveTo:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName1:{$like:" % router % ",$options:" I "}},{ConfigAttrValue1:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName2:{$like:" % router % ",$options:" I "}},{ConfigAttrValue2:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName3:{$like:" % router % ",$options:" I "}},{ConfigAttrValue3:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName4:{$like:" % router % ",$options:" I "}},{ConfigAttrValue4:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName5:{$like:" % router % ",$options:" I "}},{ConfigAttrValue5:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName6:{$like:" % router % ",$options:" I "}},{ConfigAttrValue6:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName7:{$like:" % router % ",$options:" I "}},{ConfigAttrValue7:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName8:{$like:" % router % ",$options:" I "}},{ConfigAttrValue8:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName9:{$like:" % router % ",$options:" I "}},{ConfigAttrValue9:{$like:" % router % ",$options:" I "}},{ConfigAttrVarName10:{$like:" % router % ",$options:" I "}},{ConfigAttrValue10:{$like:" % router % ",$options:" I "}}]}"
    }
  ],
}
    

Back to Top