{ "openapi":"3.0.0", "info":{ "description":"Provide consumers the ability to perform operations with different Oracle Database features through a web REST API that can be easily adopted.", "version":"2021.05.29", "title":"REST APIs for Oracle Database", "contact":{ "name":"Oracle REST Data Services", "url":"https://www.oracle.com/database/technologies/appdev/rest.html" }, "x-summary":"Provide consumers the ability to perform operations with different Oracle Database features through a web REST API that can be easily adopted." }, "externalDocs":{ "description":"Oracle REST Data Services product documentation.", "url":"https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/" }, "tags":[ { "name":"Data Dictionary", "description":"Services related to the tables and views that provide information about the database." }, { "name":"Data Guard", "description":"Services related to Oracle Data Guard. The product must be installed in the Oracle database that ORDS is configured to use." }, { "name":"Environment", "description":"Services related to the Oracle database installation." }, { "name":"General", "description":"Services related to the Oracle database instance." }, { "name":"Monitoring", "description":"Services related to monitoring the Oracle database instance." }, { "name":"Open Service Broker", "description":"Services related to the Open Service Broker compliant implementation that ORDS provides." }, { "name":"Oracle APEX", "description":"Services related to Oracle APEX. The product must be installed in the Oracle database that ORDS is configured to use." }, { "name":"Performance", "description":"Services related to the runtime performance of the Oracle database instance." }, { "name":"Pluggable Database Lifecycle Management", "description":"Services related to managing pluggable databases in an Oracle multitenant database instance." } ], "paths":{ "/apex/statistics/overview":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get instance overview", "description":"This service returns aggregated overview data for an Application Express instance. If number_of_days parameter is not specified the response is for upto 30 days of aggregated data. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"number_of_days", "in":"query", "description":"Specifies the number of days into the past to aggregate data for.", "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"All APEX workspaces in the instance.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXInstanceOverview" } } } } }, "x-internal-id":"apex-statistics-overview-get", "x-filename-id":"apex-statistics-overview-get" } }, "/apex/statistics/application/{application_id}/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get application statistics", "description":"This service returns usage statistics for a specific Oracle APEX application. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"application_id", "in":"path", "description":"Identifier of the application.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All Oracle APEX application usage statistics.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXUsageStatistics" } } } } }, "x-internal-id":"apex-statistics-application-{application_id}--get", "x-filename-id":"apex-statistics-application-application_id-get" } }, "/apex/statistics/instance/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get instance statistics", "description":"This service returns usage statistics for the whole Oracle APEX instance. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All usage statistics for the Oracle APEX instance.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXUsageStatistics" } } } } }, "x-internal-id":"apex-statistics-instance--get", "x-filename-id":"apex-statistics-instance-get" } }, "/apex/statistics/workspace/{workspace_name}/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get application statistics", "description":"This service returns usage statistics for a specific Oracle APEX workspace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"workspace_name", "in":"path", "description":"Display name of the workspace.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Statistics for all Oracle APEX workspaces in the instance.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXUsageStatistics" } } } } }, "x-internal-id":"apex-statistics-workspace-{workspace_name}--get", "x-filename-id":"apex-statistics-workspace-workspace_name-get" } }, "/apex/workspaces/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get all workspaces", "description":"Returns information about the Oracle APEX workspaces available. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All Oracle APEX workspaces in the instance.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXWorkspaces" } } } } }, "x-internal-id":"apex-workspaces--get", "x-filename-id":"apex-workspaces-get" } }, "/database/components/":{ "get":{ "tags":[ "General" ], "summary":"Get all database components", "description":"Returns information about the components loaded into the database from DBA_REGISTRY view. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All database components loaded into the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseComponents" } } } } }, "x-internal-id":"database-components--get", "x-filename-id":"database-components-get" } }, "/database/components/{comp_id}":{ "get":{ "tags":[ "General" ], "summary":"Get a database component", "description":"Returns information about the specified component loaded into the database from DBA_REGISTRY view. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"comp_id", "in":"path", "description":"Identifier of the component.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information about the specified component.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseComponentsItem" } } } } }, "x-internal-id":"database-components-{comp_id}-get", "x-filename-id":"database-components-comp_id-get" } }, "/database/connections/":{ "get":{ "tags":[ "General" ], "summary":"Get a description of all local listeners for this database", "description":"Returns LOCAL LISTENER and SERVICE NAME records from GV$LISTENER_NETWORK for this database. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All the local listeners for this database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseConnections" } } } } }, "x-internal-id":"database-connections--get", "x-filename-id":"database-connections-get" } }, "/database/connections/{host_name},{port},{service_name}":{ "get":{ "tags":[ "General" ], "summary":"Get a description of a specific local listener for this database", "description":"Returns LOCAL LISTENER and SERVICE NAME information from GV$LISTENER_NETWORK for a specific host, port, and service combination. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"host_name", "in":"path", "description":"Name of the host.", "required":true, "schema":{ "type":"string" } }, { "name":"port", "in":"path", "description":"Port number being listened on.", "required":true, "schema":{ "type":"number" } }, { "name":"service_name", "in":"path", "description":"Name of the service.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific listener and service.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseConnectionsItem" } } } } }, "x-internal-id":"database-connections-{host_name},{port},{service_name}-get", "x-filename-id":"database-connections-host_name-port-service_name-get" } }, "/database/dataguard/configuration/":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the current broker configuration", "description":"All the broker configuration. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Information on a specific listener and service.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationItem" } } } } }, "x-internal-id":"database-dataguard-configuration--get", "x-filename-id":"database-dataguard-configuration-get" }, "post":{ "tags":[ "Data Guard" ], "summary":"Add a configuration", "description":"A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "primary_database":{ "type":"string", "description":"Primary Database Name" }, "primary_connection_identifier":{ "type":"string", "description":"Connection string" } } }, "examples":{ "enable_configuration":{ "summary":"Add a configuration", "value":{ "primary_database":"MYDB", "primary_connection_identifier":"MYDB" } } } } } }, "responses":{ "201":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-configuration--post", "x-filename-id":"database-dataguard-configuration-post" }, "put":{ "tags":[ "Data Guard" ], "summary":"Enable or disable a configuration", "description":"Depending on the operation property, the endpoint will enable or disable a configuration. A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "operation":{ "type":"string", "description":"ENABLE, DISABLE", "default":"ENABLE", "enum":[ "ENABLE", "DISABLE" ] } } }, "examples":{ "enable_configuration":{ "summary":"Enable a configuration", "value":{ "operation":"ENABLE" } } } } } }, "responses":{ "200":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-configuration--put", "x-filename-id":"database-dataguard-configuration-put" }, "delete":{ "tags":[ "Data Guard" ], "summary":"Remove the configuration", "description":"A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-configuration--delete", "x-filename-id":"database-dataguard-configuration-delete" } }, "/database/dataguard/configuration/properties/":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the current broker configuration properties", "description":"All the broker confguration properties. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Information on a specific listener and service.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationPropertiesCollection" } } } } }, "x-internal-id":"database-dataguard-configuration-properties--get", "x-filename-id":"database-dataguard-configuration-properties-get" } }, "/database/dataguard/configuration/properties/{property}":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the specified broker configuration property", "description":"Get the specified configuration property. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"property", "in":"path", "description":"Name of the property", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The property value", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationPropertyItem" } } } } }, "x-internal-id":"database-dataguard-configuration-properties-{property}-get", "x-filename-id":"database-dataguard-configuration-properties-property-get" }, "put":{ "tags":[ "Data Guard" ], "summary":"Alter a configuration property", "description":"A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"property", "in":"path", "description":"Name of the property", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"Value of the property" } } }, "examples":{ "enable_configuration":{ "summary":"Alter a configuration property", "value":{ "value":"USER" } } } } } }, "responses":{ "201":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-configuration-properties-{property}-put", "x-filename-id":"database-dataguard-configuration-properties-property-put" } }, "/database/dataguard/databases/":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the current broker configuration databases", "description":"Broker confguration databases. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"List of databases", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationCollection" } } } } }, "x-internal-id":"database-dataguard-databases--get", "x-filename-id":"database-dataguard-databases-get" }, "post":{ "tags":[ "Data Guard" ], "summary":"Add a database", "description":"A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "database_name":{ "type":"string", "description":"Name of the database to add" }, "connection_identifier":{ "type":"string", "description":"Connection identifier" } } }, "examples":{ "enable_configuration":{ "summary":"Add a database", "value":{ "database_name":"MYDB", "connection_identifier":"MYDB" } } } } } }, "responses":{ "201":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-databases--post", "x-filename-id":"database-dataguard-databases-post" } }, "/database/dataguard/databases/{database}":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the current broker configuration database", "description":"All the broker confguration database. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific database in the broker configuration.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationItemLinks" } } } } }, "x-internal-id":"database-dataguard-databases-{database}-get", "x-filename-id":"database-dataguard-databases-database-get" }, "put":{ "tags":[ "Data Guard" ], "summary":"Convert, enable, disable, or set the role of a database", "description":"Depending on the operation type, the endpoint will convert to physical, convert to snapshot, enable, disable, set as failover, set as switchover, or set as reinstate a database. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database name", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "action":{ "type":"string", "description":"CONVERT, ENABLE or DISABLE, SET ROLE", "default":"ENABLE", "enum":[ "CONVERT_TO_PHYSICAL", "CONVERT_TO_SNAPSHOT", "ENABLE", "DISABLE", "FAILOVER", "SWITCHOVER", "REINSTATE" ] } } }, "examples":{ "enable_member":{ "summary":"Enable a database", "value":{ "action":"ENABLE" } } } } } }, "responses":{ "201":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-databases-{database}-put", "x-filename-id":"database-dataguard-databases-database-put" }, "delete":{ "tags":[ "Data Guard" ], "summary":"Delete the current database from the broker", "description":"Remove a database. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-databases-{database}-delete", "x-filename-id":"database-dataguard-databases-database-delete" } }, "/database/dataguard/databases/{database}/instances/":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the current broker database instances information", "description":"All the broker databases. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database Name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information of all database instances.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardInstanceCollection" } } } } }, "x-internal-id":"database-dataguard-databases-{database}-instances--get", "x-filename-id":"database-dataguard-databases-database-instances-get" } }, "/database/dataguard/databases/{database}/instances/{instance}":{ "delete":{ "tags":[ "Data Guard" ], "summary":"Delete the Data Guard instance", "description":"Delete a Data Guard instance. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database Name", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "description":"Instance name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-databases-{database}-instances-{instance}-delete", "x-filename-id":"database-dataguard-databases-database-instances-instance-delete" } }, "/database/dataguard/databases/{database}/properties/":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get the database Data Guard properties", "description":"Get database Data Guard properties. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database Name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific database Data Guard properties.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationPropertiesCollection" } } } } }, "x-internal-id":"database-dataguard-databases-{database}-properties--get", "x-filename-id":"database-dataguard-databases-database-properties-get" } }, "/database/dataguard/databases/{database}/properties/{property}":{ "get":{ "tags":[ "Data Guard" ], "summary":"Get a database Data Guard property", "description":"A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database Name", "required":true, "schema":{ "type":"string" } }, { "name":"property", "in":"path", "description":"Property Name", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific Data Guard property.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataguardConfigurationPropertyItem" } } } } }, "x-internal-id":"database-dataguard-databases-{database}-properties-{property}-get", "x-filename-id":"database-dataguard-databases-database-properties-property-get" }, "put":{ "tags":[ "Data Guard" ], "summary":"Set the value of a database Data Guard property", "description":"Sets the value of a database Data Guard property. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"database", "in":"path", "description":"Database Name", "required":true, "schema":{ "type":"string" } }, { "name":"property", "in":"path", "description":"Property Nane", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"Value of the property to set", "default":"" } } }, "examples":{ "set_value":{ "summary":"Sets a Value", "value":{ "value":"2" } } } } } }, "responses":{ "201":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/responses/BadRequest" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"integer" }, "description":"Status of the Data Guard operation." } } } }, "x-internal-id":"database-dataguard-databases-{database}-properties-{property}-put", "x-filename-id":"database-dataguard-databases-database-properties-property-put" } }, "/database/datapump/export":{ "post":{ "tags":[ "General" ], "summary":"Create an export data pump job", "description":"Create a Data Pump export job with the specified parameters and start it. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "datapump_dir":{ "type":"string", "description":"Specify the database directory to use.", "default":"DATA_PUMP_DIR" }, "filter":{ "type":"string", "description":"The filter to apply to identify database objects for export. Required when job_mode is not FULL." }, "job_mode":{ "type":"string", "description":"Specify the Data Pump job mode.", "default":"SCHEMA", "enum":[ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ] }, "threads":{ "type":"integer", "description":"The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job." }, "name_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Name Expression filter." } } } }, "schema_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Schema Expression filter." } } } }, "tablespace_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Tablespace Expression filter." } } } } } }, "examples":{ "export_scott_tables":{ "summary":"Export tables beginning with EMP, but not named EMP, from the SCOTT schema.", "value":{ "job_mode":"TABLE", "name_expressions":[ { "expression":"!='EMP'" }, { "expression":"LIKE 'EMP%'" } ], "schema_expressions":[ { "expression":"IN ('SCOTT')" } ] } } } } } }, "responses":{ "201":{ "description":"Description of the Data Pump export job that has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataPumpJobsItem" } } } } }, "x-internal-id":"database-datapump-export-post", "x-filename-id":"database-datapump-export-post" } }, "/database/datapump/import":{ "post":{ "tags":[ "General" ], "summary":"Create an import data pump job", "description":"Create a Data Pump import job with the specified parameters and start it. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "file_name" ], "properties":{ "datapump_dir":{ "type":"string", "description":"Specify the database directory to use.", "default":"DATA_PUMP_DIR" }, "job_mode":{ "type":"string", "description":"Specify the Data Pump job mode.", "default":"SCHEMA", "enum":[ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ] }, "threads":{ "type":"integer", "description":"The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job." }, "file_name":{ "type":"string", "description":"The file name pattern to use for Data Pump import. Required when operation is IMPORT." }, "remap_schemas":{ "type":"array", "description":"Used to define Remap Schema parameters for an import job.", "items":{ "type":"object", "required":[ "source", "target" ], "properties":{ "source":{ "type":"string", "description":"Source schema to remap from." }, "target":{ "type":"string", "description":"Target schema to remap to." } } } }, "name_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Name Expression filter." } } } }, "schema_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Schema Expression filter." } } } }, "tablespace_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Tablespace Expression filter." } } } } } }, "examples":{ "import_scott_to_hr":{ "summary":"Import objects from the USERS tablespace and remap SCOTT schema objects to HR schema.", "value":{ "job_mode":"SCHEMA", "file_name":"EXPDAT%U2SCOTT.DMP", "tablespace_expressions":[ { "expression":"= 'USERS'" } ], "remap_schemas":[ { "source":"SCOTT", "target":"HR" } ] } } } } } }, "responses":{ "201":{ "description":"Description of the Data Pump import job that has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataPumpJobsItem" } } } } }, "x-internal-id":"database-datapump-import-post", "x-filename-id":"database-datapump-import-post" } }, "/database/datapump/jobs/":{ "get":{ "tags":[ "General" ], "summary":"Get all data pump jobs", "description":"Describes all Data Pump jobs in the database. Uses DBA_DATAPUMP_JOBS view. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All Data Pump jobs in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataPumpJobs" } } } } }, "x-internal-id":"database-datapump-jobs--get", "x-filename-id":"database-datapump-jobs-get" }, "post":{ "tags":[ "General" ], "summary":"Create a data pump job", "description":"Create a Data Pump job with the specified parameters and start it. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "operation" ], "properties":{ "operation":{ "type":"string", "description":"Specify the Data Pump job operation.", "enum":[ "EXPORT", "IMPORT" ] }, "datapump_dir":{ "type":"string", "description":"Specify the database directory to use.", "default":"DATA_PUMP_DIR" }, "filter":{ "type":"string", "description":"The filter to apply to identify database objects for export. This an export convenience for simple lists in metadata filter parameters, carried over from 19.1 implementation." }, "job_mode":{ "type":"string", "description":"Specify the Data Pump job mode.", "default":"SCHEMA", "enum":[ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ] }, "file_name":{ "type":"string", "description":"The file name pattern to use for Data Pump import. Required when operation is IMPORT." }, "threads":{ "type":"integer", "description":"The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job." }, "remap_schemas":{ "type":"array", "description":"Used to define Remap Schema parameters for an import job. Only applicable for IMPORT.", "items":{ "type":"object", "required":[ "source", "target" ], "properties":{ "source":{ "type":"string", "description":"Source schema to remap from." }, "target":{ "type":"string", "description":"Target schema to remap to." } } } }, "name_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Name Expression filter." } } } }, "schema_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Schema Expression filter." } } } }, "tablespace_expressions":{ "type":"array", "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.", "items":{ "type":"object", "required":[ "expression" ], "properties":{ "expression":{ "type":"string", "description":"An SQL clause to be used as a Tablespace Expression filter." } } } } } }, "examples":{ "export_hr":{ "summary":"Export the HR schema.", "value":{ "operation":"EXPORT", "schema_expressions":[ { "expression":"IN ( 'HR' )" } ] } }, "import_hr_to_blake":{ "summary":"Import the HR schema and map it to the BLAKE schema.", "value":{ "operation":"IMPORT", "job_mode":"FULL", "file_name":"EXPDAT%U2019-03-25-12_55_03.DMP", "remap_schemas":[ { "source":"HR", "target":"BLAKE" } ] } } } } } }, "responses":{ "201":{ "description":"Details of the Data Pump job that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataPumpJobsItem" } } } } }, "x-internal-id":"database-datapump-jobs--post", "x-filename-id":"database-datapump-jobs-post" } }, "/database/datapump/jobs/{owner_name},{job_name}/":{ "get":{ "tags":[ "General" ], "summary":"Get a specific data pump job", "description":"Describes a specific Data Pump job in the database. Uses DBA_DATAPUMP_JOBS view. When the specified job is a Data Pump Export job, the response contains links to the log and export files. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"owner_name", "in":"path", "description":"Owner of the Data Pump job.", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of the Data Pump job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Details of the Data Pump job. For an EXPORT job, this will also include links to log and export files.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DataPumpJobsItem" } } } } }, "x-internal-id":"database-datapump-jobs-{owner_name},{job_name}--get", "x-filename-id":"database-datapump-jobs-owner_name-job_name-get" } }, "/database/datapump/jobs/{owner_name},{job_name}/{filename}":{ "get":{ "tags":[ "General" ], "summary":"Get a file for a specific data pump job", "description":"Returns the log or export file for the given data pump job. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"owner_name", "in":"path", "description":"Owner of the Data Pump job.", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of the Data Pump job.", "required":true, "schema":{ "type":"string" } }, { "name":"filename", "in":"path", "description":"Name of the file associated with the Data Pump job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The requested file for the Data Pump job. Log files are text/plain. Export file are application/vnd.tcpdump.pcap.", "content":{ "text/plain":{ "schema":{ "type":"string" } }, "application/vnd.tcpdump.pcap":{ "schema":{ "type":"string", "format":"binary" } } } } }, "x-internal-id":"database-datapump-jobs-{owner_name},{job_name}-{filename}-get", "x-filename-id":"database-datapump-jobs-owner_name-job_name-filename-get" } }, "/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/feature_usage/":{ "get":{ "tags":[ "General" ], "summary":"Get all feature usage statistics", "description":"See what features are used in the database. Returns records from DBA_FEATURE_USAGE_STATISTICS. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Feature Usage records from DBA_FEATURE_USAGE_STATISTICS.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseFeatureUsage" } } } } }, "x-internal-id":"database-feature_usage--get", "x-filename-id":"database-feature_usage-get" } }, "/database/feature_usage/{dbid},{name}":{ "get":{ "tags":[ "General" ], "summary":"Get usage statistic for a feature", "description":"Returns records from DBA_FEATURE_USAGE_STATISTICS for a specific feature. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"dbid", "in":"path", "description":"Database identifier as found in GV$DATABASE.", "required":true, "schema":{ "type":"number" } }, { "name":"name", "in":"path", "description":"Name of the feature.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on the usage statistics for a specific feature.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseFeatureUsageItem" } } } } }, "x-internal-id":"database-feature_usage-{dbid},{name}-get", "x-filename-id":"database-feature_usage-dbid-name-get" } }, "/database/monitoring/alerts/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all alerts", "description":"Returns records from V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Returns database alerts.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringAlerts" } } } } }, "x-internal-id":"database-monitoring-alerts--get", "x-filename-id":"database-monitoring-alerts-get" } }, "/database/monitoring/alerts/{record_id}":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get an alert record", "description":"Returns specific alert record from V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"record_id", "in":"path", "description":"Identifier for the alert record.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Information on a specific alert.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringAlertsItem" } } } } }, "x-internal-id":"database-monitoring-alerts-{record_id}-get", "x-filename-id":"database-monitoring-alerts-record_id-get" } }, "/database/monitoring/alerts_recent_summaries/by_message_level":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get count of recent alerts by message level", "description":"Group by message level on V$DIAG_ALERT_EXT originating within the last 7 days. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Summary of alerts from the last 7 days, aggregated by message level.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringAlertsSummaryMessageLevelItem" } } } } }, "x-internal-id":"database-monitoring-alerts_recent_summaries-by_message_level-get", "x-filename-id":"database-monitoring-alerts_recent_summaries-by_message_level-get" } }, "/database/monitoring/alerts_recent_summaries/by_message_type":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get count of recent alerts by message type", "description":"Group by message type on V$DIAG_ALERT_EXT originating within the last 7 days. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Summary of alerts from the last 7 days, aggregated by message type.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringAlertsSummaryMessageTypeItem" } } } } }, "x-internal-id":"database-monitoring-alerts_recent_summaries-by_message_type-get", "x-filename-id":"database-monitoring-alerts_recent_summaries-by_message_type-get" } }, "/database/monitoring/alerts_summaries/by_message_level":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get count of alerts by message level", "description":"Group by message level on V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Summary of alerts, broken down by message level.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringAlertsSummaryMessageLevelItem" } } } } }, "x-internal-id":"database-monitoring-alerts_summaries-by_message_level-get", "x-filename-id":"database-monitoring-alerts_summaries-by_message_level-get" } }, "/database/monitoring/alerts_summaries/by_message_type":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get count of alerts by message type", "description":"Group by message type on V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.", "parameters":[ ], "responses":{ "200":{ "description":"Summary of alerts broken down by message type.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringAlertsSummaryMessageTypeItem" } } } } }, "x-internal-id":"database-monitoring-alerts_summaries-by_message_type-get", "x-filename-id":"database-monitoring-alerts_summaries-by_message_type-get" } }, "/database/monitoring/session_limits":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all session limits", "description":"Get all resource limits for sessions using GV$RESOURCE_LIMIT view. Since GV$RESOURCE_LIMIT exposes global level information, it can only be queried from CDB$ROOT or in a non-CDB database. A client requires SQL Administrator role to invoke this service.", "parameters":[ ], "responses":{ "200":{ "description":"All session limits in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLimitsItem" } } } } }, "x-internal-id":"database-monitoring-session_limits-get", "x-filename-id":"database-monitoring-session_limits-get" } }, "/database/monitoring/session_locks/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all locks held in the database", "description":"Get all locks that are held in the database using DBA_LOCK view. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All locks held in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLocks" } } } } }, "x-internal-id":"database-monitoring-session_locks--get", "x-filename-id":"database-monitoring-session_locks-get" } }, "/database/monitoring/session_locks/{session_id},{lock_id1},{lock_id2}":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get a specific session lock record", "description":"Returns the corresponding record from DBA_LOCK view. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"session_id", "in":"path", "description":"Session holding or acquiring the lock.", "required":true, "schema":{ "type":"number" } }, { "name":"lock_id1", "in":"path", "description":"Type-specific lock identifier, part 1.", "required":true, "schema":{ "type":"string" } }, { "name":"lock_id2", "in":"path", "description":"Type-specific lock identifier, part 2.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific lock.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLocksItem" } } } } }, "x-internal-id":"database-monitoring-session_locks-{session_id},{lock_id1},{lock_id2}-get", "x-filename-id":"database-monitoring-session_locks-session_id-lock_id1-lock_id2-get" } }, "/database/monitoring/session_locks/holding/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all locks that are blocking other sessions", "description":"Using DBA_LOCKS and DBA_BLOCKERS views, this service returns a list of DBA_LOCKS records where the session is not waiting for a locked object but is holding a lock on an object for which another session is waiting. In an Oracle RAC environment, this only applies if the blocker is on the same instance. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All locks that are blocking other sessions.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLocksHolding" } } } } }, "x-internal-id":"database-monitoring-session_locks-holding--get", "x-filename-id":"database-monitoring-session_locks-holding-get" } }, "/database/monitoring/session_locks/holding/{session_id},{lock_id1},{lock_id2}":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get a session lock that is blocking other sessions", "description":"Using DBA_LOCKS and DBA_BLOCKERS views, this service returns a specific DBA_LOCKS record where the session is not waiting for a locked object but is holding a lock on an object for which another session is waiting. In an Oracle RAC environment, this only applies if the blocker is on the same instance. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"session_id", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"lock_id1", "in":"path", "description":"Type-specific lock identifier, part 1.", "required":true, "schema":{ "type":"string" } }, { "name":"lock_id2", "in":"path", "description":"Type-specific lock identifier, part 2.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific session lock.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLocksItem" } } } } }, "x-internal-id":"database-monitoring-session_locks-holding-{session_id},{lock_id1},{lock_id2}-get", "x-filename-id":"database-monitoring-session_locks-holding-session_id-lock_id1-lock_id2-get" } }, "/database/monitoring/session_locks/waiting/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all locks that sessions are waiting on", "description":"Using DBA_LOCKS and DBA_WAITERS views, this service returns a list of DBA_LOCKS records for sessions that are waiting on locks held by other sessions. In an Oracle RAC environment, this only applies if the waiter is on the same instance. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All locks in the database that sessions are waiting on.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLocksWaiting" } } } } }, "x-internal-id":"database-monitoring-session_locks-waiting--get", "x-filename-id":"database-monitoring-session_locks-waiting-get" } }, "/database/monitoring/session_locks/waiting/{session_id},{lock_id1},{lock_id2}":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get a specific lock that a session is waiting on", "description":"Using DBA_LOCKS and DBA_WAITERS views, this service returns the corresponding DBA_LOCKS records for session that is waiting on locks held by other sessions. In an Oracle RAC environment, this only applies if the waiter is on the same instance. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"session_id", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"lock_id1", "in":"path", "description":"Type-specific lock identifier, part 1.", "required":true, "schema":{ "type":"string" } }, { "name":"lock_id2", "in":"path", "description":"Type-specific lock identifier, part 2.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific lock that a session is waiting on.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionLocksItem" } } } } }, "x-internal-id":"database-monitoring-session_locks-waiting-{session_id},{lock_id1},{lock_id2}-get", "x-filename-id":"database-monitoring-session_locks-waiting-session_id-lock_id1-lock_id2-get" } }, "/database/monitoring/session_summaries/by_type":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get count of different session types", "description":"Group by session type on GV$SESSION. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Summary of different session types in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionTypeSummariesItem" } } } } }, "x-internal-id":"database-monitoring-session_summaries-by_type-get", "x-filename-id":"database-monitoring-session_summaries-by_type-get" } }, "/database/monitoring/session_wait_classes/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all session wait class records", "description":"Returns all records from GV$SESSION_WAIT_CLASS. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Summary of session wait classes in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionWaitClasses" } } } } }, "x-internal-id":"database-monitoring-session_wait_classes--get", "x-filename-id":"database-monitoring-session_wait_classes-get" } }, "/database/monitoring/session_wait_classes/{sid},{serial_number},{wait_class_number}":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get a specific session wait class record", "description":"Returns the corresponding record from GV$SESSION_WAIT_CLASS. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"serial_number", "in":"path", "description":"Session serial number.", "required":true, "schema":{ "type":"number" } }, { "name":"wait_class_number", "in":"path", "description":"Number of the wait class.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Information on the specified session wait class.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionWaitClassesItem" } } } } }, "x-internal-id":"database-monitoring-session_wait_classes-{sid},{serial_number},{wait_class_number}-get", "x-filename-id":"database-monitoring-session_wait_classes-sid-serial_number-wait_class_number-get" } }, "/database/monitoring/session_waits/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all session waits", "description":"Returns all records from GV$SESSION_WAIT.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All session wait records from GV$SESSION_WAIT. A client requires SQL Administrator role to invoke this service.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionWaits" } } } } }, "x-internal-id":"database-monitoring-session_waits--get", "x-filename-id":"database-monitoring-session_waits-get" } }, "/database/monitoring/session_waits/{sid},{seq_number}":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get a specific session wait", "description":"Returns the corresponding record from GV$SESSION_WAIT. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"seq_number", "in":"path", "description":"Wait sequence number.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Information on the specified session wait.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionWaitsItem" } } } } }, "x-internal-id":"database-monitoring-session_waits-{sid},{seq_number}-get", "x-filename-id":"database-monitoring-session_waits-sid-seq_number-get" } }, "/database/monitoring/sessions/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all current sessions", "description":"Returns all records on GV$SESSION. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All current sessions in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessions" } } } } }, "x-internal-id":"database-monitoring-sessions--get", "x-filename-id":"database-monitoring-sessions-get" } }, "/database/monitoring/sessions/{sid},{serial_number}/":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get a session", "description":"Returns the GV$SESSION for the specified Session Identifier and Session Serial Number. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"serial_number", "in":"path", "description":"Session serial number.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Information on the specified session.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionsItem" } } } } }, "x-internal-id":"database-monitoring-sessions-{sid},{serial_number}--get", "x-filename-id":"database-monitoring-sessions-sid-serial_number-get" } }, "/database/monitoring/sessions/{sid},{serial_number}/long_running_operations":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all long running operations for a session", "description":"Returns all records from GV$SESSION_LONGOPS for a specific session. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"serial_number", "in":"path", "description":"Session serial number.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Information on long running operations for the session.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionsLongRunningOperationItem" } } } } }, "x-internal-id":"database-monitoring-sessions-{sid},{serial_number}-long_running_operations-get", "x-filename-id":"database-monitoring-sessions-sid-serial_number-long_running_operations-get" } }, "/database/monitoring/sessions/{sid},{serial_number}/process":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get current active process for a session", "description":"Returns all records from GV$PROCESS for a specific session. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"serial_number", "in":"path", "description":"Session serial number.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Description of actives processes for a session.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringSessionsProcessItem" } } } } }, "x-internal-id":"database-monitoring-sessions-{sid},{serial_number}-process-get", "x-filename-id":"database-monitoring-sessions-sid-serial_number-process-get" } }, "/database/monitoring/wait_class_totals":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get time totals for all registered wait classes", "description":"Returns all the records from GV$SYSTEM_WAIT_CLASS, except 'Idle' wait class. A client requires SQL Administrator role to invoke this service.", "parameters":[ ], "responses":{ "200":{ "description":"Summary information on the wait class time totals.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringWaitClassTotalsItem" } } } } }, "x-internal-id":"database-monitoring-wait_class_totals-get", "x-filename-id":"database-monitoring-wait_class_totals-get" } }, "/database/monitoring/waits_recent":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get wait time summary from recent active session history records", "description":"Oracle Diagnostics Pack licence is required for this service. Group by sample_time and wait_class on GV$ACTIVE_SESSION_HISTORY for records with sample_time within the last 7 days. Note that time waited is in microseconds. A client requires SQL Administrator role to invoke this service.", "parameters":[ ], "responses":{ "200":{ "description":"Wait time summary from active session history records within the last 7 days.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringWaitsRecentItem" } } } } }, "x-internal-id":"database-monitoring-waits_recent-get", "x-filename-id":"database-monitoring-waits_recent-get" } }, "/database/monitoring/wait_class_metrics":{ "get":{ "tags":[ "Monitoring" ], "summary":"Get all wait class metrics", "description":"Returns all records from GV$WAITCLASSMETRIC for all GV$SYSTEM_WAIT_CLASS records except 'Idle' wait class. A client requires SQL Administrator role to invoke this service.", "parameters":[ ], "responses":{ "200":{ "description":"Wait class metrics records.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MonitoringWaitClassMetricsItem" } } } } }, "x-internal-id":"database-monitoring-wait_class_metrics-get", "x-filename-id":"database-monitoring-wait_class_metrics-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/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" } }, "/database/parameters/":{ "get":{ "tags":[ "General" ], "summary":"Get all database parameters", "description":"Return records from GV$SYSTEM_PARAMETER. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all database parameters.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseParameters" } } } } }, "x-internal-id":"database-parameters--get", "x-filename-id":"database-parameters-get" } }, "/database/parameters/{name}":{ "get":{ "tags":[ "General" ], "summary":"Get a specific database parameter", "description":"Returns the corresponding record from GV$SYSTEM_PARAMETER. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"name", "in":"path", "description":"Name of the parameter.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific database parameter.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseParametersItem" } } } } }, "x-internal-id":"database-parameters-{name}-get", "x-filename-id":"database-parameters-name-get" } }, "/database/pdbs/":{ "get":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Get all pluggable databases", "description":"Oracle Multitenant license is required when there is more than one user-created pluggable database. Returns records from GV$PDBS in the corresponding Container Database. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all Pluggable Databases in the Container database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableDatabases" } } } } }, "x-internal-id":"database-pdbs--get", "x-filename-id":"database-pdbs-get" }, "post":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Create a PDB from PDB$SEED or XML", "description":"Create a pluggable database from PDB$SEED or from an XML metadata file accessible to the database instance. The use of Oracle Transparent Data Encryption is only supported in topologies where the database and Oracle REST Data Services are on the same host. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "method", "pdb_name", "fileNameConversions" ], "properties":{ "method":{ "type":"string", "description":"This property defines the type of operation. Depending on the method specified, other properties will be required in the payload.", "enum":[ "CREATE", "PLUG" ] }, "adminName":{ "type":"string", "description":"The administrator username for the new PDB. This property is required when the method property is CREATE." }, "adminPwd":{ "type":"string", "description":"The administrator password for the new PDB. This property is required when the method property is CREATE." }, "pdb_name":{ "type":"string", "description":"The name of the new PDB. Relevant to both CREATE and PLUG method." }, "asClone":{ "type":"boolean", "description":"Indicate if 'AS CLONE' option should be used in the command to plug in a PDB. This property is applicable when the method property is PLUG but not required." }, "xmlFileName":{ "type":"string", "description":"The path of the XML metadata file to use when plugging-in a PDB." }, "copyAction":{ "type":"string", "description":"Indicate which copy option should be used in the command to plug in a PDB. This property is required when the method property is PLUG.", "enum":[ "COPY", "NOCOPY", "MOVE" ] }, "sourceFileNameConversions":{ "type":"string", "description":"This property is required when the method property is PLUG. As defined in the Oracle Multitenant Database documentation. Values can be a source filename convert pattern or NONE." }, "fileNameConversions":{ "type":"string", "description":"Relevant for create and plug operations. As defined in the Oracle Multitenant Database documentation. Values can be a filename convert pattern or NONE." }, "unlimitedStorage":{ "type":"boolean", "description":"Relevant for create and plug operations. True for unlimited storage. Even when set to true, totalSize and tempSize MUST be specified in the request if method is CREATE." }, "reuseTempFile":{ "type":"boolean", "description":"Relevant for create and plug operations. True for temporary file reusage." }, "totalSize":{ "type":"string", "description":"Relevant for create and plug operations. Total size as defined in the Oracle Multitenant Database documentation. See size_clause description in Database SQL Language Reference documentation." }, "tempSize":{ "type":"string", "description":"Relevant for create and clone operations. Total size for temporary tablespace as defined in the Oracle Multitenant Database documentation. See size_clause description in Database SQL Language Reference documentation." }, "tdePassword":{ "type":"string", "description":"TDE password when applicable (optional). Can be used in create and plug operations." }, "tdeImport":{ "type":"boolean", "description":"TDE import for plug operations." }, "tdeKeystorePath":{ "type":"string", "description":"TDE keystore path is required if the tdeImport flag is set to true. Can be used in plug operations." }, "tdeSecret":{ "type":"string", "description":"TDE secret is required if the tdeImport flag is set to true. Can be used in plug operations." }, "getScript":{ "type":"boolean", "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. A database is not created when this property is set to true." } } }, "examples":{ "create_pdb_unlimited_storage":{ "summary":"This is an example request body to create a pluggable database, called pdb_sample in this case, from PDB$SEED with unlimited storage. In this example fileNameConversions parameter is also provided which will result in a FILE_NAME_CONVERT clause included in the CREATE PLUGGABLE DATABASE statement executed in the container database.", "value":{ "method":"CREATE", "pdb_name":"pdb_sample", "adminName":"pdbadmin", "adminPwd":"W3lc0m31", "fileNameConversions":"('/disk1/oracle/dbs/pdbseed/','/disk1/oracle/dbs/pdb_sample/')", "unlimitedStorage":true, "reuseTempFile":true, "totalSize":"UNLIMITED", "tempSize":"UNLIMITED" } }, "getscript_create_pdb_custom_storage":{ "summary":"This is an example request body to get the generated script for creating a pluggable database from PDB$SEED with custom storage settings. Note that the script is not executed in the database. In this example fileNameConversions parameter has a NONE value which will result in a FILE_NAME_CONVERT=NONE clause included in the CREATE PLUGGABLE DATABASE statement generated.", "value":{ "method":"CREATE", "pdb_name":"pdb_sample", "adminName":"pdbadmin", "adminPwd":"W3lc0m31", "fileNameConversions":"NONE", "reuseTempFile":true, "totalSize":"2G", "tempSize":"800M", "getScript":true } }, "plugin_pdb":{ "summary":"This is an example request body to plugin a pluggable database called sales_pdb into the container database. The pluggable database definition is specified in the sales_pdb.xml file in this case.", "value":{ "method":"PLUG", "pdb_name":"sales_pdb", "xmlFileName":"/disk1/oracle/dbs/sales_pdb.xml", "sourceFileNameConversions":"NONE", "copyAction":"NOCOPY", "fileNameConversions":"NONE", "unlimitedStorage":true, "reuseTempFile":true, "totalSize":"UNLIMITED", "tempSize":"UNLIMITED" } } } } } }, "responses":{ "200":{ "description":"The response will indicate the successful execution of a series of PL/SQL statements, or return a set of PL/SQL statements that could be executed to create a pluggable database.", "content":{ "application/json":{ "schema":{ "anyOf":[ { "$ref":"#/components/schemas/RESTSQLCollection" }, { "$ref":"#/components/schemas/ScriptObject" } ] } } } } }, "x-internal-id":"database-pdbs--post", "x-filename-id":"database-pdbs-post" } }, "/database/pdbs/{pdb_name}/":{ "get":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Get a pluggable database", "description":"Returns data from GV$PDBS for the specified database in the corresponding Container Database. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"Name of the Pluggable Database.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of a specific Pluggable Database. All data files used by the Pluggable Database are also included.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableDatabasesItem" } } } } }, "x-internal-id":"database-pdbs-{pdb_name}--get", "x-filename-id":"database-pdbs-pdb_name-get" }, "post":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Clone or Unplug operations for PDBs", "description":"Clone or Unplug a PDB. These operations have a significant impact on the specified pluggable databases. The unplug operation will delete the PDB. Note that when cloning a pluggable database, the state of the source database will temporarily be set to OPEN READ ONLY for the duration of the operation and reset to its original state. The use of of Oracle Transparent Data Encryption is only supported in topologies where the database and Oracle REST Data Services are on the same host. This service requires db.cdb.adminUser credentials to be set in the pool configuration. ORA- errors need to be reviewed by the user. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"Name of the Pluggable Database to clone from or unplug.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "method" ], "properties":{ "method":{ "type":"string", "description":"This property defines the type of operation. Note that CLONE may change the state of the source PDB and UNPLUG will result in the PDB being dropped.", "enum":[ "CLONE", "UNPLUG" ] }, "pdb_name":{ "type":"string", "description":"Source PDB in case of clone or the PDB to be unplugged in case of an unplug operation. This property is optional and the name defined in the URI takes priority." }, "sparseClonePath":{ "type":"string", "description":"A Path specified for sparse clone snapshot copy. (Optional)" }, "clonePDBName":{ "type":"string", "description":"The name of the new clone PDB. Required when method is specified as CLONE." }, "fileNameConversions":{ "type":"string", "description":"Relevant for clone operations. As defined in the Oracle Multitenant Database documentation." }, "unlimitedStorage":{ "type":"boolean", "description":"Relevant for clone operations. True for unlimited storage. Even when set to true, totalSize and tempSize MUST be specified in the request if method is CLONE." }, "reuseTempFile":{ "type":"boolean", "description":"Relevant for clone operations. True for temporary file reusage." }, "totalSize":{ "type":"string", "description":"Relevant for clone operations. Size of the tablespace. See size_clause description in Database SQL Language Reference documentation." }, "tempSize":{ "type":"string", "description":"Relevant for clone operations. Size of the temporary tablespace. See size_clause description in Database SQL Language Reference documentation." }, "xmlFileName":{ "type":"string", "description":"Relevant for Unplug operations." }, "tdeExport":{ "type":"boolean", "description":"TDE export for unplug operations." }, "tdePassword":{ "type":"string", "description":"TDE password for unplug operations only. This is required when the tdeExport flag is set to true." }, "tdeKeystorePath":{ "type":"string", "description":"TDE keystore path is required if the tdeExport flag is set to true. Can be used in unplug operations only." }, "tdeSecret":{ "type":"string", "description":"TDE secret is required if the tdeExport flag is set to true. Can be used in unplug operations only." }, "getScript":{ "type":"boolean", "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. No action is taken when this property is true and only the script text is returned." } } }, "examples":{ "clone_pdb":{ "summary":"This is an example request body to create a new pluggable database by cloning the pluggable database specified by the pdb_name parameter in the URL. In this example fileNameConversions parameter is also provided which will result in a FILE_NAME_CONVERT clause included in the CREATE PLUGGABLE DATABASE statement executed in the container database.", "value":{ "method":"CLONE", "clonePDBName":"pdb_new", "fileNameConversions":"('/disk1/oracle/dbs/pdb_sample/','/disk1/oracle/dbs/pdb_new/')", "unlimitedStorage":true, "reuseTempFile":true, "totalSize":"UNLIMITED", "tempSize":"UNLIMITED" } }, "unplug_pdb":{ "summary":"This is an example request body to unplug the database specified by the pdb_name parameter in the URL. The pluggable database will be disassociated from the container database and therefore unusable. An XML file (sales_pdb.xml in this example) will be generated with metadata about the pluggable database after it is unplugged. This metadata contains the required information to enable a CREATE PLUGGABLE DATABASE statement on a target container database to plug in the pluggable database.", "value":{ "method":"UNPLUG", "xmlFileName":"/disk1/oracle/dbs/sales_pdb.xml" } } } } } }, "responses":{ "200":{ "description":"The response will indicate the successful execution of a series of PL/SQL statements, or return a set of PL/SQL statements that could be executed to create a pluggable database.", "content":{ "application/json":{ "schema":{ "anyOf":[ { "$ref":"#/components/schemas/RESTSQLCollection" }, { "$ref":"#/components/schemas/ScriptObject" } ] } } } } }, "x-internal-id":"database-pdbs-{pdb_name}--post", "x-filename-id":"database-pdbs-pdb_name-post" }, "delete":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Drop a PDB", "description":"Drop a pluggable database. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"Name of the Pluggable Database.", "required":true, "schema":{ "type":"string" } }, { "name":"action", "in":"query", "description":"Specify if datafiles should be removed or not. The value can be INCLUDING or KEEP (default).", "schema":{ "type":"string", "enum":[ "KEEP", "INCLUDING" ], "default":"KEEP" } }, { "name":"getScript", "in":"query", "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. Script execution does not happen and the database is not dropped.", "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"The response will indicate the successful execution of a series of PL/SQL statements, or return a set of PL/SQL statements that could be executed to create a pluggable database.", "content":{ "application/json":{ "schema":{ "anyOf":[ { "$ref":"#/components/schemas/RESTSQLCollection" }, { "$ref":"#/components/schemas/ScriptObject" } ] } } } } }, "x-internal-id":"database-pdbs-{pdb_name}--delete", "x-filename-id":"database-pdbs-pdb_name-delete" } }, "/database/pdbs/{pdb_name}/status":{ "get":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Return status information of a PDB", "description":"Returns status data from GV$PDBS for the specified database in the corresponding Container Database. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"Name of the Pluggable Database.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of a specific Pluggable Database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableDatabaseStatusItem" } } } } }, "x-internal-id":"database-pdbs-{pdb_name}-status-get", "x-filename-id":"database-pdbs-pdb_name-status-get" }, "post":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Change the state of a PDB", "description":"Changes the state of a pluggable database. The executed ALTER PLUGGABLE DATABASE command in the database includes the INSTANCES=ALL clause so that in an Oracle Real Application Clusters environment the pluggable database state is changed in all instances. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"Name of the Pluggable Database.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "state", "modifyOption" ], "properties":{ "state":{ "type":"string", "description":"The target state of the PDB.", "enum":[ "OPEN", "CLOSE" ] }, "modifyOption":{ "type":"string", "description":"Extra options for opening and closing a PDB.", "enum":[ "IMMEDIATE", "NORMAL", "READ ONLY", "READ WRITE", "RESTRICTED" ] }, "getScript":{ "type":"boolean", "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. The change of state does not happen." } } }, "examples":{ "close_pdb":{ "summary":"This is an example request body to close the pluggable database specified by the pdb_name parameter in the URL.", "value":{ "state":"CLOSE", "modifyOption":"IMMEDIATE" } }, "open_pdb":{ "summary":"This is an example request body to open the database specified by the pdb_name parameter in the URL. The modifyOption parameter is required in all cases so to allow the default open mode to be applied the value NORMAL is specified.", "value":{ "state":"OPEN", "modifyOption":"NORMAL" } } } } } }, "responses":{ "200":{ "description":"The response will indicate the successful execution of a series of PL/SQL statements, or return a set of PL/SQL statements that could be executed to create a pluggable database.", "content":{ "application/json":{ "schema":{ "anyOf":[ { "$ref":"#/components/schemas/RESTSQLCollection" }, { "$ref":"#/components/schemas/ScriptObject" } ] } } } } }, "x-internal-id":"database-pdbs-{pdb_name}-status-post", "x-filename-id":"database-pdbs-pdb_name-status-post" } }, "/database/performance/active_sessions_history/":{ "get":{ "tags":[ "Performance" ], "summary":"Get all sampled session activity in the database", "description":"Oracle Diagnostics Pack licence is required for this service. Returns all records from GV$ACTIVE_SESSION_HISTORY. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of sampled session activity in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceActionSessionHistories" } } } } }, "x-internal-id":"database-performance-active_sessions_history--get", "x-filename-id":"database-performance-active_sessions_history-get" } }, "/database/performance/active_sessions_history/{sample_id},{session_id}":{ "get":{ "tags":[ "Performance" ], "summary":"Get a specified sampled session activity in the database", "description":"Oracle Diagnostics Pack licence is required for this service. Returns specified records from GV$ACTIVE_SESSION_HISTORY. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sample_id", "in":"path", "description":"ID of the sample.", "required":true, "schema":{ "type":"number" } }, { "name":"session_id", "in":"path", "description":"Session identifier for the sampled session.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Active session history record.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceActionSessionHistoriesItem" } } } } }, "x-internal-id":"database-performance-active_sessions_history-{sample_id},{session_id}-get", "x-filename-id":"database-performance-active_sessions_history-sample_id-session_id-get" } }, "/database/performance/active_sessions_history_waits/":{ "get":{ "tags":[ "Performance" ], "summary":"Get the last 10 wait events for each active session", "description":"Return records from GV$SESSION_WAIT_HISTORY. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of session wait history.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceActionSessionHistoryWaits" } } } } }, "x-internal-id":"database-performance-active_sessions_history_waits--get", "x-filename-id":"database-performance-active_sessions_history_waits-get" } }, "/database/performance/active_sessions_history_waits/{sid},{seq_number}/":{ "get":{ "tags":[ "Performance" ], "summary":"Get the specified wait event for specific active session", "description":"Return data from GV$SESSION_WAIT_HISTORY for the specified Session Identifier and Event Sequence Number. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session Identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"seq_number", "in":"path", "description":"Sequence number of wait event; 1 is the most recent.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"The session wait history for a particular session and event.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceActionSessionHistoryWaitsItem" } } } } }, "x-internal-id":"database-performance-active_sessions_history_waits-{sid},{seq_number}--get", "x-filename-id":"database-performance-active_sessions_history_waits-sid-seq_number-get" } }, "/database/performance/active_sessions_history_waits/{sid},{seq_number}/active_sql":{ "get":{ "tags":[ "Performance" ], "summary":"Get SQL statistics for a specific session", "description":"Return records from GV$SQLAREA for a given session with current waits on GV$SESSION_WAIT_HISTORY. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sid", "in":"path", "description":"Session Identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"seq_number", "in":"path", "description":"Sequence number of wait event; 1 is the most recent.", "required":true, "schema":{ "type":"number" } } ], "responses":{ "200":{ "description":"Stastics on the SQL statements currently executing for specific session.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceActionSessionHistoryWaitsActiveSQLItem" } } } } }, "x-internal-id":"database-performance-active_sessions_history_waits-{sid},{seq_number}-active_sql-get", "x-filename-id":"database-performance-active_sessions_history_waits-sid-seq_number-active_sql-get" } }, "/database/performance/sql_statements/":{ "get":{ "tags":[ "Performance" ], "summary":"Get statistics for all SQL statements", "description":"Oracle Tuning Pack licence is required for this service. Returns data from GV$SQL with GV$SQL_MONITOR timing data. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all SQL statements in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatements" } } } } }, "x-internal-id":"database-performance-sql_statements--get", "x-filename-id":"database-performance-sql_statements-get" } }, "/database/performance/sql_statements/{sql_id}/":{ "get":{ "tags":[ "Performance" ], "summary":"Get statistics for a SQL statement", "description":"Oracle Tuning Pack licence is required for this service. Returns data from GV$SQL with GV$SQL_MONITOR timing data for the specified SQL statement identifier. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Statistic for a SQL statement.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementsItem" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}--get", "x-filename-id":"database-performance-sql_statements-sql_id-get" } }, "/database/performance/sql_statements/{sql_id}/monitor/":{ "get":{ "tags":[ "Performance" ], "summary":"Get monitoring statistics for a SQL Statement", "description":"Oracle Tuning Pack licence is required for this service. Returns all GV$SQL_MONITOR records for a specified SQL_ID. GV$SQL_MONITOR will contain statistics only for SQL statements whose execution have been (or are being) monitored by Oracle. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all monitored SQL statements in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementMonitors" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}-monitor--get", "x-filename-id":"database-performance-sql_statements-sql_id-monitor-get" } }, "/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/":{ "get":{ "tags":[ "Performance" ], "summary":"Get information on a monitored statement", "description":"Oracle Tuning Pack licence is required for this service. Returns information on a monitored statement from GV$SQL_MONITOR view. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"sql_exec_id", "in":"path", "description":"Execution identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"sql_exec_start", "in":"path", "description":"Time when the execution started.", "required":true, "schema":{ "type":"string", "format":"date-time" } } ], "responses":{ "200":{ "description":"Description of a monitored SQL statement.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementMonitorsItem" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}-monitor-{sql_exec_id},{sql_exec_start}--get", "x-filename-id":"database-performance-sql_statements-sql_id-monitor-sql_exec_id-sql_exec_start-get" } }, "/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/parallelism":{ "get":{ "tags":[ "Performance" ], "summary":"Get parallel execution information for specific statement execution", "description":"Oracle Tuning Pack licence is required for this service. Returns information on a monitored statement that is executed in parallel. Using GV$SQL_MONITOR view, the information includes the Parallel Coordinator and the instance(s) where it was executed. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"sql_exec_id", "in":"path", "description":"Execution identifier.", "required":true, "schema":{ "type":"number" } }, { "name":"sql_exec_start", "in":"path", "description":"Time when the execution started.", "required":true, "schema":{ "type":"string", "format":"date-time" } } ], "responses":{ "200":{ "description":"Returns information on a monitored statement. The structure of the data may vary depending on the database used.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementMonitorParallelism" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}-monitor-{sql_exec_id},{sql_exec_start}-parallelism-get", "x-filename-id":"database-performance-sql_statements-sql_id-monitor-sql_exec_id-sql_exec_start-parallelism-get" } }, "/database/performance/sql_statements/{sql_id}/plan":{ "get":{ "tags":[ "Performance" ], "summary":"Get execution plan for an SQL Statement", "description":"Returns all GV$SQL_PLAN records for a specified SQL_ID. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Execution plan for the specified SQL statement.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementPlanItem" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}-plan-get", "x-filename-id":"database-performance-sql_statements-sql_id-plan-get" } }, "/database/performance/sql_statements/{sql_id}/history":{ "get":{ "tags":[ "Performance" ], "summary":"Get historical statistics for a SQL statement", "description":"Oracle Diagnostics Pack licence is required for this service. Returns DBA_HIST_SQLSTAT and DBA_HIST_SNAPSHOT records for a specified SQL_ID. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Historical statistics for the specified SQL statement.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementHistoryItem" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}-history-get", "x-filename-id":"database-performance-sql_statements-sql_id-history-get" } }, "/database/performance/sql_statements/{sql_id}/text":{ "get":{ "tags":[ "Performance" ], "summary":"Get SQL statement", "description":"Returns records from GV$SQL for specified SQL_ID. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"sql_id", "in":"path", "description":"SQL identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The text of a specific SQL statement.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceSQLStatementTextItem" } } } } }, "x-internal-id":"database-performance-sql_statements-{sql_id}-text-get", "x-filename-id":"database-performance-sql_statements-sql_id-text-get" } }, "/database/performance/top_sql_statements/":{ "get":{ "tags":[ "Performance" ], "summary":"Get all SQL statements ordered by CPU time descending", "description":"Returns records from GV$SQL ordered by CPU time descending, SQL Text ascending. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of the SQL statements in the database ordered to show the top SQL statements first.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceTopSQLStatements" } } } } }, "x-internal-id":"database-performance-top_sql_statements--get", "x-filename-id":"database-performance-top_sql_statements-get" } }, "/database/performance/top_sql_statements/maximums":{ "get":{ "tags":[ "Performance" ], "summary":"Get SQL statistics maximum values", "description":"Returns maximum values for cpu time, elapsed time, disk reads, buffer gets and executions from GV$SQL. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Maximum values for SQL statement performance statistics recorded in GV$SQL.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PerformanceTopSQLStatementsMaximumsItem" } } } } }, "x-internal-id":"database-performance-top_sql_statements-maximums-get", "x-filename-id":"database-performance-top_sql_statements-maximums-get" } }, "/database/security/users/":{ "get":{ "tags":[ "General" ], "summary":"Get all database users", "description":"Returns records from DBA_USERS or ALL_USERS view 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":"Description of all users in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseUsers" } } } } }, "x-internal-id":"database-security-users--get", "x-filename-id":"database-security-users-get" } }, "/database/security/users/{username}":{ "get":{ "tags":[ "General" ], "summary":"Get a specific database user", "description":"Returns the corresponding record from DBA_USERS or ALL_USERS view depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.", "parameters":[ { "name":"username", "in":"path", "description":"Identifier for the user.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on the specified user.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseUsersItem" } } } } }, "x-internal-id":"database-security-users-{username}-get", "x-filename-id":"database-security-users-username-get" } }, "/database/status":{ "get":{ "tags":[ "General" ], "summary":"Get database status", "description":"Returns records from GV$INSTANCE and GV$DATABASE. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Description of the database state.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseStatusItem" } } } } }, "x-internal-id":"database-status-get", "x-filename-id":"database-status-get" } }, "/database/storage/bytes":{ "get":{ "tags":[ "General" ], "summary":"Get storage statistics", "description":"Returns info on bytes allocated for storage and how much is used. Using DBA_DATA_FILES data to calculate the total bytes allocated for storage along with DBA_TABLESPACE_USAGE_METRICS and DBA_TABLESPACES data to calculate the used bytes. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Total bytes across all the data files and how much is used.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseStorageBytesItem" } } } } }, "x-internal-id":"database-storage-bytes-get", "x-filename-id":"database-storage-bytes-get" } }, "/database/storage/tablespaces/":{ "get":{ "tags":[ "General" ], "summary":"Get all tablespaces", "description":"Returns records from DBA_TABLESPACES along with data usage information from DBA_TABLESPACE_USAGE_METRICS. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all tablespaces in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaces" } } } } }, "x-internal-id":"database-storage-tablespaces--get", "x-filename-id":"database-storage-tablespaces-get" } }, "/database/storage/tablespaces/{tablespace_name}/":{ "get":{ "tags":[ "General" ], "summary":"Get a tablespace", "description":"Returns data from DBA_TABLESPACES along with data usage information from DBA_TABLESPACE_USAGE_METRICS for a specific tablespace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Tablespace information, including data usage, is returned. The response structure may vary depending on the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespacesItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}--get", "x-filename-id":"database-storage-tablespaces-tablespace_name-get" } }, "/database/storage/tablespaces/{tablespace_name}/datafiles_usage":{ "get":{ "tags":[ "General" ], "summary":"Get data file usage summary for a specific tablespace", "description":"Returns GV$DATAFILE and DBA_DATA_FILES records for a specific tablespace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Tablespace data file usage.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafilesUsageItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-datafiles_usage-get", "x-filename-id":"database-storage-tablespaces-tablespace_name-datafiles_usage-get" } }, "/database/storage/tablespaces/{tablespace_name}/datafiles/":{ "get":{ "tags":[ "General" ], "summary":"Get data files for a tablespace", "description":"Returns records from DBA_DATA_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all data files for a specific tablespace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafiles" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-datafiles--get", "x-filename-id":"database-storage-tablespaces-tablespace_name-datafiles-get" } }, "/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/":{ "get":{ "tags":[ "General" ], "summary":"Get tablespace data file", "description":"Returns data from DBA_DATA_FILES for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "name":"file_id", "in":"path", "description":"File identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information about the specified data file.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafilesItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-datafiles-{file_id}--get", "x-filename-id":"database-storage-tablespaces-tablespace_name-datafiles-file_id-get" } }, "/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/usage":{ "get":{ "tags":[ "General" ], "summary":"Get tablespace data file usage", "description":"Returns GV$DATAFILE and DBA_DATA_FILES records for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "name":"file_id", "in":"path", "description":"File identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of the space usage for the tablespace data file.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafileUsageItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-datafiles-{file_id}-usage-get", "x-filename-id":"database-storage-tablespaces-tablespace_name-datafiles-file_id-usage-get" } }, "/database/storage/tablespaces/{tablespace_name}/history":{ "get":{ "tags":[ "General" ], "summary":"Get tablespace space usage history", "description":"Oracle Diagnostic Pack licence is required for this service. Returns DBA_HIST_TBSPC_SPACE_USAGE records where tablespace size has changed. These records are historical tablespace usage statistics. Recent changes in tablespace storage or usage will not appear until a snapshot is created. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Tablespace space usage history for the specified tablespace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceHistoryItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-history-get", "x-filename-id":"database-storage-tablespaces-tablespace_name-history-get" } }, "/database/storage/tablespaces/{tablespace_name}/segments/":{ "get":{ "tags":[ "General" ], "summary":"Get tablespace segments", "description":"Returns records from DBA_SEGMENTS for a specific tablespace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Collection of records from DBA_SEGMENTS for the specified tablespace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceSegments" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-segments--get", "x-filename-id":"database-storage-tablespaces-tablespace_name-segments-get" } }, "/database/storage/tablespaces/{tablespace_name}/segments/{segment_name}":{ "get":{ "tags":[ "General" ], "summary":"Get a tablespace segment", "description":"Returns data from DBA_SEGMENTS for a specific tablespace and segment. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "name":"segment_name", "in":"path", "description":"Name of the segment.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"A specific record from DBA_SEGMENTS for the tablespace and segment name.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceSegmentsItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-segments-{segment_name}-get", "x-filename-id":"database-storage-tablespaces-tablespace_name-segments-segment_name-get" } }, "/database/storage/tablespaces/{tablespace_name}/tempfiles_usage":{ "get":{ "tags":[ "General" ], "summary":"Get temporary file usage summary for a specific tablespace", "description":"Returns records from GV$TEMPFILE and DBA_TEMP_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Summary information of all temporary files used by the tablespace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafilesUsageItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-tempfiles_usage-get", "x-filename-id":"database-storage-tablespaces-tablespace_name-tempfiles_usage-get" } }, "/database/storage/tablespaces/{tablespace_name}/tempfiles/":{ "get":{ "tags":[ "General" ], "summary":"Get temporary files for a tablespace", "description":"Returns records from DBA_TEMP_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all temporary files used by the specified tablespace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceTempfiles" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-tempfiles--get", "x-filename-id":"database-storage-tablespaces-tablespace_name-tempfiles-get" } }, "/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/":{ "get":{ "tags":[ "General" ], "summary":"Get tablespace temporary file", "description":"Returns data from DBA_TEMP_FILES for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "name":"file_id", "in":"path", "description":"File identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information about the specified temporary file.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceTempfilesItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-tempfiles-{file_id}--get", "x-filename-id":"database-storage-tablespaces-tablespace_name-tempfiles-file_id-get" } }, "/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/usage":{ "get":{ "tags":[ "General" ], "summary":"Get tablespace temporary file usage", "description":"Returns GV$DATAFILE and DBA_TEMP_FILES records for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } }, { "name":"file_id", "in":"path", "description":"File identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Usage information about the temporary file.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafileUsageItem" } } } } }, "x-internal-id":"database-storage-tablespaces-{tablespace_name}-tempfiles-{file_id}-usage-get", "x-filename-id":"database-storage-tablespaces-tablespace_name-tempfiles-file_id-usage-get" } }, "/database/version":{ "get":{ "tags":[ "General" ], "summary":"Get database version", "description":"Returns records from GV$INSTANCE and GV$VERSION. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Version information about the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseVersionItem" } } } } }, "x-internal-id":"database-version-get", "x-filename-id":"database-version-get" } }, "/environment/databases/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a list of the databases defined in the default Oracle Home", "description":"Returns a description of all databases specified in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "responses":{ "200":{ "description":"Description of all databases defined in the default Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDatabases" } } } } }, "x-internal-id":"environment-databases--get", "x-filename-id":"environment-databases-get" }, "post":{ "tags":[ "Environment" ], "summary":"Create a new database in the default Oracle Home", "description":"Create a new database in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "requestBody":{ "$ref":"#/components/requestBodies/createDatabase" }, "responses":{ "202":{ "description":"Request to create a new databases has been accepted.", "headers":{ "Location":{ "description":"Location header will provide URI of DBCA job so that processing of the request can be tracked.", "schema":{ "type":"string" } } } } }, "x-internal-id":"environment-databases--post", "x-filename-id":"environment-databases-post" } }, "/environment/databases/{databaseName}":{ "get":{ "tags":[ "Environment" ], "summary":"Get a specific database defined in the default Oracle Home", "description":"Returns a description of the database specified in the default Oracle Home. The default Oracle Home is on the same host as the Oracle REST Data Services server instance and is specified using the $ORACLE_HOME environment variable. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"databaseName", "in":"path", "description":"Name of the database.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of a database defined in the default Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDatabasesItem" } } } } }, "x-internal-id":"environment-databases-{databaseName}-get", "x-filename-id":"environment-databases-databasename-get" } }, "/environment/dbca/jobs/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a list of the DBCA jobs created through ORDS Database API in the default Oracle Home", "description":"Returns a description of all DBCA jobs created through ORDS Database API in the default Oracle Home. This Oracle Home is specified by $ORACLE_HOME environment variable and is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "responses":{ "200":{ "description":"Description of all DBCA jobs created in the default Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaJobs" } } } } }, "x-internal-id":"environment-dbca-jobs--get", "x-filename-id":"environment-dbca-jobs-get" }, "post":{ "tags":[ "Environment" ], "summary":"Create a new DBCA job in the default Oracle Home", "description":"Submit a new Database Configuration Assistant (DBCA) job request to CREATE or DELETE a database in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "requestBody":{ "$ref":"#/components/requestBodies/createDBCAJob" }, "responses":{ "201":{ "description":"Description of the new DBCA job.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaJobsItem" } } } } }, "x-internal-id":"environment-dbca-jobs--post", "x-filename-id":"environment-dbca-jobs-post" } }, "/environment/dbca/jobs/{jobId}/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a specified DBCA jobs created through ORDS Database API in the default Oracle Home", "description":"Returns a description of the DBCA job created through ORDS Database API in the default Oracle Home. The default Oracle Home is specified by $ORACLE_HOME environment variable and is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"jobId", "in":"path", "description":"Identifier of the DBCA job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of the specified DBCA job created in the default Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaJobsItem" } } } } }, "x-internal-id":"environment-dbca-jobs-{jobId}--get", "x-filename-id":"environment-dbca-jobs-jobid-get" }, "delete":{ "tags":[ "Environment" ], "summary":"Delete the specified DBCA job in the default Oracle Home", "description":"Delete the DBCA job in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"jobId", "in":"path", "description":"Identifier of the DBCA job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the DBCA job has been delete." } }, "x-internal-id":"environment-dbca-jobs-{jobId}--delete", "x-filename-id":"environment-dbca-jobs-jobid-delete" } }, "/environment/dbca/jobs/{jobId}/log":{ "get":{ "tags":[ "Environment" ], "summary":"Get the DBCA log file content for a specified DBCA jobs created through ORDS Database API in the default Oracle Home", "description":"Returns the DBCA log file content from the DBCA job created through ORDS Database API in the specified Oracle Home. The Oracle Home is specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"jobId", "in":"path", "description":"Identifier of the DBCA job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Log file content from the DBCA jobs created in the default Oracle Home.", "content":{ "text/plain":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"environment-dbca-jobs-{jobId}-log-get", "x-filename-id":"environment-dbca-jobs-jobid-log-get" } }, "/environment/dbca/templates/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a list of the DBCA database templates defined in the default Oracle Home", "description":"Returns a description of all database templates specified in the default Oracle Home. The Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "responses":{ "200":{ "description":"Description of all database templates defined in the default Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaTemplates" } } } } }, "x-internal-id":"environment-dbca-templates--get", "x-filename-id":"environment-dbca-templates-get" } }, "/environment/dbca/templates/{filename}":{ "get":{ "tags":[ "Environment" ], "summary":"Get a specific database template file in the default Oracle Home", "description":"Returns the database template file in the default Oracle Home. The default Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"filename", "in":"path", "description":"Name of the database template file.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The XML content of the database template file.", "content":{ "text/XML":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"environment-dbca-templates-{filename}-get", "x-filename-id":"environment-dbca-templates-filename-get" } }, "/environment/homes/":{ "get":{ "tags":[ "Environment" ], "summary":"Get database Oracle Homes", "description":"Returns all database Oracle Homes that are on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "responses":{ "200":{ "description":"Description of all database Oracle Homes available.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentHomes" } } } } }, "x-internal-id":"environment-homes--get", "x-filename-id":"environment-homes-get" } }, "/environment/homes/{homeName}/":{ "get":{ "tags":[ "General" ], "summary":"Get specific database Oracle Home", "description":"Returns a description for a specific Oracle Home on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of the Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentHomesItem" } } } } }, "x-internal-id":"environment-homes-{homeName}--get", "x-filename-id":"environment-homes-homename-get" } }, "/environment/homes/{homeName}/databases/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a list of the databases defined in an Oracle Home", "description":"Returns a description of all databases specified in the Oracle Home. The Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of all databases defined in the Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDatabases" } } } } }, "x-internal-id":"environment-homes-{homeName}-databases--get", "x-filename-id":"environment-homes-homename-databases-get" }, "post":{ "tags":[ "Environment" ], "summary":"Create a new database in the specified Oracle Home", "description":"Create a new database in the Oracle Home. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "$ref":"#/components/requestBodies/createDatabase" }, "responses":{ "202":{ "description":"Request to create a new databases has been accepted.", "headers":{ "Location":{ "description":"Location header will provide URI of DBCA job so that processing of the request can be tracked.", "schema":{ "type":"string" } } } } }, "x-internal-id":"environment-homes-{homeName}-databases--post", "x-filename-id":"environment-homes-homename-databases-post" } }, "/environment/homes/{homeName}/databases/{databaseName}":{ "get":{ "tags":[ "Environment" ], "summary":"Get a specific database defined in a specific Oracle Home", "description":"Returns a description of the database specified in the Oracle Home. The Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } }, { "name":"databaseName", "in":"path", "description":"Name of the database.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of a database defined in the Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDatabasesItem" } } } } }, "x-internal-id":"environment-homes-{homeName}-databases-{databaseName}-get", "x-filename-id":"environment-homes-homename-databases-databasename-get" } }, "/environment/homes/{homeName}/dbca/jobs/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a list of the DBCA jobs created through ORDS Database API in the Oracle Home", "description":"Returns a description of all DBCA jobs created through ORDS Database API in the specified Oracle Home. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of all DBCA jobs created in the Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaJobs" } } } } }, "x-internal-id":"environment-homes-{homeName}-dbca-jobs--get", "x-filename-id":"environment-homes-homename-dbca-jobs-get" }, "post":{ "tags":[ "Environment" ], "summary":"Create a new DBCA job in the Oracle Home", "description":"Submit a new DBCA job request to CREATE or DELETE a database in the Oracle Home specified. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "$ref":"#/components/requestBodies/createDBCAJob" }, "responses":{ "201":{ "description":"Description of the new DBCA job.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaJobsItem" } } } } }, "x-internal-id":"environment-homes-{homeName}-dbca-jobs--post", "x-filename-id":"environment-homes-homename-dbca-jobs-post" } }, "/environment/homes/{homeName}/dbca/jobs/{jobId}/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a specified DBCA jobs created through ORDS Database API in the specified Oracle Home", "description":"Returns a description of the DBCA job created through ORDS Database API in the specified Oracle Home. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } }, { "name":"jobId", "in":"path", "description":"Identifier of the DBCA job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of the specified DBCA job created in the Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaJobsItem" } } } } }, "x-internal-id":"environment-homes-{homeName}-dbca-jobs-{jobId}--get", "x-filename-id":"environment-homes-homename-dbca-jobs-jobid-get" }, "delete":{ "tags":[ "Environment" ], "summary":"Delete the specified DBCA job in the default Oracle Home", "description":"Delete the DBCA job in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } }, { "name":"jobId", "in":"path", "description":"Identifier of the DBCA job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the DBCA job has been delete." } }, "x-internal-id":"environment-homes-{homeName}-dbca-jobs-{jobId}--delete", "x-filename-id":"environment-homes-homename-dbca-jobs-jobid-delete" } }, "/environment/homes/{homeName}/dbca/jobs/{jobId}/log":{ "get":{ "tags":[ "Environment" ], "summary":"Get the DBCA log file content for a specified DBCA jobs created through ORDS Database API in the specified Oracle Home", "description":"Returns DBCA log file content from the DBCA job created through ORDS Database API in the specified Oracle Home. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } }, { "name":"jobId", "in":"path", "description":"Identifier of the DBCA job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Log file content from the DBCA jobs created in the Oracle Home.", "content":{ "text/plain":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"environment-homes-{homeName}-dbca-jobs-{jobId}-log-get", "x-filename-id":"environment-homes-homename-dbca-jobs-jobid-log-get" } }, "/environment/homes/{homeName}/dbca/templates/":{ "get":{ "tags":[ "Environment" ], "summary":"Get a list of the DBCA database templates defined in an Oracle Home", "description":"Returns a description of all database templates specified in the Oracle Home. The Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of all database templates defined in the Oracle Home.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EnvironmentDbcaTemplates" } } } } }, "x-internal-id":"environment-homes-{homeName}-dbca-templates--get", "x-filename-id":"environment-homes-homename-dbca-templates-get" } }, "/environment/homes/{homeName}/dbca/templates/{filename}":{ "get":{ "tags":[ "Environment" ], "summary":"Get a specific database template file in a specific Oracle Home", "description":"Returns the database template file in the specified Oracle Home. The Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"homeName", "in":"path", "description":"Name of the Oracle Home.", "required":true, "schema":{ "type":"string" } }, { "name":"filename", "in":"path", "description":"Name of the database template file.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The XML content of the database template file.", "content":{ "text/XML":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"environment-homes-{homeName}-dbca-templates-{filename}-get", "x-filename-id":"environment-homes-homename-dbca-templates-filename-get" } }, "/openservicebroker/v2/catalog":{ "get":{ "tags":[ "Open Service Broker" ], "summary":"Get the catalog of services that the service broker offers", "description":"Returns the Open Service Broker catalog for the associated database pool.", "parameters":[ { "$ref":"#/components/parameters/OpenServiceBrokerAPIVersion" }, { "$ref":"#/components/parameters/OpenServiceBrokerRequestIdentity" }, { "$ref":"#/components/parameters/OpenServiceBrokerOriginatingIdentity" } ], "responses":{ "200":{ "description":"List of all services available on the Service Broker.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OpenServiceBrokerCatalog" } } } } }, "x-internal-id":"openservicebroker-v2-catalog-get", "x-filename-id":"openservicebroker-v2-catalog-get" } }, "/openservicebroker/v2/service_instances/{instance_id}":{ "delete":{ "tags":[ "Open Service Broker" ], "summary":"Deprovision a service instance", "description":"This service exists to satisfy Open Service Broker orphan mitigation flows. Service instances are not persisted by ORDS. As a result, there are no objects to delete.", "parameters":[ { "$ref":"#/components/parameters/OpenServiceBrokerAPIVersion" }, { "$ref":"#/components/parameters/OpenServiceBrokerRequestIdentity" }, { "$ref":"#/components/parameters/OpenServiceBrokerOriginatingIdentity" }, { "name":"instance_id", "in":"path", "description":"Instance id of instance to provision.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the service instance does not exist in ORDS. There is no content returned." } }, "x-internal-id":"openservicebroker-v2-service_instances-{instance_id}-delete", "x-filename-id":"openservicebroker-v2-service_instances-instance_id-delete" }, "put":{ "tags":[ "Open Service Broker" ], "summary":"Provision a service instance", "description":"When the Service Broker receives a provision request from the Platform, it MUST take whatever action is necessary to create a new resource, according to the Service Plan specified.", "parameters":[ { "$ref":"#/components/parameters/OpenServiceBrokerAPIVersion" }, { "$ref":"#/components/parameters/OpenServiceBrokerRequestIdentity" }, { "$ref":"#/components/parameters/OpenServiceBrokerOriginatingIdentity" }, { "name":"instance_id", "in":"path", "description":"Instance id of instance to provision.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "$ref":"#/components/requestBodies/ServiceInstanceProvisionRequest" }, "responses":{ "201":{ "description":"Confirmation that the corresponding Service Plan action was carried out.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServiceInstanceProvision" } } } } }, "x-internal-id":"openservicebroker-v2-service_instances-{instance_id}-put", "x-filename-id":"openservicebroker-v2-service_instances-instance_id-put" } } }, "components":{ "requestBodies":{ "createDatabase":{ "description":"A payload for creating a database.", "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "global_database_name":{ "type":"string", "description":"Global Database Name." }, "template_name":{ "type":"string", "description":"The name of the template file for DBCA to use." }, "response_file":{ "type":"string", "description":"The name of the response file for DBCA to use." }, "system_user_password":{ "type":"string", "description":"The password for the system user in the new database." }, "sys_user_password":{ "type":"string", "description":"The password for the sys user in the new database." }, "container_configuration":{ "type":"object", "description":"This object specifies that a Container Database is to be created with the PDB settings provided.", "items":{ "type":"object", "required":[ "number_of_pdbs", "pdb_administrator_password", "pdb_name" ], "properties":{ "number_of_pdbs":{ "type":"integer", "description":"The number of Pluggable Databases to create." }, "pdb_administrator_password":{ "type":"string", "description":"The password for the PDBADMIN user created in each Pluggable Database." }, "pdb_name":{ "type":"string", "description":"The name prefix to use for each Pluggable Database created." } } } }, "total_memory":{ "type":"integer", "description":"Total amount of physical memory, in megabytes, that can be used by the new database." } } }, "examples":{ "create_cdb":{ "summary":"This is an example request body to create a container database with two pluggable databases. The General_Purpose.dbc template file from the Oracle Home dbca templates directory will be used. It is by providing container_configuration property in the request that indicates a container database is to be created. The container database name will be devcdb1 and the pluggable database names will be pdbtest1 and pdbtest2 in this scenario. The response to this request will be the location of the DBCA job that has been created to process the request.", "value":{ "global_database_name":"devcdb1", "template_name":"General_Purpose.dbc", "sys_user_password":"W3lc0m31", "system_user_password":"W3lc0m31", "container_configuration":{ "number_of_pdbs":2, "pdb_name":"pdbtest", "pdb_administrator_password":"W3lc0m31" } } }, "create_noncdb":{ "summary":"This is an example request body to create a non-container database. The non-container database will be called devdb1, based on the General_Purpose.dbc template, and a predefined response file used to set additional configuration properties. The response to this request will be the location of the DBCA job that has been created to process the request.", "value":{ "global_database_name":"devdb1", "template_name":"General_Purpose.dbc", "sys_user_password":"W3lc0m31", "system_user_password":"W3lc0m31", "response_file":"/disk1/oracle/install_oracle_for_dev.rsp" } } } } } }, "createDBCAJob":{ "description":"A payload for creating a DBCA job.", "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "operation", "global_database_name" ], "properties":{ "operation":{ "type":"string", "description":"The DBCA operation to perform.", "enum":[ "CREATE", "DELETE" ] }, "global_database_name":{ "type":"string", "description":"Global Database Name to identify the database to create or delete" }, "template_name":{ "type":"string", "description":"The name of the template file for DBCA to use when creating a database." }, "response_file":{ "type":"string", "description":"The name of the response file for DBCA to use when creating a database." }, "system_user_password":{ "type":"string", "description":"The password for the system user in the new database." }, "sys_user_password":{ "type":"string", "description":"The password for the sys user in the new database." }, "container_configuration":{ "type":"object", "description":"This object specifies that a Container Database is to be created with the PDB settings provided.", "items":{ "type":"object", "required":[ "number_of_pdbs", "pdb_administrator_password", "pdb_name" ], "properties":{ "number_of_pdbs":{ "type":"integer", "description":"The number of Pluggable Databases to create." }, "pdb_administrator_password":{ "type":"string", "description":"The password for the PDBADMIN user created in each Pluggable Database." }, "pdb_name":{ "type":"string", "description":"The name prefix to use for each Pluggable Database created." } } } }, "total_memory":{ "type":"integer", "description":"Total amount of physical memory, in megabytes, that can be used by the new database." }, "username":{ "type":"string", "description":"Specifies the account with SYSDBA role which DBCA will use to delete the database. Only required for DELETE operations." }, "password":{ "type":"string", "description":"Specifies the password for the account with SYSDBA role which DBCA will use to delete the database. Only required for DELETE operations." } } }, "examples":{ "create_noncdb":{ "summary":"This is an example request body to create a DBCA job for creating a non-container database. The non-container database will be called devdb1, based on the General_Purpose.dbc template, and the total amount of physical memory used by the new database will be 700mb.", "value":{ "operation":"CREATE", "global_database_name":"devdb1", "template_name":"General_Purpose.dbc", "sys_user_password":"W3lc0m31", "system_user_password":"W3lc0m31", "total_memory":700 } }, "delete_database":{ "summary":"This is an example request body to create a DBCA job for deleting a database. The credentials for a user in the database with SYSDBA role are provided as these are required by the DBCA utility to perform the delete action.", "value":{ "operation":"DELETE", "global_database_name":"devdb1", "username":"sys", "password":"W3lc0m31" } } } } } }, "ServiceInstanceProvisionRequest":{ "description":"What a Service Instance represents can vary by service and plan. This object represents a request to provision a Service Instance.", "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "service_id", "plan_id" ], "properties":{ "service_id":{ "type":"string", "description":"The ID of a Service Offering from the catalog for this Service Broker." }, "plan_id":{ "type":"string", "description":"The ID of a Service Plan from the Service Offering that has been requested." }, "parameters":{ "type":"object", "description":"Configuration parameters for the Service Instance. Service Brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation." } } }, "examples":{ "provision_new_user":{ "summary":"This is an example request body to create a new user in the database.", "value":{ "service_id":"c03a85a4-dc35-db7d-3692-1871284187aa ", "plan_id":"c03a85a4-dc35-c8ef-e432-1871284187aa", "parameters":{ "user":"testuser1", "password":"letmein", "grants":[ "create session", "resource" ] } } } } } } } }, "responses":{ "Collection":{ "description":"A collection of items.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } }, "Item":{ "description":"A resource item.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "ReportDataResponse":{ "description":"The response returned by SQL Report Data endpoints will conform to this general pattern of paginated records. The actual structure of each item will vary depending on the report, the database version and the user's permissions.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } }, "BadRequest":{ "description":"An object with message errors.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } } } }, "schemas":{ "APEXInstanceOverview":{ "type":"object", "description":"This object represents aggregated data from APEX_APPLICATIONS record data.", "properties":{ "active_apps_timeframe":{ "type":"integer", "description":"Total of applications with last_updated_on within this timeframe." }, "active_developers_timeframe":{ "type":"integer", "description":"Total of distinct developers for applications active during this timeframe." }, "apps_total":{ "type":"integer", "description":"Total number of APEX_APPLICATIONS records." }, "reporting_timeframe_since":{ "type":"string", "description":"Indicates the start date for records that this aggregated data is based on." }, "reporting_timeframe_to":{ "type":"string", "description":"Indicates the end date for records that this aggregated data is based on." }, "schemas_total":{ "type":"integer", "description":"Total number of distinct schemas with applications." }, "workspaces_timeframe":{ "type":"integer", "description":"Total of distinct workspaces active during this timeframe." }, "workspaces_total":{ "type":"integer", "description":"Total number of workspaces with applications." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "APEXUsageStatistics":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/APEXUsageStatisticsItem" } }, "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" } } } }, "APEXUsageStatisticsItem":{ "type":"object", "description":"This object represents a APEX_WORKSPACE_LOG_ARCHIVE record of page view activity. Page view activity is a daily summary of workspace activity that is retained until physically purged.", "properties":{ "application_id":{ "type":"integer", "description":"Application ID for which this page view log was recorded." }, "application_name":{ "type":"string", "description":"Application Name for which this page view log was recorded." }, "average_render_time":{ "type":"number", "description":"Summarized information by day, application and workspace." }, "builder_events":{ "type":"integer", "description":"TBD" }, "distinct_pages":{ "type":"integer", "description":"Summarized information by day, application and workspace of the number of distinct pages used." }, "distinct_sessions":{ "type":"integer", "description":"Summarized information by day, application and workspace of the number of distinct sessions." }, "distinct_users":{ "type":"integer", "description":"Summarized information by day, application and workspace of the number of distinct users." }, "error_count":{ "type":"integer", "description":"Summarized information by day, application and workspace of the number of errors." }, "log_day":{ "type":"string", "description":"Total not null interactive report search values logged to the activity log." }, "maximum_render_time":{ "type":"number", "description":"Summarized information by day, application and workspace indicating maximum render time." }, "median_render_time":{ "type":"number", "description":"Summarized information by day, application and workspace indicating median render time." }, "page_events":{ "type":"integer", "description":"Total number of page events logged for a given day, application and workspace." }, "public_page_events":{ "type":"integer", "description":"Total public page events for a given day, application and workspace." }, "total_render_time":{ "type":"number", "description":"Summarized information by day, application and workspace indicating total render time." }, "workspace_id":{ "type":"integer", "description":"Identifies workspace." }, "workspace_login_events":{ "type":"integer", "description":"Total workspace login events by day, application and workspace." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "APEXWorkspaces":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/APEXWorkspacesItem" } }, "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" } } } }, "APEXWorkspacesItem":{ "type":"object", "description":"This object represents a single row on APEX_WORKSPACES.", "properties":{ "allow_app_building_yn":{ "type":"string", "description":"Controls availability of application building component." }, "allow_issue_files_yn":{ "type":"string", "description":"Controls availability of issue files component." }, "allow_packaged_app_ins_yn":{ "type":"string", "description":"Controls availability of packaged application installation component." }, "allow_restful_services_yn":{ "type":"string", "description":"Controls availability of RESTful services component." }, "allow_sql_workshop_yn":{ "type":"string", "description":"Controls availability of SQL workshop component." }, "allow_team_dev_files_yn":{ "type":"string", "description":"Controls availability of team development files component." }, "allow_team_development_yn":{ "type":"string", "description":"Controls availability of team development component." }, "allow_to_be_purged_yn":{ "type":"string", "description":"Controls availability of purge component." }, "allow_websheet_dev_yn":{ "type":"string", "description":"Controls availability of websheet development component." }, "apex_users":{ "type":"integer", "description":"Number of APEX users created in this workspace." }, "application_pages":{ "type":"integer", "description":"Number of application pages created in this workspace." }, "applications":{ "type":"integer", "description":"Number of applications created in this workspace." }, "created_on":{ "type":"string", "description":"The date the workspace was created." }, "last_login":{ "type":"string", "description":"Creation date of the most recently purged session. Used to track last login for workspaces who no longer have entries in the activity log." }, "workspace_display_name":{ "type":"string", "description":"Display name for the workspace." }, "workspace_id":{ "type":"integer", "description":"Primary key that identifies the workspace." }, "workspace_name":{ "type":"string", "description":"A work area mapped to one or more database schemas." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseComponents":{ "type":"object", "description":"DBA_REGISTRY displays information about all components in the database that are loaded into the component registry. The component registry tracks components that can be separately loaded into the Oracle Database. When a SQL script loads the PL/SQL packages and other database objects for a component into the database, the script records the component name, status, and version. If scripts are used to upgrade/downgrade the dictionary elements for the component, then those scripts also record status and version information.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseComponentsItem" } }, "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" } } } }, "DatabaseComponentsItem":{ "type":"object", "description":"A component registered in the database.", "properties":{ "comp_id":{ "type":"string", "description":"Component identifier." }, "comp_name":{ "type":"string", "description":"Component name." }, "version":{ "type":"string", "description":"Component version loaded." }, "version_full":{ "type":"string", "description":"Component full version." }, "status":{ "type":"string", "description":"Component status." }, "modified":{ "type":"string", "description":"Time when the component was last modified." }, "namespace":{ "type":"string", "description":"Component namespace." }, "control":{ "type":"string", "description":"User that created the component entry." }, "schema":{ "type":"string", "description":"User that contains the objects for the component." }, "procedure":{ "type":"string", "description":"Validation procedure." }, "startup":{ "type":"string", "description":"Indicates whether the component requires a startup after the upgrade (REQUIRED) or not." }, "parent_id":{ "type":"string", "description":"Parent component identifier." }, "other_schemas":{ "type":"string", "description":"A list of ancillary schema names associated with the component." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseConnections":{ "type":"object", "description":"Information on the listeners configured for the database is retrieved from GV$LISTENER_NETWORK.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseConnectionsItem" } }, "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" } } } }, "DatabaseConnectionsItem":{ "type":"object", "description":"Information on the listeners configured for the database is retrieved from GV$LISTENER_NETWORK. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$LISTENER_NETWORK view information was obtained." }, "host_name":{ "type":"string", "description":"Name of the host machine." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "service_name":{ "type":"string", "description":"Name of the database service that is registered with the listener." }, "port":{ "type":"integer", "description":"The TCP/IP port the listener is using." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DataPumpJobs":{ "type":"object", "description":"DBA_DATAPUMP_JOBS identifies all active Data Pump jobs in the database, regardless of their state, on an instance (or on all instances for Real Application Clusters). It also show all Data Pump master tables not currently associated with an active job.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DataPumpJobsItem" } }, "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" } } } }, "DataPumpJobsItem":{ "type":"object", "description":"This object represents a specified Data Pump job in the database.", "properties":{ "owner_name":{ "type":"string", "description":"User that initiated the job." }, "job_name":{ "type":"string", "description":"User-supplied name for the job (or the default name generated by the server)." }, "operation":{ "type":"string", "description":"Type of job." }, "job_mode":{ "type":"string", "description":"Mode of job." }, "state":{ "type":"string", "description":"Current job state." }, "degree":{ "type":"integer", "description":"Number of worker processes performing the operation." }, "attached_sessions":{ "type":"integer", "description":"Number of sessions attached to the job." }, "datapump_sessions":{ "type":"integer", "description":"Number of Data Pump sessions participating in the job." }, "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" } } } }, "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" } } } }, "DatabaseFeatureUsage":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseFeatureUsageItem" } }, "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" } } } }, "DatabaseFeatureUsageItem":{ "type":"object", "description":"Statistics on the usage in the database for an Oracle Database feature.", "properties":{ "dbid":{ "type":"integer", "description":"Database identifier of the database being tracked." }, "name":{ "type":"string", "description":"Name of the feature." }, "version":{ "type":"string", "description":"Database version in which the feature was tracked." }, "detected_usages":{ "type":"integer", "description":"Number of times the system has detected usage for the feature." }, "total_samples":{ "type":"integer", "description":"Number of times the system has woken up and checked for feature usage." }, "currently_used":{ "type":"string", "description":"Indicates whether usage was detected the last time the system checked (TRUE) or not (FALSE)." }, "first_usage_date":{ "type":"string", "description":"First sample time the system detected usage of the feature." }, "last_usage_date":{ "type":"string", "description":"Last sample time the system detected usage of the feature." }, "aux_count":{ "type":"integer", "description":"This column stores feature-specific usage data in number format." }, "feature_info":{ "type":"string", "description":"This column stores feature-specific usage data in character format." }, "last_sample_date":{ "type":"string", "description":"The last time the system checked for usage." }, "last_sample_period":{ "type":"integer", "description":"Amount of time (in seconds) between the last two usage sample times." }, "sample_interval":{ "type":"integer", "description":"Sample interval." }, "description":{ "type":"string", "description":"Description of the feature and usage detection logic." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringAlerts":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringAlertsItem" } }, "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" } } } }, "MonitoringAlertsItem":{ "type":"object", "description":"This object represents an alert log record from V$DIAG_ALERT_EXT. V$DIAG_ALERT_EXT shows the contents of the XML-based alert log in the Automatic Diagnostic Repository (ADR). The list of attributes may vary depending on database version.", "properties":{ "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "adr_home":{ "type":"string", "description":"Directory location of the Automatic Diagnostic Repository (ADR)." }, "originating_timestamp":{ "type":"string", "description":"Date and time when the message was generated." }, "normalized_timestamp":{ "type":"string", "description":"Date and time when the message originated, normalized for clock drift to the Oracle Enterprise Manager repository time." }, "organization_id":{ "type":"string", "description":"ID of the organization that wrote the originating component, usually the domain of the organization." }, "component_id":{ "type":"string", "description":"ID of the product or component that originated the message." }, "host_id":{ "type":"string", "description":"DNS hostname of originating host." }, "host_address":{ "type":"string", "description":"IP of other network address of the originating host for the message." }, "message_type":{ "type":"integer", "description":"Type of the message, indicating that a different type of response is required." }, "message_type_name":{ "type":"string", "description":"A text description of the corresponding message type value." }, "message_level":{ "type":"integer", "description":"Level the message belongs to. Lower level values imply higher severity for errors." }, "message_level_name":{ "type":"string", "description":"A text description of the corresponding message level value." }, "message_id":{ "type":"string", "description":"ID of the message." }, "message_group":{ "type":"string", "description":"Name of the group to which the message belongs." }, "client_id":{ "type":"string", "description":"ID of the client or security group that the message relates to." }, "module_id":{ "type":"string", "description":"ID of the module that originated the message. This value is unique within a component." }, "process_id":{ "type":"string", "description":"ID of the process that originated the message." }, "thread_id":{ "type":"string", "description":"ID of the thread of the process that originated the message." }, "user_id":{ "type":"string", "description":"ID of the user that originated the message." }, "detailed_location":{ "type":"string", "description":"Absolute pathname of supplemental detail file on the originating host." }, "upstream_comp_id":{ "type":"string", "description":"ID of a component that the originating component is working with on the upstream (client) side." }, "downstream_comp_id":{ "type":"string", "description":"ID of a component that the originating component is working with on the downstream (server) side." }, "execution_context_id":{ "type":"string", "description":"Identifies the thread of execution that the originating component participates in." }, "execution_context_sequence":{ "type":"integer", "description":"Execution sequence of the thread that the originating component participates in." }, "error_instance_id":{ "type":"integer", "description":"ID of the instance where error occurred." }, "error_instance_sequence":{ "type":"integer", "description":"Instance sequence where error occurred." }, "message_text":{ "type":"string", "description":"Fully formed and localized text of the message." }, "message_arguments":{ "type":"string", "description":"Arguments to be bound with the generic text of the message." }, "supplemental_attributes":{ "type":"string", "description":"Supplemental attributes that are specific to a message. This field contains the impacts for an incident type error message." }, "supplemental_details":{ "type":"string", "description":"Supplemental data that is specific to a particular program and error message required to complete the diagnosis." }, "partition":{ "type":"integer", "description":"Segment number of physical file." }, "record_id":{ "type":"integer", "description":"Record number for the message (this value is same as the row number)." }, "filename":{ "type":"string", "description":"Physical file on disk." }, "problem_key":{ "type":"string", "description":"Describes the key for the current problem that the message is associated with." }, "version":{ "type":"integer", "description":" Oracle ARB logging standard version number for the message." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringAlertsSummaryMessageLevelItem":{ "type":"object", "description":"This object represents a summary of V$DIAG_ALERT_EXT records by message level. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "message_level":{ "type":"integer", "description":"Level the message belongs to. Lower level values imply higher severity for errors." }, "message_level_name":{ "type":"string", "description":"A text description of the corresponding message level value." }, "number_of_messages":{ "type":"integer", "description":"The count of records that have this message level." }, "latest_messages":{ "type":"string", "description":"The text of the last 5 messages at this message level." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringAlertsSummaryMessageTypeItem":{ "type":"object", "description":"This object represents a summary of V$DIAG_ALERT_EXT records by message type. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "message_type":{ "type":"integer", "description":"Type of the message, indicating that a different type of response is required." }, "message_type_name":{ "type":"string", "description":"A text description of the corresponding message type value." }, "number_of_messages":{ "type":"integer", "description":"The count of records that have this message type." }, "latest_messages":{ "type":"string", "description":"The text of the last 5 messages at this message type." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionLimitsItem":{ "type":"object", "description":"This object is used to monitor the consumption of session resources in the database. Since GV$RESOURCE_LIMIT exposes global/ CDB level information, it can only be queried from CDB$ROOT or in a non-CDB database. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "resource_name":{ "type":"string", "description":"Name of the resource. This will always be session in this case." }, "current_utilization":{ "type":"integer", "description":"Number of (resources, locks, or processes) currently being used." }, "max_utilization":{ "type":"integer", "description":"Maximum consumption of this resource since the last instance start-up." }, "initial_allocation":{ "type":"string", "description":"Initial allocation. This will be equal to the value specified for the resource in the initialization parameter file (UNLIMITED for infinite allocation)." }, "limit_value":{ "type":"string", "description":"The maximum value of utilization that will be allowed." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionLocks":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringSessionLocksItem" } }, "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" } } } }, "MonitoringSessionLocksItem":{ "type":"object", "description":"This object is represents a record on DBA_LOCK view. DBA_LOCK lists all locks or latches held in the database, and all outstanding requests for a lock or latch. The list of attributes may vary depending on database version.", "properties":{ "session_id":{ "type":"integer", "description":"Session holding or acquiring the lock." }, "lock_type":{ "type":"string", "description":"Lock type." }, "mode_held":{ "type":"string", "description":"Lock mode." }, "mode_requested":{ "type":"string", "description":"Lock mode requested." }, "lock_id1":{ "type":"string", "description":"Type-specific lock identifier, part 1." }, "lock_id2":{ "type":"string", "description":"Type-specific lock identifier, part 2." }, "last_convert":{ "type":"integer", "description":"The last convert." }, "blocking_others":{ "type":"string", "description":"Whether the lock is currently blocking others." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionLocksHolding":{ "type":"object", "description":"This collection represents database locks held by sessions that are blocking other sessions. The list of attributes may vary depending on database version.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringSessionLocksItem" } }, "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" } } } }, "MonitoringSessionLocksWaiting":{ "type":"object", "description":"This collection represents database locks held by sessions that are waiting on other sessions. The list of attributes may vary depending on database version.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringSessionLocksItem" } }, "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" } } } }, "MonitoringSessionTypeSummariesItem":{ "type":"object", "description":"Using data from GV$SESSION this object represents a summary of the number of sessions in different states aggregated across different session types (BACKGROUND and USER).", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "type":{ "type":"string", "description":"Session type." }, "number_of_sessions":{ "type":"integer", "description":"Total number of sessions of this type." }, "number_of_active_sessions":{ "type":"integer", "description":"Total number of active sessions of this type." }, "number_of_inactive_sessions":{ "type":"integer", "description":"Total number of inactive sessions of this type." }, "number_of_active_blocking_sess":{ "type":"integer", "description":"Total number of active blocking sessions of this type." }, "number_of_act_non_blocking_ses":{ "type":"integer", "description":"Total number of active non-blocking sessions of this type." } } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionWaitClasses":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringSessionWaitClassesItem" } }, "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" } } } }, "MonitoringSessionWaitClassesItem":{ "type":"object", "description":"This object represents a record from GV$SESSION_WAIT_CLASS view. GV$SESSION_WAIT_CLASS displays the time spent in various wait event operations on a per-session basis. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "sid":{ "type":"integer", "description":"Session identifier." }, "serial#":{ "type":"integer", "description":"Serial number." }, "wait_class_id":{ "type":"integer", "description":"Identifier of the wait class." }, "wait_class#":{ "type":"integer", "description":"Number of the wait class." }, "wait_class":{ "type":"string", "description":"Name of the wait class." }, "total_waits":{ "type":"integer", "description":"Number of times waits of the class occurred for the session." }, "time_waited":{ "type":"integer", "description":"Amount of time spent in the wait class by the session." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionWaits":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringSessionWaitsItem" } }, "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" } } } }, "MonitoringSessionWaitsItem":{ "type":"object", "description":"This object represents a record from GV$SESSION_WAIT view. GV$SESSION_WAIT displays the current or last wait for each session. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "sid":{ "type":"integer", "description":"Session identifier." }, "seq#":{ "type":"integer", "description":"A number that uniquely identifies the current or last wait (incremented for each wait)." }, "event":{ "type":"string", "description":"If the session is currently waiting, then the resource or event for which the session is waiting. If the session is not in a wait, then the resource or event for which the session most recently waited." }, "p1text":{ "type":"string", "description":"Description of the first wait event parameter." }, "p1":{ "type":"integer", "description":"First wait event parameter (in decimal)." }, "p1raw":{ "type":"string", "description":"First wait event parameter (in hexadecimal)." }, "p2text":{ "type":"string", "description":"Description of the second wait event parameter." }, "p2":{ "type":"integer", "description":"Second wait event parameter (in decimal)." }, "p2raw":{ "type":"string", "description":"Second wait event parameter (in hexadecimal)." }, "p3text":{ "type":"string", "description":"Description of the third wait event parameter." }, "p3":{ "type":"integer", "description":"Third wait event parameter (in decimal)." }, "p3raw":{ "type":"string", "description":"Third wait event parameter (in hexadecimal)." }, "wait_class_id":{ "type":"integer", "description":"Identifier of the class of the wait event." }, "wait_class#":{ "type":"integer", "description":"Number of the class of the wait event." }, "wait_class":{ "type":"string", "description":"Name of the class of the wait event." }, "wait_time":{ "type":"integer", "description":"If the session is currently waiting, then the value is 0. If the session is not in a wait, then the value indicates the duration of the last wait." }, "seconds_in_wait":{ "type":"integer", "description":"If the session is currently waiting, then the value is the amount of time waited for the current wait. If the session is not in a wait, then the value is the amount of time since the start of the last wait." }, "state":{ "type":"string", "description":"Wait state." }, "wait_time_micro":{ "type":"integer", "description":"Amount of time waited (in microseconds). If the session is currently waiting, then the value is the time spent in the current wait. If the session is currently not in a wait, then the value is the amount of time waited in the last wait." }, "time_remaining_micro":{ "type":"integer", "description":"Amount of time remaining remaining before a timeout. This field may indicate that a timeout has occurred, or that no timeout will occur." }, "time_since_last_wait_micro":{ "type":"integer", "description":"Time elapsed since the end of the last wait (in microseconds). If the session is currently in a wait, then the value is 0." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessions":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/MonitoringSessionsItem" } }, "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" } } } }, "MonitoringSessionsItem":{ "type":"object", "description":"This object represents a record from GV$SESSION view. GV$SESSION displays session information for each current session. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "saddr":{ "type":"string", "description":"Session address." }, "sid":{ "type":"integer", "description":"Session identifier." }, "serial#":{ "type":"integer", "description":"Session serial number. Used to uniquely identify a session's objects. Guarantees that session-level commands are applied to the correct session objects if the session ends and another session begins with the same session ID." }, "audsid":{ "type":"integer", "description":"Auditing session ID." }, "paddr":{ "type":"string", "description":"Address of the process that owns the session." }, "user#":{ "type":"integer", "description":"Oracle user identifier." }, "username":{ "type":"string", "description":"Oracle username." }, "command":{ "type":"integer", "description":"Command in progress (last statement parsed)." }, "ownerid":{ "type":"integer", "description":"Identifier of the user who owns the migratable session." }, "taddr":{ "type":"string", "description":"Address of the transaction state object." }, "lockwait":{ "type":"string", "description":"Address of the lock the session is waiting for; NULL if none." }, "status":{ "type":"string", "description":"Status of the session." }, "server":{ "type":"string", "description":"Server type." }, "schema#":{ "type":"integer", "description":"Schema user identifier." }, "schemaname":{ "type":"string", "description":"Schema user name." }, "osuser":{ "type":"string", "description":"Operating system client user name." }, "process":{ "type":"string", "description":"Operating system client process ID." }, "machine":{ "type":"string", "description":"Operating system machine name." }, "port":{ "type":"integer", "description":"Client port number." }, "terminal":{ "type":"string", "description":"Operating system terminal name." }, "program":{ "type":"string", "description":"Operating system program name." }, "type":{ "type":"string", "description":"Session type." }, "sql_address":{ "type":"string", "description":"Used with sql_hash_value to identify the SQL statement that is currently being executed." }, "sql_hash_value":{ "type":"integer", "description":"Used with SQL_ADDRESS to identify the SQL statement that is currently being executed." }, "sql_id":{ "type":"string", "description":"SQL identifier of the SQL statement that is currently being executed." }, "sql_child_number":{ "type":"integer", "description":"Child number of the SQL statement that is currently being executed." }, "sql_exec_start":{ "type":"string", "description":"Time when the execution of the SQL currently executed by this session started; NULL if SQL_ID is NULL." }, "sql_exec_id":{ "type":"integer", "description":"SQL execution identifier; NULL if SQL_ID is NULL or if the execution of that SQL has not yet started." }, "prev_sql_addr":{ "type":"string", "description":"Used with PREV_HASH_VALUE to identify the last SQL statement executed." }, "prev_hash_value":{ "type":"integer", "description":"Used with SQL_HASH_VALUE to identify the last SQL statement executed." }, "prev_sql_id":{ "type":"string", "description":"SQL identifier of the last SQL statement executed." }, "prev_child_number":{ "type":"integer", "description":"Child number of the last SQL statement executed." }, "prev_exec_start":{ "type":"string", "description":"SQL execution start of the last executed SQL statement." }, "prev_exec_id":{ "type":"integer", "description":"SQL execution identifier of the last executed SQL statement." }, "plsql_entry_object_id":{ "type":"integer", "description":"Object ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack." }, "plsql_entry_subprogram_id":{ "type":"integer", "description":"Subprogram ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack." }, "plsql_object_id":{ "type":"integer", "description":"Object ID of the currently executing PL/SQL subprogram; NULL if executing SQL." }, "plsql_subprogram_id":{ "type":"integer", "description":"Subprogram ID of the currently executing PL/SQL object; NULL if executing SQL." }, "module":{ "type":"string", "description":"Name of the currently executing module as set by calling the DBMS_APPLICATION_INFO.SET_MODULE procedure." }, "module_hash":{ "type":"integer", "description":"Hash value of the MODULE column." }, "action":{ "type":"string", "description":"Name of the currently executing action as set by calling the DBMS_APPLICATION_INFO.SET_ACTION procedure." }, "action_hash":{ "type":"integer", "description":"Hash value of the ACTION column." }, "client_info":{ "type":"string", "description":"Information set by the DBMS_APPLICATION_INFO.SET_CLIENT_INFO procedure." }, "fixed_table_sequence":{ "type":"integer", "description":"This contains a number that increases every time the session completes a call to the database and there has been an intervening select from a dynamic performance table. This column can be used by performance monitors to monitor statistics in the database." }, "row_wait_obj#":{ "type":"integer", "description":"Object ID for the table containing the row specified in row_wait_row#." }, "row_wait_file#":{ "type":"integer", "description":"Identifier for the data file containing the row specified in row_wait_row#. This property is valid only if the session is currently waiting for another transaction to commit and the value of row_wait_obj# is not -1." }, "row_wait_block#":{ "type":"integer", "description":"Identifier for the block containing the row specified in row_wait_row#. This property is valid only if the session is currently waiting for another transaction to commit and the value of row_wait_obj# is not -1." }, "row_wait_row#":{ "type":"integer", "description":"Current row being locked. This property is valid only if the session is currently waiting for another transaction to commit and the value of row_wait_obj# is not -1." }, "top_level_call#":{ "type":"integer", "description":"Oracle top level call number." }, "logon_time":{ "type":"string", "description":"Time of logon." }, "last_call_et":{ "type":"integer", "description":"If the session STATUS is currently ACTIVE, then the value represents the elapsed time (in seconds) since the session has become active. If the session STATUS is currently INACTIVE, then the value represents the elapsed time (in seconds) since the session has become inactive." }, "pdml_enabled":{ "type":"string", "description":"This column has been replaced by the PDML_STATUS column." }, "failover_type":{ "type":"string", "description":"Indicates whether and to what extent transparent application failover (TAF) is enabled for the session." }, "failover_method":{ "type":"string", "description":"Indicates the transparent application failover method for the session." }, "failed_over":{ "type":"string", "description":"Indicates whether the session is running in failover mode and failover has occurred (YES) or not (NO)." }, "resource_consumer_group":{ "type":"string", "description":"Name of the session's current resource consumer group." }, "pdml_status":{ "type":"string", "description":"If ENABLED, the session is in a PARALLEL DML enabled mode. If DISABLED, PARALLEL DML enabled mode is not supported for the session. If FORCED, the session has been altered to force PARALLEL DML." }, "pddl_status":{ "type":"string", "description":"If ENABLED, the session is in a PARALLEL DDL enabled mode. If DISABLED, PARALLEL DDL enabled mode is not supported for the session. If FORCED, the session has been altered to force PARALLEL DDL." }, "pq_status":{ "type":"string", "description":"If ENABLED, the session is in a PARALLEL QUERY enabled mode. If DISABLED, PARALLEL QUERY enabled mode is not supported for the session. If FORCED, the session has been altered to force PARALLEL QUERY." }, "current_queue_duration":{ "type":"integer", "description":"If queued (1), the current amount of time the session has been queued. If not currently queued, the value is 0." }, "client_identifier":{ "type":"string", "description":"Client identifier of the session." }, "blocking_session_status":{ "type":"string", "description":"This column provides details on whether there is a blocking session." }, "blocking_instance":{ "type":"integer", "description":"Instance identifier of the blocking session. This column is valid only if BLOCKING_SESSION_STATUS has the value VALID." }, "blocking_session":{ "type":"integer", "description":"Session identifier of the blocking session. This column is valid only if BLOCKING_SESSION_STATUS has the value VALID." }, "final_blocking_session_status":{ "type":"string", "description":"The final blocking session is the final element in the wait chain constructed by following the sessions that are blocked by one another starting with this session. In the case of a cyclical wait chain, one of the sessions in the wait chain will be chosen as the final blocker." }, "final_blocking_instance":{ "type":"integer", "description":"Instance identifier of the final blocking session. This column is valid only if FINAL_BLOCKING_SESSION_STATUS has the value VALID." }, "final_blocking_session":{ "type":"integer", "description":"Session identifier of the blocking session. This column is valid only if FINAL_BLOCKING_SESSION_STATUS has the value VALID." }, "seq#":{ "type":"integer", "description":"A number that uniquely identifies the current or last wait (incremented for each wait)." }, "event#":{ "type":"integer", "description":"If the session is currently waiting, then the number of the resource or event for which the session is waiting. If the session is not in a wait, then the number of the resource or event for which the session most recently waited." }, "event":{ "type":"string", "description":"If the session is currently waiting, then the resource or event for which the session is waiting. If the session is not in a wait, then the resource or event for which the session most recently waited." }, "p1text":{ "type":"string", "description":"Description of the first wait event parameter." }, "p1":{ "type":"integer", "description":"First wait event parameter (in decimal)." }, "p1raw":{ "type":"string", "description":"First wait event parameter (in hexadecimal)." }, "p2text":{ "type":"string", "description":"Description of the second wait event parameter." }, "p2":{ "type":"integer", "description":"Second wait event parameter (in decimal)." }, "p2raw":{ "type":"string", "description":"Second wait event parameter (in hexadecimal)." }, "p3text":{ "type":"string", "description":"Description of the third wait event parameter." }, "p3":{ "type":"integer", "description":"Third wait event parameter (in decimal)." }, "p3raw":{ "type":"string", "description":"Third wait event parameter (in hexadecimal)." }, "wait_class_id":{ "type":"integer", "description":"Identifier of the class of the wait event." }, "wait_class#":{ "type":"integer", "description":"Number of the class of the wait event." }, "wait_class":{ "type":"string", "description":"Name of the class of the wait event." }, "wait_time":{ "type":"integer", "description":"If the session is currently waiting, then the value is 0. If the session is not in a wait, then the value indicates the duration of the last wait." }, "seconds_in_wait":{ "type":"integer", "description":"If the session is currently waiting, then the value is the amount of time waited for the current wait. If the session is not in a wait, then the value is the amount of time since the start of the last wait." }, "state":{ "type":"string", "description":"Wait state." }, "wait_time_micro":{ "type":"integer", "description":"Amount of time waited (in microseconds). If the session is currently waiting, then the value is the time spent in the current wait. If the session is currently not in a wait, then the value is the amount of time waited in the last wait." }, "time_remaining_micro":{ "type":"integer", "description":"Amount of time remaining remaining before a timeout. This field may indicate that a timeout has occurred, or that no timeout will occur." }, "time_since_last_wait_micro":{ "type":"integer", "description":"Time elapsed since the end of the last wait (in microseconds). If the session is currently in a wait, then the value is 0." }, "service_name":{ "type":"string", "description":"Service name of the session." }, "sql_trace":{ "type":"string", "description":"Indicates whether SQL tracing is enabled (ENABLED) or disabled (DISABLED)." }, "sql_trace_waits":{ "type":"string", "description":"Indicates whether wait tracing is enabled (TRUE) or not (FALSE)." }, "sql_trace_binds":{ "type":"string", "description":"Indicates whether bind tracing is enabled (TRUE) or not (FALSE)." }, "sql_trace_plan_stats":{ "type":"string", "description":"Frequency at which row source statistics are dumped in the trace files for each cursor." }, "session_edition_id":{ "type":"integer", "description":"Shows the value that, in the session, would be reported by sys_context('USERENV', 'SESSION_EDITION_ID')." }, "creator_addr":{ "type":"string", "description":"Address of the creating process or circuit." }, "creator_serial#":{ "type":"integer", "description":"Serial number of the creating process or circuit." }, "ecid":{ "type":"string", "description":"Execution context identifier (sent by Application Server)." }, "sql_translation_profile_id":{ "type":"integer", "description":"Object number of the SQL translation profile." }, "pga_tunable_mem":{ "type":"integer", "description":"The amount of tunable PGA memory (in bytes)." }, "shard_ddl_status":{ "type":"string", "description":"Indicates whether shard DDL is enabled in the current session (ENABLED) or not (DISABLED). This value is only relevant for the shard catalog database." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "external_name":{ "type":"string", "description":"External name of the database user. For enterprise users, returns the Oracle Internet Directory DN." }, "plsql_debugger_connected":{ "type":"string", "description":"Indicates whether the session is connected to a PL/SQL debugger." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionsLongRunningOperationItem":{ "type":"object", "description":"This object represents operations for a specific session that run for longer than 6 seconds (in absolute time).", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "sid":{ "type":"integer", "description":"Identifier of the session processing the long-running operation. If multiple sessions are cooperating in the long-running operation, then SID corresponds to the main or master session." }, "serial#":{ "type":"integer", "description":"Serial number of the session processing the long-running operation. If multiple sessions are cooperating in the long-running operation, then SERIAL# corresponds to the main or master session. SERIAL# is used to uniquely identify a session's objects. Guarantees that session-level commands are applied to the correct session objects if the session ends and another session begins with the same session ID." }, "opname":{ "type":"string", "description":"Brief description of the operation." }, "target":{ "type":"string", "description":"Object on which the operation is carried out." }, "target_desc":{ "type":"string", "description":"Description of the target." }, "sofar":{ "type":"integer", "description":"Units of work done so far for the operation specified in the OPNAME column." }, "totalwork":{ "type":"integer", "description":"Total units of work for the operation specified in the OPNAME column." }, "units":{ "type":"string", "description":"Units of measurement." }, "start_time":{ "type":"string", "description":"Starting time of the operation." }, "last_update_time":{ "type":"string", "description":"Time when statistics were last updated for the operation." }, "timestamp":{ "type":"string", "description":"Timestamp specific to the operation." }, "time_remaining":{ "type":"integer", "description":"Estimate (in seconds) of time remaining for the operation to complete." }, "elapsed_seconds":{ "type":"integer", "description":"Number of elapsed seconds from the start of the operations." }, "context":{ "type":"integer", "description":"Context." }, "message":{ "type":"string", "description":"Statistics summary message." }, "username":{ "type":"string", "description":"User ID of the user performing the operation." }, "sql_address":{ "type":"string", "description":"Used with sql_hash_value to identify the SQL statement that is currently being executed." }, "sql_hash_value":{ "type":"integer", "description":"Used with SQL_ADDRESS to identify the SQL statement that is currently being executed." }, "sql_id":{ "type":"string", "description":"SQL identifier of the SQL statement that is currently being executed." }, "sql_plan_hash_value":{ "type":"integer", "description":"Used with the value of the SQL_ADDRESS column to identify the SQL statement associated with the operation." }, "sql_exec_start":{ "type":"string", "description":"Time when the execution of the SQL currently executed by this session started; NULL if SQL_ID is NULL." }, "sql_exec_id":{ "type":"integer", "description":"SQL execution identifier; NULL if SQL_ID is NULL or if the execution of that SQL has not yet started." }, "sql_plan_line_id":{ "type":"integer", "description":"SQL plan line ID corresponding to the long operation; NULL if the long operation is not associated with a line of the execution plan." }, "sql_plan_operation":{ "type":"string", "description":"Plan operation name; NULL if SQL_PLAN_LINE_ID is NULL." }, "sql_plan_options":{ "type":"string", "description":"Plan operation options; NULL if SQL_PLAN_LINE_ID is NULL." }, "qcsid":{ "type":"integer", "description":"Session identifier of the parallel coordinator." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringSessionsProcessItem":{ "type":"object", "description":"This object represents information about the currently active processes for a specific session. Data is retrieved from GV$PROCESS view.", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "addr":{ "type":"string", "description":"Address of the process state object." }, "pid":{ "type":"integer", "description":"Oracle process identifier." }, "sosid":{ "type":"string", "description":"Operating system (process, thread) identifier." }, "spid":{ "type":"string", "description":"Operating system process identifier." }, "stid":{ "type":"string", "description":"Operating system thread identifier." }, "execution_type":{ "type":"string", "description":"Operating system execution type." }, "pname":{ "type":"string", "description":"Name of this process." }, "username":{ "type":"string", "description":"Operating system process username." }, "serial#":{ "type":"integer", "description":"Process serial number." }, "terminal":{ "type":"string", "description":"Operating system terminal identifier." }, "program":{ "type":"string", "description":"Program in progress." }, "traceid":{ "type":"string", "description":"Trace file identifier." }, "tracefile":{ "type":"string", "description":"Trace file name of the process." }, "background":{ "type":"string", "description":"1 for a SYSTEM background process; NULL for foreground processes or non-SYSTEM background processes." }, "latchwait":{ "type":"string", "description":"Address of the latch the process is waiting for; NULL if none." }, "latchspin":{ "type":"string", "description":"This column is obsolete." }, "pga_used_mem":{ "type":"integer", "description":"PGA memory currently used by the process (in bytes)." }, "pga_alloc_mem":{ "type":"integer", "description":"PGA memory currently allocated by the process (including free PGA memory not yet released to the operating system by the server process), in bytes." }, "pga_freeable_mem":{ "type":"integer", "description":"Allocated PGA memory which can be freed (in bytes)." }, "pga_max_mem":{ "type":"integer", "description":"Maximum PGA memory ever allocated by the process (in bytes)." }, "numa_default":{ "type":"integer", "description":"The NUMA processor group of this process at initialization time." }, "numa_curr":{ "type":"integer", "description":"The NUMA processor group of this process currently." }, "cpu_used":{ "type":"integer", "description":"Tracks the CPU used by this process (in microseconds) from the time it was spawned." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringWaitClassTotalsItem":{ "type":"object", "description":"Time totals for each registered wait class", "properties":{ "inst_id":{ "type":"integer", "description":"Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1." }, "wait_class_id":{ "type":"integer", "description":"Identifier of the wait class." }, "wait_class#":{ "type":"integer", "description":"Number of the wait class." }, "wait_class":{ "type":"string", "description":"Name of the wait class." }, "total_waits":{ "type":"integer", "description":"Number of times waits of the class occurred." }, "time_waited":{ "type":"integer", "description":"Amount of time (in hundredths of a second) spent in the wait by all sessions in the instance." }, "total_waits_fg":{ "type":"integer", "description":"Number of times waits from this wait class occurred in foreground sessions." }, "time_waited_fg":{ "type":"integer", "description":"Amount of time (in hundredths of a second) spent in waits from this wait class in foreground sessions." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringWaitsRecentItem":{ "type":"object", "description":"A summary of time waited for each wait class in GV$ACTIVE_SESSION_HISTORY.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "sample_time":{ "type":"string", "description":"Time at which the sample was taken." }, "wait_class":{ "type":"string", "description":"Wait class name of the event for which the session was waiting at the time of sampling." }, "time_waited":{ "type":"integer", "description":"Amount of time (in microseconds) spent in waits from this wait class at the time of sampling." } } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "MonitoringWaitClassMetricsItem":{ "type":"object", "description":"This object combines data from GV$WAITCLASSMETRIC and GV$SYSTEM_WAIT_CLASS views to represent metric values of wait classes for the most recent 60-second interval.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "begin_time":{ "type":"string", "description":"Begin time of the interval." }, "end_time":{ "type":"string", "description":"End time of the interval." }, "intsize_csec":{ "type":"integer", "description":"Interval size (in hundredths of a second)." }, "average_waiter_count":{ "type":"integer", "description":"Average waiter count." }, "dbtime_in_wait":{ "type":"integer", "description":"Percent of database time spent in the wait." }, "wait_count":{ "type":"integer", "description":"Number of times waited." }, "wait_count_fg":{ "type":"integer", "description":"Number of times foreground processes waited." }, "wait_class_id":{ "type":"integer", "description":"Identifier of the wait class." }, "wait_class#":{ "type":"integer", "description":"Number of the wait class." }, "wait_class":{ "type":"string", "description":"Name of the wait class." }, "total_waits":{ "type":"integer", "description":"Number of times waits of the class occurred." }, "time_waited":{ "type":"integer", "description":"Amount of time (in hundredths of a second) spent in the wait by all sessions in the instance." }, "total_waits_fg":{ "type":"integer", "description":"Number of times waits from this wait class occurred in foreground sessions." }, "time_waited_fg":{ "type":"integer", "description":"Amount of time (in hundredths of a second) spent in waits from this wait class in foreground sessions." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." } } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "OpenServiceBrokerCatalog":{ "type":"object", "description":"This object is a list of all services available on the Service Broker.", "properties":{ "services":{ "type":"array", "items":{ "$ref":"#/components/schemas/OpenServiceBrokerService" } } } }, "OpenServiceBrokerService":{ "type":"object", "description":"This object is a list of all services available on the Service Broker.", "properties":{ "name":{ "type":"string", "description":"The name of the Service Offering." }, "id":{ "type":"string", "description":"An identifier used to correlate this Service Offering in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this Service Offering." }, "description":{ "type":"string", "description":"A short description of the service." }, "bindable":{ "type":"boolean", "description":"Specifies whether Service Instances of the service can be bound to applications. This specifies the default for all Service Plans of this Service Offering." }, "tags":{ "type":"array", "description":"Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service, enabling equivalent services to be swapped out without changes to dependent logic in applications, buildpacks, or other services.", "items":{ "type":"string" } }, "metadata":{ "type":"object", "description":"An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.", "properties":{ "displayName":{ "type":"string", "description":"The name of the service to be displayed in graphical clients." }, "documentationUrl":{ "type":"string", "description":"Link to documentation page for the service." }, "imageUrl":{ "type":"string", "description":"TThe URL to an image or a data URL containing an image." }, "longDescription":{ "type":"string", "description":"Long description of the Service Offering." }, "providerDisplayName":{ "type":"string", "description":"The name of the upstream entity providing the actual service." }, "supportUrl":{ "type":"string", "description":"Link to support page for the service." } } }, "plans":{ "type":"array", "items":{ "$ref":"#/components/schemas/OpenServiceBrokerPlan" } } } }, "OpenServiceBrokerPlan":{ "type":"object", "description":"The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.", "properties":{ "name":{ "type":"string", "description":"The name of the Service Plan." }, "id":{ "type":"string", "description":"An identifier used to correlate this Plan in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this Service Plan." }, "description":{ "type":"string", "description":"A short description of the Service Plan." }, "free":{ "type":"boolean", "description":"When false, Service Instances of this Service Plan have a cost. The default is true." }, "metadata":{ "type":"object", "description":"An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.", "properties":{ "displayName":{ "type":"string", "description":"The name of the Service Plan to be displayed in graphical clients." }, "bullets":{ "type":"array", "description":"Features of this Service Plan, to be displayed in a bulleted-list.", "items":{ "type":"string" } } } }, "schemas":{ "$ref":"#/components/schemas/OpenServiceBrokerSchemas" } } }, "OpenServiceBrokerSchemas":{ "type":"object", "description":"Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.", "properties":{ "service_instance":{ "$ref":"#/components/schemas/OpenServiceBrokerServiceInstanceSchema" } } }, "OpenServiceBrokerServiceInstanceSchema":{ "type":"object", "description":"The schema definitions for creating and updating a Service Instance.", "properties":{ "create":{ "$ref":"#/components/schemas/OpenServiceBrokerSchemaParameters" } } }, "OpenServiceBrokerSchemaParameters":{ "type":"object", "description":"The schema definitions for providing parameters to a Service Broker operation.", "properties":{ "parameters":{ "description":"The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object.", "type":"object" } } }, "ServiceInstanceProvision":{ "type":"object", "description":"The response for successfully provisioning a service instance will vary." }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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." }, "table_name":{ "type":"string", "description":"Name associated with the table (or view) with the constraint definition." }, "column_name":{ "type":"string", "description":"Name of the column or attribute of the object type column specified in the constraint definition." }, "r_owner":{ "type":"string", "description":"Owner of the table referred to in a referential constraint." }, "r_table_name":{ "type":"string", "description":"Name of the table referred to in a referential constraint." }, "r_column_name":{ "type":"string", "description":"Name of the column referred to in a referential constraint." }, "position":{ "type":"integer", "description":"The position of the column_name and referenced r_column_name." }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "DatabaseParameters":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseParametersItem" } }, "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" } } } }, "DatabaseParametersItem":{ "type":"object", "description":"This documentation represents an initialization parameter that is currently in effect for the instance. A new session inherits parameter values from the instance-wide values. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$SYSTEM_PARAMETER view information was obtained." }, "num":{ "type":"integer", "description":"Parameter number." }, "name":{ "type":"string", "description":"Name of the parameter." }, "type":{ "type":"integer", "description":"Parameter type." }, "value":{ "type":"string", "description":"Instance-wide parameter value." }, "display_value":{ "type":"string", "description":"Parameter value in a user-friendly format. For example, if the VALUE column shows the value 262144 for a big integer parameter, then the DISPLAY_VALUE column will show the value 256K." }, "default_value":{ "type":"string", "description":"The default value for this parameter. This is the value of the parameter if a value is not explicitly specified for the parameter." }, "isdefault":{ "type":"string", "description":"Indicates whether the parameter is set to the default value (TRUE) or the parameter value was specified in the parameter file (FALSE). The database sets the value of the ISDEFAULT column to TRUE for parameters that are not specified in the init.ora or server parameter file (SPFILE)." }, "isses_modifiable":{ "type":"string", "description":"Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE)." }, "issys_modifiable":{ "type":"string", "description":"Indicates whether the parameter can be changed with ALTER SYSTEM and when the change takes effect." }, "ispdb_modifiable":{ "type":"string", "description":"Indicates whether the parameter can be modified inside a PDB (TRUE) or not (FALSE). In a non-CDB, the value of this column is NULL." }, "isinstance_modifiable":{ "type":"string", "description":"For parameters that can be changed with ALTER SYSTEM, indicates whether the value of the parameter can be different for every instance (TRUE) or whether the parameter must have the same value for all Real Application Clusters instances (FALSE). If the ISSYS_MODIFIABLE column is FALSE, then this column is always FALSE." }, "ismodified":{ "type":"string", "description":"Indicates how the parameter was modified. If an ALTER SYSTEM was performed, the value will be MODIFIED." }, "isadjusted":{ "type":"string", "description":"Indicates whether Oracle adjusted the input value to a more suitable value (for example, the parameter value should be prime, but the user input a non-prime number, so Oracle adjusted the value to the next prime number)." }, "isdeprecated":{ "type":"string", "description":"Indicates whether the parameter has been deprecated (TRUE) or not (FALSE)." }, "isbasic":{ "type":"string", "description":"Indicates whether the parameter is a basic parameter (TRUE) or not (FALSE)." }, "description":{ "type":"string", "description":"Description of the parameter." }, "update_comment":{ "type":"string", "description":"Comments associated with the most recent update." }, "hash":{ "type":"integer", "description":"Hash value for the parameter name." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabasePluggableDatabases":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabasePluggableDatabasesItem" } }, "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" } } } }, "DatabasePluggableDatabasesItem":{ "type":"object", "description":"This object describes a Pluggable Database associated with the current instance. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$PDBS view information was obtained." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "dbid":{ "type":"integer", "description":"PDB identifier calculated when the PDB is created and stored in all file headers associated with the PDB." }, "con_uid":{ "type":"integer", "description":"Unique identifier associated with the PDB." }, "guid":{ "type":"string", "description":"Globally unique identifier (GUID) of this PDB." }, "name":{ "type":"string", "description":"Name of the PDB." }, "open_mode":{ "type":"string", "description":"Open mode information." }, "restricted":{ "type":"string", "description":"Indicates whether only users possessing RESTRICTED SESSION privilege can connect to the PDB." }, "open_time":{ "type":"string", "description":"Date and time when the database was last opened." }, "create_scn":{ "type":"integer", "description":"System change number (SCN) for the creation of this PDB." }, "total_size":{ "type":"integer", "description":"Shows the disk space (in bytes) used by the PBB, including both data and temp files." }, "block_size":{ "type":"integer", "description":"The current block size for the PDB." }, "recovery_status":{ "type":"string", "description":"Shows whether recovery is enabled or disabled for the PDB." }, "snapshot_parent_con_id":{ "type":"string", "description":"This column shows the container ID of the master PDB that this PDB is a snapshot clone of. This column shows a nonzero value only if the PDB is a snapshot clone. For all other cases, it shows a value of 0." }, "application_root":{ "type":"string", "description":"Indicates whether the PDB is an application root." }, "application_pdb":{ "type":"string", "description":"Indicates whether the PDB is an application PDB." }, "application_seed":{ "type":"string", "description":"Indicates whether the PDB is an application seed (an application seed is also an application PDB)." }, "application_root_con_id":{ "type":"integer", "description":"If this PDB is an application PDB, the container ID of an application root to which this application PDB belongs. If this PDB is an application root clone, the container ID of an application root to which this application root clone belongs. Otherwise, NULL." }, "application_root_clone":{ "type":"string", "description":"Indicates whether this PDB is an application root clone (YES) or not (NO)." }, "proxy_pdb":{ "type":"string", "description":"Indicates whether this PDB is a proxy PDB (YES) or not (NO)." }, "local_undo":{ "type":"integer", "description":"Shows whether the PDB is in local undo. This column is not relevant for CDB$ROOT." }, "undo_scn":{ "type":"integer", "description":"System change number (SCN) at which the PDB was last converted from shared to local undo, or from local to shared undo. This column is not relevant for CDB$ROOT." }, "undo_timestamp":{ "type":"string", "description":"Date and time at which the PDB was last converted from shared to local undo, or from local to shared undo. This column is not relevant for CDB$ROOT." }, "creation_time":{ "type":"string", "description":"Date and time at which the PDB was created." }, "diagnostics_size":{ "type":"integer", "description":"Shows the current disk space usage (in bytes) of the diagnostic traces generated in the PDB, which is represented by the CON_ID column of the row." }, "pdb_count":{ "type":"integer", "description":"The number of user-created PDBs belonging to a given application root or CDB$ROOT. For all other containers, its value is 0." }, "audit_files_size":{ "type":"integer", "description":"Shows the current disk space usage (in bytes) by Unified Audit files (.bin format) in the current PDB." }, "max_size":{ "type":"integer", "description":"Shows the maximum amount of disk space (in bytes) that can be used by data and temp files in the PDB." }, "max_diagnostics_size":{ "type":"integer", "description":"Shows the maximum amount of disk space (in bytes) that can be used by diagnostic traces generated in the PDB." }, "max_audit_size":{ "type":"integer", "description":"Shows the maximum amount of disk space (in bytes) that can be used by Unified Audit files (.bin format) in the PDB." }, "last_changed_by":{ "type":"string", "description":"Indicates what type of user last changed the PDB." }, "tenant_id":{ "type":"string", "description":"Pluggable database tenant key." }, "guid_base64":{ "type":"string", "description":"The GUID of the PDB, encoded in base64." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabasePluggableDatabaseStatusItem":{ "type":"object", "description":"This object describes the status of a Pluggable Database.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$PDBS view information was obtained." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "name":{ "type":"string", "description":"Name of the PDB." }, "open_mode":{ "type":"string", "description":"Open mode information." }, "restricted":{ "type":"string", "description":"Indicates whether only users possessing RESTRICTED SESSION privilege can connect to the PDB." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceActionSessionHistories":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PerformanceActionSessionHistoriesItem" } }, "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" } } } }, "PerformanceActionSessionHistoriesItem":{ "type":"object", "description":"This object represents a sampled session activity in the database from GV$ACTIVE_SESSION_HISTORY. It contains snapshots of active database sessions taken once a second. A database session is considered active if it was on the CPU or was waiting for an event that didn't belong to the Idle wait class. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$ACTIVE_SESSION_HISTORY view information was obtained." }, "sample_id":{ "type":"integer", "description":"ID of the sample." }, "sample_time":{ "type":"string", "description":"Time at which the sample was taken." }, "is_awr_sample":{ "type":"string", "description":"Indicates whether this sample has been flushed or will be flushed to the Automatic Workload Repository (DBA_HIST_ACTIVE_SESS_HISTORY) (Y) or not (N)." }, "session_id":{ "type":"integer", "description":"Session identifier; maps to GV$SESSION.SID." }, "session_serial#":{ "type":"integer", "description":"Session serial number (used to uniquely identify a session's objects); maps to GV$SESSION.SERIAL#." }, "session_type":{ "type":"string", "description":"Session type." }, "user_id":{ "type":"integer", "description":"Oracle user identifier; maps to GV$SESSION.USER#." }, "sql_id":{ "type":"string", "description":"SQL identifier of the SQL statement that the session was executing at the time of sampling." }, "is_sqlid_current":{ "type":"string", "description":"Indicates whether the SQL identifier in the SQL_ID column is being executed (Y) or not (N)." }, "sql_child_number":{ "type":"integer", "description":"Child number of the SQL statement that the session was executing at the time of sampling." }, "sql_opcode":{ "type":"integer", "description":"Indicates what phase of operation the SQL statement was in." }, "force_matching_signature":{ "type":"integer", "description":"Signature used when the CURSOR_SHARING parameter is set to FORCE." }, "top_level_sql_id":{ "type":"string", "description":"SQL identifier of the top level SQL statement." }, "top_level_sql_opcode":{ "type":"integer", "description":"Indicates what phase of operation the top level SQL statement was in." }, "sql_opname":{ "type":"string", "description":"SQL command name." }, "sql_adaptive_plan_resolved":{ "type":"integer", "description":"Indicates whether the SQL plan of the sampled database session is a resolved adaptive plan or not." }, "sql_full_plan_hash_value":{ "type":"integer", "description":"Numerical representation of the complete SQL plan for the cursor being executed by this session." }, "sql_plan_hash_value":{ "type":"integer", "description":"Numeric representation of the SQL plan for the cursor. This information might not be available for all session samples." }, "sql_plan_line_id":{ "type":"integer", "description":"SQL plan line ID." }, "sql_plan_operation":{ "type":"string", "description":"Plan operation name." }, "sql_plan_options":{ "type":"string", "description":"Plan operation options." }, "sql_exec_id":{ "type":"integer", "description":"SQL execution identifier." }, "sql_exec_start":{ "type":"string", "description":"Time when the execution of the SQL started." }, "plsql_entry_object_id":{ "type":"integer", "description":"Object ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack. Maps to DBA_OBJECTS.OBJECT_ID." }, "plsql_entry_subprogram_id":{ "type":"integer", "description":"Subprogram ID of the top-most PL/SQL subprogram on the stack. Maps to DBA_OBJECTS.DATA_OBJECT_ID." }, "plsql_object_id":{ "type":"integer", "description":"Object ID of the currently executing PL/SQL subprogram." }, "plsql_subprogram_id":{ "type":"integer", "description":"Subprogram ID of the currently executing PL/SQL object." }, "qc_instance_id":{ "type":"integer", "description":"Query coordinator instance ID. This information is only available if the sampled session is a parallel query slave. For all other sessions, the value is 0." }, "qc_session_id":{ "type":"integer", "description":"Query coordinator session ID. This information is only available if the sampled session is a parallel query slave. For all other sessions, the value is 0." }, "qc_session_serial#":{ "type":"integer", "description":"Query coordinator session serial number. This information is only available if the sampled session is a parallel query slave. For all other sessions, the value is 0." }, "event":{ "type":"string", "description":"If SESSION_STATE = WAITING, then the event for which the session was waiting for at the time of sampling. If SESSION_STATE = ON CPU, then this column is NULL." }, "event_id":{ "type":"integer", "description":"Identifier of the resource or event for which the session is waiting or for which the session last waited. Interpretation is similar to that of the EVENT column." }, "event#":{ "type":"integer", "description":"Number of the resource or event for which the session is waiting or for which the session last waited. Interpretation is similar to that of the EVENT column." }, "seq#":{ "type":"integer", "description":"Sequence number that uniquely identifies the wait (incremented for each wait)." }, "p1text":{ "type":"string", "description":"Description of the first wait event parameter." }, "p1":{ "type":"integer", "description":"First wait event parameter (in decimal)." }, "p2text":{ "type":"string", "description":"Description of the second wait event parameter." }, "p2":{ "type":"integer", "description":"Second wait event parameter (in decimal)." }, "p3text":{ "type":"string", "description":"Description of the third wait event parameter." }, "p3":{ "type":"integer", "description":"Third wait event parameter (in decimal)." }, "wait_class":{ "type":"string", "description":"Wait class name of the event for which the session was waiting at the time of sampling." }, "wait_class_id":{ "type":"integer", "description":"Wait class identifier of the event for which the session was waiting at the time of sampling." }, "wait_time":{ "type":"integer", "description":"Total wait time for the event for which the session last waited if the session was on the CPU when sampled; 0 if the session was waiting at the time of sampling." }, "session_state":{ "type":"string", "description":"Session state." }, "time_waited":{ "type":"integer", "description":"If SESSION_STATE = WAITING, then the time that the session actually spent waiting for that event (in microseconds). This column is set for waits that were in progress at the time the sample was taken. If a wait event lasted for more than a second and was caught waiting in more than one session sample row, then the actual time spent waiting for that wait event will be populated in the last of those session sample rows. At any given time, this information will not be available for the latest session sample." }, "blocking_session_status":{ "type":"string", "description":"Status of the blocking session." }, "blocking_session":{ "type":"integer", "description":"Session identifier of the blocking session. Populated only if the blocker is on the same instance and the session was waiting for enqueues or a 'buffer busy' wait." }, "blocking_session_serial#":{ "type":"integer", "description":"Serial number of the blocking session." }, "blocking_inst_id":{ "type":"integer", "description":"Instance number of the blocker shown in BLOCKING_SESSION." }, "blocking_hangchain_info":{ "type":"string", "description":"Indicates whether the information about BLOCKING_SESSION comes from the hang chain (Y) or not (N)." }, "current_obj#":{ "type":"integer", "description":"Object ID of the object that the session is referencing. This information is only available if the session was waiting for application, cluster, concurrency, and user I/O wait events." }, "current_file#":{ "type":"integer", "description":"File number of the file containing the block that the session is referencing. This information is only available if the session was waiting for cluster, concurrency, and user I/O wait events." }, "current_block#":{ "type":"integer", "description":"ID of the block that the session is referencing. This information is only available if the session was waiting for cluster, concurrency, and user I/O wait events." }, "current_row#":{ "type":"integer", "description":"Row identifier that the session is referencing. This information is only available if the session was waiting for cluster, concurrency, and user I/O wait events." }, "top_level_call#":{ "type":"integer", "description":"Oracle top level call number." }, "top_level_call_name":{ "type":"string", "description":"Oracle top level call name." }, "consumer_group_id":{ "type":"integer", "description":"Consumer group ID." }, "xid":{ "type":"string", "description":"Transaction ID that the session was working on at the time of sampling." }, "remote_instance#":{ "type":"integer", "description":"Remote instance identifier that will serve the block that this session is waiting for. This information is only available if the session was waiting for cluster events." }, "time_model":{ "type":"integer", "description":"Time model information." }, "in_connection_mgmt":{ "type":"string", "description":"Indicates whether the session was doing connection management at the time of sampling (Y) or not (N)." }, "in_parse":{ "type":"string", "description":"Indicates whether the session was parsing at the time of sampling (Y) or not (N)." }, "in_hard_parse":{ "type":"string", "description":"Indicates whether the session was hard parsing at the time of sampling (Y) or not (N)." }, "in_sql_execution":{ "type":"string", "description":"Indicates whether the session was executing SQL statements at the time of sampling (Y) or not (N)." }, "in_plsql_execution":{ "type":"string", "description":"Indicates whether the session was executing PL/SQL at the time of sampling (Y) or not (N)." }, "in_plsql_rpc":{ "type":"string", "description":"Indicates whether the session was executing inbound PL/SQL RPC calls at the time of sampling (Y) or not (N)." }, "in_plsql_compilation":{ "type":"string", "description":"Indicates whether the session was compiling PL/SQL at the time of sampling (Y) or not (N)." }, "in_java_execution":{ "type":"string", "description":"Indicates whether the session was executing Java at the time of sampling (Y) or not (N)." }, "in_bind":{ "type":"string", "description":"Indicates whether the session was doing bind operations at the time of sampling (Y) or not (N)." }, "in_cursor_close":{ "type":"string", "description":"Indicates whether the session was closing a cursor at the time of sampling (Y) or not (N)." }, "in_sequence_load":{ "type":"string", "description":"Indicates whether the session is loading in sequence (in sequence load code) (Y) or not (N)." }, "in_inmemory_query":{ "type":"string", "description":"Indicates whether the session was querying the In-Memory Column Store (IM column store) at the time of sampling (Y) or not (N)." }, "in_inmemory_populate":{ "type":"string", "description":"Indicates whether the session was populating the IM column store at the time of sampling (Y) or not (N)." }, "in_inmemory_prepopulate":{ "type":"string", "description":"Indicates whether the session was prepopulating the IM column store at the time of sampling (Y) or not (N)." }, "in_inmemory_repopulate":{ "type":"string", "description":"Indicates whether the session was repopulating the IM column store at the time of sampling (Y) or not (N)." }, "in_inmemory_trepopulate":{ "type":"string", "description":"Indicates whether the session was trickle repopulating the IM column store at the time of sampling (Y) or not (N)." }, "in_tablespace_encryption":{ "type":"string", "description":"Indicates whether encryption or decryption of a tablespace occurred at the time of sampling (Y) or not (N)." }, "capture_overhead":{ "type":"string", "description":"Indicates whether the session is executing capture code (Y) or not (N)." }, "replay_overhead":{ "type":"string", "description":"Indicates whether the session is executing replay code (Y) or not (N)." }, "is_captured":{ "type":"string", "description":"Indicates whether the session is being captured (Y) or not (N)." }, "is_replayed":{ "type":"string", "description":"Indicates whether the session is being replayed (Y) or not (N)." }, "is_replay_sync_token_holder":{ "type":"string", "description":"Indicates whether the session is holding a synchronization token (Y) or not (N) during workload replay." }, "service_hash":{ "type":"integer", "description":"Hash that identifies the Service." }, "program":{ "type":"string", "description":"Name of the operating system program." }, "module":{ "type":"string", "description":"Name of the executing module when sampled, as set by the DBMS_APPLICATION_INFO.SET_MODULE procedure." }, "action":{ "type":"string", "description":"Name of the executing module when sampled, as set by the DBMS_APPLICATION_INFO.SET_ACTION procedure." }, "client_id":{ "type":"string", "description":"Client identifier of the session." }, "machine":{ "type":"string", "description":"Client's operating system machine name." }, "port":{ "type":"integer", "description":"Client port number." }, "ecid":{ "type":"string", "description":"Execution context identifier (sent by Application Server)." }, "dbreplay_file_id":{ "type":"integer", "description":"If the session is being captured or replayed, then DBREPLAY_FILE_ID is the file ID for the workload capture or workload replay; otherwise it is NULL." }, "dbreplay_call_counter":{ "type":"integer", "description":"If the session is being captured or replayed, then DBREPLAY_CALL_COUNTER is the call counter of the user call that is being captured or replayed; otherwise it is NULL." }, "tm_delta_time":{ "type":"integer", "description":"Time interval (in microseconds) over which TM_DELTA_CPU_TIME and TM_DELTA_DB_TIME are accumulated." }, "tm_delta_cpu_time":{ "type":"integer", "description":"Amount of time this session spent on CPU over the last TM_DELTA_TIME microseconds." }, "tm_delta_db_time":{ "type":"integer", "description":"Amount of time spent by this session in database calls over the last TM_DELTA_TIME microseconds." }, "delta_time":{ "type":"integer", "description":"Time interval (in microseconds) since the last time this session was sampled or created, over which the next five statistics are accumulated." }, "delta_read_io_requests":{ "type":"integer", "description":"Number of read I/O requests made by this session over the last DELTA_TIME microseconds." }, "delta_write_io_requests":{ "type":"integer", "description":"Number of write I/O requests made by this session over the last DELTA_TIME microseconds." }, "delta_read_io_bytes":{ "type":"integer", "description":"Number of I/O bytes read by this session over the last DELTA_TIME microseconds." }, "delta_write_io_bytes":{ "type":"integer", "description":"Number of I/O bytes written by this session over the last DELTA_TIME microseconds." }, "delta_interconnect_io_bytes":{ "type":"integer", "description":"Number of I/O bytes sent over the I/O interconnect over the last DELTA_TIME microseconds." }, "delta_read_mem_bytes":{ "type":"integer", "description":"Number of read bytes through the buffer cache." }, "pga_allocated":{ "type":"integer", "description":"Amount of PGA memory (in bytes) consumed by this session at the time this sample was taken." }, "temp_space_allocated":{ "type":"integer", "description":"Amount of TEMP memory (in bytes) consumed by this session at the time this sample was taken." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "dbop_name":{ "type":"string", "description":"Database operation name. If the type is SQL, the DBOP_NAME will be NULL." }, "dbop_exec_id":{ "type":"integer", "description":"Database operation execution identifier for the current execution. If the type is SQL, the DBOP_EXEC_ID will be NULL." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceActionSessionHistoryWaits":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PerformanceActionSessionHistoryWaitsItem" } }, "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" } } } }, "PerformanceActionSessionHistoryWaitsItem":{ "type":"object", "description":"Describes a wait event for a session. Data corresponds to a record from GV$SESSION_WAIT_HISTORY. The list of attributes may vary depending on database version.", "properties":{ "username":{ "type":"string", "description":"Name of the user that is associated with the session." }, "inst_id":{ "type":"integer", "description":"Instance number from which the associated V$ view information was obtained." }, "sid":{ "type":"integer", "description":"Session identifier." }, "seq#":{ "type":"integer", "description":"Sequence of wait events; 1 is the most recent." }, "event#":{ "type":"integer", "description":"Event number." }, "event":{ "type":"string", "description":"Resource or event for which the session is waiting." }, "p1text":{ "type":"string", "description":"Description of the first wait event parameter." }, "p1":{ "type":"integer", "description":"First wait event parameter (in decimal)." }, "p2text":{ "type":"string", "description":"Description of the second wait event parameter." }, "p2":{ "type":"integer", "description":"Second wait event parameter (in decimal)." }, "p3text":{ "type":"string", "description":"Description of the third wait event parameter." }, "p3":{ "type":"integer", "description":"Third wait event parameter (in decimal)." }, "wait_time":{ "type":"integer", "description":"Amount of time waited (in hundredths of a second)." }, "wait_time_micro":{ "type":"integer", "description":"Amount of time waited (in microseconds)." }, "time_since_last_wait_micro":{ "type":"integer", "description":"Time elapsed (in microseconds) since the end of the previous wait in the wait history." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceActionSessionHistoryWaitsActiveSQLItem":{ "type":"object", "description":"Describes statistics on an SQL statement that is in memory, parsed and ready for execution but waiting on an event. The list of attributes may vary depending on database version.", "properties":{ "username":{ "type":"string", "description":"Name of the user that is associated with the session that is waiting." }, "inst_id":{ "type":"integer", "description":"Instance number from which the associated V$ view information was obtained." }, "sql_text":{ "type":"string", "description":"First thousand characters of the SQL text for the current cursor." }, "sql_fulltext":{ "type":"string", "description":"All characters of the SQL text for the current cursor." }, "sql_id":{ "type":"string", "description":"SQL identifier of the parent cursor in the library cache." }, "sharable_mem":{ "type":"integer", "description":"Amount of shared memory used by a cursor. If multiple child cursors exist, then the sum of all shared memory used by all child cursors." }, "persistent_mem":{ "type":"integer", "description":"Fixed amount of memory used for the lifetime of an open cursor. If multiple child cursors exist, then the fixed sum of memory used for the lifetime of all the child cursors." }, "runtime_mem":{ "type":"integer", "description":"Fixed amount of memory required during execution of a cursor. If multiple child cursors exist, then the fixed sum of all memory required during execution of all the child cursors." }, "sorts":{ "type":"integer", "description":"Sum of the number of sorts that were done for all the child cursors." }, "version_count":{ "type":"integer", "description":"Number of child cursors that are present in the cache under this parent." }, "loaded_versions":{ "type":"integer", "description":"Number of child cursors that are present in the cache and have their context heap loaded." }, "open_versions":{ "type":"integer", "description":"Number of child cursors that are currently open under this current parent." }, "users_opening":{ "type":"integer", "description":"Number of users that have any of the child cursors open." }, "fetches":{ "type":"integer", "description":"Number of fetches associated with the SQL statement." }, "executions":{ "type":"integer", "description":"Total number of executions, totalled over all the child cursors." }, "px_servers_executions":{ "type":"integer", "description":"Total number of executions performed by parallel execution servers (0 when the statement has never been executed in parallel)." }, "end_of_fetch_count":{ "type":"integer", "description":"Number of times this cursor was fully executed since the cursor was brought into the library cache. The value of this statistic is not incremented when the cursor is partially executed, either because it failed during the execution or because only the first few rows produced by this cursor are fetched before the cursor is closed or re-executed. By definition, the value of the END_OF_FETCH_COUNT column should be less or equal to the value of the EXECUTIONS column." }, "users_executing":{ "type":"integer", "description":"Total number of users executing the statement over all child cursors." }, "loads":{ "type":"integer", "description":"Number of times the object was loaded or reloaded." }, "first_load_time":{ "type":"string", "description":"Timestamp of the parent creation time." }, "invalidations":{ "type":"integer", "description":"Total number of invalidations over all the child cursors." }, "parse_calls":{ "type":"integer", "description":"Sum of all parse calls to all the child cursors under this parent." }, "disk_reads":{ "type":"integer", "description":"Sum of the number of disk reads over all child cursors." }, "direct_writes":{ "type":"integer", "description":"Sum of the number of direct writes over all child cursors." }, "direct_reads":{ "type":"integer", "description":"Sum of the number of direct reads over all child cursors." }, "buffer_gets":{ "type":"integer", "description":"Sum of buffer gets over all child cursors." }, "application_wait_time":{ "type":"integer", "description":"Application wait time (in microseconds)." }, "concurrency_wait_time":{ "type":"integer", "description":"Concurrency wait time (in microseconds)." }, "cluster_wait_time":{ "type":"integer", "description":"Cluster wait time (in microseconds)." }, "user_io_wait_time":{ "type":"integer", "description":"User I/O Wait Time (in microseconds)." }, "plsql_exec_time":{ "type":"integer", "description":"PL/SQL execution time (in microseconds)." }, "java_exec_time":{ "type":"integer", "description":"Java execution time (in microseconds)." }, "rows_processed":{ "type":"integer", "description":"Total number of rows processed on behalf of this SQL statement." }, "command_type":{ "type":"integer", "description":"Oracle command type definition." }, "optimizer_mode":{ "type":"string", "description":"Mode under which the SQL statement was executed." }, "optimizer_cost":{ "type":"integer", "description":"Cost of this query given by the optimizer." }, "optimizer_env":{ "type":"string", "description":"Optimizer environment." }, "optimizer_env_hash_value":{ "type":"integer", "description":"Hash value for the optimizer environment." }, "parsing_user_id":{ "type":"integer", "description":"User ID of the user that has parsed the very first cursor under this parent." }, "parsing_schema_id":{ "type":"integer", "description":"Schema ID that was used to parse this child cursor." }, "parsing_schema_name":{ "type":"string", "description":"Schema name that was used to parse this child cursor." }, "kept_versions":{ "type":"integer", "description":"Number of child cursors that have been marked to be kept using the DBMS_SHARED_POOL package." }, "address":{ "type":"string", "description":"Address of the handle to the parent for this cursor." }, "hash_value":{ "type":"integer", "description":"Hash value of the parent statement in the library cache." }, "old_hash_value":{ "type":"integer", "description":"Old SQL hash value." }, "plan_hash_value":{ "type":"integer", "description":"Numeric representation of the current SQL plan for this cursor. Comparing one PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line)." }, "full_plan_hash_value":{ "type":"integer", "description":"Numeric representation of the complete SQL plan for this cursor. Comparing one FULL_PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line). Note that the FULL_PLAN_HASH_VALUE cannot be compared across databases releases. It is not backward compatible." }, "module":{ "type":"string", "description":"Contains the name of the module that was executing when the SQL statement was first parsed as set by calling DBMS_APPLICATION_INFO.SET_MODULE" }, "module_hash":{ "type":"integer", "description":"Hash value of the module that is named in the MODULE column." }, "action":{ "type":"string", "description":"Contains the name of the action that was executing when the SQL statement was first parsed as set by calling DBMS_APPLICATION_INFO.SET_ACTION." }, "action_hash":{ "type":"integer", "description":"Hash value of the action that is named in the ACTION column." }, "serializable_aborts":{ "type":"integer", "description":"Number of times the transaction failed to serialize, producing ORA-08177 errors, totalled over all the child cursors." }, "outline_category":{ "type":"string", "description":"If an outline was applied during construction of the cursor, then this column displays the category of that outline. Otherwise the column is left blank." }, "cpu_time":{ "type":"integer", "description":"CPU time (in microseconds) used by this cursor for parsing, executing, and fetching." }, "elapsed_time":{ "type":"integer", "description":"Elapsed time (in microseconds) used by this cursor for parsing, executing, and fetching. If the cursor uses parallel execution, then ELAPSED_TIME is the cumulative time for the query coordinator, plus all parallel query slave processes." }, "outline_sid":{ "type":"string", "description":"Outline session identifier." }, "last_active_child_address":{ "type":"string", "description":"Address (identifier) of the child cursor that was the last to be active in the group (that is, the child cursor on behalf of which statistics in GV$SQL were updated)." }, "remote":{ "type":"string", "description":"Indicates whether the cursor is remote mapped (Y) or not (N)." }, "object_status":{ "type":"string", "description":"Status of the cursor." }, "literal_hash_value":{ "type":"integer", "description":"Hash value of the literals which are replaced with system-generated bind variables and are to be matched, when CURSOR_SHARING is used. This is not the hash value for the SQL statement. If CURSOR_SHARING is not used, then the value is 0." }, "last_load_time":{ "type":"string", "description":"Time at which the query plan was loaded into the library cache." }, "is_obsolete":{ "type":"string", "description":"Indicates whether the cursor has become obsolete (Y) or not (N). This can happen if the number of child cursors is too large." }, "is_bind_sensitive":{ "type":"string", "description":"Indicates whether the cursor is bind sensitive (Y) or not (N). A query is considered bind-sensitive if the optimizer peeked at one of its bind variable values when computing predicate selectivities and where a change in a bind variable value may cause the optimizer to generate a different plan." }, "is_bind_aware":{ "type":"string", "description":"Indicates whether the cursor is bind aware (Y) or not (N). A query is considered bind-aware if it has been marked to use extended cursor sharing. The query would already have been marked as bind-sensitive." }, "child_latch":{ "type":"integer", "description":"Child latch number that is protecting the cursor. This column is obsolete and maintained for backward compatibility." }, "sql_profile":{ "type":"string", "description":"SQL profile used for this statement, if any." }, "sql_patch":{ "type":"string", "description":"SQL patch used for this statement, if any." }, "sql_plan_baseline":{ "type":"string", "description":"SQL plan baseline used for this statement, if any." }, "program_id":{ "type":"integer", "description":"Program identifier." }, "program_line#":{ "type":"integer", "description":"Program line number." }, "exact_matching_signature":{ "type":"integer", "description":"Signature used when the CURSOR_SHARING parameter is set to EXACT." }, "force_matching_signature":{ "type":"integer", "description":"Signature used when the CURSOR_SHARING parameter is set to FORCE." }, "last_active_time":{ "type":"string", "description":"Time at which the query plan was last active." }, "bind_data":{ "type":"string", "description":"Bind data." }, "typecheck_mem":{ "type":"integer", "description":"Typecheck memory." }, "io_cell_offload_eligible_bytes":{ "type":"integer", "description":"Number of I/O bytes which can be filtered by the Exadata storage system." }, "io_interconnect_bytes":{ "type":"integer", "description":"Number of I/O bytes exchanged between Oracle Database and the storage system." }, "physical_read_requests":{ "type":"integer", "description":"Number of physical read I/O requests issued by the monitored SQL." }, "physical_read_bytes":{ "type":"integer", "description":"Number of bytes read from disks by the monitored SQL." }, "physical_write_requests":{ "type":"integer", "description":"Number of physical write I/O requests issued by the monitored SQL." }, "physical_write_bytes":{ "type":"integer", "description":"Number of bytes written to disks by the monitored SQL." }, "optimized_phy_read_requests":{ "type":"integer", "description":"Number of physical read I/O requests from Database Smart Flash Cache issued by the monitored SQL." }, "locked_total":{ "type":"integer", "description":"Total number of times the child cursor has been locked." }, "pinned_total":{ "type":"integer", "description":"Total number of times the child cursor has been pinned." }, "io_cell_uncompressed_bytes":{ "type":"integer", "description":"Number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells." }, "io_cell_offload_returned_bytes":{ "type":"integer", "description":"Number of bytes that are returned by Exadata cell through the regular I/O path." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "is_reoptimizable":{ "type":"string", "description":"This columns shows whether the next execution matching this child cursor will trigger a reoptimization." }, "is_resolved_adaptive_plan":{ "type":"string", "description":"This column shows whether all of the adaptive parts of a plan have been resolved to the final plan." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceSQLStatements":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PerformanceSQLStatementsItem" } }, "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" } } } }, "PerformanceSQLStatementsItem":{ "type":"object", "description":"This object describes an SQL statement. The list of attributes may vary depending on database version.", "properties":{ "elapsed_time":{ "type":"integer", "description":"Elapsed time (in microseconds); updated as the statement executes." }, "sql_exec_id":{ "type":"integer", "description":"SQL execution identifier; NULL if SQL_ID is NULL or if the execution of that SQL has not yet started." }, "status":{ "type":"string", "description":"SQL execution status." }, "duration":{ "type":"integer", "description":"Indicates the length of time the SQL statement has been running for. Calculated based on SQL_EXEC_START and LAST_REFRESH_TIME from GV$SQL_MONITOR." }, "sql_id":{ "type":"string", "description":"SQL identifier of the statement." }, "session_id":{ "type":"integer", "description":"Session identifier executing (or having executed) the SQL statement being monitored." }, "session_serial":{ "type":"integer", "description":"Session serial number executing the statement being monitored." }, "instance_dop":{ "type":"string", "description":"Distinct number of instances that the SQL statement executed compared with the logical parallel execution server process number executing (or having executed) the statement being monitored." }, "cpu_time":{ "type":"number", "description":"Sum of total CPU time; updated as the statement executes." }, "io_time":{ "type":"number", "description":"Sum of total User I/O Wait Time; updated as the statement executes" }, "start_time":{ "type":"string", "description":"Time when the execution started" }, "sql_exec_start":{ "type":"string", "description":"Time when the execution started. Part of the execution key for identifying a single record in GV$SQL_MONITOR." }, "end_time":{ "type":"string", "description":"When the status is 'DONE (ALL ROWS)' this is the LAST_REFRESH_TIME value from GV$SQL_MONITOR." }, "sql_fulltext":{ "type":"string", "description":"All characters of the SQL text for the current cursor." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceSQLStatementMonitors":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/PerformanceSQLStatementMonitorsItem" } }, "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" } } } }, "PerformanceSQLStatementMonitorsItem":{ "type":"object", "description":"This object provides statistics for a single execution of an SQL statement. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$SQL_MONITOR view information was obtained." }, "key":{ "type":"integer", "description":"Artificial join key to efficiently join GV$SQL_MONITOR with its corresponding plan level monitoring statistics stored in GV$SQL_PLAN_MONITOR." }, "report_id":{ "type":"integer", "description":"Unique ID of the XML report stored in Automatic Workload Repository (AWR) for this monitored entity." }, "status":{ "type":"string", "description":"SQL execution status." }, "user#":{ "type":"integer", "description":"User ID of the database user who issued the SQL being monitored." }, "username":{ "type":"string", "description":"User name of the database user who issued the SQL being monitored." }, "module":{ "type":"string", "description":"Name of the executing module when sampled, as set by the DBMS_APPLICATION_INFO.SET_MODULE procedure." }, "action":{ "type":"string", "description":"Name of the executing action when sampled, as set by the DBMS_APPLICATION_INFO.SET_ACTION procedure." }, "service_name":{ "type":"string", "description":"Service name of the user session." }, "client_identifier":{ "type":"string", "description":"Client identifier from the user session." }, "client_info":{ "type":"string", "description":"Client information for the user session." }, "program":{ "type":"string", "description":"Name of the operating system program that issued the monitored SQL." }, "plsql_entry_object_id":{ "type":"integer", "description":"Object ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack." }, "plsql_entry_subprogram_id":{ "type":"integer", "description":"Subprogram ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack." }, "plsql_object_id":{ "type":"integer", "description":"Object ID of the currently executing PL/SQL subprogram; NULL if executing SQL." }, "plsql_subprogram_id":{ "type":"integer", "description":"Subprogram ID of the currently executing PL/SQL object; NULL if executing SQL." }, "first_refresh_time":{ "type":"string", "description":"Time when monitoring of the SQL statement started, generally a few seconds after execution start time." }, "last_refresh_time":{ "type":"string", "description":"Time when statistics in V$SQL_MONITOR were last updated for the SQL statement. Statistics are generally refreshed every second when the statement executes." }, "refresh_count":{ "type":"integer", "description":"Number of times V$SQL_MONITOR statistics have been refreshed (generally once every second when the SQL statement executes)." }, "dbop_exec_id":{ "type":"integer", "description":"Database operation execution identifier for the current execution. If the type is SQL, the DBOP_EXEC_ID will be NULL." }, "dbop_name":{ "type":"string", "description":"Database operation name. If the type is SQL, the DBOP_NAME will be NULL." }, "sid":{ "type":"integer", "description":"Session identifier executing (or having executed) the SQL statement being monitored." }, "process_name":{ "type":"string", "description":"Process name identifier executing (or having executed)the statement; ora if the process is foreground, else the background process name (for example, p001 for PX server p001)." }, "sql_id":{ "type":"string", "description":"SQL identifier of the statement being monitored." }, "sql_text":{ "type":"string", "description":"Up to the first 2000 characters of the text of the SQL being monitored." }, "is_full_sqltext":{ "type":"string", "description":"Indicates whether the SQL_TEXT column has the entire SQL text (Y) or not (N)." }, "sql_exec_start":{ "type":"string", "description":"Time when the execution started." }, "sql_exec_id":{ "type":"integer", "description":"Execution identifier. Together, the three columns SQL_ID, SQL_EXEC_START, and SQL_EXEC_ID represent the execution key. The execution key is used to uniquely identify one execution of the SQL statement." }, "sql_plan_hash_value":{ "type":"integer", "description":"SQL plan hash value." }, "sql_full_plan_hash_value":{ "type":"integer", "description":"Numeric representation of the complete SQL plan for this cursor. Comparing one SQL_FULL_PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line). Note that the SQL_FULL_PLAN_HASH_VALUE cannot be compared across databases releases. It is not backward compatible." }, "exact_matching_signature":{ "type":"integer", "description":"Signature calculated on the normalized SQL text. The normalization includes the removal of white space and the uppercasing of all non-literal strings." }, "force_matching_signature":{ "type":"integer", "description":"Same as EXACT_MATCHING_SIGNATURE but literals in the SQL text are replaced by binds." }, "sql_child_address":{ "type":"string", "description":"Address of the child cursor (can be used with SQL_ID to join with GV$SQL)." }, "session_serial#":{ "type":"integer", "description":"Session serial number executing the statement being monitored." }, "px_is_cross_instance":{ "type":"string", "description":"Indicates whether the SQL statement ran parallel across multiple instances (Y) or not (N)." }, "px_maxdop":{ "type":"integer", "description":"Maximum degree of parallelism for any plan operation executed on behalf of the monitored SQL." }, "px_maxdop_instances":{ "type":"integer", "description":"Number of database instances touched at the maximum degree of parallelism." }, "px_servers_requested":{ "type":"integer", "description":"Total number of parallel execution servers requested to execute the monitored SQL." }, "px_servers_allocated":{ "type":"integer", "description":"Actual number of parallel execution servers allocated to execute the query" }, "px_server#":{ "type":"integer", "description":"Logical parallel execution server process number executing (or having executed) the statement being monitored; NULL if this monitoring entry is not associated with an execution server. This is a logical number within the parallel server set (see SERVER# in V$PX_SESSION)." }, "px_server_group":{ "type":"integer", "description":"Logical parallel execution server group number to which PX_SERVER# belongs (see SERVER_GROUP in V$PX_SESSION); NULL if this monitoring entry is not associated with a parallel execution server. This value is generally 1 unless the SQL statement has one or more parallel sub-queries." }, "px_server_set":{ "type":"integer", "description":"Number (1 or 2) of the logical set of parallel execution servers to which PX_SERVER# belongs (see SERVER_SET in V$PX_SESSION); NULL if this monitoring entry is not associated with a parallel execution server." }, "px_qcinst_id":{ "type":"integer", "description":"Instance identifier where the parallel execution coordinator runs; NULL if PX_SERVER# is NULL." }, "px_qcsid":{ "type":"integer", "description":"Session identifier for the parallel execution coordinator; NULL if PX_SERVER# is NULL." }, "error_number":{ "type":"string", "description":"Error number encountered in case a SQL fails to execute successfully (for example, 932 in case of ORA-00932)." }, "error_facility":{ "type":"string", "description":"Error facility in case a SQL fails to execute successfully (for example, ORA in case of ORA-00932)." }, "error_message":{ "type":"string", "description":"Detailed error message displayed corresponding to the error number and error facility when a SQL fails to execute successfully." }, "binds_xml":{ "type":"string", "description":"Information about bind variables used with the SQL, such as name, position, value, data type, and so on (stored in XML format)." }, "other_xml":{ "type":"string", "description":"Additional information about SQL execution stored in XML format." }, "elapsed_time":{ "type":"integer", "description":"Elapsed time (in microseconds); updated as the statement executes." }, "queuing_time":{ "type":"integer", "description":"Duration of time (in microseconds) spent by SQL in the statement queue." }, "cpu_time":{ "type":"integer", "description":"CPU time (in microseconds); updated as the statement executes." }, "fetches":{ "type":"integer", "description":"Number of fetches associated with the SQL statement; updated as the statement executes." }, "buffer_gets":{ "type":"integer", "description":"Number of buffer get operations; updated as the statement executes." }, "disk_reads":{ "type":"integer", "description":"Number of disk reads; updated as the statement executes." }, "direct_writes":{ "type":"integer", "description":"Number of direct writes; updated as the statement executes." }, "io_interconnect_bytes":{ "type":"integer", "description":"Number of I/O bytes exchanged between Oracle Database and the storage system." }, "physical_read_requests":{ "type":"integer", "description":"Number of physical read I/O requests issued by the monitored SQL." }, "physical_read_bytes":{ "type":"integer", "description":"Number of bytes read from disks by the monitored SQL." }, "physical_write_requests":{ "type":"integer", "description":"Number of physical write I/O requests issued by the monitored SQL." }, "physical_write_bytes":{ "type":"integer", "description":"Number of bytes written to disks by the monitored SQL." }, "application_wait_time":{ "type":"integer", "description":"Application wait time (in microseconds); updated as the statement executes." }, "concurrency_wait_time":{ "type":"integer", "description":"Concurrency wait time (in microseconds); updated as the statement executes." }, "cluster_wait_time":{ "type":"integer", "description":"Cluster wait time (in microseconds); updated as the statement executes." }, "user_io_wait_time":{ "type":"integer", "description":"User I/O Wait Time (in microseconds); updated as the statement executes." }, "plsql_exec_time":{ "type":"integer", "description":"PL/SQL execution time (in microseconds); updated as the statement executes." }, "java_exec_time":{ "type":"integer", "description":"Java execution time (in microseconds); updated as the statement executes." }, "rm_last_action":{ "type":"string", "description":"The most recent action that was taken on this SQL operation by Resource Manager." }, "rm_last_action_reason":{ "type":"string", "description":"The reason for the most recent action that was taken on this SQL operation by Resource Manager." }, "rm_last_action_time":{ "type":"string", "description":"The time of the most recent action that was taken on this SQL operation by Resource Manager." }, "rm_consumer_group":{ "type":"string", "description":"The current consumer group for this SQL operation." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "con_name":{ "type":"string", "description":"Container name of the object. The value of this column is NULL in non-CDBs." }, "ecid":{ "type":"string", "description":"Execution context identifier (sent by Application Server)." }, "is_adaptive_plan":{ "type":"string", "description":"Indicates whether the statistics are from an adaptive plan (Y) or not (N)." }, "is_final_plan":{ "type":"string", "description":"Indicates whether the statistics are from the final plan (Y) or not (N)." }, "in_dbop_name":{ "type":"string", "description":"If the SQL that is monitored was executed by a session that was also monitored by a database operation (DBOP), then this column specifies the name of that DBOP." }, "in_dbop_exec_id":{ "type":"integer", "description":"If the SQL that is monitored was executed by a session that was also monitored by a database operation (DBOP), then this column specifies the execution ID of that DBO." }, "io_cell_uncompressed_bytes":{ "type":"integer", "description":"Number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells." }, "io_cell_offload_eligible_bytes":{ "type":"integer", "description":"Number of I/O bytes which can be filtered by the Exadata storage system." }, "io_cell_offload_returned_bytes":{ "type":"integer", "description":"Number of filtered bytes returned by Exadata cells (that is, the number of bytes returned after processing has been offloaded on the Exadata cells)." }, "current_user":{ "type":"integer", "description":"Unique number identifying the current user." }, "current_username":{ "type":"integer", "description":"Username for the current user." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceSQLStatementMonitorParallelism":{ "type":"object", "description":"Describes the parallel execution of an SQL Statement. Using GV$SQL_MONITOR view, the information includes the Parallel Coordinator and the instance(s) where it was executed.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "node_id":{ "type":"integer", "description":"Used as a distinguishing value in the Parallelism metadata. The value may be an Instance Number to represent the execution on an instance, 10000 when a Parallel Coordinator or some other value derived from the SERVER_GROUP data." }, "parent_node_id":{ "type":"number", "description":"The value may be an Instance Number to represent the execution of Parallel Coordinator or Server Group on an instance. May be NULL." }, "name":{ "type":"string", "description":"Name of either the Instance, Parallel Coordinator, Parallel Group, Parallel Set or Parallel Server that corresponds to the GV$SQL_MONITOR record." }, "inst_id":{ "type":"number", "description":"The Instance Number from the GV$SQL_MONITOR record." }, "server_set":{ "type":"integer", "description":"Number (1 or 2) of the logical set of parallel execution servers to which PX_SERVER# belongs (see SERVER_SET in V$PX_SESSION); NULL if this monitoring entry is not associated with a parallel execution server." }, "process_name":{ "type":"string", "description":"Process name identifier executing (or having executed)the statement; ora if the process is foreground, else the background process name (for example, p001 for PX server p001)." }, "db_time":{ "type":"number", "description":"The greater of either ELAPSED_TIME or a total of the following CPU_TIME + QUEUING_TIME + APPLICATION_WAIT_TIME + CONCURRENCY_WAIT_TIME + CLUSTER_WAIT_TIME + USER_IO_WAIT_TIME + PLSQL_EXEC_TIME + JAVA_EXEC_TIME." }, "db_time_prop":{ "type":"number", "description":"The proportional time spent for this GV$SQL_MONITOR record compared to other execution records for the same SQL Statement." }, "db_time_max":{ "type":"number", "description":"The maximum time spent for an execution of the SQL Statement." }, "cpu_time":{ "type":"integer", "description":"CPU time (in microseconds) used by this cursor for parsing, executing, and fetching." }, "queuing_time":{ "type":"integer", "description":"Duration of time (in microseconds) spent by SQL in the statement queue." }, "application_wait_time":{ "type":"number", "description":"Application wait time (in microseconds); updated as the statement executes." }, "concurrency_wait_time":{ "type":"number", "description":"Concurrency wait time (in microseconds); updated as the statement executes." }, "cluster_wait_time":{ "type":"number", "description":"Cluster wait time (in microseconds); updated as the statement executes." }, "user_io_wait_time":{ "type":"number", "description":"User I/O Wait Time (in microseconds); updated as the statement executes." }, "plsql_exec_time":{ "type":"number", "description":"PL/SQL execution time (in microseconds); updated as the statement executes." }, "java_exec_time":{ "type":"number", "description":"Java execution time (in microseconds); updated as the statement executes." }, "other_wait_time":{ "type":"number", "description":"The greater of either zero or a total of the following CPU_TIME - QUEUING_TIME - APPLICATION_WAIT_TIME - CONCURRENCY_WAIT_TIME - CLUSTER_WAIT_TIME - USER_IO_WAIT_TIME - PLSQL_EXEC_TIME - JAVA_EXEC_TIME." }, "io_requests":{ "type":"number", "description":"Total of number of physical read and write I/O requests issued by the monitored SQL." }, "io_requests_prop":{ "type":"number", "description":"The proportional number of physical read and write I/O requests issued by the monitored SQL compared to other execution records for the same SQL Statement." }, "io_requests_max":{ "type":"number", "description":"The maximum number of physical read and write I/O requests issued by a monitored SQL execution for the same SQL Statement." }, "io_bytes":{ "type":"number", "description":"Total of number of bytes read from disks and bytes written to disks by the monitored SQL." }, "io_bytes_prop":{ "type":"number", "description":"The proportional number of bytes read from disks and bytes written to disks by the monitored SQL compared to other execution records for the same SQL Statement." }, "io_bytes_max":{ "type":"number", "description":"The maximum number of bytes read from disks and bytes written to disks by a monitored SQL execution for the same SQL Statement." }, "buffer_gets":{ "type":"number", "description":"Number of buffer get operations; updated as the statement executes." }, "buffer_gets_prop":{ "type":"number", "description":"The proportional number of buffer get operations compared to other execution records for the same SQL Statement." }, "buffer_gets_max":{ "type":"number", "description":"The maximum number of buffer get operations by a monitored SQL execution for the same SQL Statement." }, "dop_downgrade":{ "type":"string", "description":"Percentage of actual number of parallel execution servers allocated to execute the query compared to the total number of parallel execution servers requested to execute the query." }, "servers_requested":{ "type":"number", "description":"Total number of parallel execution servers requested to execute the monitored SQL." }, "servers_allocated":{ "type":"number", "description":"Actual number of parallel execution servers allocated to execute the query." } } } }, "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" } } } }, "PerformanceSQLStatementPlanItem":{ "type":"object", "description":"Describes the explain plan for an SQL Statement.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"A number assigned to each step in the execution plan." }, "depth":{ "type":"integer", "description":"Depth (or level) of the operation in the tree. The root operation (statement) is level 0." }, "operation":{ "type":"string", "description":"Name of the internal operation performed in this step (for example, TABLE ACCESS)." }, "rows":{ "type":"string", "description":"The number of rows the optimizer is expecting the operation to produce each time it is called. Also known as E-Rows." }, "rowsourcetimes":{ "type":"integer", "description":"The number of times the SQL Statement is referenced in GV$ACTIVE_SESSION_HISTORY." } } } }, "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" } } } }, "PerformanceSQLStatementHistoryItem":{ "type":"object", "description":"This object represents historical information about SQL statistics. The structure is based on DBA_HIST_SQLSTAT. The list of attributes may vary depending on database version.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "begin_interval_time_utc":{ "type":"string", "description":"Time at the beginning of the snapshot interval in UTC timezone." }, "startup_time":{ "type":"string", "description":"Startup time of the instance." }, "begin_interval_time":{ "type":"string", "description":"Time at the beginning of the snapshot interval." }, "end_interval_time":{ "type":"string", "description":"Time at the end of the snapshot interval; the actual time the snapshot was taken." }, "flush_elapsed":{ "type":"string", "description":"Amount of time to perform the snapshot." }, "error_count":{ "type":"integer", "description":"Number of errors occurring in the tables for the particular snapshot." }, "snap_flag":{ "type":"integer", "description":"Condition under which the snapshot was inserted." }, "snap_timezone":{ "type":"string", "description":"Snapshot time zone expressed as offset from UTC (Coordinated Universal Time) time zone." }, "sql_id":{ "type":"string", "description":"SQL identifier of the parent cursor in the library cache." }, "snap_id":{ "type":"integer", "description":"Unique snapshot ID." }, "dbid":{ "type":"integer", "description":"Database ID for the snapshot." }, "instance_number":{ "type":"integer", "description":"Instance number for the snapshot." }, "plan_hash_value":{ "type":"integer", "description":"Numerical representation of the SQL plan for the cursor. Comparing one PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line)." }, "optimizer_cost":{ "type":"integer", "description":"Cost of the query given by the optimizer." }, "optimizer_mode":{ "type":"string", "description":"Mode under which the SQL statement is executed." }, "optimizer_env_hash_value":{ "type":"integer", "description":"Hash Value for the optimizer environment." }, "sharable_mem":{ "type":"integer", "description":"Amount of shared memory used by the child cursor (in bytes)." }, "loaded_versions":{ "type":"integer", "description":"Indicates whether the context heap is loaded (1) or not (0)." }, "version_count":{ "type":"integer", "description":"Number of children associated with the cursor." }, "module":{ "type":"string", "description":"Contains the name of the module that was executing at the time that the SQL statement was first parsed, which is set by calling DBMS_APPLICATION_INFO.SET_MODULE." }, "action":{ "type":"string", "description":"Contains the name of the action that was executing at the time that the SQL statement was first parsed, which is set by calling DBMS_APPLICATION_INFO.SET_ACTION." }, "sql_profile":{ "type":"string", "description":"Name of the applied SQL Profile." }, "force_matching_signature":{ "type":"integer", "description":"The signature used when the CURSOR_SHARING parameter is set to FORCE." }, "parsing_schema_id":{ "type":"integer", "description":"Schema ID that was used to originally build the child cursor." }, "parsing_schema_name":{ "type":"string", "description":"Schema name that was used to originally build the child cursor." }, "parsing_user_id":{ "type":"integer", "description":"User ID that was used to originally build the child cursor." }, "fetches_total":{ "type":"integer", "description":"Cumulative number of fetches associated with the SQL statement." }, "fetches_delta":{ "type":"integer", "description":"Delta number of fetches associated with the SQL statement." }, "end_of_fetch_count_total":{ "type":"integer", "description":"Cumulative number of times this cursor was fully executed since the cursor was brought into the library cache. The value of this statistic is not incremented when the cursor is partially executed, either because it failed during the execution or because only the first few rows produced by this cursor are fetched before the cursor is closed or re-executed. By definition, the value of the END_OF_FETCH_COUNT column should be less or equal to the value of the EXECUTIONS column." }, "end_of_fetch_count_delta":{ "type":"integer", "description":"Delta number of times this cursor was fully executed since the cursor was brought into the library cache. The value of this statistic is not incremented when the cursor is partially executed, either because it failed during the execution or because only the first few rows produced by this cursor are fetched before the cursor is closed or re-executed." }, "sorts_total":{ "type":"integer", "description":"Cumulative number of sorts that were done for this child cursor." }, "sorts_delta":{ "type":"integer", "description":"Delta number of sorts that were done for this child cursor." }, "executions_total":{ "type":"integer", "description":"Cumulative number of executions that took place on this object since it was brought into the library cache." }, "executions_delta":{ "type":"integer", "description":"Delta number of executions that took place on this object since it was brought into the library cache." }, "px_servers_execs_total":{ "type":"integer", "description":"Cumulative number of PX server executions." }, "px_servers_execs_delta":{ "type":"integer", "description":"Delta number of PX server executions." }, "loads_total":{ "type":"integer", "description":"Cumulative number of times the object was either loaded or reloaded." }, "loads_delta":{ "type":"integer", "description":"Delta number of times the object was either loaded or reloaded." }, "invalidations_total":{ "type":"integer", "description":"Cumulative number of times this child cursor has been invalidated." }, "invalidations_delta":{ "type":"integer", "description":"Delta number of times this child cursor has been invalidated." }, "parse_calls_total":{ "type":"integer", "description":"Cumulative number of parse calls for this child cursor." }, "parse_calls_delta":{ "type":"integer", "description":"Delta number of parse calls for this child cursor." }, "disk_reads_total":{ "type":"integer", "description":"Cumulative number of disk reads for this child cursor." }, "disk_reads_delta":{ "type":"integer", "description":"Delta number of disk reads for this child cursor." }, "buffer_gets_total":{ "type":"integer", "description":"Cumulative number of buffer gets for this child cursor." }, "buffer_gets_delta":{ "type":"integer", "description":"Delta number of buffer gets for this child cursor." }, "rows_processed_total":{ "type":"integer", "description":"Cumulative number of rows the parsed SQL statement returns." }, "rows_processed_delta":{ "type":"integer", "description":"Delta number of rows the parsed SQL statement returns." }, "cpu_time_total":{ "type":"integer", "description":"Cumulative value of CPU time (in microseconds) used by this cursor for parsing/executing/fetching." }, "cpu_time_delta":{ "type":"integer", "description":"Delta value of CPU time (in microseconds) used by this cursor for parsing/executing/fetching." }, "elapsed_time_total":{ "type":"integer", "description":"Cumulative value of elapsed time (in microseconds) used by this cursor for parsing/executing/fetching. If the cursor uses parallel execution, then ELAPSED_TIME_TOTAL is the cumulative time for the query coordinator, plus all parallel query slave processes." }, "elapsed_time_delta":{ "type":"integer", "description":"Delta value of elapsed time (in microseconds) used by this cursor for parsing/executing/fetching." }, "iowait_total":{ "type":"integer", "description":"Cumulative value of user I/O wait time (in microseconds)." }, "iowait_delta":{ "type":"integer", "description":"Delta value of user I/O wait time (in microseconds)." }, "clwait_total":{ "type":"integer", "description":"Cumulative value of cluster wait time (in microseconds)." }, "clwait_delta":{ "type":"integer", "description":"Delta value of cluster wait time (in microseconds)." }, "apwait_total":{ "type":"integer", "description":"Cumulative value of application wait time (in microseconds)." }, "apwait_delta":{ "type":"integer", "description":"Delta value of application wait time (in microseconds)." }, "ccwait_total":{ "type":"integer", "description":"Cumulative value of concurrency wait time (in microseconds)." }, "ccwait_delta":{ "type":"integer", "description":"Delta value of concurrency wait time (in microseconds)." }, "direct_writes_total":{ "type":"integer", "description":"Cumulative value of direct writes." }, "direct_writes_delta":{ "type":"integer", "description":"Delta value of direct writes." }, "plsexec_time_total":{ "type":"integer", "description":"Cumulative value of PL/SQL Execution Time (in microseconds)." }, "plsexec_time_delta":{ "type":"integer", "description":"Delta value of PL/SQL Execution Time (in microseconds)." }, "javexec_time_total":{ "type":"integer", "description":"Cumulative value of Java Execution Time (in microseconds)." }, "javexec_time_delta":{ "type":"integer", "description":"Delta value of Java Execution Time (in microseconds)." }, "io_offload_elig_bytes_total":{ "type":"integer", "description":"Cumulative value of number of I/O bytes which can be filtered by the Exadata storage system." }, "io_offload_elig_bytes_delta":{ "type":"integer", "description":"Delta value of number of I/O bytes which can be filtered by the Exadata storage system." }, "io_interconnect_bytes_total":{ "type":"integer", "description":"Cumulative value of number of I/O bytes exchanged between Oracle Database and the storage system." }, "io_interconnect_bytes_delta":{ "type":"integer", "description":"Delta value of number of I/O bytes exchanged between Oracle Database and the storage system." }, "physical_read_requests_total":{ "type":"integer", "description":"Cumulative value of number of physical read I/O requests issued by the monitored SQL." }, "physical_read_requests_delta":{ "type":"integer", "description":"Delta value of number of physical read I/O requests issued by the monitored SQL." }, "physical_read_bytes_total":{ "type":"integer", "description":"Cumulative value of number of bytes read from disks by the monitored SQL." }, "physical_read_bytes_delta":{ "type":"integer", "description":"Delta value of number of bytes read from disks by the monitored SQL." }, "physical_write_requests_total":{ "type":"integer", "description":"Cumulative value of number of physical write I/O requests issued by the monitored SQL." }, "physical_write_requests_delta":{ "type":"integer", "description":"Delta value of number of physical write I/O requests issued by the monitored SQL." }, "physical_write_bytes_total":{ "type":"integer", "description":"Cumulative value of number of bytes written to disks by the monitored SQL." }, "physical_write_bytes_delta":{ "type":"integer", "description":"Delta value of number of bytes written to disks by the monitored SQL." }, "optimized_physical_reads_total":{ "type":"integer", "description":"Cumulative value of number of physical reads from the Database Smart Flash Cache or the Exadata Smart Flash Cache by the monitored SQL." }, "optimized_physical_reads_delta":{ "type":"integer", "description":"Delta value of number of physical reads from the Database Smart Flash Cache or the Exadata Smart Flash Cache by the monitored SQL." }, "cell_uncompressed_bytes_total":{ "type":"integer", "description":"Cumulative value of number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells." }, "cell_uncompressed_bytes_delta":{ "type":"integer", "description":"Delta value of number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells." }, "io_offload_return_bytes_total":{ "type":"integer", "description":"Cumulative value of number of bytes that are returned by the Exadata cell for smart scan only (that is, not including bytes for other database I/O)." }, "io_offload_return_bytes_delta":{ "type":"integer", "description":"Delta value of number of bytes that are returned by the Exadata cell for smart scan only (that is, not including bytes for other database I/O)." }, "bind_data":{ "type":"string", "description":"Bind data." }, "con_dbid":{ "type":"integer", "description":"The database ID of the PDB for the sampled session." }, "con_id":{ "type":"integer", "description":"The ID of the container that CON_DBID identifies." }, "elapsed_time_delta_s_per_exec":{ "type":"number", "description":"Average elapsed time (in seconds) for parsing/executing/fetching across all recorded executions." }, "sum_executions_delta":{ "type":"integer", "description":"Total of all executions that took place on this object since it was brought into the library cache." } } } }, "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" } } } }, "PerformanceSQLStatementTextItem":{ "type":"object", "description":"Describes the SQL Statement.", "properties":{ "sql_text":{ "type":"string", "description":"First thousand characters of the SQL text for the current cursor." }, "sql_fulltext":{ "type":"string", "description":"Full text for the SQL statement." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceTopSQLStatements":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/SQLStatement" } }, "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" } } } }, "SQLStatement":{ "type":"object", "description":"Corresponding to a record on GV$SQL, this object describes an SQL Statement. The list of attributes may vary depending on database version.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$SQL view information was obtained." }, "sql_text":{ "type":"string", "description":"First thousand characters of the SQL text for the current cursor." }, "sql_fulltext":{ "type":"string", "description":"Full text for the SQL statement exposed as a CLOB column. The full text of a SQL statement can be retrieved using this column instead of joining with the V$SQLTEXT dynamic performance view." }, "sql_id":{ "type":"string", "description":"SQL identifier of the parent cursor in the library cache." }, "sharable_mem":{ "type":"integer", "description":"Amount of shared memory used by the child cursor (in bytes)." }, "persistent_mem":{ "type":"integer", "description":"Fixed amount of memory used for the lifetime of the child cursor (in bytes)." }, "runtime_mem":{ "type":"integer", "description":"Fixed amount of memory required during the execution of the child cursor." }, "sorts":{ "type":"integer", "description":"Number of sorts that were done for the child cursor." }, "loaded_versions":{ "type":"integer", "description":"Indicates whether the context heap is loaded (1) or not (0)." }, "open_versions":{ "type":"integer", "description":"Indicates whether the child cursor is locked (1) or not (0)." }, "users_opening":{ "type":"integer", "description":"Number of users that have any of the child cursors open." }, "fetches":{ "type":"integer", "description":"Number of fetches associated with the SQL statement." }, "executions":{ "type":"integer", "description":"Number of executions that took place on this object since it was brought into the library cache." }, "px_servers_executions":{ "type":"integer", "description":"Total number of executions performed by parallel execution servers (0 when the statement has never been executed in parallel)." }, "end_of_fetch_count":{ "type":"integer", "description":"Number of times this cursor was fully executed since the cursor was brought into the library cache. The value of this statistic is not incremented when the cursor is partially executed, either because it failed during the execution or because only the first few rows produced by this cursor are fetched before the cursor is closed or re-executed. By definition, the value of the END_OF_FETCH_COUNT column should be less or equal to the value of the EXECUTIONS column." }, "users_executing":{ "type":"integer", "description":"Number of users executing the statement." }, "loads":{ "type":"integer", "description":"Number of times the object was either loaded or reloaded." }, "first_load_time":{ "type":"string", "description":"Timestamp of the parent creation time." }, "invalidations":{ "type":"integer", "description":"Number of times this child cursor has been invalidated." }, "parse_calls":{ "type":"integer", "description":"Number of parse calls for this child cursor." }, "disk_reads":{ "type":"integer", "description":"Number of disk reads for this child cursor." }, "direct_writes":{ "type":"integer", "description":"Number of direct writes for this child cursor." }, "direct_reads":{ "type":"integer", "description":"Number of direct reads for this child cursor." }, "buffer_gets":{ "type":"integer", "description":"Number of buffer gets for this child cursor." }, "application_wait_time":{ "type":"integer", "description":"Application wait time (in microseconds)." }, "concurrency_wait_time":{ "type":"integer", "description":"Concurrency wait time (in microseconds)." }, "cluster_wait_time":{ "type":"integer", "description":"Cluster wait time (in microseconds)." }, "user_io_wait_time":{ "type":"integer", "description":"User I/O Wait Time (in microseconds)." }, "plsql_exec_time":{ "type":"integer", "description":"PL/SQL execution time (in microseconds)." }, "java_exec_time":{ "type":"integer", "description":"Java execution time (in microseconds)." }, "rows_processed":{ "type":"integer", "description":"Total number of rows the parsed SQL statement returns." }, "command_type":{ "type":"integer", "description":"Oracle command type definition." }, "optimizer_mode":{ "type":"string", "description":"Mode under which the SQL statement was executed." }, "optimizer_cost":{ "type":"integer", "description":"Cost of this query given by the optimizer." }, "optimizer_env":{ "type":"string", "description":"Optimizer environment." }, "optimizer_env_hash_value":{ "type":"integer", "description":"Hash value for the optimizer environment." }, "parsing_user_id":{ "type":"integer", "description":"User ID of the user who originally built this child cursor." }, "parsing_schema_id":{ "type":"integer", "description":"Schema ID that was used to originally build this child cursor." }, "parsing_schema_name":{ "type":"string", "description":"Schema name that was used to originally build this child cursor." }, "kept_versions":{ "type":"integer", "description":"Indicates whether this child cursor has been marked to be kept pinned in the cache using the DBMS_SHARED_POOL package." }, "address":{ "type":"string", "description":"Address of the handle to the parent for this cursor." }, "type_chk_heap":{ "type":"string", "description":"Descriptor of the type check heap for this child cursor." }, "hash_value":{ "type":"integer", "description":"Hash value of the parent statement in the library cache." }, "old_hash_value":{ "type":"integer", "description":"Old SQL hash value." }, "plan_hash_value":{ "type":"integer", "description":"Numeric representation of the current SQL plan for this cursor. Comparing one PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line)." }, "full_plan_hash_value":{ "type":"integer", "description":"Numeric representation of the complete SQL plan for this cursor. Comparing one FULL_PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line). Note that the FULL_PLAN_HASH_VALUE cannot be compared across databases releases. It is not backward compatible." }, "child_number":{ "type":"integer", "description":"Number of this child cursor." }, "service":{ "type":"string", "description":"Service name." }, "service_hash":{ "type":"integer", "description":"Hash value for the name listed in the SERVICE column." }, "module":{ "type":"string", "description":"Contains the name of the module that was executing when the SQL statement was first parsed, which is set by calling DBMS_APPLICATION_INFO.SET_MODULE." }, "module_hash":{ "type":"integer", "description":"Hash value of the module listed in the MODULE column." }, "action":{ "type":"string", "description":"Contains the name of the action that was executing when the SQL statement was first parsed, which is set by calling DBMS_APPLICATION_INFO.SET_ACTION." }, "action_hash":{ "type":"integer", "description":"Hash value of the action listed in the ACTION column." }, "serializable_aborts":{ "type":"integer", "description":"Number of times the transaction failed to serialize, producing ORA-08177 errors, per cursor." }, "outline_category":{ "type":"string", "description":"If an outline was applied during construction of the cursor, then this column displays the category of that outline. Otherwise the column is left blank." }, "cpu_time":{ "type":"integer", "description":"CPU time (in microseconds) used by this cursor for parsing, executing, and fetching." }, "elapsed_time":{ "type":"integer", "description":"Elapsed time (in microseconds) used by this cursor for parsing, executing, and fetching. If the cursor uses parallel execution, then ELAPSED_TIME is the cumulative time for the query coordinator, plus all parallel query slave processes." }, "outline_sid":{ "type":"integer", "description":"Outline session identifier." }, "child_address":{ "type":"string", "description":"Address of the child cursor." }, "sqltype":{ "type":"integer", "description":"Denotes the version of the SQL language used for this statement." }, "remote":{ "type":"string", "description":"Indicates whether the cursor is remote mapped (Y) or not (N)." }, "object_status":{ "type":"string", "description":"Status of the cursor." }, "literal_hash_value":{ "type":"integer", "description":"Hash value of the literals which are replaced with system-generated bind variables and are to be matched, when CURSOR_SHARING is used. This is not the hash value for the SQL statement. If CURSOR_SHARING is not used, then the value is 0." }, "last_load_time":{ "type":"string", "description":"Time at which the query plan was loaded into the library cache." }, "is_obsolete":{ "type":"string", "description":"Indicates whether the cursor has become obsolete (Y) or not (N). This can happen if the number of child cursors is too large." }, "is_bind_sensitive":{ "type":"string", "description":"Indicates whether the cursor is bind sensitive (Y) or not (N). A query is considered bind-sensitive if the optimizer peeked at one of its bind variable values when computing predicate selectivities and where a change in a bind variable value may cause the optimizer to generate a different plan." }, "is_bind_aware":{ "type":"string", "description":"Indicates whether the cursor is bind aware (Y) or not (N). A query is considered bind-aware if it has been marked to use extended cursor sharing. The query would already have been marked as bind-sensitive." }, "is_shareable":{ "type":"string", "description":"Indicates whether the cursor can be shared (Y) or not (N)." }, "child_latch":{ "type":"integer", "description":"Child latch number that is protecting the cursor. This column is obsolete and maintained for backward compatibility." }, "sql_profile":{ "type":"string", "description":"SQL profile used for this statement, if any." }, "sql_patch":{ "type":"string", "description":"SQL patch used for this statement, if any." }, "sql_plan_baseline":{ "type":"string", "description":"SQL plan baseline used for this statement, if any." }, "program_id":{ "type":"integer", "description":"Program identifier." }, "program_line#":{ "type":"integer", "description":"Program line number." }, "exact_matching_signature":{ "type":"integer", "description":"Signature calculated on the normalized SQL text. The normalization includes the removal of white space and the uppercasing of all non-literal strings." }, "force_matching_signature":{ "type":"integer", "description":"Signature used when the CURSOR_SHARING parameter is set to FORCE." }, "last_active_time":{ "type":"string", "description":"TIme at which the query plan was last active." }, "bind_data":{ "type":"string", "description":"Bind data." }, "typecheck_mem":{ "type":"integer", "description":"Typecheck memory." }, "io_cell_offload_eligible_bytes":{ "type":"integer", "description":"Number of I/O bytes which can be filtered by the Exadata storage system." }, "io_interconnect_bytes":{ "type":"integer", "description":"Number of I/O bytes exchanged between Oracle Database and the storage system." }, "physical_read_requests":{ "type":"integer", "description":"Number of physical read I/O requests issued by the monitored SQL." }, "physical_read_bytes":{ "type":"integer", "description":"Number of bytes read from disks by the monitored SQL." }, "physical_write_requests":{ "type":"integer", "description":"Number of physical write I/O requests issued by the monitored SQL." }, "physical_write_bytes":{ "type":"integer", "description":"Number of bytes written to disks by the monitored SQL." }, "optimized_phy_read_requests":{ "type":"integer", "description":"Number of physical read I/O requests from Database Smart Flash Cache issued by the monitored SQL." }, "locked_total":{ "type":"integer", "description":"Total number of times the child cursor has been locked." }, "pinned_total":{ "type":"integer", "description":"Total number of times the child cursor has been pinned." }, "io_cell_uncompressed_bytes":{ "type":"integer", "description":"Number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells." }, "io_cell_offload_returned_bytes":{ "type":"integer", "description":"Number of filtered bytes returned by Exadata cells (that is, the number of bytes returned after processing has been offloaded on the Exadata cells)." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "is_reoptimizable":{ "type":"string", "description":"This columns shows whether the next execution matching this child cursor will trigger a reoptimization." }, "is_resolved_adaptive_plan":{ "type":"string", "description":"This column shows whether all of the adaptive parts of a plan have been resolved to the final plan. Once the plan is resolved, the plan hash value and the plan displayed by DBMS_XPLAN will not change through the end of execution." }, "im_scans":{ "type":"integer", "description":"Number of In-Memory Column Store (IM column store) segment scans." }, "im_scan_bytes_uncompressed":{ "type":"integer", "description":"Uncompressed size of data scanned from the IM column store." }, "im_scan_bytes_inmemory":{ "type":"integer", "description":"In-memory size of data scanned from the IM column store." }, "ddl_no_invalidate":{ "type":"string", "description":"Indicates if a DDL statement updated a dependent object and did not invalidate this cursor." }, "is_rolling_invalid":{ "type":"string", "description":"Indicates if this cursor is rolling validated." }, "is_rolling_refresh_invalid":{ "type":"string", "description":"Indicates if this cursor is rolling validated and requires execution time refresh." }, "result_cache":{ "type":"string", "description":"Indicates whether the function is result???cached (YES) or not (NO)." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "PerformanceTopSQLStatementsMaximumsItem":{ "type":"object", "description":"Describes the maximum values on GV$SQL view.", "properties":{ "max_cpu_time":{ "type":"integer", "description":"Maximum CPU time (in microseconds) used by an SQL Statement for parsing, executing, and fetching." }, "max_elapsed_time":{ "type":"integer", "description":"Maximum elapsed time (in microseconds) used by an SQL Statement for parsing, executing, and fetching." }, "max_disk_reads":{ "type":"integer", "description":"Maximum number of disk reads by an SQL Statement." }, "max_buffer_gets":{ "type":"integer", "description":"Maximum number of buffer gets by an SQL Statement." }, "max_executions":{ "type":"integer", "description":"Maximum number of executions that took place for an SQL Statement since it was brought into the library cache." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseUsers":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseUsersItem" } }, "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" } } } }, "DatabaseUsersItem":{ "type":"object", "description":"This object describes a database user. The list of attributes may vary depending on database version.", "properties":{ "username":{ "type":"string", "description":"Name of the user." }, "user_id":{ "type":"integer", "description":"ID number of the user." }, "account_status":{ "type":"string", "description":"Account status." }, "lock_date":{ "type":"string", "description":"Date the account was locked if account status was LOCKED." }, "expiry_date":{ "type":"string", "description":"Date of expiration of the account." }, "default_tablespace":{ "type":"string", "description":"Default tablespace for data." }, "temporary_tablespace":{ "type":"string", "description":"Name of the default tablespace for temporary tables or the name of a tablespace group." }, "local_temp_tablespace":{ "type":"string", "description":"Default local temporary tablespace for the user." }, "created":{ "type":"string", "description":"User creation date." }, "profile":{ "type":"string", "description":"User resource profile name." }, "initial_rsrc_consumer_group":{ "type":"string", "description":"Initial resource consumer group for the user." }, "external_name":{ "type":"string", "description":"User external name. For centrally managed users, if the database user mapping is an exclusive mapping, then this will be the directory service DN for the user. If this database user is a shared schema, it will be the DN of a group." }, "password_versions":{ "type":"string", "description":"Shows the list of versions of the password hashes (also known as 'verifiers') existing for the account." }, "editions_enabled":{ "type":"string", "description":"Indicates whether editions have been enabled for the corresponding user (Y) or not (N)." }, "authentication_type":{ "type":"string", "description":"Indicates the authentication mechanism for the user." }, "proxy_only_connect":{ "type":"string", "description":"Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges for this account (that is, by users who have been granted the 'connect through' privilege for this account)." }, "common":{ "type":"string", "description":"Indicates whether a given user is common." }, "last_login":{ "type":"string", "description":"The time of the last user login." }, "oracle_maintained":{ "type":"string", "description":"Denotes whether the user was created, and is maintained, by Oracle-supplied scripts (such as catalog.sql or catproc.sql). A user for which this column has the value Y must not be changed in any way except by running an Oracle-supplied script." }, "inherited":{ "type":"string", "description":"Indicates whether the user definition was inherited from another container (YES) or not (NO)." }, "default_collation":{ "type":"string", "description":"Default collation for the user???s schema." }, "implicit":{ "type":"string", "description":"Indicates whether this user is a common user created by an implicit application (YES) or not (NO)." }, "all_shard":{ "type":"string", "description":"In a sharded database, the value in this column indicates whether the user was created with shard DDL enabled." }, "locked_account":{ "type":"integer", "description":"When LOCK_DATE is set, 1, otherwise 0." }, "expired_account":{ "type":"integer", "description":"When EXPIRY_DATE is in the past, 1, otherwise 0." }, "open_account":{ "type":"integer", "description":"When ACCOUNT_STATUS = 'OPEN', 1, otherwise 0." }, "days_left":{ "type":"integer", "description":"Indicates the number of days left before the account expires. Can be a negative value if the account is expired." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseStatusItem":{ "type":"object", "description":"Relying on GV$INSTANCE and GV$DATABASE views this object provides information on the status of the database.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$INSTANCE view information was obtained." }, "instance_number":{ "type":"integer", "description":"Instance number used for instance registration (corresponds to the INSTANCE_NUMBER initialization parameter)." }, "instance_name":{ "type":"string", "description":"Name of the instance." }, "host_name":{ "type":"string", "description":"Name of the host machine." }, "version":{ "type":"string", "description":"Database version." }, "version_legacy":{ "type":"string", "description":"The legacy database version used before Oracle Database 18c. This column displays the same value as the VERSION column." }, "version_full":{ "type":"string", "description":"The version string with the new Oracle Database version scheme introduced in Oracle Database 18c." }, "startup_time":{ "type":"string", "description":"Time when the instance was started." }, "status":{ "type":"string", "description":"Status of the instance." }, "parallel":{ "type":"string", "description":"Indicates whether the instance is mounted in cluster database mode (YES) or not (NO)." }, "thread#":{ "type":"integer", "description":"Redo thread opened by the instance." }, "archiver":{ "type":"string", "description":"Automatic archiving status." }, "log_switch_wait":{ "type":"string", "description":"Event that log switching is waiting for." }, "logins":{ "type":"string", "description":"Indicates whether the instance is in unrestricted mode, allowing logins by all users (ALLOWED, or in restricted mode, allowing logins by database administrators only (RESTRICTED)." }, "shutdown_pending":{ "type":"string", "description":"Indicates whether a shutdown is pending (YES) or not (NO)." }, "database_status":{ "type":"string", "description":"Status of the database." }, "instance_role":{ "type":"string", "description":"Indicates whether the instance is an active instance (PRIMARY_INSTANCE) or an inactive secondary instance (SECONDARY_INSTANCE), or UNKNOWN if the instance has been started but not mounted." }, "active_state":{ "type":"string", "description":"Quiesce state of the instance." }, "blocked":{ "type":"string", "description":"Indicates whether all services are blocked (YES) or not (NO)." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "instance_mode":{ "type":"string", "description":"Shows the instance mode of the current instance." }, "edition":{ "type":"string", "description":"The edition of the database." }, "database_type":{ "type":"string", "description":"Database type." }, "name":{ "type":"string", "description":"Name of the database." }, "db_unique_name":{ "type":"string", "description":"Unique database name." }, "open_mode":{ "type":"string", "description":"Open mode information." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseVersionItem":{ "type":"object", "description":"Relying on GV$INSTANCE and GV$VERSION views this object provides information on the version of the database.", "properties":{ "inst_id":{ "type":"integer", "description":"Instance number from which the associated GV$INSTANCE view information was obtained." }, "instance_number":{ "type":"integer", "description":"Instance number used for instance registration (corresponds to the INSTANCE_NUMBER initialization parameter)." }, "instance_name":{ "type":"string", "description":"Name of the instance." }, "host_name":{ "type":"string", "description":"Name of the host machine." }, "version":{ "type":"string", "description":"Database version." }, "version_legacy":{ "type":"string", "description":"The legacy database version used before Oracle Database 18c. This column displays the same value as the VERSION column." }, "version_full":{ "type":"string", "description":"The version string with the new Oracle Database version scheme introduced in Oracle Database 18c." }, "startup_time":{ "type":"string", "description":"Time when the instance was started." }, "status":{ "type":"string", "description":"Status of the instance." }, "parallel":{ "type":"string", "description":"Indicates whether the instance is mounted in cluster database mode (YES) or not (NO)." }, "thread#":{ "type":"integer", "description":"Redo thread opened by the instance." }, "archiver":{ "type":"string", "description":"Automatic archiving status." }, "log_switch_wait":{ "type":"string", "description":"Event that log switching is waiting for." }, "logins":{ "type":"string", "description":"Indicates whether the instance is in unrestricted mode, allowing logins by all users (ALLOWED, or in restricted mode, allowing logins by database administrators only (RESTRICTED)." }, "shutdown_pending":{ "type":"string", "description":"Indicates whether a shutdown is pending (YES) or not (NO)." }, "database_status":{ "type":"string", "description":"Status of the database." }, "instance_role":{ "type":"string", "description":"Indicates whether the instance is an active instance (PRIMARY_INSTANCE) or an inactive secondary instance (SECONDARY_INSTANCE), or UNKNOWN if the instance has been started but not mounted." }, "active_state":{ "type":"string", "description":"Quiesce state of the instance." }, "blocked":{ "type":"string", "description":"Indicates whether all services are blocked (YES) or not (NO)." }, "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "instance_mode":{ "type":"string", "description":"Shows the instance mode of the current instance." }, "edition":{ "type":"string", "description":"The edition of the database." }, "database_type":{ "type":"string", "description":"Database type." }, "instance_version":{ "type":"array", "items":{ "type":"object", "properties":{ "banner":{ "type":"string", "description":"Component name and version number." } } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseStorageBytesItem":{ "type":"object", "description":"Total size of data files in the database and their total usage.", "properties":{ "total_bytes":{ "type":"integer", "description":"Total size (in bytes) of all the data files in the database." }, "used_bytes":{ "type":"integer", "description":"Total number of bytes used by all the tablespaces in the database." }, "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" } } } }, "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" } } } }, "DatabaseTablespaceDatafilesUsageItem":{ "type":"object", "description":"Using GV$DATAFILE and DBA_FREE_SPACE data this object represents the usage of a data file in the database.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "file_name":{ "type":"string", "description":"Name of the database file." }, "tablespace":{ "type":"string", "description":"Name of the tablespace." }, "status":{ "type":"string", "description":"File status." }, "total_space":{ "type":"integer", "description":"Total size of the files (in bytes)." }, "used_space":{ "type":"integer", "description":"Total used space (in bytes)." }, "used_space_pct":{ "type":"number", "description":":Percentage of how much space is used." }, "autoextend":{ "type":"string", "description":"Indicates whether the file is autoextensible (YES) or not (NO)." } } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseTablespaceDatafiles":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseTablespaceDatafilesItem" } }, "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" } } } }, "DatabaseTablespaceDatafilesItem":{ "type":"object", "description":"", "properties":{ "file_name":{ "type":"string", "description":"Name of the database file." }, "tablespace":{ "type":"string", "description":"Name of the tablespace." }, "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." }, "lost_write_protect":{ "type":"integer", "description":"Lost write protection status of the file." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseTablespaceDatafileUsageItem":{ "type":"object", "description":"Using GV$DATAFILE and DBA_FREE_SPACE data this object represents the usage of a data file in the database.", "properties":{ "file_name":{ "type":"string", "description":"Name of the database file." }, "file_id":{ "type":"integer", "description":"File identifier number of the database file." }, "tablespace":{ "type":"string", "description":"Name of the tablespace." }, "status":{ "type":"string", "description":"File status." }, "total_space":{ "type":"integer", "description":"Total size of the files (in bytes)." }, "used_space":{ "type":"integer", "description":"Total used space (in bytes)." }, "used_space_pct":{ "type":"number", "description":":Percentage of how much space is used." }, "autoextend":{ "type":"string", "description":"Indicates whether the file is autoextensible (YES) or not (NO)." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseTablespaceHistoryItem":{ "type":"object", "description":"Describes historical tablespace usage statistics.", "properties":{ "snap_id":{ "type":"integer", "description":"Unique snapshot ID." }, "dbid":{ "type":"integer", "description":"Database ID for the snapshot." }, "tablespace_id":{ "type":"integer", "description":"Tablespace ID." }, "tablespace_size":{ "type":"integer", "description":"Tablespace size (in database blocks)." }, "tablespace_maxsize":{ "type":"integer", "description":"Maximum size of the tablespace (in database blocks)." }, "tablespace_usedsize":{ "type":"integer", "description":"Used size of the tablespace (in database blocks)." }, "rtime":{ "type":"string", "description":"Runtime." }, "con_dbid":{ "type":"integer", "description":"The database ID of the PDB for the sampled session." }, "con_id":{ "type":"integer", "description":"The ID of the container that CON_DBID identifies." }, "prev_tablespace_size":{ "type":"integer", "description":"The previous tablespace size (in database blocks)." }, "name":{ "type":"string", "description":"Tablespace name." } } }, "DatabaseTablespaceSegments":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseTablespaceSegmentsItem" } }, "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" } } } }, "DatabaseTablespaceSegmentsItem":{ "type":"object", "description":"Describes the storage allocated for a segments in the database.", "properties":{ "owner":{ "type":"string", "description":"Username of the segment owner." }, "segment_name":{ "type":"string", "description":"Name, if any, of the segment." }, "partition_name":{ "type":"string", "description":"Object Partition Name (Set to NULL for nonpartitioned objects)." }, "segment_type":{ "type":"string", "description":"Type of segment." }, "segment_subtype":{ "type":"string", "description":"Subtype of LOB segment: SECUREFILE, ASSM, MSSM, and NULL." }, "tablespace_name":{ "type":"string", "description":"Name of the tablespace containing the segment." }, "header_file":{ "type":"integer", "description":"ID of the file containing the segment header." }, "header_block":{ "type":"integer", "description":"ID of the block containing the segment header." }, "bytes":{ "type":"integer", "description":"Size, in bytes, of the segment." }, "blocks":{ "type":"integer", "description":"Size, in Oracle blocks, of the segment." }, "extents":{ "type":"integer", "description":"Number of extents allocated to the segment." }, "initial_extent":{ "type":"integer", "description":"Size in bytes requested for the initial extent of the segment at create time. Oracle rounds the extent size to multiples of 5 blocks if the requested size is greater than 5 blocks." }, "next_extent":{ "type":"integer", "description":"Size in bytes of the next extent to be allocated to the segment." }, "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." }, "max_size":{ "type":"integer", "description":"Maximum number of blocks allowed in the segment." }, "retention":{ "type":"string", "description":"Retention option for SECUREFILE segment." }, "minretention":{ "type":"integer", "description":"Minimum retention duration for SECUREFILE segment." }, "pct_increase":{ "type":"integer", "description":"Percent by which to increase the size of the next extent to be allocated." }, "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." }, "relative_fno":{ "type":"integer", "description":"Relative file number of the segment header." }, "buffer_pool":{ "type":"string", "description":"Buffer pool to be used for segment blocks." }, "flash_cache":{ "type":"string", "description":"Database Smart Flash Cache hint to be used for segment blocks." }, "cell_flash_cache":{ "type":"string", "description":"Cell flash cache hint to be used for segment blocks." }, "inmemory":{ "type":"string", "description":"Indicates whether the In-Memory Column Store (IM column store) is enabled (ENABLED) or disabled (DISABLED) for this segment." }, "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_duplicate":{ "type":"string", "description":"Indicates the duplicate setting for the IM column store in an Oracle RAC environment." }, "inmemory_compression":{ "type":"string", "description":"Indicates the compression level for the IM column store." }, "cellmemory":{ "type":"string", "description":"The value for columnar compression in the storage cell flash cache." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabaseTablespaceTempfiles":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseTablespaceTempfilesItem" } }, "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" } } } }, "DatabaseTablespaceTempfilesItem":{ "type":"object", "description":"Describes a temporary file in the database.", "properties":{ "file_name":{ "type":"string", "description":"Name of the database file." }, "file_id":{ "type":"integer", "description":"File identifier number of the database temp file." }, "tablespace_name":{ "type":"string", "description":"Name of the tablespace." }, "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)." }, "shared":{ "type":"string", "description":"Type of tablespace this file belongs to." }, "inst_id":{ "type":"integer", "description":"Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "EnvironmentDbcaTemplates":{ "type":"object", "description":"Represents a list of the DBCA Database Templates in the Oracle Home.", "properties":{ "items":{ "type":"array", "items":{ "type":"object", "properties":{ "filename":{ "type":"string", "description":"Name of the template file." }, "size":{ "type":"integer", "description":"Size (in bytes) of the template file." }, "updated":{ "type":"string", "description":"The last update date of the template file." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "EnvironmentDbcaJobs":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnvironmentDbcaJobsItem" } }, "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" } } } }, "EnvironmentDbcaJobsItem":{ "type":"object", "description":"Describes a Database Configuration Assistant job.", "properties":{ "job_id":{ "type":"string", "description":"Unique identifier for the DBCA job in the Oracle Home." }, "description":{ "type":"string", "description":"DBCA job description." }, "status":{ "type":"string", "description":"DBCA job status." }, "submitted":{ "type":"string", "description":"Timestamp for when the DBCA job request was submitted." }, "finished":{ "type":"string", "description":"Timestamp for when the DBCA job request finished." }, "job_request":{ "type":"object", "description":"Describes the DBCA job request.", "properties":{ "operation":{ "type":"string", "description":"The DBCA operation to be performed: CREATE or DELETE." }, "container_configuration":{ "type":"object", "description":"This object represents container configuration details for a CDB.", "properties":{ "number_of_pdbs":{ "type":"string", "description":"Number of PDBs to create." }, "pdb_name":{ "type":"string", "description":"Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1." } } }, "database_system_identifier":{ "type":"string", "description":"The database identifier." }, "global_database_name":{ "type":"string", "description":"Global database name." }, "response_file":{ "type":"string", "description":"Path for response file for DBCA to use when creating a database." }, "template_name":{ "type":"string", "description":"Path for the database template for DBCA to use when creating a database." }, "total_memory":{ "type":"string", "description":"Total memory parameter to provide to DBCA when creating a database." }, "username":{ "type":"string", "description":"The sysdba username for DBCA to use when deleting a database." } } }, "dbca_log":{ "type":"array", "description":"The output from the DBCA process as it executes.", "items":{ "type":"string" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "EnvironmentDatabases":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnvironmentDatabasesItem" } }, "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" } } } }, "EnvironmentDatabasesItem":{ "type":"object", "description":"A database has a unique name within the context of the Oracle home it belongs to.", "properties":{ "name":{ "type":"string", "description":"The name of the database." }, "type":{ "type":"string", "description":"The type of database. Either CDB or NON_CDB" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "EnvironmentHomes":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnvironmentHomesItem" } }, "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" } } } }, "EnvironmentHomesItem":{ "type":"object", "description":"An Oracle home is a directory into which Oracle software is installed.", "properties":{ "name":{ "type":"string", "description":"The name of the Oracle home." }, "version":{ "type":"string", "description":"The product version." }, "default":{ "type":"boolean", "description":"Indicates if the Oracle home is specified by the $ORACLE_HOME environment variable." }, "read_only_home":{ "type":"boolean", "description":"Indicates if the Oracle home is configured in read only mode." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "ScriptObject":{ "type":"object", "properties":{ "binds":{ "type":"array", "items":{ "type":"object" } }, "statementText":{ "type":"string" } } }, "RESTSQLCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/SQLItem" } }, "env":{ "type":"string" } } }, "SQLItem":{ "type":"object", "properties":{ "statementId":{ "type":"integer" }, "response":{ "type":"array", "items":{ "type":"string" } }, "result":{ "type":"integer" } } }, "DataguardConfigurationCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DataguardConfigurationItem" } }, "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" } } } }, "DataguardConfigurationItem":{ "type":"object", "properties":{ "inst_id":{ "type":"integer" }, "database":{ "type":"string" }, "connection_identifier":{ "type":"string" }, "dataguard_role":{ "type":"string" }, "redo_source":{ "type":"string" }, "enabled":{ "type":"string" }, "status":{ "type":"integer" }, "severity":{ "type":"string" }, "status_message":{ "type":"string" }, "version":{ "type":"string" }, "con_id":{ "type":"integer" } } }, "DataguardConfigurationCollectionLinks":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DataguardConfigurationItemLinks" } }, "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" } } } }, "DataguardConfigurationItemLinks":{ "type":"object", "properties":{ "inst_id":{ "type":"integer" }, "database":{ "type":"string" }, "connection_identifier":{ "type":"string" }, "dataguard_role":{ "type":"string" }, "redo_source":{ "type":"string" }, "enabled":{ "type":"string" }, "status":{ "type":"integer" }, "severity":{ "type":"string" }, "status_message":{ "type":"string" }, "version":{ "type":"string" }, "con_id":{ "type":"integer" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DataguardConfigurationPropertiesCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DataguardConfigurationPropertyItem" } }, "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" } } } }, "DataguardConfigurationPropertyItem":{ "type":"object", "properties":{ "property":{ "type":"string" }, "property_type":{ "type":"string" }, "value":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DataguardInstanceCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DataguardInstanceItem" } }, "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" } } } }, "DataguardInstanceItem":{ "type":"object", "properties":{ "inst_id":{ "type":"integer" }, "instance_number":{ "type":"integer" }, "instance_name":{ "type":"string" }, "host_name":{ "type":"string" }, "version":{ "type":"string" }, "version_legacy":{ "type":"string" }, "version_full":{ "type":"string" }, "startup_time":{ "type":"string", "format":"date-time" }, "status":{ "type":"string" }, "parallel":{ "type":"string" }, "thread#":{ "type":"integer" }, "archiver":{ "type":"string" }, "log_switch_wait":{ "type":"string" }, "logins":{ "type":"string" }, "shutdown_pending":{ "type":"string" }, "database_status":{ "type":"string" }, "instance_role":{ "type":"string" }, "active_state":{ "type":"string" }, "blocked":{ "type":"string" }, "con_id":{ "type":"integer" }, "instance_mode":{ "type":"string" }, "edition":{ "type":"string" }, "family":{ "type":"string" }, "database_type":{ "type":"string" } } }, "ItemsCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceItem" } }, "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" } } } }, "ResourceItem":{ "type":"object", "additionalProperties":true, "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "LinkRelation":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "required":[ "rel", "href" ] }, "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" } } } ] }, "ErrorObject":{ "type":"object", "properties":{ "code":{ "type":"string" }, "message":{ "type":"string" }, "type":{ "type":"string" }, "instance":{ "type":"string" } } } }, "parameters":{ "OpenServiceBrokerAPIVersion":{ "name":"X-Broker-API-Version", "in":"header", "description":"The version number of the Service Broker API that the Platform will use.", "required":true, "schema":{ "type":"string" } }, "OpenServiceBrokerRequestIdentity":{ "name":"X-Broker-API-Request-Identity", "in":"header", "description":"A Platform might wish to uniquely identify a specific request as it flows throughout the system. This header holds that request tracking information.", "required":false, "schema":{ "type":"string" } }, "OpenServiceBrokerOriginatingIdentity":{ "name":"X-Broker-API-Originating-Identity", "in":"header", "description":"The identity of the Platform user that initiated the request from the Platform. The value for this header consists of two parts which are described in the Open Service Broker specification.", "required":false, "schema":{ "type":"string" } }, "Limit":{ "name":"limit", "in":"query", "description":"The maximum number of records to return.", "required":false, "schema":{ "type":"integer", "format":"int32" } }, "Offset":{ "name":"offset", "in":"query", "description":"The index of the first record to start returning results for. Used with pagination.", "required":false, "schema":{ "type":"integer", "format":"int32" } }, "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" } } } }, "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" } } }, "FilterSinceTimestamp":{ "summary":"Include records with a date property, in this example originating_timestamp, after a specific date." }, "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" } } } } }, "swagger":"2.0" }