openapi: 3.2.0
info:
  description: '<p>Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.</p><p>To install and configure Oracle REST Data Services refer to the <a href=https://docs.oracle.com/pls/topic/lookup?ctx=ords-latest&id=ORDIG> Oracle&reg REST Data Services Installation and Configuration Guide</a>.</p>

    <p>An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration. <p><p>The pattern for the API document URL is: </p>

    <code>https://&lt;server&gt;/&lt;context root&gt;/&lt;my database&gt;/&lt;my schema&gt;/_/db-api/stable/&lt;service path&gt;  </code>

    <p>Where, the <code>&lt;my database&gt;</code> and  <code>&lt;my schema&gt;</code> variables can be optional, depending on the ORDS configuration and the service invoked.'
  version: 2026.03.26
  title: Oracle REST Data Services Data Dictionary API
  contact:
    name: Oracle REST Data Services
    url: https://www.oracle.com/database/technologies/appdev/rest.html
  x-summary: Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API.
tags:
- name: Data Dictionary
  description: Services related to the tables and views that provide information about the database.
paths:
  /database/db_links/:
    get:
      tags:
      - Data Dictionary
      summary: Get all database links
      description: Describes all database links in the database. Uses DBA_DB_LINKS or ALL_DB_LINKS view depending on the role access at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All database links in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseLinks'
      x-internal-id: database-db_links--get
      x-filename-id: database-db_links-get
  /database/db_links/{owner},{db_link}:
    get:
      tags:
      - Data Dictionary
      summary: Get a database link
      description: Describes a database link in the database. Uses DBA_DB_LINKS or ALL_DB_LINKS view depending on the role access at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner for the database link.
        required: true
        schema:
          type: string
      - name: db_link
        in: path
        description: Name of the database link.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on the specific database link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseLinksItem'
      x-internal-id: database-db_links-{owner},{db_link}-get
      x-filename-id: database-db_links-owner-db_link-get
  /database/objects/:
    get:
      tags:
      - Data Dictionary
      summary: Get all database objects
      description: Returns all records from DBA_OBJECTS or ALL_OBJECTS depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All database objects in the database. Returns records from DBA_OBJECTS or ALL_OBJECTS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjects'
      x-internal-id: database-objects--get
      x-filename-id: database-objects-get
  /database/objects/{owner},{object_name},{object_type}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific object
      description: Returns the corresponding record from DBA_OBJECTS or ALL_OBJECTS view depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner for the index.
        required: true
        schema:
          type: string
      - name: object_name
        in: path
        description: Name of the object.
        required: true
        schema:
          type: string
      - name: object_type
        in: path
        description: Type of the object.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsItem'
      x-internal-id: database-objects-{owner},{object_name},{object_type}-get
      x-filename-id: database-objects-owner-object_name-object_type-get
  /database/objects/arguments/:
    get:
      tags:
      - Data Dictionary
      summary: Get all arguments for functions and procedures
      description: Returns all records from DBA_ARGUMENTS or ALL_ARGUMENTS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All records from DBA_ARGUMENTS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseArguments'
      x-internal-id: database-objects-arguments--get
      x-filename-id: database-objects-arguments-get
  /database/objects/arguments/{object_id},{subprogram_id},{argument_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get an argument
      description: Returns the specified argument information from DBA_ARGUMENTS or ALL_ARGUMENTS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: object_id
        in: path
        description: Identifier of the object the argument belongs to.
        required: true
        schema:
          type: number
      - name: subprogram_id
        in: path
        description: Identifier of the subprogram the argument belongs to.
        required: true
        schema:
          type: number
      - name: argument_name
        in: path
        description: Name of the argument.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information for the specified argument.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseArgumentsItem'
      x-internal-id: database-objects-arguments-{object_id},{subprogram_id},{argument_name}-get
      x-filename-id: database-objects-arguments-object_id-subprogram_id-argument_name-get
  /database/objects/columns/:
    get:
      tags:
      - Data Dictionary
      summary: Get all table columns
      description: Returns all records from DBA_TAB_COLUMNS or ALL_TAB_COLUMNS view depending on role at runtime. Records included in the response describes the columns of all tables, views, and clusters that the role has access to. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All columns in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsColumns'
      x-internal-id: database-objects-columns--get
      x-filename-id: database-objects-columns-get
  /database/objects/columns/{owner},{table_name},{column_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific column
      description: Returns the corresponding record from DBA_TAB_COLUMNS or ALL_TAB_COLUMNS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner for the index.
        required: true
        schema:
          type: string
      - name: table_name
        in: path
        description: Name of the table the column belongs to.
        required: true
        schema:
          type: string
      - name: column_name
        in: path
        description: Name of the column.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific column.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsColumnsItem'
      x-internal-id: database-objects-columns-{owner},{table_name},{column_name}-get
      x-filename-id: database-objects-columns-owner-table_name-column_name-get
  /database/objects/foreign_keys/:
    get:
      tags:
      - Data Dictionary
      summary: Get all foreign keys
      description: Returns all records where the constraint type is 'R' from DBA_CONSTRAINTS and DBA_CONS_COLUMNS, or ALL_CONSTRAINTS and ALL_CONS_COLUMNS, views depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Describes all constraint definitions, with constraint type 'R', on all tables in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsForeignKeys'
      x-internal-id: database-objects-foreign_keys--get
      x-filename-id: database-objects-foreign_keys-get
  /database/objects/foreign_keys/{owner},{constraint_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific foreign keys
      description: Returns the corresponding record from DBA_CONSTRAINTS and DBA_CONS_COLUMNS, or ALL_CONSTRAINTS and ALL_CONS_COLUMNS, views depending on role at runtime. Recorded included in the response are where the constraint type is 'R'. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner for the foreign key.
        required: true
        schema:
          type: string
      - name: constraint_name
        in: path
        description: Name of the constraint for the foreign key.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific foreign key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsForeignKeysItem'
      x-internal-id: database-objects-foreign_keys-{owner},{constraint_name}-get
      x-filename-id: database-objects-foreign_keys-owner-constraint_name-get
  /database/objects/functions/:
    get:
      tags:
      - Data Dictionary
      summary: Get all functions
      description: Returns records where OBJECT_TYPE = 'FUNCTION' from DBA_PROCEDURES or ALL_PROCEDURES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Description of all functions in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsFunctions'
      x-internal-id: database-objects-functions--get
      x-filename-id: database-objects-functions-get
  /database/objects/functions/{object_id}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific function
      description: Returns the corresponding record from DBA_PROCEDURES or ALL_PROCEDURES view depending on role at runtime. Records included in the response are where OBJECT_TYPE = 'FUNCTION'. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: object_id
        in: path
        description: Object Identifier for the function.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information for the specified function.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsFunctionsItem'
      x-internal-id: database-objects-functions-{object_id}-get
      x-filename-id: database-objects-functions-object_id-get
  /database/objects/indexes/:
    get:
      tags:
      - Data Dictionary
      summary: Get all indexes
      description: Describes all the indexes in the database using DBA_INDEXES or ALL_INDEXES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Description of all indexes in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsIndexes'
      x-internal-id: database-objects-indexes--get
      x-filename-id: database-objects-indexes-get
  /database/objects/indexes/{owner},{index_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific index
      description: Returns the corresponding record from DBA_INDEXES or ALL_INDEXES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner for the index.
        required: true
        schema:
          type: string
      - name: index_name
        in: path
        description: Name of the index.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific index.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsIndexesItem'
      x-internal-id: database-objects-indexes-{owner},{index_name}-get
      x-filename-id: database-objects-indexes-owner-index_name-get
  /database/objects/materialized_view_logs/:
    get:
      tags:
      - Data Dictionary
      summary: Get all materialized view logs
      description: Returns all records from DBA_MVIEW_LOGS or ALL_MVIEW_LOGS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All records from DBA_MVIEW_LOGS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsMaterializedViewLogs'
      x-internal-id: database-objects-materialized_view_logs--get
      x-filename-id: database-objects-materialized_view_logs-get
  /database/objects/materialized_view_logs/{log_owner},{log_table}:
    get:
      tags:
      - Data Dictionary
      summary: Get information on a specific materialized view log
      description: Returns the corresponding record from DBA_MVIEW_LOGS or ALL_MVIEW_LOGS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: log_owner
        in: path
        description: Owner for the materialized view log.
        required: true
        schema:
          type: string
      - name: log_table
        in: path
        description: Log table for the materialized view log.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific materialized view log.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsMaterializedViewLogsItem'
      x-internal-id: database-objects-materialized_view_logs-{log_owner},{log_table}-get
      x-filename-id: database-objects-materialized_view_logs-log_owner-log_table-get
  /database/objects/packages/procedures/:
    get:
      tags:
      - Data Dictionary
      summary: Get all procedures defined in package
      description: Returns all records from DBA_PROCEDURES or ALL_PROCEDURES view depending on role at runtime. Records included in the response are where OBJECT_TYPE = 'PACKAGE' and PROCEDURE_NAME is not null. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Describes all procedures that are defined in a package.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsProcedures'
      x-internal-id: database-objects-packages-procedures--get
      x-filename-id: database-objects-packages-procedures-get
  /database/objects/packages/procedures/{object_id},{subprogram_id}:
    get:
      tags:
      - Data Dictionary
      summary: Get a procedure that is defined in package
      description: Returns the corresponding record from DBA_PROCEDURES or ALL_PROCEDURES view depending on role at runtime. Records included in the response are where OBJECT_TYPE = 'PACKAGE' and PROCEDURE_NAME is not null. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: object_id
        in: path
        description: Object identifier for the package the procedure belongs to.
        required: true
        schema:
          type: number
      - name: subprogram_id
        in: path
        description: Subprogram identifier for the procedure.
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Information on the specified procedure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsProceduresItem'
      x-internal-id: database-objects-packages-procedures-{object_id},{subprogram_id}-get
      x-filename-id: database-objects-packages-procedures-object_id-subprogram_id-get
  /database/objects/partitions/:
    get:
      tags:
      - Data Dictionary
      summary: Get all partitions in the database
      description: Returns all records from DBA_TAB_PARTITIONS or ALL_TAB_PARTITIONS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Description of all partitions in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsPartitions'
      x-internal-id: database-objects-partitions--get
      x-filename-id: database-objects-partitions-get
  /database/objects/partitions/{table_owner},{table_name},{partition_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a partition
      description: Returns the specified partition information from DBA_TAB_PARTITIONS or ALL_TAB_PARTITIONS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: table_owner
        in: path
        description: Owner for the index.
        required: true
        schema:
          type: string
      - name: table_name
        in: path
        description: Name of the table.
        required: true
        schema:
          type: string
      - name: partition_name
        in: path
        description: Name of the partition.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information for the specified partition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsPartitionsItem'
      x-internal-id: database-objects-partitions-{table_owner},{table_name},{partition_name}-get
      x-filename-id: database-objects-partitions-table_owner-table_name-partition_name-get
  /database/objects/synonyms/:
    get:
      tags:
      - Data Dictionary
      summary: Get all synonyms in the database
      description: Returns all records on DBA_SYNONYMS or ALL_SYNONYMS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Describes, using DBA_SYNONYMS or ALL_SYNONYMS view, all synonyms in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsSynonyms'
      x-internal-id: database-objects-synonyms--get
      x-filename-id: database-objects-synonyms-get
  /database/objects/synonyms/{owner},{synonym_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a synonym
      description: Returns a record from DBA_SYNONYMS or ALL_SYNONYMS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner of the synonym.
        required: true
        schema:
          type: string
      - name: synonym_name
        in: path
        description: Name of the synonym.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific synonym.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsSynonymsItem'
      x-internal-id: database-objects-synonyms-{owner},{synonym_name}-get
      x-filename-id: database-objects-synonyms-owner-synonym_name-get
  /database/objects/tables/:
    get:
      tags:
      - Data Dictionary
      summary: Get all tables
      description: Describes all the tables in the database using DBA_TABLES or ALL_TABLES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All tables in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsTables'
      x-internal-id: database-objects-tables--get
      x-filename-id: database-objects-tables-get
  /database/objects/tables/{owner},{table_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific table
      description: Describes a specific table in the database using DBA_TABLES or ALL_TABLES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner of the table.
        required: true
        schema:
          type: string
      - name: table_name
        in: path
        description: Name of the table.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: All tables in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsTablesItem'
      x-internal-id: database-objects-tables-{owner},{table_name}-get
      x-filename-id: database-objects-tables-owner-table_name-get
  /database/tablespaces/:
    get:
      tags:
      - Data Dictionary
      summary: Get all tablespaces
      description: Describes all the tablespaces in the database using DBA_TABLESPACES or USER_TABLESPACES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: All tablespaces in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseTablespaces'
      x-internal-id: database-tablespaces--get
      x-filename-id: database-tablespaces-get
  /database/tablespaces/{tablespace_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get a specific tablespace
      description: Describes a specific tablespace in the database using DBA_TABLESPACES or USER_TABLESPACES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: tablespace_name
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: All tablespaces in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseTablespacesItem'
      x-internal-id: database-tablespaces-{tablespace_name}-get
      x-filename-id: database-tablespaces-tablespace_name-get
  /database/objects/types/:
    get:
      tags:
      - Data Dictionary
      summary: Get all object types
      description: Describes all object types in the database. Uses DBA_TYPES or ALL_TYPES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          description: Description of all object types in the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsTypes'
      x-internal-id: database-objects-types--get
      x-filename-id: database-objects-types-get
  /database/objects/types/{owner},{type_name}:
    get:
      tags:
      - Data Dictionary
      summary: Get an object type
      description: Describes a specific object type in the database. Uses DBA_TYPES or ALL_TYPES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
      parameters:
      - name: owner
        in: path
        description: Owner of the type.
        required: true
        schema:
          type: string
      - name: type_name
        in: path
        description: Name of the type.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific object type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectsTypesItem'
      x-internal-id: database-objects-types-{owner},{type_name}-get
      x-filename-id: database-objects-types-owner-type_name-get
components:
  schemas:
    DatabaseArgumentsItem:
      type: object
      description: This object represents arguments of the functions and procedures that are available in the database. The list of attributes may vary depending on database version.
      properties:
        owner:
          type: string
          description: Owner of the object.
        object_name:
          type: string
          description: Name of the procedure or function.
        package_name:
          type: string
          description: Name of the package.
        object_id:
          type: integer
          description: Dictionary object number of the object.
        overload:
          type: string
          description: Indicates the nth overloading ordered by its appearance in the source; otherwise, it is NULL.
        subprogram_id:
          type: integer
          description: Unique subprogram identifier.
        argument_name:
          type: string
          description: If the argument is a scalar type, then the argument name is the name of the argument. A null argument name is used to denote a function return. If the function return or argument is a composite type, this view will have one row for each attribute of the composite type. Attributes are recursively expanded if they are composite.
        position:
          type: integer
          description: If DATA_LEVEL is zero, then this column holds the position of this item in the argument list, or zero for a function return value.If DATA_LEVEL is greater than zero, then this column holds the position of this item with respect to its siblings at the same DATA_LEVEL. So, for a referenced record field, this is the index of the field within the record. For a referenced collection element, this is 1 (because collection elements do not have siblings.)
        sequence:
          type: integer
          description: Defines the sequential order of the argument and its attributes. Argument sequence starts from 1. Return type and its recursively expanded (preorder tree walk) attributes will come first, and each argument with its recursively expanded (preorder tree walk) attributes will follow.
        data_level:
          type: integer
          description: Nesting depth of the argument for composite types.
        data_type:
          type: string
          description: Datatype of the argument.
        defaulted:
          type: string
          description: Specifies whether or not the argument is defaulted.
        default_value:
          type: integer
          description: Reserved for future use.
        default_length:
          type: integer
          description: Reserved for future use.
        in_out:
          type: string
          description: 'Direction of the argument: IN, OUT, IN/OUT.'
        data_length:
          type: integer
          description: Length of the column (in bytes).
        data_precision:
          type: integer
          description: Length in decimal digits (NUMBER) or binary digits (FLOAT).
        data_scale:
          type: integer
          description: Digits to the right of the decimal point in a number.
        radix:
          type: integer
          description: Argument radix for a number.
        character_set_name:
          type: string
          description: Character set name for the argument.
        type_owner:
          type: string
          description: Owner of the type of the argument.
        type_name:
          type: string
          description: Name of the type of the argument. If the type is a package local type (that is, it is declared in a package specification), then this column displays the name of the package.
        type_subname:
          type: string
          description: Relevant only for package local types. Displays the name of the type declared in the package identified in the TYPE_NAME column.
        type_link:
          type: string
          description: Relevant only for package local types when the package identified in the TYPE_NAME column is a remote package. This column displays the database link used to refer to the remote package.
        type_object_type:
          type: string
          description: Displays the type of the type described by the TYPE_OWNER, TYPE_NAME, and TYPE_SUBNAME columns.
        pls_type:
          type: string
          description: For numeric arguments, the name of the PL/SQL type of the argument. Null otherwise.
        char_length:
          type: integer
          description: Character limit for string datatypes.
        char_used:
          type: string
          description: Indicates whether the byte limit (B) or char limit (C) is official for the string.
        origin_con_id:
          type: integer
          description: The ID of the container where the data originates.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjects:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsIndexesItem:
      type: object
      description: Describes an index in the database.
      properties:
        owner:
          type: string
          description: Owner of the index.
        index_name:
          type: string
          description: Name of the index.
        index_type:
          type: string
          description: Type of the index.
        table_owner:
          type: string
          description: Owner of the indexed object.
        table_name:
          type: string
          description: Name of the indexed object.
        table_type:
          type: string
          description: Type of the indexed object.
        uniqueness:
          type: string
          description: Indicates whether the index is unique (UNIQUE) or nonunique (NONUNIQUE).
        compression:
          type: string
          description: The type of compression being used for the index.
        prefix_length:
          type: integer
          description: Number of columns in the prefix of the compression key.
        tablespace_name:
          type: string
          description: Name of the tablespace containing the index.
        ini_trans:
          type: integer
          description: Initial number of transactions.
        max_trans:
          type: integer
          description: Maximum number of transactions.
        initial_extent:
          type: integer
          description: Size of the initial extent.
        next_extent:
          type: integer
          description: Size of secondary extents.
        min_extents:
          type: integer
          description: Minimum number of extents allowed in the segment.
        max_extents:
          type: integer
          description: Maximum number of extents allowed in the segment.
        pct_increase:
          type: number
          description: Percentage increase in extent size.
        pct_threshold:
          type: number
          description: Threshold percentage of block space allowed per index entry.
        include_column:
          type: integer
          description: Column ID of the last column to be included in index-organized table primary key (non-overflow) index.
        freelists:
          type: integer
          description: Number of process freelists allocated to this segment.
        freelist_groups:
          type: integer
          description: Number of freelist groups allocated to this segment.
        pct_free:
          type: integer
          description: Minimum percentage of free space in a block.
        logging:
          type: string
          description: Indicates whether or not changes to the index are logged.
        blevel:
          type: integer
          description: B*-Tree level (depth of the index from its root block to its leaf blocks). A depth of 0 indicates that the root block and leaf block are the same.
        leaf_blocks:
          type: integer
          description: Number of leaf blocks in the index.
        distinct_keys:
          type: integer
          description: Number of distinct indexed values.
        avg_leaf_blocks_per_key:
          type: integer
          description: Average number of leaf blocks in which each distinct value in the index appears, rounded to the nearest integer.
        avg_data_blocks_per_key:
          type: integer
          description: Average number of data blocks in the table that are pointed to by a distinct value in the index rounded to the nearest integer.
        clustering_factor:
          type: number
          description: Indicates the amount of order of the rows in the table based on the values of the index.
        status:
          type: string
          description: Indicates whether a nonpartitioned index is VALID or UNUSABLE.
        num_rows:
          type: integer
          description: Number of rows in the index.
        sample_size:
          type: integer
          description: Size of the sample used to analyze the index.
        last_analyzed:
          type: string
          description: Date on which this index was most recently analyzed.
        degree:
          type: string
          description: Number of threads per instance for scanning the index, or DEFAULT.
        instances:
          type: string
          description: Number of instances across which the indexes to be scanned, or DEFAULT.
        partitioned:
          type: string
          description: Indicates whether the index is partitioned (YES) or not (NO).
        temporary:
          type: string
          description: Indicates whether the index is on a temporary table (Y) or not (N).
        generated:
          type: string
          description: Indicates whether the name of the index is system-generated (Y) or not (N).
        secondary:
          type: string
          description: Indicates whether the index is a secondary object created by the ODCIIndexCreate method of the Oracle Data Cartridge (Y) or not (N).
        buffer_pool:
          type: string
          description: Buffer pool to be used for index blocks.
        flash_cache:
          type: string
          description: Database Smart Flash Cache hint to be used for index blocks.
        cell_flash_cache:
          type: string
          description: Cell flash cache hint to be used for index blocks.
        user_stats:
          type: string
          description: Indicates whether statistics were entered directly by the user (YES) or not (NO).
        duration:
          type: string
          description: Indicates the duration of a temporary table.
        pct_direct_access:
          type: number
          description: For a secondary index on an index-organized table, the percentage of rows with VALID guess.
        ityp_owner:
          type: string
          description: For a domain index, the owner of the indextype.
        ityp_name:
          type: string
          description: For a domain index, the name of the indextype.
        parameters:
          type: string
          description: For a domain index, the parameter string.
        global_stats:
          type: string
          description: GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO.
        domidx_status:
          type: string
          description: Status of a domain index.
        domidx_opstatus:
          type: string
          description: Status of the operation on a domain index.
        funcidx_status:
          type: string
          description: Status of a function-based index.
        join_index:
          type: string
          description: Indicates whether the index is a join index (YES) or not (NO).
        iot_redundant_pkey_elim:
          type: string
          description: Indicates whether redundant primary key columns are eliminated from secondary indexes on index-organized tables (YES) or not (NO).
        dropped:
          type: string
          description: Indicates whether redundant primary key columns are eliminated from secondary indexes on index-organized tables (YES) or not (NO).
        visibility:
          type: string
          description: Indicates whether the index is VISIBLE or INVISIBLE to the optimizer.
        domidx_management:
          type: string
          description: If this is a domain index, indicates whether the domain index is system-managed (SYSTEM_MANAGED) or user-managed (USER_MANAGED).
        segment_created:
          type: string
          description: Indicates whether the index segment has been created (YES) or not (NO).
        orphaned_entries:
          type: string
          description: Indicates whether a global index contains stale entries because of deferred index maintenance during DROP/TRUNCATE PARTITION, or MODIFY PARTITION INDEXING OFF operations.
        indexing:
          type: string
          description: Indicates whether a global index is decoupled from the underlying table.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsForeignKeys:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsForeignKeysItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseArguments:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseArgumentsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsTables:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsTablesItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsIndexes:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsIndexesItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseTablespacesItem:
      type: object
      description: Describes a tablespace in the database.
      properties:
        tablespace_name:
          type: string
          description: Name of the tablespace.
        file_name:
          type: string
          description: Name of the database file.
        file_id:
          type: integer
          description: File identifier number of the database file.
        bytes:
          type: integer
          description: Size of the file (in bytes).
        blocks:
          type: integer
          description: Size of the file (in Oracle blocks).
        status:
          type: string
          description: File status.
        relative_fno:
          type: integer
          description: Tablespace-relative file number.
        autoextensible:
          type: string
          description: Indicates whether the file is autoextensible (YES) or not (NO).
        maxbytes:
          type: integer
          description: Maximum size of the file (in bytes).
        maxblocks:
          type: integer
          description: Maximum size of the file (in Oracle blocks).
        increment_by:
          type: integer
          description: Default increment for autoextension (in Oracle blocks).
        user_bytes:
          type: integer
          description: The size of the file available for user data. The actual size of the file minus the USER_BYTES value is used to store file related metadata.
        user_blocks:
          type: integer
          description: Size of the useful portion of the file (in Oracle blocks).
        online_status:
          type: string
          description: Online status of the file.
        total_space:
          type: integer
          description: Total size of the files (in bytes).
        used_space:
          type: integer
          description: Total used space (in bytes).
        free_space:
          type: integer
          description: Total free space (in bytes).
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsColumns:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsColumnsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsPartitionsItem:
      type: object
      description: This object represents partition-level partitioning information, partition storage parameters, and partition statistics generated by the DBMS_STATS package for a partition in the database. The list of attributes may vary depending on database version.
      properties:
        table_owner:
          type: string
          description: Owner of the table.
        table_name:
          type: string
          description: Name of the table.
        composite:
          type: string
          description: Indicates whether the table is composite-partitioned (YES) or not (NO).
        partition_name:
          type: string
          description: Name of the partition.
        subpartition_count:
          type: integer
          description: If this is a composite partitioned table, the number of subpartitions in the partition.
        high_value:
          type: number
          description: Partition bound value expression.
        high_value_length:
          type: integer
          description: Length of the partition bound value expression.
        partition_position:
          type: integer
          description: Position of the partition within the table.
        tablespace_name:
          type: string
          description: Name of the tablespace containing the partition.
        pct_free:
          type: integer
          description: Minimum percentage of free space in a block.
        pct_used:
          type: integer
          description: Minimum percentage of used space in a block.
        ini_trans:
          type: integer
          description: Initial number of transactions.
        max_trans:
          type: integer
          description: Maximum number of transactions.
        initial_extent:
          type: integer
          description: Size of the initial extent in bytes (for a range partition); size of the initial extent in blocks (for a composite partition).
        next_extent:
          type: integer
          description: Size of secondary extents in bytes (for a range partition); size of secondary extents in blocks (for a composite partition).
        min_extent:
          type: integer
          description: Minimum number of extents allowed in the segment.
        max_extent:
          type: integer
          description: Maximum number of extents allowed in the segment.
        max_size:
          type: integer
          description: Maximum number of blocks allowed in the segment.
        pct_increase:
          type: integer
          description: Percentage increase in extent size.
        freelists:
          type: integer
          description: Number of process freelists allocated in this segment.
        freelist_groups:
          type: integer
          description: Number of freelist groups allocated in this segment.
        logging:
          type: string
          description: Indicates whether or not changes to the table are logged.
        compression:
          type: string
          description: Indicates the actual compression property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE.
        compress_for:
          type: string
          description: Default compression for what kind of operations.
        num_rows:
          type: integer
          description: Number of rows in the partition.
        blocks:
          type: integer
          description: Number of used data blocks in the partition.
        empty_blocks:
          type: integer
          description: Number of empty (never used) data blocks in the partition. This column is populated only if you collect statistics on the table using the DBMS_STATS package.
        avg_space:
          type: integer
          description: Average amount of free space, in bytes, in a data block allocated to the partition.
        chain_cnt:
          type: integer
          description: Number of rows in the partition that are chained from one data block to another, or which have migrated to a new block, requiring a link to preserve the old ROWID.
        avg_row_len:
          type: integer
          description: Average length of a row in the partition (in bytes).
        sample_size:
          type: integer
          description: Sample size used in analyzing this partition.
        last_analyzed:
          type: string
          description: Date on which this partition was most recently analyzed.
        buffer_pool:
          type: string
          description: Buffer pool to be used for the partition blocks.
        flash_cache:
          type: string
          description: Buffer pool to be used for the partition blocks.
        cell_flash_cache:
          type: string
          description: Cell flash cache hint to be used for partition blocks.
        global_stats:
          type: string
          description: GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO.
        user_stats:
          type: string
          description: Indicates whether statistics were entered directly by the user (YES) or not (NO).
        is_nested:
          type: string
          description: Indicates whether this is a nested table partition (YES) or not (NO).
        parent_table_partition:
          type: string
          description: Parent table's corresponding partition.
        interval:
          type: string
          description: Indicates whether the partition is in the interval section of an interval partitioned table (YES) or whether the partition is in the range section (NO).
        segment_created:
          type: string
          description: Indicates the actual segment creation property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE.
        indexing:
          type: string
          description: Indicates the actual indexing property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE.
        read_only:
          type: string
          description: Indicates the default setting for the partition.
        inmemory:
          type: string
          description: Indicates whether the In-Memory Column Store (IM column store) is enabled (ENABLED) or disabled (DISABLED) for this partition.
        inmemory_priority:
          type: string
          description: Indicates the priority for In-Memory Column Store (IM column store) population.
        inmemory_distribute:
          type: string
          description: Indicates how the IM column store is distributed in an Oracle Real Application Clusters (Oracle RAC) environment.
        inmemory_compression:
          type: string
          description: Indicates the compression level for the IM column store.
        inmemory_duplicate:
          type: string
          description: Indicates the duplicate setting for the IM column store in an Oracle RAC environment.
        cellmemory:
          type: string
          description: The value for columnar compression in the storage cell flash cache.
        inmemory_service:
          type: string
          description: Indicates how the IM column store is populated on various instances.
        inmemory_service_name:
          type: string
          description: Indicates the service name for the service on which the IM column store should be populated. This column has a value only when the corresponding INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null.
        memoptimize_read:
          type: string
          description: Indicates whether the table is enabled for Fast Key Based Access (ENABLED) or not (DISABLED).
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsColumnsItem:
      type: object
      description: Describes the column of table, view, or cluster in the database.
      properties:
        owner:
          type: string
          description: Owner of the table, view, or cluster.
        table_name:
          type: string
          description: Name of the table, view, or cluster.
        column_name:
          type: string
          description: Column name.
        data_type:
          type: string
          description: Data type of the column.
        data_type_mod:
          type: string
          description: Data type modifier of the column.
        data_type_owner:
          type: string
          description: Owner of the data type of the column.
        data_length:
          type: integer
          description: Length of the column (in bytes).
        data_precision:
          type: integer
          description: Decimal precision for NUMBER data type; binary precision for FLOAT data type; NULL for all other data types.
        data_scale:
          type: integer
          description: Digits to the right of the decimal point in a number.
        nullable:
          type: string
          description: Indicates whether a column allows NULLs. The value is N if there is a NOT NULL constraint on the column or if the column is part of a PRIMARY KEY. The constraint should be in an ENABLE VALIDATE state.
        column_id:
          type: integer
          description: Sequence number of the column as created.
        default_length:
          type: number
          description: Length of the default value for the column.
        data_default:
          type: integer
          description: Default value for the column.
        num_distinct:
          type: number
          description: Number of distinct values in the column.
        low_value:
          type: string
          description: Low value in the column.
        high_value:
          type: string
          description: High value in the column.
        density:
          type: number
          description: If a histogram is available on COLUMN_NAME, then this column displays the selectivity of a value that spans fewer than 2 endpoints in the histogram. It does not represent the selectivity of values that span 2 or more endpoints. If a histogram is not available on COLUMN_NAME, then the value of this column is 1/NUM_DISTINCT.
        num_nulls:
          type: integer
          description: Number of NULLs in the column.
        num_buckets:
          type: integer
          description: Number of buckets in the histogram for the column.
        last_analyzed:
          type: string
          description: Date on which this column was most recently analyzed.
        sample_size:
          type: integer
          description: Sample size used in analyzing this column.
        character_set_name:
          type: string
          description: Name of the character set.
        char_col_decl_length:
          type: number
          description: Declaration length of the character type column.
        global_stats:
          type: string
          description: GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO.
        user_stats:
          type: string
          description: Indicates whether statistics were entered directly by the user (YES) or not (NO).
        avg_col_len:
          type: integer
          description: Average length of the column (in bytes).
        char_length:
          type: integer
          description: Displays the length of the column in characters.
        char_used:
          type: string
          description: 'Indicates that the column uses BYTE length semantics (B) or CHAR length semantics (C), or whether the data type is not any of the following (NULL): CHAR, VARCHAR2, NCHAR, NVARCHAR2.'
        v80_fmt_image:
          type: string
          description: Indicates whether the column data is in release 8.0 image format (YES) or not (NO).
        data_upgraded:
          type: string
          description: Indicates whether the column data has been upgraded to the latest type version format (YES) or not (NO).
        histogram:
          type: string
          description: Indicates existence/type of histogram.
        default_on_null:
          type: string
          description: Indicates whether the column has DEFAULT ON NULL semantics (YES) or not (NO).
        identity_column:
          type: string
          description: Indicates whether this is an identity column (YES) or not (NO).
        sensitive_column:
          type: string
          description: Indicates whether this is a sensitive column (YES) or not (NO).
        evaluation_edition:
          type: string
          description: Name of the edition in which editioned objects referenced in an expression column are resolved.
        unusable_before:
          type: string
          description: Name of the oldest edition in which the index may be used as part of a query plan.
        unusable_beginning:
          type: string
          description: Name of the edition for which the index may not be used as part of a query plan in this edition or any of its descendants.
        collation:
          type: string
          description: Collation for the column. Only applies to columns with character data types.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsTypes:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsTypesItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseTablespaces:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseTablespacesItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsTablesItem:
      type: object
      description: This object describes a relational table in the database.
      properties:
        owner:
          type: string
          description: Owner of the table.
        table_name:
          type: string
          description: Name of the table.
        tablespace_name:
          type: string
          description: Name of the tablespace containing the table; NULL for partitioned, temporary, and index-organized tables.
        cluster_name:
          type: string
          description: Name of the cluster, if any, to which the table belongs.
        iot_name:
          type: string
          description: Name of the index-organized table, if any, to which the overflow or mapping table entry belongs. If the IOT_TYPE column is not NULL, then this column contains the base table name.
        status:
          type: string
          description: If a previous DROP TABLE operation failed, indicates whether the table is unusable (UNUSABLE) or valid (VALID).
        pct_free:
          type: integer
          description: Minimum percentage of free space in a block; NULL for partitioned tables.
        pct_used:
          type: integer
          description: Minimum percentage of used space in a block; NULL for partitioned tables.
        ini_trans:
          type: integer
          description: Initial number of transactions; NULL for partitioned tables.
        max_trans:
          type: integer
          description: Maximum number of transactions; NULL for partitioned tables.
        initial_extent:
          type: integer
          description: Size of the initial extent (in bytes); NULL for partitioned tables.
        next_extent:
          type: integer
          description: Size of secondary extents (in bytes); NULL for partitioned tables.
        min_extents:
          type: integer
          description: Minimum number of extents allowed in the segment; NULL for partitioned tables.
        max_extents:
          type: integer
          description: Maximum number of extents allowed in the segment; NULL for partitioned tables.
        pct_increase:
          type: integer
          description: Percentage increase in extent size; NULL for partitioned tables.
        freelists:
          type: integer
          description: Number of process freelists allocated to the segment; NULL for partitioned tables.
        freelist_groups:
          type: integer
          description: Number of freelist groups allocated to the segment; NULL for partitioned tables.
        logging:
          type: string
          description: Indicates whether or not changes to the table are logged; YES, NO, or NULL for partitioned tables.
        backed_up:
          type: string
          description: Indicates whether the table has been backed up since the last modification (Y) or not (N).
        num_rows:
          type: integer
          description: Number of rows in the table.
        blocks:
          type: integer
          description: Number of used data blocks in the table.
        empty_blocks:
          type: integer
          description: Number of empty (never used) data blocks in the table. This column is populated only if you collect statistics on the table using the DBMS_STATS package.
        avg_space:
          type: integer
          description: Average amount of free space, in bytes, in a data block allocated to the table.
        chain_cnt:
          type: integer
          description: Number of rows in the table that are chained from one data block to another, or which have migrated to a new block, requiring a link to preserve the old ROWID.
        avg_row_len:
          type: integer
          description: Average length of a row in the table (in bytes).
        avg_space_freelist_blocks:
          type: integer
          description: Average freespace of all blocks on a freelist.
        num_freelist_blocks:
          type: integer
          description: Number of blocks on the freelist.
        degree:
          type: string
          description: Number of threads per instance for scanning the table, or DEFAULT.
        instances:
          type: string
          description: Number of instances across which the table is to be scanned, or DEFAULT.
        cache:
          type: string
          description: Indicates whether the table is to be cached in the buffer cache (Y) or not (N).
        table_lock:
          type: string
          description: Indicates whether table locking is enabled (ENABLED) or disabled (DISABLED).
        sample_size:
          type: integer
          description: Sample size used in analyzing this table.
        last_analyzed:
          type: string
          description: Date on which this table was most recently analyzed.
        partitioned:
          type: string
          description: Indicates whether the table is partitioned (YES) or not (NO).
        iot_type:
          type: string
          description: If the table is an index-organized table, then IOT_TYPE is IOT, IOT_OVERFLOW, or IOT_MAPPING. If the table is not an index-organized table, then IOT_TYPE is NULL.
        temporary:
          type: string
          description: Indicates whether the table is temporary (Y) or not (N).
        secondary:
          type: string
          description: Indicates whether the table is a secondary object created by the ODCIIndexCreate method of the Oracle Data Cartridge (Y) or not (N).
        nested:
          type: string
          description: Indicates whether the table is a nested table (YES) or not (NO).
        buffer_pool:
          type: string
          description: Buffer pool for the table.
        flash_cache:
          type: string
          description: Database Smart Flash Cache hint to be used for table blocks.
        cell_flash_cache:
          type: string
          description: Cell flash cache hint to be used for table blocks.
        row_movement:
          type: string
          description: Indicates whether partitioned row movement is enabled (ENABLED) or disabled (DISABLED).
        global_stats:
          type: string
          description: GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO.
        user_stats:
          type: string
          description: Indicates whether statistics were entered directly by the user (YES) or not (NO).
        duration:
          type: string
          description: Indicates the duration of a temporary table.
        skip_corrupt:
          type: string
          description: Indicates whether Oracle Database ignores blocks marked corrupt during table and index scans (ENABLED) or raises an error (DISABLED). To enable this feature, run the DBMS_REPAIR.SKIP_CORRUPT_BLOCKS procedure.
        monitoring:
          type: string
          description: Indicates whether the table has the MONITORING attribute set (YES) or not (NO).
        cluster_owner:
          type: string
          description: Owner of the cluster, if any, to which the table belongs.
        dependencies:
          type: string
          description: Indicates whether row-level dependency tracking is enabled (ENABLED) or disabled (DISABLED).
        compression:
          type: string
          description: Indicates whether table compression is enabled (ENABLED) or not (DISABLED); NULL for partitioned tables.
        compress_for:
          type: string
          description: Default compression for what kind of operations:.
        dropped:
          type: string
          description: Indicates whether the table has been dropped and is in the recycle bin (YES) or not (NO); NULL for partitioned tables. This view does not return the names of tables that have been dropped.
        read_only:
          type: string
          description: Indicates whether the table segment is READ-ONLY or not.
        segment_created:
          type: string
          description: Indicates whether the table segment is created.
        result_cache:
          type: string
          description: Result cache mode annotation for the table.
        clustering:
          type: string
          description: Indicates whether the table has the attribute clustering clause (YES) or not (NO).
        activity_tracking:
          type: string
          description: Indicates whether Heat Map tracking is enabled on the table.
        dml_timestamp:
          type: string
          description: Modification time, creation time, or both for Automatic Data Optimization.
        has_identity:
          type: string
          description: Indicates whether the table has an identity column (YES) or not (NO).
        container_data:
          type: string
          description: Indicates whether the table contains container-specific data.
        inmemory:
          type: string
          description: Indicates whether the In-Memory Column Store (IM column store) is enabled (ENABLED) or disabled (DISABLED) for this table
        inmemory_priority:
          type: string
          description: Indicates the priority for In-Memory Column Store (IM column store) population.
        inmemory_distribute:
          type: string
          description: Indicates how the IM column store is distributed in an Oracle Real Application Clusters (Oracle RAC) environment.
        inmemory_compression:
          type: string
          description: Indicates the compression level for the IM column store.
        inmemory_duplicate:
          type: string
          description: Indicates the duplicate setting for the IM column store in an Oracle RAC environment.
        default_collation:
          type: string
          description: Default collation for the table.
        duplicated:
          type: string
          description: Indicates whether this object is duplicated on this shard (Y) or not (N).
        sharded:
          type: string
          description: Indicates whether this object is sharded (Y) or not (N).
        external:
          type: string
          description: Indicates whether the table is an external table (YES) or not (NO).
        hybrid:
          type: string
          description: Indicates whether the table is a hybrid partitioned table (YES) or not (NO). A hybrid partitioned table can contain a mixture of partitions stored in segments and partitions stored externally.
        cellmemory:
          type: string
          description: The value for columnar compression in the storage cell flash cache.
        containers_default:
          type: string
          description: Indicates whether the table is enabled for CONTAINERS() by default (YES) or not (NO).
        container_map:
          type: string
          description: Indicates whether the table is enabled for use with the container_map database property (YES) or not (NO).
        extended_data_link:
          type: string
          description: Indicates whether the table is enabled for fetching an extended data link from the root (YES) or not (NO).
        inmemory_service:
          type: string
          description: Indicates how the IM column store is populated on various instances.
        inmemory_service_name:
          type: string
          description: Indicates the service name for the service on which the IM column store should be populated. This column has a value only when the corresponding INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null.
        container_map_object:
          type: string
          description: Indicates whether the table is used as the value of the container_map database property (YES) or not (NO).
        memoptimize_read:
          type: string
          description: Indicates whether the table is enabled for Fast Key Based Access (ENABLED) or not (DISABLED).
        has_sensitive_column:
          type: string
          description: Indicates whether the table has one or more sensitive columns (YES) or not (NO).
        admit_null:
          type: string
          description: Indicates whether the table admits null CON_ID data (YES) or not (NO).
        data_link_dml_enabled:
          type: string
          description: Indicates whether DML is permitted on the Data Link table (YES) or not (NO).
        logical_replication:
          type: string
          description: Indicates whether the table is enabled for logical replication (ENABLED) or not (DISABLED). This setting is ignored if database-wide column data supplemental logging is enabled.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsSynonyms:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsSynonymsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsProceduresItem:
      type: object
      description: Describes a procedure available in the database, along with associated properties. The list of attributes may vary depending on database version.
      properties:
        owner:
          type: string
          description: Owner of the procedure.
        object_name:
          type: string
          description: Name of the procedure package.
        procedure_name:
          type: string
          description: Name of the procedure.
        object_id:
          type: integer
          description: Object number of the object.
        subprogram_id:
          type: integer
          description: Unique subprogram identifier.
        overload:
          type: string
          description: Overload unique identifier.
        object_type:
          type: string
          description: The typename of the object.
        aggregate:
          type: string
          description: Indicates whether the procedure is an aggregate function (YES) or not (NO).
        pipelined:
          type: string
          description: Indicates whether the procedure is a pipelined table function (YES) or not (NO).
        impltypeowner:
          type: string
          description: Owner of the implementation type, if any.
        impltypename:
          type: string
          description: Name of the implementation type, if any.
        parallel:
          type: string
          description: Indicates whether the procedure or function is parallel-enabled (YES) or not (NO).
        interface:
          type: string
          description: YES, if the procedure/function is a table function implemented using the ODCI interface; otherwise NO.
        deterministic:
          type: string
          description: YES, if the procedure/function is declared to be deterministic; otherwise NO.
        authid:
          type: string
          description: Indicates whether the procedure/function is declared to execute as DEFINER or CURRENT_USER (invoker).
        result_cache:
          type: string
          description: Indicates whether the function is result???cached (YES) or not (NO).
        origin_con_id:
          type: integer
          description: The ID of the container where the data originates.
        polymorphic:
          type: string
          description: The type of polymorphic table function.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    LinkRelation:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
      required:
      - rel
      - href
    DatabaseObjectsForeignKeysItem:
      type: object
      description: Describes a foreign key constraint for referential integrity.
      properties:
        owner:
          type: string
          description: Owner of the constraint definition.
        constraint_name:
          type: string
          description: Owner of the constraint definition.
        constraint_type:
          type: string
          description: Type of constraint.
        table_name:
          type: string
          description: Name associated with the table (or view) with the constraint definition.
        r_owner:
          type: string
          description: Owner of the table referred to in a referential constraint.
        r_constraint_name:
          type: string
          description: Owner of the constraint definition.
        columns:
          type: object
          description: Describes all the columns that make reference to  owner, constraint_name.
          properties:
            r_column_name:
              type: string
              description: Name of the column referred to in a referential constraint.
            r_table_name:
              type: string
              description: Name of the table referred to in a referential constraint.
            column_name:
              type: string
              description: Name of the column or attribute of the object type column specified in the constraint definition.
            position:
              type: integer
              description: The position of the column_name and referenced r_column_name.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsFunctionsItem:
      type: object
      description: Describes a function available in the database, along with associated properties. The list of attributes may vary depending on database version.
      properties:
        owner:
          type: string
          description: Owner of the function.
        object_name:
          type: string
          description: Name of the top-level function.
        procedure_name:
          type: string
          description: Name of the procedure.
        object_id:
          type: integer
          description: Object number of the object.
        subprogram_id:
          type: integer
          description: Unique subprogram identifier.
        overload:
          type: string
          description: Overload unique identifier.
        object_type:
          type: string
          description: The typename of the object.
        aggregate:
          type: string
          description: Indicates whether the procedure is an aggregate function (YES) or not (NO).
        pipelined:
          type: string
          description: Indicates whether the procedure is a pipelined table function (YES) or not (NO).
        impltypeowner:
          type: string
          description: Owner of the implementation type, if any.
        impltypename:
          type: string
          description: Name of the implementation type, if any.
        parallel:
          type: string
          description: Indicates whether the procedure or function is parallel-enabled (YES) or not (NO).
        interface:
          type: string
          description: YES, if the procedure/function is a table function implemented using the ODCI interface; otherwise NO.
        deterministic:
          type: string
          description: YES, if the procedure/function is declared to be deterministic; otherwise NO.
        authid:
          type: string
          description: Indicates whether the procedure/function is declared to execute as DEFINER or CURRENT_USER (invoker).
        result_cache:
          type: string
          description: Indicates whether the function is result???cached (YES) or not (NO).
        origin_con_id:
          type: integer
          description: The ID of the container where the data originates.
        polymorphic:
          type: string
          description: The type of polymorphic table function.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseLinks:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseLinksItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    Filter:
      type: object
      description: See Oracle REST Data Services production documentation 'Filtering in Queries' section.
      externalDocs:
        url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/
      anyOf:
      - type: object
        description: Any key / value pair for specifying a Filter Criteria.
      - type: object
        properties:
          $orderby:
            description: Specify which properties to order the result set by.
            type: object
          $asof:
            description: Specify a time related query parameter to limit the results. Parameter value can be a System Change Number or a Date.
            type: object
    DatabaseObjectsMaterializedViewLogs:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsMaterializedViewLogsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsFunctions:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsFunctionsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsPartitions:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsPartitionsItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsItem:
      type: object
      description: A description of an object in the database.
      properties:
        owner:
          type: string
          description: Owner of the object.
        object_name:
          type: string
          description: Name of the object.
        subobject_name:
          type: string
          description: Name of the subobject (for example, partition).
        object_id:
          type: integer
          description: Dictionary object number of the object.
        data_object_id:
          type: integer
          description: Dictionary object number of the segment that contains the object.
        object_type:
          type: string
          description: Type of the object (such as TABLE, INDEX).
        created:
          type: string
          description: Timestamp for the creation of the object.
        last_ddl_time:
          type: string
          description: Timestamp for the last modification of the object and dependent objects resulting from a DDL statement (including grants and revokes).
        timestamp:
          type: string
          description: Timestamp for the specification of the object (character data).
        status:
          type: string
          description: Status of the object.
        temporary:
          type: string
          description: Indicates whether the object is temporary (the current session can see only data that it placed in this object itself) (Y) or not (N).
        generated:
          type: string
          description: Indicates whether the name of this object was system-generated (Y) or not (N).
        secondary:
          type: string
          description: Indicates whether this is a secondary object created by the ODCIIndexCreate method of the Oracle Data Cartridge (Y) or not (N).
        namespace:
          type: integer
          description: Namespace for the object.
        edition_name:
          type: string
          description: Name of the edition in which the object is actual.
        sharing:
          type: string
          description: Indicates if the object is a metadata-linked, data-linked or not linked.
        editionable:
          type: string
          description: Indicates if the object editionable in the database.
        oracle_maintained:
          type: string
          description: Denotes whether the object was created, and is maintained, by Oracle-supplied scripts (such as catalog.sql or catproc.sql). An object for which this column has the value Y must not be changed in any way except by running an Oracle-supplied script.
        application:
          type: string
          description: Indicates whether the object is an Application common object (Y) or not (N).
        default_collation:
          type: string
          description: Default collation for the object.
        duplicated:
          type: string
          description: Indicates whether this object is duplicated on this shard (Y) or not (N).
        sharded:
          type: string
          description: Indicates whether this object is sharded (Y) or not (N).
        created_appid:
          type: integer
          description: ID of the Application that created the object.
        created_vsnid:
          type: integer
          description: ID of the Application Version that created the object.
        modified_appid:
          type: integer
          description: ID of the Application that last modified the object.
        modified_vsnid:
          type: integer
          description: ID of the Application Version that last modified the object.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsProcedures:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseObjectsProceduresItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsMaterializedViewLogsItem:
      type: object
      description: This object describes a materialized view log in the database.
      properties:
        log_owner:
          type: string
          description: Owner of the materialized view log.
        master:
          type: string
          description: Name of the master table or master materialized view whose changes are logged.
        log_table:
          type: string
          description: Name of the table where the changes to the master table or master materialized view are logged.
        rowids:
          type: string
          description: Indicates whether rowid information is recorded (YES) or not (NO).
        primary_key:
          type: string
          description: Indicates whether primary key information is recorded (YES) or not (NO).
        object_id:
          type: string
          description: Indicates whether object identifier information in an object table is recorded (YES) or not (NO).
        filter_columns:
          type: string
          description: Indicates whether filter column information is recorded (YES) or not (NO).
        sequence:
          type: string
          description: Indicates whether the sequence value, which provides additional ordering information, is recorded (YES) or not (NO).
        include_new_values:
          type: string
          description: Indicates whether both old and new values are recorded (YES) or old values are recorded but new values are not recorded (NO).
        purge_asynchronous:
          type: string
          description: Indicates whether the materialized view log is purged asynchronously (YES) or not (NO).
        purge_deferred:
          type: string
          description: Indicates whether the materialized view log is purged in a deferred manner (YES) or not (NO).
        purge_start:
          type: string
          description: For deferred purge, the purge start date.
        purge_interval:
          type: string
          description: For deferred purge, the purge interval.
        last_purge_date:
          type: string
          description: Date of the last purge.
        last_purge_status:
          type: integer
          description: Status of the last purge (error code or 0 for success).
        num_rows_purged:
          type: integer
          description: Number of rows purged in the last purge.
        commit_scn_based:
          type: string
          description: Indicates whether the materialized view log is commit SCN-based (YES) or not (NO).
        staging_log:
          type: string
          description: Indicates whether the materialized view log is a staging log for synchronous refresh (YES) or not (NO).
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsTypesItem:
      type: object
      description: This object describes an object type in the database.
      properties:
        owner:
          type: string
          description: Owner of the type.
        type_name:
          type: string
          description: Name of the type.
        type_oid:
          type: string
          description: Object identifier (OID) of the type.
        typecode:
          type: string
          description: Typecode of the type.
        attributes:
          type: integer
          description: Number of attributes (if any) in the type.
        methods:
          type: integer
          description: Number of methods (if any) in the type.
        predefined:
          type: string
          description: Indicates whether the type is a predefined type (YES) or not (NO).
        incomplete:
          type: string
          description: Indicates whether the type is an incomplete type (YES) or not (NO).
        final:
          type: string
          description: Indicates whether the type is a final type (YES) or not (NO).
        instantiable:
          type: string
          description: Indicates whether the type is an instantiable type (YES) or not (NO).
        persistable:
          type: string
          description: Indicates whether the type is a persistable type (YES) or not (NO).
        supertype_owner:
          type: string
          description: Owner of the supertype (NULL if type is not a subtype).
        supertype_name:
          type: string
          description: Name of the supertype (NULL if type is not a subtype).
        local_attributes:
          type: integer
          description: Number of local (not inherited) attributes (if any) in the subtype.
        local_methods:
          type: integer
          description: Number of local (not inherited) methods (if any) in the subtype.
        typeid:
          type: string
          description: Type ID value of the type.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseObjectsSynonymsItem:
      type: object
      description: This object describes a synonym in the database. The list of attributes may vary depending on database version.
      properties:
        owner:
          type: string
          description: Owner of the synonym.
        synonym_name:
          type: string
          description: Name of the synonym.
        table_owner:
          type: string
          description: Owner of the object referenced by the synonym, or creator of the referring synonym if the target is a public synonym (that is, the object referred to by TABLE_NAME). Although the column is called TABLE_OWNER, the object owned is not necessarily a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on.
        table_name:
          type: string
          description: Name of the object referenced by the synonym. Although the column is called TABLE_NAME, the object does not necessarily have to be a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on.
        db_link:
          type: string
          description: Name of the database link referenced, if any.
        origin_con_id:
          type: integer
          description: The ID of the container where the data originates.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DatabaseLinksItem:
      type: object
      description: A database link is a connection between two physical database servers that allows a client to access them as one logical database.
      properties:
        owner:
          type: string
          description: Owner of the database link.
        db_link:
          type: string
          description: Name of the database link.
        username:
          type: string
          description: Name of the user when logging in.
        host:
          type: string
          description: Oracle Net connect string.
        created:
          type: string
          description: Creation time of the database link.
        shard_internal:
          type: string
          description: Indicates whether the database link is used to support operations across sharded databases.
        valid:
          type: string
          description: Indicates whether the database link is valid and usable.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
  examples:
    FilterCriteria:
      summary: Implicit EQUALS operator for a number. Supports String and Dates too.
      value:
        SALARY: 1000
    OrderByProperty:
      summary: Order by with literals.
      value:
        $orderby:
          SALARY: ASC
          ENAME: DESC
    FilterAndOrder:
      summary: Filter criteria supports a wide range of operators. In this example LIKE operator ($like) is used. See Oracle REST Data Services production documentation 'Filtering in Queries' section for further information on the operators available.
      value:
        ENAME:
          $like: AX%
        $orderby:
          ENAME: ASC
  parameters:
    Filter:
      name: q
      in: query
      description: Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.
      required: false
      schema:
        $ref: '#/components/schemas/Filter'
      examples:
        FilterCriteriaExample:
          $ref: '#/components/examples/FilterCriteria'
        OrderByPropertyExample:
          $ref: '#/components/examples/OrderByProperty'
        FilterAndOrderExample:
          $ref: '#/components/examples/FilterAndOrder'
    Limit:
      name: limit
      in: query
      description: The maximum number of records to return.
      required: false
      schema:
        type: integer
        format: int32
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    BearerAuth:
      type: http
      scheme: bearer
    OAuth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: /oauth/auth
          scopes: {}
        authorizationCode:
          authorizationUrl: /oauth/auth
          tokenUrl: /oauth/token
          scopes: {}
        clientCredentials:
          tokenUrl: /oauth/token
          scopes: {}
externalDocs:
  description: Oracle REST Data Services product documentation.
  url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/