{ "openapi":"3.0.0", "info":{ "description":"

Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.

To install and configure Oracle REST Data Services refer to the Oracle® REST Data Services Installation and Configuration Guide.

\n

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

The pattern for the API document URL is:

\nhttps://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path> \n

Where, the <my database> and <my schema> variables can be optional, depending on the ORDS configuration and the service invoked.", "version":"2026.03.26", "title":"Oracle REST Data Services API", "contact":{ "name":"Oracle REST Data Services", "url":"https://www.oracle.com/database/technologies/appdev/rest.html" }, "x-summary":"Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API." }, "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":"Data Pump", "description":"Services related to Oracle Data Pump. Oracle Data Pump technology enables very high-speed movement of data and metadata from one database to another. Functionality may differ depending on the configuration and permissions the database user has." }, { "name":"Data Tools", "description":"Services related to loading, manipulating and analyzing data." }, { "name":"Environment", "description":"Services related to the Oracle database installation. The implementation is only available for Unix based operating systems." }, { "name":"General", "description":"Services related to the Oracle database instance." }, { "name":"Monitoring", "description":"Services related to monitoring the Oracle database instance." }, { "name":"ORDS REST Services", "description":"Custom Oracle REST Data Services built with SQL & PL/SQL." }, { "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":"Oracle Transactional Event Queues", "description":"Services related to Oracle Transactional Event Queues." }, { "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." }, { "name":"Pluggable Database Snapshot Carousel", "description":"Services related to managing pluggable databases snapshots in an Oracle database instance." }, { "name":"RDF Graph", "description":"Services related to Oracle RDF Graph. Oracle RDF Graph provides functionality to manage knowledge graphs based on World Wide Web Consortium (W3C) standards such as RDF, OWL and SPARQL." }, { "name":"Scheduler", "description":"Oracle Scheduler, an enterprise job scheduler to help you simplify the scheduling of hundreds or even thousands of tasks. Oracle Scheduler (the Scheduler) is implemented by the procedures and functions in the DBMS_SCHEDULER PL/SQL package." }, { "name":"Vector Database/Inference Operations", "description":"The operations from the Vector Database/Inference Operations category." }, { "name":"Vector Database/Models", "description":"The operations from the Vector Database/Models category." }, { "name":"Vector Database/Summary", "description":"The operations from the Vector Database/Summary category." }, { "name":"Vector Database/Vector Indexes", "description":"The operations from the Vector Database/Vector Indexes category." }, { "name":"Vector Database/Vector Operations", "description":"The operations from the Vector Database/Vector Operations category." }, { "name":"Vector Database/Vector Search", "description":"The operations from the Vector Database/Vector Search category." }, { "name":"Vector Database/Vector Tables", "description":"The operations from the Vector Database/Vector Tables category." } ], "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" }, "examples":{ "all_workspaces_in_schema":{ "summary":"An example of a list of all workspaces that the user has access to.", "value":{ "count":1, "hasMore":false, "items":[ { "workspace_id":"2499355381608110", "workspace_name":"WORK120", "workspace_display_name":"WORK120", "workspace_description":null, "schemas":1, "created_on":"2022-11-24T01:54:20Z", "last_login":null, "allow_app_building_yn":"Y", "allow_packaged_app_ins_yn":null, "allow_sql_workshop_yn":"Y", "allow_websheet_dev_yn":null, "allow_team_development_yn":"Y", "allow_team_dev_files_yn":"N", "allow_issue_files_yn":"Y", "allow_to_be_purged_yn":"Y", "allow_restful_services_yn":"Y", "applications":0, "application_pages":0, "apex_users":1, "links":[ { "rel":"self", "href":"http://localhost:8080/ords/_/db-api/stable/apex/workspaces/WORK120/" }, { "rel":"related", "href":"http://localhost:8080/ords/_/db-api/stable/apex/workspaces/WORK120/applications/" }, { "rel":"related", "href":"http://localhost:8080/ords/_/db-api/stable/apex/statistics/workspace/WORK120/", "title":"Workspace Statistics" } ] } ], "limit":25, "links":[ { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/workspaces/example_workspace/applications/", "rel":"self" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/metadata-catalog/", "rel":"describedby" } ], "offset":0 } } } } } } }, "x-internal-id":"apex-workspaces--get", "x-filename-id":"apex-workspaces-get" } }, "/apex/workspaces/{workspace_name}/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get workspace", "description":"This service returns 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":"A specific Oracle APEX workspace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXWorkspacesItem" } } } } }, "x-internal-id":"apex-workspaces-{workspace_name}--get", "x-filename-id":"apex-workspaces-workspace_name-get" } }, "/apex/workspaces/{workspace_name}/datasets/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get all datasets in the specified workspace", "description":"Returns information about the datasets available in the specified 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":"All datasets in the workspace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXDatasets" }, "examples":{ "all_datasets_in_workspace":{ "summary":"An example of a list of all the datasets in the workspace that the user has access to.", "value":{ "count":1, "hasMore":false, "items":[ { "dataset_id":"2066291953340216", "dataset_name":"Simple-Dataset", "dataset_description":"Description of dataset", "static_id":"SIMPLE_DATASET", "workspace_display_name":"ORDS", "workspace":"ORDS", "workspace_id":"2063824650324169", "last_updated_by":"PAIGE", "last_updated_on":"2022-04-06T07:37:17Z", "links":[ { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/datasets/Simple-Dataset", "rel":"self" } ] } ], "limit":25, "links":[ { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/workspaces/example_workspace/datasets/", "rel":"self" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/metadata-catalog/", "rel":"describedby" } ], "offset":0 } } } } } } }, "x-internal-id":"apex-workspaces-{workspace_name}-datasets--get", "x-filename-id":"apex-workspaces-workspace_name-datasets-get" } }, "/apex/workspaces/{workspace_name}/datasets/{dataset_name}":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get a specific Oracle APEX Dataset", "description":"This service returns a representation of the specified Oracle APEX Dataset. The representation data will be a metadata about the Oracle APEX Dataset from APEX_DR_DATASETS view. See APEX documentation for more information. A client requires SQL Developer or SQL Administrator role.", "parameters":[ { "name":"workspace_name", "in":"path", "description":"Display name of the workspace.", "required":true, "schema":{ "type":"string" } }, { "name":"dataset_name", "in":"path", "description":"Display name of the dataset.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The specified Oracle APEX Dataset.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatasetItem" }, "examples":{ "dataset_example":{ "summary":"An example of the details returned for the specified Oracle APEX Dataset.", "value":{ "dataset_id":"2066291953340216", "dataset_name":"Simple-Dataset", "dataset_description":"Description of dataset", "static_id":"SIMPLE_DATASET", "workspace_display_name":"ORDS", "workspace":"ORDS", "workspace_id":"2063824650324169", "last_updated_by":"PAIGE", "last_updated_on":"2022-04-06T07:37:17Z", "links":[ { "rel":"collection", "href":"https://myserver/ords/myschema/_/db-api/stable/apex/workspaces/example_workspace/datasets/" } ] } } } } } }, "400":{ "description":"Bad Request - The dataset does not exist." } }, "x-internal-id":"apex-workspaces-{workspace_name}-datasets-{dataset_name}-get", "x-filename-id":"apex-workspaces-workspace_name-datasets-dataset_name-get" } }, "/apex/workspaces/{workspace_name}/applications/":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get all applications in the specified workspace", "description":"Returns information about the Oracle APEX applications available in the specified workspace. This endpoint is a convenience. The same information can be retreived using /apex/applications/?q={\"workspace_display_name\":\"EXAMPLE_WORKSPACE\"} endpoint. 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":"All Oracle APEX applications in the workspace.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXApplications" }, "examples":{ "all_applications_in_workspace":{ "summary":"An example of a list of all applications in the workspace that the user has access to.", "value":{ "count":1, "hasMore":false, "items":[ { "application_id":400, "application_name":"Sample Calendar", "application_alias":"A782020211201055214947", "application_group":"22.1 Sample Apps", "application_owner":"HR", "page_count":37, "application_type":"STANDARD", "workspace":"ORDS", "availability_status":"Available with Edit Links", "last_updated_by":"PAIGE", "last_updated_on":"2022-04-06T07:37:17Z", "links":[ { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/applications/101", "rel":"self" } ] } ], "limit":25, "links":[ { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/workspaces/example_workspace/applications/", "rel":"self" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/metadata-catalog/", "rel":"describedby" } ], "offset":0 } } } } } } }, "x-internal-id":"apex-workspaces-{workspace_name}-applications--get", "x-filename-id":"apex-workspaces-workspace_name-applications-get" } }, "/apex/applications/{application_id}":{ "get":{ "tags":[ "Oracle APEX" ], "summary":"Get or export a specific APEX application", "description":"This service returns a representation of the specified APEX Application. The representation data will be a metadata about the APEX Application from APEX_APPLICATIONS view or an export of the entire application using APEX GET_APPLICATION.EXPORT database procedure. See APEX documentation for more information. A client requires SQL Developer or SQL Administrator role.", "parameters":[ { "name":"application_id", "in":"path", "description":"Application Primary Key, Unique over all workspaces.", "required":true, "schema":{ "type":"string" } }, { "name":"export_format", "in":"query", "description":"Indicates the file format to return the entire application components. Valid values SQL_SCRIPT | SQL_ZIP", "schema":{ "type":"string", "enum":[ "SQL_SCRIPT", "SQL_ZIP" ] } }, { "name":"export_type", "in":"query", "description":"Parameter for APEX Export function. Comma-delimited list of export types to perform APPLICATION_SOURCE,EMBEDDED_CODE, CHECKSUM-SH1", "schema":{ "type":"string" }, "examples":{ "export_type_src":{ "summary":"Export application source", "value":"APPLICATION_SOURCE" } } }, { "name":"with_date", "in":"query", "description":"Parameter for APEX Export function. If true include export date and time in the result. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_ir_public_reports", "in":"query", "description":"Parameter for APEX Export function. If true, include public reports that a user saved. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_ir_private_reports", "in":"query", "description":"Parameter for APEX Export function. If true, include private reports that a user saved. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_ir_notifications", "in":"query", "description":"Parameter for APEX Export function. If true, include report notifications. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_translations", "in":"query", "description":"Parameter for APEX Export function. If true, include application translation mappings and all text from the translation repository. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_pkg_app_mapping", "in":"query", "description":"If true, export installed packaged applications with references to the packaged application definition. If false, export them as normal applications.", "schema":{ "type":"boolean" } }, { "name":"with_original_ids", "in":"query", "description":"Parameter for APEX Export function. If true, export with the IDs as they were when the application was imported. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_no_subscriptions", "in":"query", "description":"Parameter for APEX Export function. If true, components contain subscription references. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_comments", "in":"query", "description":"Parameter for APEX Export function. If true, include developer comments. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_supporting_objects", "in":"query", "description":"Parameter for APEX Export function. If 'Y', export supporting objects. If 'I',automatically install on import. If 'N', do not export supporting objects. If null, the application's include in export deployment value is used. Only valid if export_format query parameter is also specified.", "schema":{ "type":"string", "enum":[ "Y", "I", "N" ] } }, { "name":"with_acl_assignments", "in":"query", "description":"Parameter for APEX Export function. If true, export ACL user role assignments. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_audit_info", "in":"query", "description":"Parameter for the APEX Export function. If \"NULL\", export excludes all audit information. If \"NAMES_AND_DATES\", export includes Created On, Created By, Updated On, and Updated By values if they exist. If \"DATES_ONLY\", export includes Created On and Updated On values only; user names are excluded. Only valid if the export_format query parameter is also specified. Enum: \"NAMES_AND_DATES\", \"DATES_ONLY\".", "schema":{ "type":"string", "enum":[ "NAMES_AND-DATES", "DATES_ONLY" ] } } ], "responses":{ "200":{ "description":"The specified Oracle APEX application.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXApplicationsItem" }, "examples":{ "application_example":{ "summary":"An example of the details returned for the specified application. Returned when export_format query parameter is not specified in the request.", "value":{ "application_id":103, "application_name":"Sample Cards", "application_alias":"SAMPLE-CARDS103", "application_group":null, "application_owner":"HR", "page_count":25, "application_type":"STANDARD", "workspace":"ORDS", "availability_status":"Available with Edit Links", "last_updated_by":"TIM", "last_updated_on":"2022-04-06T12:31:05Z", "links":[ { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/applications/101", "rel":"self" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/statistics/application/101/", "rel":"related", "title":"Application Statistics" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/workspaces/example_workspace/", "rel":"related", "title":"Workspace" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/applications/101?export_format=SQL_SCRIPT&with_date=true", "rel":"enclosure", "type":"application/sql", "title":"Export Application as SQL file" }, { "href":"https://myserver/ords/myschema/_/db-api/stable/apex/applications/101?export_format=SQL_ZIP&with_date=true&with_supporting_objects=false", "rel":"enclosure", "type":"application/zip", "title":"Export Application as ZIP file" } ] } } } }, "application/sql":{ "schema":{ "type":"string", "format":"binary" }, "examples":{ "sqlExample":{ "summary":"The APEX application source exported in single SQL script. Returned when export_format query parameter is SQL_SCRIPT in the request.", "value":"--begin SQL script snippet sample\n ...\n wwv_flow_imp.import_begin (p_version_yyyy_mm_dd=>'2022.10.07'\n ,p_release=>'22.2.0'\n ,p_default_workspace_id=>7586151564871204\n ,p_default_application_id=>101\n ,p_default_id_offset=>7587564257891170\n ,p_default_owner=>'EXAMPLEWS'\n );\n ...\n--end SQL script snippet sample" } } }, "application/zip":{ "schema":{ "type":"string", "format":"binary" }, "examples":{ "zipExample":{ "summary":"The APEX application source exported in ZIP format. Returned when export_format query parameter is SQL_ZIP in the request.", "value":"--begin zip snippet sample UEsDBBQAAAgIAG5aYlUY6d2blwAAAL0AAAASAAAAZjEwNi9jb3B5cmlnaHQudHh0LY3LCsIwEEX3/Yq7VJCk7bJbFyKICuIHDOnUBtIkZKYV/9762NzVOfecaeION5pyYByjciGnfmEciu+l2q --end zip snippet sample" } } } } }, "400":{ "description":"Bad Request - The export related query parameters provided without specifying export_format." } }, "x-internal-id":"apex-applications-{application_id}-get", "x-filename-id":"apex-applications-application_id-get" }, "post":{ "tags":[ "Oracle APEX" ], "summary":"Export APEX application components and/or runtime instance data", "description":"Exports selected components of a specified APEX application and/or runtime instance data.", "parameters":[ { "name":"application_id", "in":"path", "description":"Application Primary Key, Unique over all workspaces.", "required":true, "schema":{ "type":"string" } }, { "name":"export_format", "in":"query", "description":"Indicates the file format to return the entire application components. Valid values SQL_SCRIPT | SQL_ZIP", "schema":{ "type":"string", "enum":[ "SQL_SCRIPT", "SQL_ZIP" ] } }, { "name":"export_type", "in":"query", "description":"Parameter for APEX Export function. Comma-delimited list of export types to perform APPLICATION_SOURCE,EMBEDDED_CODE, CHECKSUM-SH1", "schema":{ "type":"string" }, "examples":{ "export_type_src":{ "summary":"Export application source", "value":"APPLICATION_SOURCE" } } }, { "name":"with_date", "in":"query", "description":"Parameter for APEX Export function. If true include export date and time in the result. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_ir_public_reports", "in":"query", "description":"Parameter for APEX Export function. If true, include public reports that a user saved. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_ir_private_reports", "in":"query", "description":"Parameter for APEX Export function. If true, include private reports that a user saved. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_ir_notifications", "in":"query", "description":"Parameter for APEX Export function. If true, include report notifications. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_translations", "in":"query", "description":"Parameter for APEX Export function. If true, include application translation mappings and all text from the translation repository. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_pkg_app_mapping", "in":"query", "description":"If true, export installed packaged applications with references to the packaged application definition. If false, export them as normal applications.", "schema":{ "type":"boolean" } }, { "name":"with_original_ids", "in":"query", "description":"Parameter for APEX Export function. If true, export with the IDs as they were when the application was imported. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_no_subscriptions", "in":"query", "description":"Parameter for APEX Export function. If true, components contain subscription references. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_comments", "in":"query", "description":"Parameter for APEX Export function. If true, include developer comments. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_supporting_objects", "in":"query", "description":"Parameter for the APEX Export function. If \"NULL\", export excludes all audit information. If \"NAMES_AND_DATES\", export includes Created On, Created By, Updated On, and Updated By values if they exist. If \"DATES_ONLY\", export includes Created On and Updated On values only; user names are excluded. Only valid if the export_format query parameter is also specified. Enum: \"NAMES_AND_DATES\", \"DATES_ONLY\".", "schema":{ "type":"string", "enum":[ "Y", "I", "N" ] } }, { "name":"with_acl_assignments", "in":"query", "description":"Parameter for APEX Export function. If true, export ACL user role assignments. Only valid if export_format query parameter is also specified.", "schema":{ "type":"boolean" } }, { "name":"with_audit_info", "in":"query", "description":"Parameter for APEX Export function. If 'NULL', export excludes all audit information. if 'NAMES_AND_DATES', export includes Created On, Created By, Updated On, Updated By values if they exist. If 'DATES_ONLY', export includes Created On and Updated On values if they exist. User names are excluded. Only valid if export_format query parameter is also specified.", "schema":{ "type":"string", "enum":[ "NAMES_AND-DATES", "DATES_ONLY" ] } } ], "requestBody":{ "description":"Defines what should be exported from the APEX application. You can export application components, runtime instance data, or both.", "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "description":"This object represents an export request for APEX application components and/or runtime instance data.", "required":[ "export_format" ], "properties":{ "components":{ "description":"Parameter for APEX Export function. The list of components in the specified APEX Application to export.", "type":"array", "items":{ "description":"Alias of the component. Format is TYPE:IDENTIFIER.", "type":"string" } }, "withRuntimeInstances":{ "description":"Parameter for APEX Export function. An array with components for which to export runtime instance data", "type":"array", "items":{ "description":"If \"WORKFLOW\", exports workflow instances and their associated task instances. If \"TASK\", exports task instances that are not associated with any workflow. If \"WORKFLOW, TASK\", exports both workflow instances with their associated tasks and task instances not associated with any workflow.", "type":"string", "enum":[ "WORKFLOW", "TASK" ] } } } }, "examples":{ "export_specific_components":{ "summary":"Listing two specific APEX Applications components to export. The query parameter export_format MUST be specified.", "value":{ "components":[ "LOV:123", "PAGE:321" ] } }, "export_runtime_instances":{ "summary":"Setting the runtime instance to WORKFLOW, in order to export workflow instances and their associated task instances. The query parameter export_format MUST be specified.", "value":{ "withRuntimeInstances":[ "WORKFLOW" ] } } } } } }, "responses":{ "200":{ "description":"The current state of the specified Oracle APEX application components.", "content":{ "application/sql":{ "schema":{ "type":"string", "format":"binary" }, "examples":{ "sqlExample":{ "summary":"The APEX application components source exported in single SQL script", "value":"--begin SQL script snippet sample\n ...\n wwv_flow_imp.import_begin (p_version_yyyy_mm_dd=>'2022.10.07'\n ,p_release=>'22.2.0'\n ,p_default_workspace_id=>7586151564871204\n ,p_default_application_id=>101\n ,p_default_id_offset=>7587564257891170\n ,p_default_owner=>'EXAMPLEWS'\n );\n ...\n--end SQL script snippet sample" } } }, "application/zip":{ "schema":{ "type":"string", "format":"binary" }, "examples":{ "zipExample":{ "summary":"The APEX application components source exported in ZIP format", "value":"--begin zip snippet sample UEsDBBQAAAgIAG5aYlUY6d2blwAAAL0AAAASAAAAZjEwNi9jb3B5cmlnaHQudHh0LY3LCsIwEEX3/Yq7VJCk7bJbFyKICuIHDOnUBtIkZKYV/9762NzVOfecaeION5pyYByjciGnfmEciu+l2q --end zip snippet sample" } } } } }, "400":{ "description":"Bad Request - The service requested requires a body in the request." } }, "x-internal-id":"apex-applications-{application_id}-post", "x-filename-id":"apex-applications-application_id-post" } }, "/apex/workspaces/{workspace_name}/applications/{application_id}":{ "put":{ "tags":[ "Oracle APEX" ], "summary":"Create or Update an APEX application, with a specific application id, in the specified workspace", "description":"This services creates a new application in the specified workspace, using the given application/sql, application/apex, or application/zip input content using APEX install application procedure. The Application ID in the input file is ignored. If an application already exists with the application_id in the URL then it is overwritten. Otherwise, a new application is created in the workspace with the specified application_id from the URL. A client requires SQL Developer or SQL Administrator role to access this endpoint.", "parameters":[ { "name":"workspace_name", "in":"path", "description":"Display name of the workspace.", "required":true, "schema":{ "type":"string" } }, { "name":"application_id", "in":"path", "description":"Application Primary Key, Unique over all workspaces.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/sql":{ "schema":{ "type":"string" } }, "application/apex":{ "schema":{ "type":"string" } }, "application/zip":{ "schema":{ "type":"string" } } } }, "responses":{ "201":{ "description":"Details of the created/updated application", "headers":{ "Location":{ "schema":{ "type":"string" }, "description":"Location header will provide URI of created APEX application." } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APEXApplicationsItem" } } } }, "400":{ "description":"Bad Request - The input file could not be processed." } }, "x-internal-id":"apex-workspaces-{workspace_name}-applications-{application_id}-put", "x-filename-id":"apex-workspaces-workspace_name-applications-application_id-put" }, "delete":{ "tags":[ "Oracle APEX" ], "summary":"Delete the specified APEX application", "description":"Permanently delete the APEX application from the database. A client requires SQL Developer or SQL Administrator role to access this endpoint.", "parameters":[ { "name":"workspace_name", "in":"path", "description":"Display name of the workspace.", "required":true, "schema":{ "type":"string" } }, { "name":"application_id", "in":"path", "description":"Application Primary Key, Unique over all workspaces.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the APEX application was removed." } }, "x-internal-id":"apex-workspaces-{workspace_name}-applications-{application_id}-delete", "x-filename-id":"apex-workspaces-workspace_name-applications-application_id-delete" } }, "/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":"Add a configuration. 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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"Remove the configuration. A client requires SQL Administrator role to invoke this service.", "responses":{ "200":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"Alter a 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" } } ], "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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"Add a database. 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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":{ "operation":{ "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":{ "operation":"ENABLE" } } } } } }, "responses":{ "201":{ "description":"Data Guard status", "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":"Get 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 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":"string" }, "description":"Status of the Data Guard operation." } } }, "400":{ "description":"Data Guard Bad Request", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ErrorObject" } } }, "headers":{ "DG-STATUS":{ "schema":{ "type":"string" }, "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":[ "Data Pump" ], "summary":"Create an export data pump job", "description":"Create a Data Pump export job with the specified parameters and start it. Data and object structures can be exported to a directory in the Oracle database server or to Oracle Object Store. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator or SQL Developer role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "credential_name":{ "type":"string", "description":"Specify the name of the credentials, owned by the database user, to be used to export to object storage." }, "datapump_dir":{ "type":"string", "description":"Specify the database directory to use.", "default":"DATA_PUMP_DIR" }, "file_name":{ "type":"string", "description":"The file name pattern to use for Data Pump export. Will default to a pattern with a timestamp in the name. Required when credential_name is specified. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location." }, "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." } } } }, "keep_master":{ "type":"integer", "description":"indicates whether the Data Pump control job table should be deleted or retained at the end of an Oracle Data Pump job that completes successfully. ", "default":1, "enum":[ 0, 1 ] } } }, "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')" } ], "keep_master":1 } } } } } }, "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":[ "Data Pump" ], "summary":"Create an import data pump job", "description":"Create a Data Pump import job with the specified parameters and start it. Data and object structures can be imported from a directory in the Oracle database server or from Oracle Object Store. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator or SQL Developer role to invoke this service.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "file_name" ], "properties":{ "credential_name":{ "type":"string", "description":"Specify the name of the credential, owned by the database user, to be used to import from object storage." }, "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. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location." }, "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." } } } }, "keep_master":{ "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.", "default":1, "enum":[ 0, 1 ] } } }, "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" } ], "keep_master":1 } } } } } }, "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":[ "Data Pump" ], "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 or SQL Developer 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 or SQL Developer 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" ] }, "credential_name":{ "type":"string", "description":"Specify the name of the credential, owned by the database user, to be used to import from object storage or export to object storage." }, "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 or when credential_name is specified. For EXPORT the file_name will default to a pattern with a timestamp in the name. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location." }, "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." } } } }, "keep_master":{ "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.", "default":1, "enum":[ 0, 1 ] } } }, "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":[ "Data Pump" ], "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 or SQL Developer 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":[ "Data Pump" ], "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 or SQL Developer 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/tablespaces/":{ "get":{ "tags":[ "Data Dictionary" ], "summary":"Get all tablespaces", "description":"Describes all the tablespaces in the database using DBA_TABLESPACES or USER_TABLESPACES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All tablespaces in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespaces" } } } } }, "x-internal-id":"database-tablespaces--get", "x-filename-id":"database-tablespaces-get" } }, "/database/tablespaces/{tablespace_name}":{ "get":{ "tags":[ "Data Dictionary" ], "summary":"Get a specific tablespace", "description":"Describes a specific tablespace in the database using DBA_TABLESPACES or USER_TABLESPACES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.", "parameters":[ { "name":"tablespace_name", "in":"path", "description":"Name of the tablespace.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"All tablespaces in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseTablespacesItem" } } } } }, "x-internal-id":"database-tablespaces-{tablespace_name}-get", "x-filename-id":"database-tablespaces-tablespace_name-get" } }, "/database/objects/types/":{ "get":{ "tags":[ "Data Dictionary" ], "summary":"Get all object types", "description":"Describes all object types in the database. Uses DBA_TYPES or ALL_TYPES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Description of all object types in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseObjectsTypes" } } } } }, "x-internal-id":"database-objects-types--get", "x-filename-id":"database-objects-types-get" } }, "/database/objects/types/{owner},{type_name}":{ "get":{ "tags":[ "Data Dictionary" ], "summary":"Get an object type", "description":"Describes a specific object type in the database. Uses DBA_TYPES or ALL_TYPES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.", "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the type.", "required":true, "schema":{ "type":"string" } }, { "name":"type_name", "in":"path", "description":"Name of the type.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on a specific object type.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabaseObjectsTypesItem" } } } } }, "x-internal-id":"database-objects-types-{owner},{type_name}-get", "x-filename-id":"database-objects-types-owner-type_name-get" } }, "/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 Pluggable Database", "description":"Create a pluggable database from PDB$SEED or from an XML metadata file accessible to the database instance, hot clone PDB from another PDB or snapshot. 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":[ "new_pdb_name" ], "properties":{ "new_pdb_name":{ "type":"string", "description":"The name of the new PDB." }, "admin_user":{ "type":"string", "description":"The administrator username for the new PDB. This property is required when creating pdb from PDB$SEED." }, "admin_password":{ "type":"string", "description":"The administrator password for the new PDB. This property is required when creating pdb from PDB$SEED." }, "roles":{ "type":"string", "description":"Grant one or more roles to the PDB_DBA role. This property is optional when creating pdb from PDB$SEED." }, "source_pdb_name":{ "type":"string", "description":"The name of the source PDB. This property is for clone pdb and clone pdb from snapshot." }, "snapshot_name":{ "type":"string", "description":"The name of the PDB snapshot that the new PDB will clone from. Only one of snapshot_name, snapshot_scn and snapshot_timestame can be provided." }, "snapshot_scn":{ "type":"string", "description":"The id of the PDB snapshot that new PDB will clone from. Only one of snapshot_name, snapshot_scn and snapshot_timestame can be provided." }, "snapshot_timestamp":{ "type":"string", "description":"The time stamp of the PDB snapshot that new PDB will clone from. Only one of snapshot_name, snapshot_scn and snapshot_timestame can be provided." }, "as_clone":{ "type":"boolean", "description":"Indicate if 'AS CLONE' option should be used in the command to plug in a PDB. This property is optional when creating pdb from XML file." }, "xml_file_name":{ "type":"string", "description":"The path of the XML metadata file to use when plugging-in a PDB. This property is required when creating pdb from XML file." }, "source_file_name_convert":{ "type":"string", "description":"Values can be a source filename convert pattern or NONE, This property is optional when creating pdb from XML file." }, "xml_file_action":{ "type":"string", "description":"Indicate which copy option should be used in the command to plug in a PDB. This property is optional when creating pdb from XML file.", "enum":[ "COPY", "NOCOPY", "MOVE" ] }, "keystore_password":{ "type":"string", "description":"TDE password when applicable (optional). This property is optional when creating pdb from a source pdb or a snapshot." }, "file_name_convert":{ "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." }, "service_name_convert":{ "type":"string", "description":"Relevant for create and plug operations. As defined in the Oracle Multitenant Database documentation. Values can be an even number of strings or NONE." }, "temp_file_reuse":{ "type":"boolean", "description":"Relevant for create and plug operations. True for temporary file reusage." }, "no_data":{ "type":"boolean", "description":"Relevant for clone operations. Specifies that the source pluggable database data model definition is cloned but not the data. Defaults to false." }, "snapshot_copy":{ "type":"boolean", "description":"Creates a snapshot copy PDB from a storage-managed snapshot. Storage-managed snapshots are only supported on specific file systems. It must not be used with snapshotName, snapshotScn and snapshotTimestamp parameters." }, "create_file_dest":{ "type":"string", "description":"NONE to disable Oracle Managed Files for the PDB, Specify either directory_path_name or diskgroup_name to enable Oracle Managed Files for the PDB. It is optional." }, "storage":{ "type":"string", "description":"Storage limits for the PDB. it can be UNLIMITED, MAXSIZE or MAX_AUDIT_SIZE, MAX_DIAG_SIZE etc." }, "dryrun":{ "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_from_seed":{ "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":{ "new_pdb_name":"pdb_sample", "admin_user":"pdbadmin", "admin_password":"W3lc0m31", "file_name_convert":"('/disk1/oracle/dbs/pdbseed/','/disk1/oracle/dbs/pdb_sample/')", "service_name_convert":"('service1','service2')", "storage":"UNLIMITED", "roles":"(DBA)", "temp_file_reuse":true } }, "create_pdb_clone":{ "summary":"This is an example request body to create a new pluggable database by cloning the pluggable database. ", "value":{ "new_pdb_name":"pdb_sample", "source_pdb_name":"src_pdb_sample", "file_name_convert":"('/disk1/oracle/dbs/pdb_sample/','/disk1/oracle/dbs/pdb_new/')", "service_name_convert":"('service1','service2')", "keystore_password":"password", "storage":"(MAXSIZE 2G MAX_SHARED_TEMP_SIZE 2G)", "temp_file_reuse":true } }, "create_pdb_from_xml":{ "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":{ "new_pdb_name":"newpdb", "xml_file_name":"/disk1/oracle/dbs/pdb.xml", "source_file_name_convert":"NONE", "xml_file_action":"MOVE", "file_name_convert":"('/disk1/oracle/dbs/pdbxml','/disk1/oracle/dbs/newpdb')", "as_clone":"true", "storage":"(MAXSIZE 2G)", "temp_file_reuse":true } } } } } }, "responses":{ "202":{ "description":"The response indicates that the dbms scheduler job is created and the information on the scheduler job for creating a pdb.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SchedulerJobsItem" } } } } }, "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" }, "patch":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"Update a specific PDB", "description":"This includes unplug, open, or close a PDB. Unplug operation has a significant impact on the specified pluggable databases. The unplug operation can delete the PDB. 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.admin user 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 open, close or unplug.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "unplug_file_name":{ "type":"string", "description":"Relevant for Unplug operations, the full path name of the operating system file in which to store information about the PDB." }, "drop_pdb":{ "type":"boolean", "description":"Relevant for Unplug operations, if it is true, this will drop the pdb after unplug operation." }, "state":{ "type":"string", "description":"Relevant for open/close pdb operations, the target state of the PDB.", "enum":[ "OPEN", "CLOSE" ] }, "read_only":{ "type":"boolean", "description":"Relevant for open pdb operations, change the open mode to READ ONLY." }, "read_write":{ "type":"boolean", "description":"Relevant for open pdb operations, change the open mode to READ WRITE." }, "restricted":{ "type":"boolean", "description":"Relevant for open pdb operations, If it is true, then the PDB is accessible only to users with the RESTRICTED SESSION privilege in the PDB." }, "force":{ "type":"boolean", "description":"Relevant for open/close pdb operations, Specify this keyword to change the open mode of a PDB from READ WRITE to READ ONLY, or from READ ONLY to READ WRITE. The FORCE keyword allows users to remain connected to the PDB while the open mode is changed." }, "instances":{ "type":"string", "example":"ALL", "description":"Relevant for open/close pdb operations, specify one or more instance names, in a comma-separated list enclosed in parenthesis. This modifies the state of the PDB only in those instances." }, "immediate":{ "type":"boolean", "description":"Relevant for close pdb operations, If it is true, then this is the PDB equivalent of the SQL*Plus SHUTDOWN command with the immediate mode. Otherwise, the PDB is shut down with the normal mode" }, "dryrun":{ "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":{ "open_pdb":{ "summary":"This is an example request body to open a pluggable database.", "value":{ "state":"open", "read_write":true } }, "close_pdb":{ "summary":"This is an example request body to close a pluggable database.", "value":{ "state":"close", "immediate":false } }, "unplug_pdb":{ "summary":"This is an example request body to unplug and drop 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":{ "drop_pdb":"true", "unplug_file_name":"/disk1/oracle/dbs/sales_pdb.xml" } } } } } }, "responses":{ "200":{ "description":"Description of the specific Pluggable Database that is opened/closed. All data files used by the Pluggable Database are also included.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableDatabasesItem" } } } }, "202":{ "description":"The response is only for unplug operations and indicates that the dbms scheduler job is created and the information on the scheduler job for unplugging a pdb.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SchedulerJobsItem" } } } }, "404":{ "description":"Bad request, it could be the pdb name in URL does not exist" } }, "x-internal-id":"database-pdbs-{pdb_name}-patch", "x-filename-id":"database-pdbs-pdb_name-patch" }, "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":"including_datafiles", "in":"query", "description":"To delete the data files associated with the PDB being dropped. The temp file for the PDB is also deleted", "schema":{ "type":"boolean" } }, { "name":"keep_datafiles", "in":"query", "description":"To retain the data files associated with the PDB after the PDB is dropped..", "schema":{ "type":"boolean" } }, { "name":"force", "in":"query", "description":"To drop an orphaned application root container", "schema":{ "type":"boolean" } }, { "name":"dryrun", "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":{ "204":{ "description":"The response will indicate the successful execution of a series of PL/SQL statements." } }, "x-internal-id":"database-pdbs-{pdb_name}-delete", "x-filename-id":"database-pdbs-pdb_name-delete" } }, "/database/pdb_snapshots/":{ "get":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"The snapshots of all pluggable databases (PDBs) in the Container Database", "description":"Returns records from dba_pdb_snapshots. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"PDB snapshots in the container database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshots" } } } } }, "x-internal-id":"database-pdb_snapshots--get", "x-filename-id":"database-pdb_snapshots-get" } }, "/database/pdb_snapshots/{pdb_name}/":{ "get":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"The list of all snapshots taken for the specified pluggable databases (PDBs)", "description":"Returns records from dba_pdb_snapshots based on container name. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"The name of the specified PDB to retrieve the list of snapshots for.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"PDB snapshots in the specified pluggable database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshots" } } } } }, "x-internal-id":"database-pdb_snapshots-{pdb_name}--get", "x-filename-id":"database-pdb_snapshots-pdb_name-get" } }, "/database/pdb_snapshots/{pdb_name}/{snapshot_name}":{ "get":{ "tags":[ "Pluggable Database Lifecycle Management" ], "summary":"The specific snapshot taken of the specific pluggable databases (PDBs)", "description":"Returns records from dba_pdb_snapshots based on container name and snapshot name. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"pdb_name", "in":"path", "description":"The name of the specified PDB to retrieve the snapshot for.", "required":true, "schema":{ "type":"string" } }, { "name":"snapshot_name", "in":"path", "description":"The name of the snapshot to retrieve.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"PDB snapshot in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotWithFileItem" } } } } }, "x-internal-id":"database-pdb_snapshots-{pdb_name}-{snapshot_name}-get", "x-filename-id":"database-pdb_snapshots-pdb_name-snapshot_name-get" } }, "/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/rdf/networks/":{ "get":{ "tags":[ "RDF Graph" ], "summary":"List RDF networks", "description":"Returns a collection of RDF networks visible to the current user. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Offset" } ], "responses":{ "200":{ "description":"Returns an array of network owner, network name pairs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkElemCollection" }, "example":"{\n \"items\": [\n {\n \"owner\": \"RDFUSER\",\n \"network_name\": \"NET1\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/\"\n }\n ]\n}\n" } } } }, "x-internal-id":"database-rdf-networks--get", "x-filename-id":"database-rdf-networks-get" } }, "/database/rdf/networks/{network_owner},{network_name}":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" } ], "get":{ "tags":[ "RDF Graph" ], "summary":"RDF network information", "description":"Returns metadata describing the specified network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "responses":{ "200":{ "description":"Returns metadata about the specified network.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkDetailElem" }, "example":"{\n \"owner\": \"RDFUSER\",\n \"network_name\": \"NET1\",\n \"parameters\": [\n {\n \"namespace\": \"NETWORK\",\n \"attribute\": \"COMPRESSION\",\n \"value\": \"COMPRESS=RSCB\",\n \"description\": \"Compression setting for semantic network\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-get" }, "put":{ "tags":[ "RDF Graph" ], "summary":"Create RDF network", "description":"Creates an RDF network. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.CREATE_RDF_NETWORK documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_rdf_network.html" }, "requestBody":{ "$ref":"#/components/requestBodies/createNetwork" }, "parameters":[ ], "responses":{ "201":{ "description":"Successful RDF network creation.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkDetailElem" }, "example":"{\n \"owner\": \"RDFUSER\",\n \"network_name\": \"NET1\",\n \"parameters\": [\n {\n \"namespace\": \"NETWORK\",\n \"attribute\": \"COMPRESSION\",\n \"value\": \"COMPRESS=RSCB\",\n \"description\": \"Compression setting for semantic network\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1\"\n }\n ]\n}\n" } } }, "400":{ "description":"RDF network already exists" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-put", "x-filename-id":"database-rdf-networks-network_owner-network_name-put" }, "delete":{ "tags":[ "RDF Graph" ], "summary":"Drop RDF network", "description":"Drops an RDF network. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.DROP_RDF_NETWORK documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_rdf_network.html" }, "parameters":[ { "in":"query", "name":"cascade", "required":false, "example":true, "description":"true to drop all data in the RDF network.", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successful drop RDF network operation." }, "400":{ "description":"Attempt to drop a non-empty RDF network without the cascade option" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-delete", "x-filename-id":"database-rdf-networks-network_owner-network_name-delete" } }, "/database/rdf/networks/{network_owner},{network_name}/models/":{ "get":{ "tags":[ "RDF Graph" ], "summary":"List RDF models", "description":"Returns metadata describing all RDF models in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Offset" } ], "responses":{ "200":{ "description":"Returns an array of elements containing metadata about all models in the specified network.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ModelDetailCollection" }, "example":"{\n \"items\": [\n {\n \"owner\": \"RDFUSER\",\n \"model_id\": \"1\",\n \"model_name\": \"M1\",\n \"table_name\": null,\n \"column_name\": null,\n \"model_tablespace_name\": \"DATA\",\n \"model_type\": \"M\",\n \"inmemory\": \"F\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models--get", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-get" } }, "/database/rdf/networks/{network_owner},{network_name}/models/{model_name}":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "in":"path", "name":"model_name", "required":true, "example":"M1", "description":"The name of the RDF model.", "schema":{ "type":"string" } } ], "get":{ "tags":[ "RDF Graph" ], "summary":"RDF model information", "description":"Returns metadata describing the specified RDF model. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "responses":{ "200":{ "description":"Returns metadata about the specified RDF model.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ModelDetailSingle" }, "example":"{\n \"owner\": \"RDFUSER\",\n \"model_id\": \"1\",\n \"model_name\": \"M1\",\n \"table_name\": null,\n \"column_name\": null,\n \"model_tablespace_name\": \"DATA\",\n \"model_type\": \"M\",\n \"inmemory\": \"F\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network or model does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-get" }, "put":{ "tags":[ "RDF Graph" ], "summary":"Create RDF model", "description":"Creates an RDF model. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.CREATE_RDF_GRAPH documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_rdf_graph.html" }, "requestBody":{ "$ref":"#/components/requestBodies/createModel" }, "parameters":[ ], "responses":{ "201":{ "description":"Successful RDF model creation.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ModelDetailSingle" }, "example":"{\n \"owner\": \"RDFUSER\",\n \"model_id\": \"1\",\n \"model_name\": \"M1\",\n \"table_name\": null,\n \"column_name\": null,\n \"model_tablespace_name\": \"DATA\",\n \"model_type\": \"M\",\n \"inmemory\": \"F\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1\"\n }\n ]\n}\n" } } }, "400":{ "description":"RDF model already exists" }, "404":{ "description":"RDF network does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-put", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-put" }, "delete":{ "tags":[ "RDF Graph" ], "summary":"Drop RDF model", "description":"Drops an RDF model. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.DROP_RDF_GRAPH documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_rdf_graph.html" }, "parameters":[ ], "responses":{ "204":{ "description":"Successful drop RDF network operation." }, "404":{ "description":"RDF network or model does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-delete", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-delete" } }, "/database/rdf/networks/{network_owner},{network_name}/entailments/":{ "get":{ "tags":[ "RDF Graph" ], "summary":"List entailments", "description":"Returns metadata describing all entailments in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Offset" } ], "responses":{ "200":{ "description":"Returns an array of elements containing metadata about all entailments in the specified network.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntailmentDetailCollection" }, "example":"{\n \"items\": [\n {\n \"owner\": \"RDFUSER\",\n \"index_name\": \"M1OWL\",\n \"index_view_name\": \"NET1#RDFI_M1OWL\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/m1owl\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-entailments--get", "x-filename-id":"database-rdf-networks-network_owner-network_name-entailments-get" } }, "/database/rdf/networks/{network_owner},{network_name}/entailments/{entailment_name}":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "in":"path", "name":"entailment_name", "required":true, "example":"M1OWL", "description":"The name of the entailment.", "schema":{ "type":"string" } } ], "get":{ "tags":[ "RDF Graph" ], "summary":"Entailment information", "description":"Returns metadata describing the specified entailment. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "responses":{ "200":{ "description":"Returns an array of elements containing metadata about the specified entailment.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntailmentDetailSingle" }, "example":"{\n \"owner\": \"RDFUSER\",\n \"index_name\": \"M1OWL\",\n \"index_view_name\": \"NET1#RDFI_M1OWL\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/m1owl\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network or entailment does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-entailments-{entailment_name}-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-entailments-entailment_name-get" }, "put":{ "tags":[ "RDF Graph" ], "summary":"Create entailment", "description":"Creates an entailment. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.CREATE_INFERRED_GRAPH documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_inferred_graph.html" }, "requestBody":{ "$ref":"#/components/requestBodies/createEntailment" }, "parameters":[ ], "responses":{ "201":{ "description":"Successful entailment creation.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntailmentDetailSingle" }, "example":"{\n \"owner\": \"RDFUSER\",\n \"index_name\": \"M1OWL\",\n \"index_view_name\": \"NET1#RDFI_M1OWL\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/entailments/m1owl\"\n }\n ]\n}\n" } } }, "400":{ "description":"A valid entailment already exists with the same name or with the same model-rulebase combination" }, "404":{ "description":"RDF network does not exist or one of the referenced models or rulebases does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-entailments-{entailment_name}-put", "x-filename-id":"database-rdf-networks-network_owner-network_name-entailments-entailment_name-put" }, "delete":{ "tags":[ "RDF Graph" ], "summary":"Drop entailment", "description":"Drops an entailment. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.DROP_INFERRED_GRAPH documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_inferred_graph.html" }, "responses":{ "204":{ "description":"Successful drop entailment operation." }, "404":{ "description":"RDF network or entailment does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-entailments-{entailment_name}-delete", "x-filename-id":"database-rdf-networks-network_owner-network_name-entailments-entailment_name-delete" } }, "/database/rdf/networks/{network_owner},{network_name}/virtual_models/":{ "get":{ "tags":[ "RDF Graph" ], "summary":"List virtual models", "description":"Returns metadata describing all virtual models in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Offset" } ], "responses":{ "200":{ "description":"Returns an array of elements containing metadata about all virtual models in the specified network.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VirtualModelDetailCollection" }, "example":"{\n \"items\": [\n {\n \"owner\": \"RDUSER\",\n \"virtual_model_name\": \"VM1\",\n \"unique_view_name\": \"NET1#SEMU_VM1\",\n \"duplicate_view_name\": \"NET1#SEMV_VM1\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"rules_index_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/vm1\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-virtual_models--get", "x-filename-id":"database-rdf-networks-network_owner-network_name-virtual_models-get" } }, "/database/rdf/networks/{network_owner},{network_name}/virtual_models/{virtual_model_name}":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "in":"path", "name":"virtual_model_name", "required":true, "example":"VM1", "description":"The name of the virtual model.", "schema":{ "type":"string" } } ], "get":{ "tags":[ "RDF Graph" ], "summary":"Virtual model information", "description":"Returns metadata describing the specified virtual model. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "responses":{ "200":{ "description":"Returns an array of elements containing metadata about the specified virtual model.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VirtualModelDetailSingle" }, "example":"{\n \"owner\": \"RDUSER\",\n \"virtual_model_name\": \"VM1\",\n \"unique_view_name\": \"NET1#SEMU_VM1\",\n \"duplicate_view_name\": \"NET1#SEMV_VM1\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"rules_index_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/vm1\"\n }\n ]\n}\n" } } }, "404":{ "description":"RDF network or virtual model does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-virtual_models-{virtual_model_name}-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-virtual_models-virtual_model_name-get" }, "put":{ "tags":[ "RDF Graph" ], "summary":"Create virtual model", "description":"Creates a virtual model. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.CREATE_RDF_GRAPH_COLLECTION documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-create_rdf_graph_collection.html" }, "requestBody":{ "$ref":"#/components/requestBodies/createVirtualModel" }, "parameters":[ ], "responses":{ "201":{ "description":"Successful virtual model creation.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VirtualModelDetailSingle" }, "example":"{\n \"owner\": \"RDUSER\",\n \"virtual_model_name\": \"VM1\",\n \"unique_view_name\": \"NET1#SEMU_VM1\",\n \"duplicate_view_name\": \"NET1#SEMV_VM1\",\n \"status\": \"VALID\",\n \"model_count\": \"1\",\n \"rulebase_count\": \"1\",\n \"rules_index_count\": \"1\",\n \"datasets\": \"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/virtual_models/vm1\"\n }\n ]\n}\n" } } }, "400":{ "description":"A virtual model with the same name or the same model-rulebase-entailment combination already exists or no entailment exists for the given model-rulebase combination" }, "404":{ "description":"RDF network does not exist or one of the referenced models, rulebases, or entailments does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-virtual_models-{virtual_model_name}-put", "x-filename-id":"database-rdf-networks-network_owner-network_name-virtual_models-virtual_model_name-put" }, "delete":{ "tags":[ "RDF Graph" ], "summary":"Drop virtual model", "description":"Drops a virtual model. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.DROP_RDF_GRAPH_COLLECTION documentation", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-drop_rdf_graph_collection.html" }, "parameters":[ ], "responses":{ "204":{ "description":"Successful drop virtual model operation." }, "404":{ "description":"RDF network or virtual model does not exist" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-virtual_models-{virtual_model_name}-delete", "x-filename-id":"database-rdf-networks-network_owner-network_name-virtual_models-virtual_model_name-delete" } }, "/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql/1.1":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "$ref":"#/components/parameters/ModelName" }, { "$ref":"#/components/parameters/DefaultGraphUri" }, { "$ref":"#/components/parameters/NamedGraphUri" }, { "$ref":"#/components/parameters/SparqlOptions" } ], "get":{ "tags":[ "RDF Graph" ], "summary":"Execute a SPARQL query", "description":"Executes a SPARQL query and returns the result in JSON format (application/sparql-results+json) or XML format (application/sparql-results+xml) for SPARQL SELECT and ASK queries, or N-Triples format (application/n-triples) for CONSTRUCT and DESCRIBE queries. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "externalDocs":{ "description":"SPARQL 1.1 Protocol", "url":"https://www.w3.org/TR/2013/REC-sparql11-protocol-20130321/" }, "parameters":[ { "in":"query", "name":"query", "required":true, "example":"SELECT%20%2A%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%2010", "description":"A URL-encoded SPARQL query string.", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful query execution.", "content":{ "application/sparql-results+xml":{ "schema":{ "$ref":"#/components/schemas/SparqlXmlResult" }, "examples":{ "select":{ "value":"\n\n \n \n \n \n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/dept\n \n \n http://www.example.oracle.com/sales\n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/fname\n \n \n John\n \n \n \n\n" }, "ask":{ "value":"\n\n \n true\n\n" } } }, "application/sparql-results+json":{ "schema":{ "$ref":"#/components/schemas/SparqlJsonResult" }, "examples":{ "select":{ "value":"{\n \"head\": { \n \"vars\": [\"s\", \"p\", \"o\"] \n },\n \"results\": {\n \"bindings\": [\n { \n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/dept\"},\n \"o\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/sales\"}\n },\n {\n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/fname\"},\n \"o\": {\"type\": \"literal\", \"value\": \"John\", \"xml:lang\": \"en\"}\n }\n ]\n }\n}\n" }, "ask":{ "value":"{ \n \"head\": {}, \n \"boolean\": true \n}\n" } } }, "application/n-triples":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 N-Triples", "url":"https://www.w3.org/TR/n-triples/" }, "type":"string" }, "examples":{ "construct":{ "value":" .\n \"John\"@en .\n" } } } } } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql-1.1-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-sparql-1.1-get" }, "post":{ "tags":[ "RDF Graph" ], "summary":"Execute a SPARQL query or update", "description":"Executes a SPARQL update or executes a SPARQL query and returns the result in JSON format (application/sparql-results+json) or XML format (application/sparql-results+xml) for SPARQL SELECT and ASK queries, or N-Triples format (application/n-triples) for CONSTRUCT and DESCRIBE queries. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SPARQL 1.1 Protocol", "url":"https://www.w3.org/TR/2013/REC-sparql11-protocol-20130321/" }, "parameters":[ { "in":"query", "name":"using-graph-uri", "required":false, "description":"A URL-encoded IRI identifying a named graph that should be included in the DEFAULT graph of the update dataset.", "schema":{ "type":"string" }, "example":"http%3A%2F%2Fwww.example.oracle.com%2Fg1" }, { "in":"query", "name":"using-named-graph-uri", "required":false, "description":"A URL-encoded IRI identifying a named graph that should be included in the set of named graphs for the update dataset.", "schema":{ "type":"string" }, "example":"http%3A%2F%2Fwww.example.oracle.com%2Fg1" }, { "in":"query", "name":"match_model", "required":false, "description":"The name of the model to evaluate the WHERE portion of a SPARQL update against. The default is the value of the modelName path parameter.", "schema":{ "type":"string" }, "example":"M2" }, { "in":"query", "name":"match_options", "required":false, "description":"The options string to use when evaluating the WHERE portion of a SPARQL update.", "schema":{ "type":"string" }, "example":"ALLOW_DUP=T" } ], "requestBody":{ "description":"A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters) or SPARQL update (exactly one update parameter, zero or more using-graph-uri parameters, and zero or more using-named-graph-uri parameters), or a direct POST request with an unencoded SPARQL query or update string in the message body to be used with optional default-graph-uri, named-graph-uri, using-graph-uri, and using-named-graph-uri query parameters in the request URL.", "content":{ "application/x-www-form-urlencoded":{ "schema":{ "description":"A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters) or SPARQL update (exactly one update parameter, zero or more using-graph-uri parameters, and zero or more using-named-graph-uri parameters)", "type":"string" }, "examples":{ "query":{ "value":"query=SELECT%20%3Fs%20%3Fp%20%3Fo%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%202\n" }, "update":{ "value":"update=PREFIX%20%3A%20%3Chttp%3A%2F%2Fwww.example.oracle.com%2F%3E%0AINSERT%20DATA%20%7B%0A%20%20%3Ajohn%20%3Afname%20%22John%22%40en%20%3B%0A%20%20%20%20%20%20%20%20%20%20%20%3Alname%20%22Smith%22%40en%20%3B%0A%20%20%20%20%20%20%20%20%20%20%20%3Adept%20%3Asales%20%3B%0A%20%20%20%20%20%20%20%20%20%20%20%3Ajob%20%3Aconsultant%20.%0A%7D\n" } } }, "application/sparql-query":{ "schema":{ "description":"An unencoded SPARQL query string", "type":"string" }, "examples":{ "select":{ "value":"SELECT ?s ?p ?o\nWHERE { ?s ?p ?o }\nORDER BY ?s ?p ?o\nLIMIT 2\n" }, "construct":{ "value":"PREFIX : \nCONSTRUCT { ?s ?p ?o }\nWHERE {\n ?s ?p ?o\n FILTER (?s = :john)\n}\n" } } }, "application/sparql-update":{ "schema":{ "description":"An unencoded SPARQL update string", "type":"string" }, "examples":{ "insert data":{ "value":"PREFIX : \nINSERT DATA {\n :john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :dept :sales ;\n :job :consultant .\n}\n" }, "delete insert where":{ "value":"PREFIX : \nDELETE { :john :job ?job }\nINSERT { :john :job :manager }\nWHERE { :john :job ?job }\n" } } } } }, "responses":{ "200":{ "description":"Successful query or update execution.", "content":{ "application/sparql-results+xml":{ "schema":{ "$ref":"#/components/schemas/SparqlXmlResult" }, "examples":{ "select":{ "value":"\n\n \n \n \n \n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/dept\n \n \n http://www.example.oracle.com/sales\n \n \n \n \n http://www.example.oracle.com/john\n \n \n http://www.example.oracle.com/fname\n \n \n John\n \n \n \n\n" }, "ask":{ "value":"\n\n \n true\n\n" } } }, "application/sparql-results+json":{ "schema":{ "$ref":"#/components/schemas/SparqlJsonResult" }, "examples":{ "select":{ "value":"{\n \"head\": { \n \"vars\": [\"s\", \"p\", \"o\"] \n },\n \"results\": {\n \"bindings\": [\n { \n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/dept\"},\n \"o\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/sales\"}\n },\n {\n \"s\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/john\"},\n \"p\": {\"type\": \"uri\", \"value\": \"http://www.example.oracle.com/fname\"},\n \"o\": {\"type\": \"literal\", \"value\": \"John\", \"xml:lang\": \"en\"}\n }\n ]\n }\n}\n" }, "ask":{ "value":"{ \n \"head\": {}, \n \"boolean\": true \n}\n" } } }, "application/n-triples":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 N-Triples", "url":"https://www.w3.org/TR/n-triples/" }, "type":"string" }, "examples":{ "construct":{ "value":" .\n \"John\"@en .\n" } } } } } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql-1.1-post", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-sparql-1.1-post" } }, "/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql2sql/1.1":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "$ref":"#/components/parameters/ModelName" }, { "$ref":"#/components/parameters/DefaultGraphUri" }, { "$ref":"#/components/parameters/NamedGraphUri" }, { "$ref":"#/components/parameters/SparqlOptions" } ], "get":{ "tags":[ "RDF Graph" ], "summary":"Translate SPARQL to SQL", "description":"Returns the SQL translation for a SPARQL query. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.SPARQL_TO_SQL", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-sparql_to_sql.html" }, "parameters":[ { "in":"query", "name":"query", "required":true, "description":"A URL-encoded SPARQL query string.", "example":"SELECT%20%2A%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%2010", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "text/plain":{ "schema":{ "description":"The SQL translation of the submitted SPARQL query against the input RDF network and model.", "type":"string" }, "example":"SELECT * FROM (\nSELECT /*+ NO_MERGE(R) */ R.S, R.S$RDFVID, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFVTYP, R.S$RDFCLOB, R.S$RDFLTYP, R.S$RDFLANG,\nR.P, R.P$RDFVID, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFVTYP, R.P$RDFCLOB, R.P$RDFLTYP, R.P$RDFLANG,\nR.O, R.O$RDFVID, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFVTYP, R.O$RDFCLOB, R.O$RDFLTYP, R.O$RDFLANG,\nR.SEM$ROWNUM AS SEM$ROWNUM\nFROM (SELECT /*+ NO_MERGE(R) */ R.P$RDFVID, R.P, R.P$RDFVTYP, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFLTYP, R.P$RDFLANG, R.P$RDFCLOB, R.S$RDFVID, R.S, R.S$RDFVTYP, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFLTYP, R.S$RDFLANG, R.S$RDFCLOB, R.O$RDFVID, R.O, R.O$RDFVTYP, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFLTYP, R.O$RDFLANG, R.O$RDFCLOB, ROWNUM AS SEM$ROWNUM\nFROM (\nSELECT V0.VNAME_PREFIX || V0.VNAME_SUFFIX AS P, V0.VALUE_ID AS P$RDFVID, V0.VNAME_PREFIX AS P$_PREFIX, V0.VNAME_SUFFIX AS P$_SUFFIX, (CASE WHEN V0.VALUE_TYPE IS NULL THEN NULL WHEN V0.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V0.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS P$RDFVTYP, TO_CLOB(NULL) AS P$RDFCLOB, V0.LITERAL_TYPE AS P$RDFLTYP, V0.LANGUAGE_TYPE AS P$RDFLANG,\nV1.VNAME_PREFIX || V1.VNAME_SUFFIX AS S, V1.VALUE_ID AS S$RDFVID, V1.VNAME_PREFIX AS S$_PREFIX, V1.VNAME_SUFFIX AS S$_SUFFIX, (CASE WHEN V1.VALUE_TYPE IS NULL THEN NULL WHEN V1.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V1.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS S$RDFVTYP, TO_CLOB(NULL) AS S$RDFCLOB, V1.LITERAL_TYPE AS S$RDFLTYP, V1.LANGUAGE_TYPE AS S$RDFLANG,\nV2.VNAME_PREFIX || V2.VNAME_SUFFIX AS O, V2.VALUE_ID AS O$RDFVID, V2.VNAME_PREFIX AS O$_PREFIX, V2.VNAME_SUFFIX AS O$_SUFFIX, (CASE WHEN V2.VALUE_TYPE IS NULL THEN NULL WHEN V2.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V2.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS O$RDFVTYP, V2.LONG_VALUE AS O$RDFCLOB, V2.LITERAL_TYPE AS O$RDFLTYP, V2.LANGUAGE_TYPE AS O$RDFLANG\nFROM (\nSELECT T0.P_VALUE_ID AS P$RDFVID,\nT0.START_NODE_ID AS S$RDFVID,\nT0.CANON_END_NODE_ID AS O$RDFVID,\nT0.START_NODE_ID AS BGP$1\nFROM (\nSELECT * FROM \"RDFUSER\".NET1#RDFM_M1) T0\nWHERE (1=1)\n) R\n, \"RDFUSER\".NET1#RDF_VALUE$ V0, \"RDFUSER\".NET1#RDF_VALUE$ V1, \"RDFUSER\".NET1#RDF_VALUE$ V2\nWHERE (1=1) AND (R.P$RDFVID = V0.VALUE_ID) AND (R.S$RDFVID = V1.VALUE_ID) AND (R.O$RDFVID = V2.VALUE_ID)\n ORDER BY V1.ORDER_TYPE ASC NULLS FIRST, V1.ORDER_NUM ASC NULLS FIRST, V1.ORDER_DATE ASC NULLS FIRST,\n(V1.VNAME_PREFIX || V1.VNAME_SUFFIX) ASC NULLS FIRST,\nV0.ORDER_TYPE ASC NULLS FIRST, V0.ORDER_NUM ASC NULLS FIRST, V0.ORDER_DATE ASC NULLS FIRST,\n(V0.VNAME_PREFIX || V0.VNAME_SUFFIX) ASC NULLS FIRST,\nV2.ORDER_TYPE ASC NULLS FIRST, V2.ORDER_NUM ASC NULLS FIRST, V2.ORDER_DATE ASC NULLS FIRST,\n(V2.VNAME_PREFIX || V2.VNAME_SUFFIX) ASC NULLS FIRST\n) R\nWHERE (1=1) AND ROWNUM <= 10) R\nWHERE (1=1) AND ROWNUM <= 10\n) WHERE (1=1)\n" } } } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql2sql-1.1-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-sparql2sql-1.1-get" }, "post":{ "tags":[ "RDF Graph" ], "summary":"Translate SPARQL to SQL", "description":"Returns the SQL translation for a SPARQL query. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SEM_APIS.SPARQL_TO_SQL", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/sem_apis-sparql_to_sql.html" }, "requestBody":{ "description":"A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters), or a direct POST request with an unencoded SPARQL querystring in the message body to be used with optional default-graph-uri and named-graph-uri query parameters in the request URL.", "content":{ "application/x-www-form-urlencoded":{ "schema":{ "description":"A POST request with URL-encoded, ampersand-separated query parameters for SPARQL query (exactly one query parameter, zero or more named-graph-uri parameters, and zero or more default-graph-uri parameters)", "type":"string" }, "examples":{ "query":{ "value":"query=SELECT%20%3Fs%20%3Fp%20%3Fo%0AWHERE%20%7B%20%3Fs%20%3Fp%20%3Fo%20%7D%0AORDER%20BY%20%3Fs%20%3Fp%20%3Fo%0ALIMIT%202\n" } } }, "application/sparql-query":{ "schema":{ "description":"An unencoded SPARQL query string", "type":"string" }, "examples":{ "select":{ "value":"SELECT ?s ?p ?o\nWHERE { ?s ?p ?o }\nORDER BY ?s ?p ?o\nLIMIT 2\n" }, "construct":{ "value":"PREFIX : \nCONSTRUCT { ?s ?p ?o }\nWHERE {\n ?s ?p ?o\n FILTER (?s = :john)\n}\n" } } } } }, "responses":{ "200":{ "description":"Success", "content":{ "text/plain":{ "schema":{ "description":"The SQL translation of the submitted SPARQL query against the input RDF network and model.", "type":"string" }, "example":"SELECT * FROM (\nSELECT /*+ NO_MERGE(R) */ R.S, R.S$RDFVID, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFVTYP, R.S$RDFCLOB, R.S$RDFLTYP, R.S$RDFLANG,\nR.P, R.P$RDFVID, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFVTYP, R.P$RDFCLOB, R.P$RDFLTYP, R.P$RDFLANG,\nR.O, R.O$RDFVID, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFVTYP, R.O$RDFCLOB, R.O$RDFLTYP, R.O$RDFLANG,\nR.SEM$ROWNUM AS SEM$ROWNUM\nFROM (SELECT /*+ NO_MERGE(R) */ R.P$RDFVID, R.P, R.P$RDFVTYP, R.P$_PREFIX, R.P$_SUFFIX, R.P$RDFLTYP, R.P$RDFLANG, R.P$RDFCLOB, R.S$RDFVID, R.S, R.S$RDFVTYP, R.S$_PREFIX, R.S$_SUFFIX, R.S$RDFLTYP, R.S$RDFLANG, R.S$RDFCLOB, R.O$RDFVID, R.O, R.O$RDFVTYP, R.O$_PREFIX, R.O$_SUFFIX, R.O$RDFLTYP, R.O$RDFLANG, R.O$RDFCLOB, ROWNUM AS SEM$ROWNUM\nFROM (\nSELECT V0.VNAME_PREFIX || V0.VNAME_SUFFIX AS P, V0.VALUE_ID AS P$RDFVID, V0.VNAME_PREFIX AS P$_PREFIX, V0.VNAME_SUFFIX AS P$_SUFFIX, (CASE WHEN V0.VALUE_TYPE IS NULL THEN NULL WHEN V0.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V0.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS P$RDFVTYP, TO_CLOB(NULL) AS P$RDFCLOB, V0.LITERAL_TYPE AS P$RDFLTYP, V0.LANGUAGE_TYPE AS P$RDFLANG,\nV1.VNAME_PREFIX || V1.VNAME_SUFFIX AS S, V1.VALUE_ID AS S$RDFVID, V1.VNAME_PREFIX AS S$_PREFIX, V1.VNAME_SUFFIX AS S$_SUFFIX, (CASE WHEN V1.VALUE_TYPE IS NULL THEN NULL WHEN V1.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V1.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS S$RDFVTYP, TO_CLOB(NULL) AS S$RDFCLOB, V1.LITERAL_TYPE AS S$RDFLTYP, V1.LANGUAGE_TYPE AS S$RDFLANG,\nV2.VNAME_PREFIX || V2.VNAME_SUFFIX AS O, V2.VALUE_ID AS O$RDFVID, V2.VNAME_PREFIX AS O$_PREFIX, V2.VNAME_SUFFIX AS O$_SUFFIX, (CASE WHEN V2.VALUE_TYPE IS NULL THEN NULL WHEN V2.VALUE_TYPE IN ('UR','URI') THEN 'URI'\n WHEN V2.VALUE_TYPE IN ('BN', 'BLN') THEN 'BLN'\n ELSE 'LIT'\nEND) AS O$RDFVTYP, V2.LONG_VALUE AS O$RDFCLOB, V2.LITERAL_TYPE AS O$RDFLTYP, V2.LANGUAGE_TYPE AS O$RDFLANG\nFROM (\nSELECT T0.P_VALUE_ID AS P$RDFVID,\nT0.START_NODE_ID AS S$RDFVID,\nT0.CANON_END_NODE_ID AS O$RDFVID,\nT0.START_NODE_ID AS BGP$1\nFROM (\nSELECT * FROM \"RDFUSER\".NET1#RDFM_M1) T0\nWHERE (1=1)\n) R\n, \"RDFUSER\".NET1#RDF_VALUE$ V0, \"RDFUSER\".NET1#RDF_VALUE$ V1, \"RDFUSER\".NET1#RDF_VALUE$ V2\nWHERE (1=1) AND (R.P$RDFVID = V0.VALUE_ID) AND (R.S$RDFVID = V1.VALUE_ID) AND (R.O$RDFVID = V2.VALUE_ID)\n ORDER BY V1.ORDER_TYPE ASC NULLS FIRST, V1.ORDER_NUM ASC NULLS FIRST, V1.ORDER_DATE ASC NULLS FIRST,\n(V1.VNAME_PREFIX || V1.VNAME_SUFFIX) ASC NULLS FIRST,\nV0.ORDER_TYPE ASC NULLS FIRST, V0.ORDER_NUM ASC NULLS FIRST, V0.ORDER_DATE ASC NULLS FIRST,\n(V0.VNAME_PREFIX || V0.VNAME_SUFFIX) ASC NULLS FIRST,\nV2.ORDER_TYPE ASC NULLS FIRST, V2.ORDER_NUM ASC NULLS FIRST, V2.ORDER_DATE ASC NULLS FIRST,\n(V2.VNAME_PREFIX || V2.VNAME_SUFFIX) ASC NULLS FIRST\n) R\nWHERE (1=1) AND ROWNUM <= 2) R\nWHERE (1=1) AND ROWNUM <= 2\n) WHERE (1=1)\n" } } } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-sparql2sql-1.1-post", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-sparql2sql-1.1-post" } }, "/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/graph_store/1.1":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "in":"path", "name":"model_name", "required":true, "description":"The name of the RDF model.", "schema":{ "type":"string" }, "example":"M1" }, { "in":"query", "name":"graph", "required":false, "description":"A URL-encoded named graph URI", "schema":{ "type":"string" }, "example":"http%3A%2F%2Fwww.example.oracle.com%2Fg1" }, { "in":"query", "name":"default", "required":false, "allowEmptyValue":true, "description":"An empty-valued parameter that signifies the default graph.", "schema":{ "type":"string" } } ], "get":{ "tags":[ "RDF Graph" ], "summary":"Get a graph", "description":"Retrieves an RDF payload that is the serialization of the requested named graph or default graph. A client requires SQL Developer, RDF Developer or RDF Reader role to invoke this servce.", "externalDocs":{ "description":"SPARQL 1.1 Graph Store HTTP Protocol", "url":"https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/" }, "responses":{ "200":{ "description":"Success", "content":{ "application/n-triples":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 N-Triples", "url":"https://www.w3.org/TR/n-triples/" }, "type":"string" }, "example":" \"John\"@en .\n \"Smith\"@en .\n .\n .\n" } } } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-get" }, "post":{ "tags":[ "RDF Graph" ], "summary":"Append a graph", "description":"Appends the RDF content in the request payload to the target named graph or default graph. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SPARQL 1.1 Graph Store HTTP Protocol", "url":"https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/" }, "requestBody":{ "description":"An RDF payload", "content":{ "application/n-triples":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 N-Triples", "url":"https://www.w3.org/TR/n-triples/" }, "type":"string" }, "example":" \"John\"@en .\n \"Smith\"@en .\n .\n .\n" }, "text/turtle":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 Turtle", "url":"https://www.w3.org/TR/turtle/" }, "type":"string" }, "example":"@prefix : .\n:john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n" }, "application/trig":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 TriG", "url":"https://www.w3.org/TR/trig/" }, "type":"string" }, "example":"@prefix : .\n{\n :john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n}\n" } } }, "responses":{ "200":{ "description":"Success" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-post", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-post" }, "put":{ "tags":[ "RDF Graph" ], "summary":"Replace a graph", "description":"Deletes all triples in the target named graph or defaut graph and replaces its content with the RDF content in the request payload. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SPARQL 1.1 Graph Store HTTP Protocol", "url":"https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/" }, "requestBody":{ "description":"An RDF payload", "content":{ "application/n-triples":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 N-Triples", "url":"https://www.w3.org/TR/n-triples/" }, "type":"string" }, "example":" \"John\"@en .\n \"Smith\"@en .\n .\n .\n" }, "text/turtle":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 Turtle", "url":"https://www.w3.org/TR/turtle/" }, "type":"string" }, "example":"@prefix : .\n:john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n" }, "application/trig":{ "schema":{ "externalDocs":{ "description":"RDF 1.1 TriG", "url":"https://www.w3.org/TR/trig/" }, "type":"string" }, "example":"@prefix : .\n{\n :john :fname \"John\"@en ;\n :lname \"Smith\"@en ;\n :job :consultant ;\n :dept: :sales .\n}\n" } } }, "responses":{ "200":{ "description":"Success" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-put", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-put" }, "delete":{ "tags":[ "RDF Graph" ], "summary":"Delete a graph", "description":"Deletes all triples in the target named graph or defaut graph. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"SPARQL 1.1 Graph Store HTTP Protocol", "url":"https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/" }, "responses":{ "204":{ "description":"Success" } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-graph_store-1.1-delete", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-graph_store-1.1-delete" } }, "/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/search":{ "parameters":[ { "$ref":"#/components/parameters/NetworkOwner" }, { "$ref":"#/components/parameters/NetworkName" }, { "$ref":"#/components/parameters/ModelName" }, { "in":"query", "name":"search_string", "required":true, "description":"Full text search string", "schema":{ "type":"string" }, "example":"software" }, { "in":"query", "name":"index_scan_limit", "required":false, "description":"The number of results to return from the initial text index scan (note that this is a random set of the first N rows - not an ordered set of rows based on top N scores). The default value is 5000. Use a value of 0 for an unlimited number of results from the index scan.", "example":1000, "schema":{ "type":"integer", "format":"int32" } }, { "in":"query", "name":"max_objs_per_search_string", "required":false, "description":"The maximum number of distinct object values allowed to match the search string. The default value is 100.", "example":50, "schema":{ "type":"integer", "format":"int32" } }, { "in":"query", "name":"max_results_per_pred_obj", "required":false, "description":"The maximum number of results allowed for a single (predicate, object) combination. The default value is 25.", "example":50, "schema":{ "type":"integer", "format":"int32" } }, { "in":"query", "name":"max_results_per_sub", "required":false, "description":"The maximum number of results allowed for a single subject. The default value is 25.", "example":50, "schema":{ "type":"integer", "format":"int32" } }, { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Offset" } ], "get":{ "tags":[ "RDF Graph" ], "summary":"Execute full text search", "description":"Performs a full text search over RDF data. Finds subject resources with property values that match the search string. A full text index must be created on the target RDF network before this service can be used. A client requires SQL Developer or RDF Developer role to invoke this servce.", "externalDocs":{ "description":"RDF Full Text Search", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/using-sem_match-table-function-query-rdf-data.html#GUID-7001881A-9DE6-4F3D-8593-F31F2004FE37" }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RDFTextSearchResultCollection" }, "example":"{\n \"items\": [\n {\n \"sub\": \"http://example.oracle.com/oracle_corporation\",\n \"vals\": \"third largest software company in the world... a suite of enterprise software products\",\n \"score\": \"14\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1/sparql/1.1?query=DESCRIBE%20%3Chttp%3A%2F%2Fexample.oracle.com%2Foracle_corporation%3E\"\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://server:port/ords/rdfuser/_/db-api/stable/database/rdf/networks/rdfuser,net1/models/m1/search?search_string=software&index_scan_limit=5000&max_objs_per_search_string=100&max_results_per_pred_obj=25&max_results_per_sub=25&offset=0&limit=25\"\n }\n ]\n}\n" } } } }, "x-internal-id":"database-rdf-networks-{network_owner},{network_name}-models-{model_name}-search-get", "x-filename-id":"database-rdf-networks-network_owner-network_name-models-model_name-search-get" } }, "/database/scheduler/jobs/":{ "get":{ "tags":[ "Scheduler" ], "summary":"Get all Oracle Scheduler jobs", "description":"Returns records from DBA_SCHEDULER_JOBS or ALL_SCHEDULER_JOBS view depending on the role at runtime. This service requires db.cdb.adminUser credentials to be set in the pool configuration. 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 jobs in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SchedulerJobs" } } } } }, "x-internal-id":"database-scheduler-jobs--get", "x-filename-id":"database-scheduler-jobs-get" } }, "/database/scheduler/jobs/{owner},{job_name}":{ "get":{ "tags":[ "Scheduler" ], "summary":"Get a specific Oracle Scheduler job", "description":"Returns specific record from DBA_SCHEDULER_JOBS or ALL_SCHEDULER_JOBS view depending on the role at runtime. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator or SQL Developer role to invoke this service.", "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job.", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of the job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information on the specific scheduler job in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SchedulerJobsItem" } } } } }, "x-internal-id":"database-scheduler-jobs-{owner},{job_name}-get", "x-filename-id":"database-scheduler-jobs-owner-job_name-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/sessionless-transactions/":{ "post":{ "tags":[ "General" ], "summary":"Start a sessionless transaction", "description":"Start a new sessionless transaction.", "responses":{ "200":{ "description":"Transaction started successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransactionResponse" }, "example":{ "gtrid":"de9b1f488f4244e39580987547d63e8d", "status":"Start transaction" } } } }, "400":{ "description":"Sessionless transactions are not supported" } }, "x-internal-id":"database-sessionless-transactions--post", "x-filename-id":"database-sessionless-transactions-post" } }, "/database/sessionless-transactions/{sessionlessTransactionID}":{ "put":{ "tags":[ "General" ], "summary":"Commit a sessionless transaction", "description":"Commit a sessionless transaction with the specified ID.", "parameters":[ { "name":"sessionlessTransactionID", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Transaction committed successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransactionResponse" }, "example":{ "gtrid":"de9b1f488f4244e39580987547d63e8d", "status":"Committed" } } } }, "400":{ "description":"Sessionless transactions are not supported or the transaction does not exist" } }, "x-internal-id":"database-sessionless-transactions-{sessionlessTransactionID}-put", "x-filename-id":"database-sessionless-transactions-sessionlesstransactionid-put" }, "delete":{ "tags":[ "General" ], "summary":"Rollback a sessionless transaction", "description":"Rollback a sessionless transaction with the specified ID.", "parameters":[ { "name":"sessionlessTransactionID", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Transaction rolled back successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransactionResponse" }, "example":{ "gtrid":"de9b1f488f4244e39580987547d63e8d", "status":"Rolled Back" } } } }, "400":{ "description":"Sessionless transactions are not supported or the transaction does not exist" } }, "x-internal-id":"database-sessionless-transactions-{sessionlessTransactionID}-delete", "x-filename-id":"database-sessionless-transactions-sessionlesstransactionid-delete" } }, "/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 storage data", "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 storage for a specific 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/txeventq/topics":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get all Transactional Event Queue Topics in the schema", "description":"This API is compiant witht the Confluent Kafka API. Get a list of Transactional Event Queue Topics defined. A client requires SQL Developer role to invoke this service. Database user requires EXECUTE on DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"List of Transactional Event Queue Topics.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "x-internal-id":"database-txeventq-topics-get", "x-filename-id":"database-txeventq-topics-get" } }, "/database/txeventq/topics/{topic_name}":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Produce a message to the Transactional Event Queue Topic specified by topic_name", "description":"Produce a message to the topic specified by topic_name with a key and value. Optionally, specify a partition to produce the message in. If no partition is specified one is automatically chosen. A client requires SQL Developer role to invoke this service. Database user requires Execute privilege on DBMS_AQ, DBMS_AQADM and OWA_UTIL packages. Topic must belong to Database User's schema.", "responses":{ "201":{ "description":"The successfully created record." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Produce Messages in Topic":{ "summary":"This API produces messages in Topic", "value":{ "records":[ { "key":"color", "value":"red", "partition":5 }, { "key":7, "value":77 } ] } } } } } } }, "parameters":[ { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-topics-{topic_name}-post", "x-filename-id":"database-txeventq-topics-topic_name-post" }, "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get description of a particular Transactional Event Queue Topic.", "description":"Get description of a particular topic. A client requires SQL Developer role to invoke this service. Database user requires READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"Topic Description" } }, "parameters":[ { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-topics-{topic_name}-get", "x-filename-id":"database-txeventq-topics-topic_name-get" } }, "/database/txeventq/clusters/{cluster_id}/consumer-groups":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get Consumer Groups in Cluster", "description":"Returns the list of consumer groups that belong to the specified cluster. A client requires SQL Developer role to invoke this service.", "responses":{ "200":{ "description":"Consmer Group Description" } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-get", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-get" } }, "/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Create a Consumer Group", "description":"Create a new consumer consumer group in the specified Cluster Id. A client requires SQL Developer role to invoke this service. Database user requires Execute privilege on DBMS_AQADM and OWA_UTIL packages and the Topic must be created in the Database User's' schema.", "responses":{ "201":{ "description":"Successfully created Consumer Group." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Create a Consumer Group":{ "summary":"This API creates a Consumer Group in Topic", "value":{ "topic_name":"myTopic" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"consumer_group_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"Topic", "in":"header", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-{consumer_group_id}-post", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-consumer_group_id-post" }, "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get a Consumer Group", "description":"Get the consumer group specified by the consumer_group_id.", "responses":{ "200":{ "description":"The Consumer Group" } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"consumer_group_id", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-{consumer_group_id}-get", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-consumer_group_id-get" }, "delete":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Delete a Consumer Group", "description":"Delete consumer consumer group in the specified Cluster Id. A client requires SQL Developer role to invoke this service. Database User requires Execute privilege on DBMS_AQADM and OWA_UTIL packages and the Topic must have been created in Database User's schema.", "responses":{ "200":{ "description":"Deleted Consumer Group." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Delete a Consumer Group":{ "summary":"This API deletes a Consumer Group in Topic", "value":{ "topic_name":"myTopic" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"consumer_group_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"Topic", "in":"header", "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-{consumer_group_id}-delete", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-consumer_group_id-delete" } }, "/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get lag summary for Consumer Groups in Cluster", "description":"Gets the max and total lag of the consumers in the specified consumer group. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"The Consumer Group Lag Summary." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"consumer_group_id", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-{consumer_group_id}-lag-summary-get", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-consumer_group_id-lag-summary-get" } }, "/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Lags/Offsets of consumers in the Consumer group ", "description":"Gets a list of Current/Log-End Offsets and Lag of consumers belonging to the specified consumer group. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"The Consumer Lag and Offsets" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"consumer_group_id", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-{consumer_group_id}-lags-get", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-consumer_group_id-lags-get" } }, "/database/txeventq/clusters/{cluster_id}/topics":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Create a new Transactional Event Queue Topic", "description":"Create a new Topic. A client requires SQL Developer role to invoke this service. Database User requires Execute privilege on DBMS_AQADM and OWA_UTIL packages as well as Resource and Unlimited Tablespace privileges.", "responses":{ "201":{ "description":"The successfully created topic." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Create a Topic":{ "summary":"This API creates a Topic", "value":{ "topic_name":"myTopic", "partitions_count":"10" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"header", "required":true, "schema":{ "type":"string" } }, { "name":"partitions_count", "in":"header", "required":true, "schema":{ "type":"integer" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-topics-post", "x-filename-id":"database-txeventq-clusters-cluster_id-topics-post" }, "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"List Transactional Event Queue Topics that belong to the specified database cluster", "description":"List topics that belong to the specified database cluster. A client requires SQL Developer role to invoke this service. Database User requires Execute privilege on DBMS_AQADM and OWA_UTIL packages and READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"Topics in Cluster" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-topics-get", "x-filename-id":"database-txeventq-clusters-cluster_id-topics-get" } }, "/database/txeventq/clusters/{cluster_id}/topics/{topic_name}":{ "delete":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Delete the Transactional Event Queue Topic with the specified topic_name", "description":"Delete the topic with the specified topic_name. A client requires SQL Developer role to invoke this service. Database User requires Execute privilege on DBMS_AQADM and OWA_UTIL packages and the Topic must have been created in the database user's schema.", "responses":{ "200":{ "description":"Deleted topic." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-topics-{topic_name}-delete", "x-filename-id":"database-txeventq-clusters-cluster_id-topics-topic_name-delete" }, "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Describes Transactional Event Queue Topic in Cluster", "description":"Get a full description of the topic specified by the topic_name. A client requires SQL Developer role to invoke this service. Database User requires to have READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"The topic specified." } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-topics-{topic_name}-get", "x-filename-id":"database-txeventq-clusters-cluster_id-topics-topic_name-get" } }, "/database/txeventq/clusters/{cluster_id}/topics/{topic_name}/partitions":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"List Partitions for a Transactional Event Queue Topic in Cluster", "description":"Get all the partitions that belong to a specified topic. A client requires SQL Developer role to invoke this service. Database User requires READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"The topic partitions." } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-topics-{topic_name}-partitions-get", "x-filename-id":"database-txeventq-clusters-cluster_id-topics-topic_name-partitions-get" } }, "/database/txeventq/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Describe Transactional Event Queue Topic Partition specified in Cluster", "description":"Get the partition with a specified partition_id for the specified Topic in cluster. A client requires SQL Developer role to invoke this service. Database User requires READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"The specified Topic Partition" } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"partition_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-topics-{topic_name}-partitions-{partition_id}-get", "x-filename-id":"database-txeventq-clusters-cluster_id-topics-topic_name-partitions-partition_id-get" } }, "/database/txeventq/consumers/{group_name}":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Create Consumer Instance", "description":"Create a new consumer instance in the consumer group. Database user requires SQL Developer role and EXECUTE privilege on OWA_UTIL package to invoke this service. The database user also requires SELECT privilege on V_$SESSION to perform this operation.", "responses":{ "201":{ "description":"Created consumer instance" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Create Consumer Instance":{ "summary":"This create a Consumer Instance in a Consumer Group", "value":{ "name":"MY-Consumer-Instance" } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-post", "x-filename-id":"database-txeventq-consumers-group_name-post" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}":{ "delete":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Delete Consumer Instance", "description":"Delete the consumer instance. A client requires SQL Developer role to invoke this service. Also EXECUTE privilege on OWA_UTIL package.", "responses":{ "204":{ "description":"Deleted Consumer Instance." }, "404":{ "description":"Not Found.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-delete", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-delete" } }, "/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get consumer lag for Transactional Event Queue Topic Partition", "description":"Get the consumer lag on a specified partition in a topic. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"Consumer-Group lag for Partition" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"cluster_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"consumer_group_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"partition_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-clusters-{cluster_id}-consumer-groups-{consumer_group_id}-lags-{topic_name}-partitions-{partition_id}-get", "x-filename-id":"database-txeventq-clusters-cluster_id-consumer-groups-consumer_group_id-lags-topic_name-partitions-partition_id-get" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}/offsets":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get Consumer last Commit Offsets", "description":"Get the last committed offsets for the given partition. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"Consumer-Group Commit Offsets" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Consumer-Group Commit Offsets":{ "summary":"Get Consumer's Commit Offsets", "value":{ "partitions":[ { "topic":"myTopic1", "partition":0 }, { "topic":"myTopic2", "partition":3 } ] } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"List of Topic and Partition", "in":"query", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-offsets-get", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-offsets-get" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}/positions":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Seek to specified Transactional Event Queue Topic partition offsets for Consumer Group", "description":"Seek to the offsets for each of the Topic partition. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQ, DBMS_AQADM and OWA_UTIL packages. Also needs READ privilege on V$DATABASE and V$TRANSPORTABLE_PLATFORM.", "responses":{ "201":{ "description":"Moved Consumer offset to specified position" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Move Consumer Offset":{ "summary":"Move Consumer position to specified offset in Partition", "value":{ "offsets":[ { "topic":"myTopic", "partition":0, "offset":2 } ] } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-positions-post", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-positions-post" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}/positions/beginning":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Seek to start of Partitions for Consumer Group", "description":"Seek to the beginning offset for each of the given partitions. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQ and OWA_UTIL packages.", "responses":{ "201":{ "description":"Moved Consumer offset to start of the Partitions specified." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Move Consumer Offset to the Start of Partition":{ "summary":"Move Consumer position to the start of specified Partitions", "value":{ "partitions":[ { "topic":"myTopic", "partition":4 } ] } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-positions-beginning-post", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-positions-beginning-post" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}/positions/end":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Seek to End of Partitions for Consumer Group", "description":"Seek to the End offset for each of the given partitions. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQ and OWA_UTIL packages.", "responses":{ "201":{ "description":"Moved Consumer offset to end of the Partitions specified " }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Move Consumer Offset to the end of Partition":{ "summary":"Move Consumer position to the end of specified Partitions", "value":{ "partitions":[ { "topic":"myTopic", "partition":4 } ] } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-positions-end-post", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-positions-end-post" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}/records":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Fetch messages for the specified Consumer", "description":"Fetch messages for the specified Consumer in Consumer Group from Topics its Subscribed to. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQ, DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"The fetched messages" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"Maximum Bytes of Records", "in":"query", "required":false, "schema":{ "type":"integer" } }, { "name":"Timeout in Milli Seconds", "in":"query", "required":false, "schema":{ "type":"integer" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-records-get", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-records-get" } }, "/database/txeventq/consumers/{group_name}/instances/{instance}/subscription":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Subscribed list of Transactional Event Queue Topics", "description":"Get the current subscribed list of topics for the consumer group instance. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQADM and OWA_UTIL packagse.", "responses":{ "200":{ "description":"The queried record." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"group_name", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"instance", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-consumers-{group_name}-instances-{instance}-subscription-get", "x-filename-id":"database-txeventq-consumers-group_name-instances-instance-subscription-get" } }, "/database/txeventq/topics/{topic_name}/partitions":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Describe Transactional Event Queue Topic Partitions", "description":"Get a list of partitions for the specified topic_name. A client requires SQL Developer role to invoke this service. Database User requires READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"The queried record." } }, "parameters":[ { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-topics-{topic_name}-partitions-get", "x-filename-id":"database-txeventq-topics-topic_name-partitions-get" } }, "/database/txeventq/topics/{topic_name}/partitions/{partition_id}":{ "post":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Produce messages in the specified Transactional Event Queue Topic Partition", "description":"Produce messages to the specified partition of the topic. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQ, DBMS_AQADM and OWA_UTIL packages.", "responses":{ "201":{ "description":"Produced messages to the specified partition of the topic" }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } }, "examples":{ "Produce Messages to a specified Partition":{ "summary":"Produce messages in the specified Partitions", "value":{ "records":[ { "key":99, "value":9999 } ] } } } } } } }, "parameters":[ { "name":"partition_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-topics-{topic_name}-partitions-{partition_id}-post", "x-filename-id":"database-txeventq-topics-topic_name-partitions-partition_id-post" }, "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Describe the specified Transactional Event Queue Topic Partition", "description":"Get metadata details of a specified partition in the topic. A client requires SQL Developer role to invoke this service. Database User requires READ privilege on USER_QUEUE_SHARDS.", "responses":{ "200":{ "description":"The Topic Partition Metadata." } }, "parameters":[ { "name":"partition_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-topics-{topic_name}-partitions-{partition_id}-get", "x-filename-id":"database-txeventq-topics-topic_name-partitions-partition_id-get" } }, "/database/txeventq/topics/{topic_name}/partitions/{partition_id}/offsets":{ "get":{ "tags":[ "Oracle Transactional Event Queues" ], "summary":"Get Transactional Event Queue Topic Partition Offsets", "description":"Get the first and last offset in the specified partition. A client requires SQL Developer role to invoke this service. Database User requires EXECUTE privilege on DBMS_AQADM and OWA_UTIL packages.", "responses":{ "200":{ "description":"The Topic Partition Offsets." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "SQL ERROR MESSAGE":{ "type":"string" } } } } } } }, "parameters":[ { "name":"partition_id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"topic_name", "in":"path", "required":true, "schema":{ "type":"string" } } ], "x-internal-id":"database-txeventq-topics-{topic_name}-partitions-{partition_id}-offsets-get", "x-filename-id":"database-txeventq-topics-topic_name-partitions-partition_id-offsets-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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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" } }, "/database/snapshots/":{ "get":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"get all snapshots of the current pluggable databases", "description":"Returns all snapshot record. A client requires SQL Administrator role to invoke this service.", "responses":{ "201":{ "description":"Pdb snapshot in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotItem" } } } } }, "x-internal-id":"database-snapshots--get", "x-filename-id":"database-snapshots-get" }, "post":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"Create snapshot of the current pluggable databases, the name will be generated", "description":"Returns created snapshot record. A client requires SQL Administrator role to invoke this service.", "responses":{ "201":{ "description":"PDB snapshot in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotItem" } } } } }, "x-internal-id":"database-snapshots--post", "x-filename-id":"database-snapshots-post" }, "put":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"Configure automatic PDB snapshots.", "description":"Configure max snapshot and snapshot mode for the current PDB.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "maxSnapshot", "snapshotMode" ], "properties":{ "maxSnapshot":{ "type":"integer", "description":"Setting the maximum number of snapshots. 0 will drop all snapshots.", "enum":[ "CREATE", "PLUG" ] }, "snapshotMode":{ "type":"string", "description":"Configure automatic PDB snapshots. it can be NONE, MANUAL or every n hours/minutes." } } }, "examples":{ "set_max_snapshot":{ "summary":"This is an example request body to configure PDB snapshot", "value":{ "maxSnapshot":"8" } }, "set_snapshot_max_mode":{ "summary":" This is an example request body to configure PDB snapshot", "value":{ "maxSnapshot":"8", "snapshotMode":"every 20 hours" } } } } } }, "responses":{ "204":{ "description":"Confirmation that snapshot setting has been updated." } }, "x-internal-id":"database-snapshots--put", "x-filename-id":"database-snapshots-put" } }, "/database/snapshots/{snapshot_name}":{ "get":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"Get specific snapshot based on the name in current PDB", "description":"Returns a specific snapshot record. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"snapshot_name", "in":"path", "description":"Snapshot Name.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "201":{ "description":"PDB snapshot in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotWithFileItem" } } } } }, "x-internal-id":"database-snapshots-{snapshot_name}-get", "x-filename-id":"database-snapshots-snapshot_name-get" }, "post":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"Create snapshot of the current pluggable databases, the name will be {snapshotName}", "description":"Returns created snapshot record. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"snapshot_name", "in":"path", "description":"Snapshot Name.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "201":{ "description":"PDB snapshot in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotItem" } } } } }, "x-internal-id":"database-snapshots-{snapshot_name}-post", "x-filename-id":"database-snapshots-snapshot_name-post" }, "delete":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"Delete the specified snapshot", "description":"Delete specified snapshot by snapshot name, A client requires System Administrator role to invoke this service.", "parameters":[ { "name":"snapshot_name", "in":"path", "description":"Snapshot Name.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the snapshot has been delete." } }, "x-internal-id":"database-snapshots-{snapshot_name}-delete", "x-filename-id":"database-snapshots-snapshot_name-delete" } }, "/database/snapshot_mode":{ "get":{ "tags":[ "Pluggable Database Snapshot Carousel" ], "summary":"Get snapshot mode in current PDB", "description":"Returns a snapshot mode. A client requires SQL Administrator role to invoke this service.", "responses":{ "201":{ "description":"PDB snapshot mode in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotModeItem" } } } } }, "x-internal-id":"database-snapshot_mode-get", "x-filename-id":"database-snapshot_mode-get" } }, "/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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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.The implementation is only available for Unix based operating systems.", "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.The implementation is only available for Unix based operating systems.", "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.The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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. The implementation is only available for Unix based operating systems.", "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" } }, "/data-tools/data-loads/":{ "post":{ "description":"Creates data load jobs", "operationId":"createDataLoadJobs", "tags":[ "Data Tools" ], "parameters":[ ], "requestBody":{ "$ref":"#/components/requestBodies/data-loads" }, "responses":{ "201":{ "$ref":"#/components/responses/data-load-job-ids", "description":"Data Load Jobs Created" }, "204":{ "description":"No content" } }, "summary":"Creates data load jobs", "x-internal-id":"data-tools-data-loads--post", "x-filename-id":"data-tools-data-loads-post" }, "get":{ "description":"Gets data load jobs", "operationId":"getDataLoadJobs", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "200":{ "$ref":"#/components/responses/data-load-statuses" }, "204":{ "description":"No jobs found" } }, "summary":"Gets data load jobs", "x-internal-id":"data-tools-data-loads--get", "x-filename-id":"data-tools-data-loads-get" } }, "/data-tools/data-loads/{owner},{data_load_job_id}":{ "get":{ "description":"Gets specific data load job", "operationId":"getDataLoadJob", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the data load.", "required":true, "schema":{ "type":"string" } }, { "name":"data_load_job_id", "in":"path", "description":"name of data load job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "200":{ "$ref":"#/components/responses/data-load-statuses" }, "404":{ "description":"Data Load Job not found" } }, "summary":"Gets specific data load job", "x-internal-id":"data-tools-data-loads-{owner},{data_load_job_id}-get", "x-filename-id":"data-tools-data-loads-owner-data_load_job_id-get" }, "delete":{ "description":"Delete data load job", "operationId":"deleteDataLoadJob", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the data load.", "required":true, "schema":{ "type":"string" } }, { "name":"data_load_job_id", "in":"path", "required":true, "style":"simple", "description":"Data load job ID to delete", "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Data load job deleted" }, "404":{ "description":"Data load job not found" } }, "summary":"Delete data load job", "x-internal-id":"data-tools-data-loads-{owner},{data_load_job_id}-delete", "x-filename-id":"data-tools-data-loads-owner-data_load_job_id-delete" } }, "/data-tools/data-loads/{owner},{data_load_job_id}/progress":{ "get":{ "description":"Gets progress of data load job", "operationId":"getDataLoadJobProgress", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the data load.", "required":true, "schema":{ "type":"string" } }, { "name":"data_load_job_id", "in":"path", "description":"name of data load job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "200":{ "$ref":"#/components/responses/data-load-statuses" }, "404":{ "description":"Data Load Job not found" } }, "summary":"Gets progress of data load job", "x-internal-id":"data-tools-data-loads-{owner},{data_load_job_id}-progress-get", "x-filename-id":"data-tools-data-loads-owner-data_load_job_id-progress-get" } }, "/data-tools/jobs/":{ "post":{ "description":"Creates a Data Tools job", "operationId":"createDataToolsJobs", "tags":[ "Data Tools" ], "parameters":[ ], "requestBody":{ "$ref":"#/components/requestBodies/data-tools-job" }, "responses":{ "201":{ "$ref":"#/components/responses/data-tools-job", "description":"Data Tools Job Created" }, "204":{ "description":"No content" } }, "summary":"Creates a Data Tools job", "x-internal-id":"data-tools-jobs--post", "x-filename-id":"data-tools-jobs-post" }, "get":{ "description":"Gets data tools jobs", "operationId":"getDataToolsJobs", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "200":{ "$ref":"#/components/responses/data-tools-jobs" }, "204":{ "description":"No jobs found" } }, "summary":"Gets data tools jobs", "x-internal-id":"data-tools-jobs--get", "x-filename-id":"data-tools-jobs-get" } }, "/data-tools/jobs/run":{ "post":{ "description":"Runs a Data Tools job", "operationId":"runDataToolsJobs", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-job", "description":"Data Tools Job started" }, "204":{ "description":"No content" } }, "summary":"Runs a Data Tools job", "x-internal-id":"data-tools-jobs-run-post", "x-filename-id":"data-tools-jobs-run-post" } }, "/data-tools/jobs/activity":{ "get":{ "description":"Gets Data Tools jobs activity", "operationId":"getDataToolsJobActivity", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Data Tools Jobs Activity" }, "204":{ "description":"No content" } }, "summary":"Gets Data Tools jobs activity", "x-internal-id":"data-tools-jobs-activity-get", "x-filename-id":"data-tools-jobs-activity-get" } }, "/data-tools/jobs/activity/{owner},{job_name}":{ "get":{ "description":"Checks specific Data Tools job activity", "operationId":"getDataToolsJobActivityByName", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Data Tools Jobs Activity" }, "204":{ "description":"No content" } }, "summary":"Checks specific Data Tools job activity", "x-internal-id":"data-tools-jobs-activity-{owner},{job_name}-get", "x-filename-id":"data-tools-jobs-activity-owner-job_name-get" } }, "/data-tools/jobs/activity/{owner},{job_name}/{id}":{ "get":{ "description":"Checks specific Data Tools job run activity", "operationId":"getDataToolsJobActivityById", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" }, { "name":"id", "in":"path", "description":"ID of job run to get", "required":true, "schema":{ "type":"number" }, "style":"simple" } ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Data Tools Jobs Activity" }, "204":{ "description":"No content" } }, "summary":"Checks specific Data Tools job run activity", "x-internal-id":"data-tools-jobs-activity-{owner},{job_name}-{id}-get", "x-filename-id":"data-tools-jobs-activity-owner-job_name-id-get" } }, "/data-tools/jobs/activity-detail":{ "get":{ "description":"Gets Data Tools jobs activity detail", "operationId":"getDataToolsJobActivityDetail", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Data Tools Jobs Activity Details" }, "204":{ "description":"No content" } }, "summary":"Gets Data Tools jobs activity detail", "x-internal-id":"data-tools-jobs-activity-detail-get", "x-filename-id":"data-tools-jobs-activity-detail-get" } }, "/data-tools/jobs/activity-detail/{owner},{job_name}":{ "get":{ "description":"Checks specific Data Tools job activity detail", "operationId":"getDataToolsJobActivityDetailByName", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Data Tools Jobs Activity Details" }, "204":{ "description":"No content" } }, "summary":"Checks specific Data Tools job activity detail", "x-internal-id":"data-tools-jobs-activity-detail-{owner},{job_name}-get", "x-filename-id":"data-tools-jobs-activity-detail-owner-job_name-get" } }, "/data-tools/jobs/activity-detail/{owner},{job_name}/{id}":{ "get":{ "description":"Checks specific Data Tools job run activity detail", "operationId":"getDataToolsJobActivityDetailById", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" }, { "name":"id", "in":"path", "description":"ID of job run to get", "required":true, "schema":{ "type":"number" }, "style":"simple" } ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Data Tools Jobs Activity Details" }, "204":{ "description":"No content" } }, "summary":"Checks specific Data Tools job run activity detail", "x-internal-id":"data-tools-jobs-activity-detail-{owner},{job_name}-{id}-get", "x-filename-id":"data-tools-jobs-activity-detail-owner-job_name-id-get" } }, "/data-tools/jobs/running":{ "get":{ "description":"Gets running Data Tools jobs", "operationId":"getDataToolsJobsRunning", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Running Data Tools Jobs" }, "204":{ "description":"No content" } }, "summary":"Gets running Data Tools jobs", "x-internal-id":"data-tools-jobs-running-get", "x-filename-id":"data-tools-jobs-running-get" } }, "/data-tools/jobs/running/{owner},{job_name}":{ "get":{ "description":"Gets specific running Data Tools job", "operationId":"getDataToolsJobsRunningByName", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Running Data Tools Jobs" }, "204":{ "description":"No content" } }, "summary":"Gets specific running Data Tools job", "x-internal-id":"data-tools-jobs-running-{owner},{job_name}-get", "x-filename-id":"data-tools-jobs-running-owner-job_name-get" } }, "/data-tools/jobs/running/{owner},{job_name}/{id}":{ "get":{ "description":"Gets specific running Data Tools job run", "operationId":"getDataToolsJobsRunningById", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" }, { "name":"id", "in":"path", "description":"ID of job run to get", "required":true, "schema":{ "type":"number" }, "style":"simple" } ], "responses":{ "201":{ "$ref":"#/components/responses/data-tools-jobs", "description":"Running Data Tools Jobs" }, "204":{ "description":"No content" } }, "summary":"Gets specific running Data Tools job run", "x-internal-id":"data-tools-jobs-running-{owner},{job_name}-{id}-get", "x-filename-id":"data-tools-jobs-running-owner-job_name-id-get" } }, "/data-tools/jobs/{owner},{job_name}":{ "get":{ "description":"Gets specific data tools job", "operationId":"getDataToolsJob", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "200":{ "$ref":"#/components/responses/data-tools-job" }, "404":{ "description":"Data Tools Job not found" } }, "summary":"Gets specific data tools job", "x-internal-id":"data-tools-jobs-{owner},{job_name}-get", "x-filename-id":"data-tools-jobs-owner-job_name-get" }, "delete":{ "description":"Delete Data Tools job", "operationId":"deleteDataToolsJob", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "required":true, "style":"simple", "description":"Name of job to delete", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Job deleted" }, "404":{ "description":"Job not found" } }, "summary":"Delete Data Tools job", "x-internal-id":"data-tools-jobs-{owner},{job_name}-delete", "x-filename-id":"data-tools-jobs-owner-job_name-delete" }, "patch":{ "description":"Updates data tools job", "operationId":"updateDataToolsJob", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner of the job", "required":true, "schema":{ "type":"string" } }, { "name":"job_name", "in":"path", "description":"Name of job to update", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "200":{ "$ref":"#/components/responses/data-tools-job" }, "404":{ "description":"Data Tools Job not found" } }, "summary":"Updates data tools job", "x-internal-id":"data-tools-jobs-{owner},{job_name}-patch", "x-filename-id":"data-tools-jobs-owner-job_name-patch" } }, "/data-tools/surveys/":{ "post":{ "description":"Surveys input data", "operationId":"createSurvey", "tags":[ "Data Tools" ], "parameters":[ ], "requestBody":{ "$ref":"#/components/requestBodies/surveys" }, "responses":{ "201":{ "$ref":"#/components/responses/surveys" }, "204":{ "description":"No content" } }, "summary":"Surveys input data", "x-internal-id":"data-tools-surveys--post", "x-filename-id":"data-tools-surveys-post" } }, "/data-tools/live-table-feeds/":{ "post":{ "description":"Creates Live Table Feed", "operationId":"createLiveTableFeed", "tags":[ "Data Tools" ], "parameters":[ ], "requestBody":{ "$ref":"#/components/requestBodies/live-table-feeds" }, "responses":{ "201":{ "description":"Live Table Feeds were succesfully created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/live-table-feeds" } } } }, "204":{ "description":"No content" }, "409":{ "description":"Name conflict with existing Live Table Feed" } }, "summary":"Creates Live Table Feed", "x-internal-id":"data-tools-live-table-feeds--post", "x-filename-id":"data-tools-live-table-feeds-post" }, "get":{ "description":"Gets Live Table Feeds", "operationId":"getLiveTableFeeds", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "200":{ "$ref":"#/components/responses/live-table-feeds" }, "404":{ "description":"No Live Table Feeds found" } }, "summary":"Gets Live Table Feeds", "x-internal-id":"data-tools-live-table-feeds--get", "x-filename-id":"data-tools-live-table-feeds-get" } }, "/data-tools/live-table-feeds/{owner},{feed_name}":{ "get":{ "description":"Gets specific Live Table Feed", "operationId":"getLiveTableFeed", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Live Table Feed.", "required":true, "schema":{ "type":"string" } }, { "name":"feed_name", "in":"path", "required":true, "style":"simple", "schema":{ "$ref":"#/components/schemas/live_table_feed_name" } } ], "responses":{ "200":{ "$ref":"#/components/responses/live-table-feeds" }, "404":{ "description":"Live Table Feed not found" } }, "summary":"Gets specific Live Table Feed", "x-internal-id":"data-tools-live-table-feeds-{owner},{feed_name}-get", "x-filename-id":"data-tools-live-table-feeds-owner-feed_name-get" }, "put":{ "description":"Modify Live Table Feed", "operationId":"putLiveTableFeed", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Live Table Feed.", "required":true, "schema":{ "type":"string" } }, { "name":"feed_name", "in":"path", "required":true, "style":"simple", "schema":{ "$ref":"#/components/schemas/live_table_feed_name" } } ], "responses":{ "200":{ "$ref":"#/components/responses/live-table-feeds" }, "404":{ "description":"Live Table Feed not found" } }, "summary":"Modify Live Table Feed", "x-internal-id":"data-tools-live-table-feeds-{owner},{feed_name}-put", "x-filename-id":"data-tools-live-table-feeds-owner-feed_name-put" }, "delete":{ "description":"Delete Live Table Feed", "operationId":"deleteLiveTableFeed", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Live Table Feed.", "required":true, "schema":{ "type":"string" } }, { "name":"feed_name", "in":"path", "required":true, "style":"simple", "description":"Live Table Feed to delete", "schema":{ "$ref":"#/components/schemas/live_table_feed_name" } } ], "responses":{ "204":{ "description":"Live Table Feed deleted" }, "404":{ "description":"Live Table Feed not found" } }, "summary":"Delete Live Table Feed", "x-internal-id":"data-tools-live-table-feeds-{owner},{feed_name}-delete", "x-filename-id":"data-tools-live-table-feeds-owner-feed_name-delete" } }, "/data-tools/live-table-feeds/{owner},{feed_name}/key":{ "get":{ "description":"Gets Live Table Feed notification key", "operationId":"getLiveTableFeedKey", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Live Table Feed.", "required":true, "schema":{ "type":"string" } }, { "name":"feed_name", "in":"path", "required":true, "style":"simple", "schema":{ "$ref":"#/components/schemas/live_table_feed_name" } } ], "responses":{ "200":{ "$ref":"#/components/responses/live-table-feed-key" }, "404":{ "description":"Live Table Feed not found" } }, "summary":"Gets Live Table Feed notification key", "x-internal-id":"data-tools-live-table-feeds-{owner},{feed_name}-key-get", "x-filename-id":"data-tools-live-table-feeds-owner-feed_name-key-get" } }, "/data-tools/live-table-feeds/{owner},{feed_name}/load_new_data":{ "post":{ "description":"Triggers data load for Live Table Feed.", "operationId":"triggerLiveTableFeed", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Live Table Feed.", "required":true, "schema":{ "type":"string" } }, { "name":"feed_name", "in":"path", "required":true, "style":"simple", "schema":{ "$ref":"#/components/schemas/live_table_feed_name" } } ], "responses":{ "200":{ "$ref":"#/components/responses/live-table-feeds" }, "404":{ "description":"Live Table Feed not found" } }, "summary":"Triggers data load for Live Table Feed", "x-internal-id":"data-tools-live-table-feeds-{owner},{feed_name}-load_new_data-post", "x-filename-id":"data-tools-live-table-feeds-owner-feed_name-load_new_data-post" } }, "/data-tools/cloud-storage-links/":{ "post":{ "description":"Creates Cloud Storage Link", "operationId":"createCloudStorageLink", "tags":[ "Data Tools" ], "parameters":[ ], "requestBody":{ "$ref":"#/components/requestBodies/cloud-storage-links" }, "responses":{ "201":{ "description":"Cloud Storage Links were succesfully created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cloud-storage-links" } } } }, "204":{ "description":"No content" }, "409":{ "description":"Name conflict with existing Cloud Storage Link" } }, "summary":"Creates Cloud Storage Link", "x-internal-id":"data-tools-cloud-storage-links--post", "x-filename-id":"data-tools-cloud-storage-links-post" }, "get":{ "description":"Gets Cloud Storage Links", "operationId":"getCloudStorageLinks", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "200":{ "$ref":"#/components/responses/cloud-storage-links" }, "404":{ "description":"No Cloud Storage Links found" } }, "summary":"Gets Cloud Storage Links", "x-internal-id":"data-tools-cloud-storage-links--get", "x-filename-id":"data-tools-cloud-storage-links-get" } }, "/data-tools/cloud-storage-links/{owner},{storage_link_name}":{ "get":{ "description":"Gets specific Cloud Storage Link", "operationId":"getCloudStorageLink", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Cloud Storage Link.", "required":true, "schema":{ "type":"string" } }, { "name":"storage_link_name", "in":"path", "description":"Name of Cloud Storage Link to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "200":{ "$ref":"#/components/responses/cloud-storage-links" }, "404":{ "description":"Cloud Storage Link not found" } }, "summary":"Gets specific Cloud Storage Link", "x-internal-id":"data-tools-cloud-storage-links-{owner},{storage_link_name}-get", "x-filename-id":"data-tools-cloud-storage-links-owner-storage_link_name-get" }, "delete":{ "description":"Delete a Cloud Storage Link", "operationId":"deleteCloudStorageLink", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Cloud Storage Link.", "required":true, "schema":{ "type":"string" } }, { "name":"storage_link_name", "in":"path", "description":"Name of Cloud Storage Link to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "204":{ "description":"Cloud Storage Link deleted" }, "404":{ "description":"Cloud Storage Link not found" } }, "summary":"Delete a Cloud Storage Link", "x-internal-id":"data-tools-cloud-storage-links-{owner},{storage_link_name}-delete", "x-filename-id":"data-tools-cloud-storage-links-owner-storage_link_name-delete" } }, "/data-tools/credentials/":{ "post":{ "description":"Creates credentials", "operationId":"createCredentials", "tags":[ "Data Tools" ], "parameters":[ ], "requestBody":{ "$ref":"#/components/requestBodies/credentials" }, "responses":{ "201":{ "description":"Credentials were succesfully created" }, "204":{ "description":"No content" }, "409":{ "description":"Name conflict with existing Credential" } }, "summary":"Creates credentials", "x-internal-id":"data-tools-credentials--post", "x-filename-id":"data-tools-credentials-post" }, "get":{ "description":"Gets credentials", "operationId":"getCredentials", "tags":[ "Data Tools" ], "parameters":[ ], "responses":{ "200":{ "$ref":"#/components/responses/credentials" }, "404":{ "description":"No credentials found" } }, "summary":"Gets credentials", "x-internal-id":"data-tools-credentials--get", "x-filename-id":"data-tools-credentials-get" } }, "/data-tools/credentials/{owner},{credential_name}":{ "get":{ "description":"Gets specific credential", "operationId":"getCredential", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Credential.", "required":true, "schema":{ "type":"string" } }, { "name":"credential_name", "in":"path", "description":"Name of credential to get", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "200":{ "$ref":"#/components/responses/credentials" }, "404":{ "description":"Credential not found" } }, "summary":"Gets specific credential", "x-internal-id":"data-tools-credentials-{owner},{credential_name}-get", "x-filename-id":"data-tools-credentials-owner-credential_name-get" }, "delete":{ "description":"Delete a credential", "operationId":"deleteCredential", "tags":[ "Data Tools" ], "parameters":[ { "name":"owner", "in":"path", "description":"Owner for the Credential.", "required":true, "schema":{ "type":"string" } }, { "name":"credential_name", "in":"path", "description":"Name of credential to delete", "required":true, "schema":{ "type":"string" }, "style":"simple" } ], "responses":{ "204":{ "description":"Credential deleted" }, "404":{ "description":"Credential not found" } }, "summary":"Delete a credential", "x-internal-id":"data-tools-credentials-{owner},{credential_name}-delete", "x-filename-id":"data-tools-credentials-owner-credential_name-delete" } }, "/ords/properties/":{ "get":{ "operationId":"ordsPropertiesGet", "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS properties values", "description":"Returns information about the ORDS properties that have values set in the database. Depending on the associated database account permissions the data will be returned from USER_ORDS_PROPERTIES view for that correspond REST Enabled schema or all REST Enabled schemas if the database account has access to them. A client requires SQL Developer or SQL Administrator role to invoke this service.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"All ORDS properties values in the database that are visible to the user.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" }, "examples":{ "All ORDS property values":{ "summary":"Executed as an administrator a mixture of DATABASE and SCHEMA level properties", "value":{ "items":[ { "schema":null, "key":"global.ui.footer_message.text.en", "scope":"DATABASE", "visibility":"PUBLIC", "comments":"Footer message text (English)", "value":"Set through service", "created_by":"ADMIN", "created_on":"2022-11-22T19:27:44Z", "updated_by":"ADMIN", "updated_on":"2022-11-22T19:27:44Z", "links":[ { "rel":"self", "href":"http://localhost:8080/ords/admin/_/db-api/stable/ords/properties/global.ui.footer_message.text.en" } ] }, { "schema":"HR", "key":"debug.printDebugToScreen", "scope":"SCHEMA", "visibility":"PROTECTED", "comments":"Include stack trace in error responses", "value":"true", "created_by":"ADMIN", "created_on":"2022-11-22T16:38:43Z", "updated_by":"ADMIN", "updated_on":"2022-11-22T16:38:43Z", "links":[ { "rel":"self", "href":"http://localhost:8080/ords/admin/_/db-api/stable/ords/properties/HR/debug.printDebugToScreen" } ] }, { "schema":"ADMIN", "key":"debug.printDebugToScreen", "scope":"SCHEMA", "visibility":"PROTECTED", "comments":"Include stack trace in error responses", "value":"true", "created_by":"ADMIN", "created_on":"2022-11-22T16:40:01Z", "updated_by":"ADMIN", "updated_on":"2022-11-22T16:40:01Z", "links":[ { "rel":"self", "href":"http://localhost:8080/ords/admin/_/db-api/stable/ords/properties/ADMIN/debug.printDebugToScreen" } ] } ], "hasMore":false, "limit":25, "offset":0, "count":3, "links":[ { "rel":"self", "href":"http://localhost:8080/ords/admin/_/db-api/stable/ords/properties/" }, { "rel":"describedby", "href":"http://localhost:8080/ords/admin/_/db-api/stable/metadata-catalog/" }, { "rel":"first", "href":"http://localhost:8080/ords/admin/_/db-api/stable/ords/properties/" } ] } } } } } } }, "x-internal-id":"ords-properties--get", "x-filename-id":"ords-properties-get" } }, "/ords/properties/{key}":{ "get":{ "operationId":"ordsPropertiesKeyGet", "tags":[ "ORDS REST Services" ], "summary":"Get an ORDS property value", "description":"Returns information about a specfic ORDS property that has a value set in the database. Depending on the associated database account permissions the data will be returned from USER_ORDS_PROPERTIES view for that correspond REST Enabled schema or all REST Enabled schemas if the database account has access to them. Users can view their own ORDS property values that are defined at SCHEMA scope through this endpoint. ORDS properties that are defined at DATABASE scope can be view through this endpoint by an administrator. A client requires SQL Developer or SQL Administrator role to invoke this service.", "parameters":[ { "name":"key", "in":"path", "description":"The name of the ORDS property.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information about a specific ORDS property value in the database that is visible to the user.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-properties-{key}-get", "x-filename-id":"ords-properties-key-get" }, "put":{ "operationId":"ordsPropertiesKeyPut", "tags":[ "ORDS REST Services" ], "summary":"Set an ORDS property value", "description":"Set a specfic ORDS property value in the database. Depending on the associated database account permissions the data will be returned from USER_ORDS_PROPERTIES view for that correspond REST Enabled schema or all REST Enabled schemas if the database account has access to them. Users can set their own ORDS property values that are defined at SCHEMA scope through this endpoint. ORDS properties that are defined at DATABASE scope can be set through this endpoint by an administrator. A client requires SQL Developer or SQL Administrator role to invoke this service.", "parameters":[ { "name":"key", "in":"path", "description":"The name of the ORDS property.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"The value to set for the property." } } } } } }, "responses":{ "200":{ "description":"Information about a specific ORDS property value in the database that is visible to the user.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-properties-{key}-put", "x-filename-id":"ords-properties-key-put" }, "delete":{ "operationId":"ordsPropertiesKeyDelete", "tags":[ "ORDS REST Services" ], "summary":"Unset an ORDS property value", "description":"Removes a specfic ORDS property value in the database. Depending on the associated database account permissions the data will be returned from USER_ORDS_PROPERTIES view for that correspond REST Enabled schema or all REST Enabled schemas if the database account has access to them. Users can unset their own ORDS property values that are defined at SCHEMA scope through this endpoint. ORDS properties that are defined at DATABASE scope can be unset through this endpoint by an administrator. A client requires SQL Developer or SQL Administrator role to invoke this service.", "parameters":[ { "name":"key", "in":"path", "description":"The name of the ORDS property.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the specific ORDS property value is not set in the database." } }, "x-internal-id":"ords-properties-{key}-delete", "x-filename-id":"ords-properties-key-delete" } }, "/ords/properties/{schema}/{key}":{ "get":{ "operationId":"ordsPropertiesSchemaKeyGet", "tags":[ "ORDS REST Services" ], "summary":"Get an ORDS property value for a schema", "description":"Returns information about a specfic ORDS property that has a value set in the database for the specified schema. ORDS property values that are defined at SCHEMA scope can be view through this endpoint. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"schema", "in":"path", "description":"The name of the REST Enabled database schema.", "required":true, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "description":"The name of the ORDS property.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Information about a specific ORDS property value in the database for the specified REST Enabled schema", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-properties-{schema}-{key}-get", "x-filename-id":"ords-properties-schema-key-get" }, "put":{ "operationId":"ordsPropertiesSchemaKeyPut", "tags":[ "ORDS REST Services" ], "summary":"Set an ORDS property value for a schema", "description":"Set a specfic ORDS property value in the database for the specified schema. ORDS property values that are defined at SCHEMA scope can be managed through this endpoint. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"schema", "in":"path", "description":"The name of the REST Enabled database schema.", "required":true, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "description":"The name of the ORDS property.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"The value to set for the property." } } } } } }, "responses":{ "200":{ "description":"Information about a specific ORDS property value in the database that is visible to the user.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-properties-{schema}-{key}-put", "x-filename-id":"ords-properties-schema-key-put" }, "delete":{ "operationId":"ordsPropertiesSchemaKeyDelete", "tags":[ "ORDS REST Services" ], "summary":"Unset an ORDS property value for a schema", "description":"Removes a specfic ORDS property value in the database for the specified schema. ORDS property values that are defined at SCHEMA scope can be unset through this endpoint. A client requires SQL Administrator role to invoke this service.", "parameters":[ { "name":"schema", "in":"path", "description":"The name of the REST Enabled database schema.", "required":true, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "description":"The name of the ORDS property.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Confirmation that the specific ORDS property value is not set in the database." } }, "x-internal-id":"ords-properties-{schema}-{key}-delete", "x-filename-id":"ords-properties-schema-key-delete" } }, "/ords/rest/modules/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST modules", "description":"Describes all the REST modules.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the REST modules.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-modules--get", "x-filename-id":"ords-rest-modules-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create a REST module", "description":"Creates a REST module.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "name", "base_path" ], "properties":{ "name":{ "type":"string", "description":"Name of the owning RESTful service module. Case sensitive." }, "base_path":{ "type":"string", "description":"The base of the URI that is used to access this RESTful service. Example: hr/ means that all URIs starting with hr/ will be serviced by this resource module." }, "origins_allowed":{ "type":"string", "description":"Set the allowed origins for the module containing the web service call." }, "items_per_page":{ "type":"integer", "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: 25." }, "module_status":{ "type":"string", "description":"Publication status. Valid values: PUBLISHED (default) or NOT_PUBLISHED." }, "comments":{ "type":"string", "description":"Comment text." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "200":{ "description":"Source code of the REST module to be created. Used for showcode.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "201":{ "description":"Details of the REST module that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "409":{ "description":"A module with that name or base path already exists. " }, "404":{ "description":"No name or base_path parameter provided." } }, "x-internal-id":"ords-rest-modules--post", "x-filename-id":"ords-rest-modules-post" } }, "/ords/rest/modules/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST module", "description":"Desribes a REST module.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific module.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the REST module.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-modules-{id}-get", "x-filename-id":"ords-rest-modules-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update a REST module", "description":"Updates a REST module.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific module.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "name", "base_path", "module_status" ], "properties":{ "name":{ "type":"string", "description":"Name of the owning RESTful service module. Case sensitive." }, "base_path":{ "type":"string", "description":"The base of the URI that is used to access this RESTful service. Example: hr/ means that all URIs starting with hr/ will be serviced by this resource module." }, "origins_allowed":{ "type":"string", "description":"Set the allowed origins for the module containing the web service call." }, "items_per_page":{ "type":"integer", "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: 25." }, "module_status":{ "type":"string", "description":"Publication status. Valid values: PUBLISHED (default) or NOT_PUBLISHED." }, "comments":{ "type":"string", "description":"Comment text." } } } } } }, "responses":{ "200":{ "description":"Details of the REST module that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No items_per_page or status parameter provided." }, "404":{ "description":"No name or base_path parameter provided." }, "409":{ "description":"A module name or base path already exists." } }, "x-internal-id":"ords-rest-modules-{id}-put", "x-filename-id":"ords-rest-modules-id-put" } }, "/ords/rest/modules/{id}/source":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST module source", "description":"Exports the REST module source code.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific module.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"SQL file of the exported module.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "404":{ "description":"Module does not exist." } }, "x-internal-id":"ords-rest-modules-{id}-source-get", "x-filename-id":"ords-rest-modules-id-source-get" } }, "/ords/rest/templates/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST module templates", "description":"Describes all the REST templates.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the REST templates.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-templates--get", "x-filename-id":"ords-rest-templates-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create a REST module template", "description":"Creates a REST module template.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "module_id", "uri_prefix" ], "properties":{ "module_id":{ "type":"integer", "description":"ID for specific reosurce module" }, "uri_prefix":{ "type":"string", "description":"A matching pattern for the resource template. For example, a pattern of /objects/:object/:id? will match /objects/emp/101 (matches a request for the item in the emp resource with id of 101) and will also match /objects/emp/. (Matches a request for the emp resource, because the :id parameter is annotated with the ? modifier, which indicates that the id parameter is optional.)" }, "priority":{ "type":"integer", "description":"The priority for the order of how the resource template should be evaluated: 0 (low priority. the default) through 9 (high priority)." }, "etag_type":{ "type":"string", "description":"A type of entity tag to be used by the resource template. An entity tag is an HTTP Header that acts as a version identifier for a resource. Use entity tag headers to avoid retrieving previously retrieved resources and to perform optimistic locking when updating resources. Valid values are HASH, QUERY, NONE." }, "etag_query":{ "type":"string", "description":"Query that is used to generate the entity tag." }, "comments":{ "type":"string", "description":"Comment text." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "201":{ "description":"Details of the REST module template that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No pattern parameter provided or Module not specified." }, "404":{ "description":"Module does not exist" }, "409":{ "description":"A template with that pattern already exists." } }, "x-internal-id":"ords-rest-templates--post", "x-filename-id":"ords-rest-templates-post" } }, "/ords/rest/templates/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST module template", "description":"Describes a REST module template.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific template.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the REST module template.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-templates-{id}-get", "x-filename-id":"ords-rest-templates-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update a REST module template", "description":"Updates a REST module template.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific template.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "uri_prefix", "priority", "etag_type" ], "properties":{ "uri_prefix":{ "type":"string", "description":"A matching pattern for the resource template. For example, a pattern of /objects/:object/:id? will match /objects/emp/101 (matches a request for the item in the emp resource with id of 101) and will also match /objects/emp/. (Matches a request for the emp resource, because the :id parameter is annotated with the ? modifier, which indicates that the id parameter is optional.)" }, "priority":{ "type":"integer", "description":"The priority for the order of how the resource template should be evaluated: 0 (low priority. the default) through 9 (high priority)." }, "etag_type":{ "type":"string", "description":"A type of entity tag to be used by the resource template. An entity tag is an HTTP Header that acts as a version identifier for a resource. Use entity tag headers to avoid retrieving previously retrieved resources and to perform optimistic locking when updating resources. Valid values are HASH, QUERY, NONE." }, "etag_query":{ "type":"string", "description":"Query that is used to generate the entity tag." }, "comments":{ "type":"string", "description":"Comment text." } } } } } }, "responses":{ "200":{ "description":"Details of the REST module template that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No etag_type or pattern or priority parameter provided." }, "404":{ "description":"Template does not exist" }, "409":{ "description":"Template pattern already exists in the module." } }, "x-internal-id":"ords-rest-templates-{id}-put", "x-filename-id":"ords-rest-templates-id-put" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Delete a REST module template", "description":"Deletes a REST module template.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific template.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Confirmation that the REST module template has been delete." } }, "x-internal-id":"ords-rest-templates-{id}-delete", "x-filename-id":"ords-rest-templates-id-delete" } }, "/ords/rest/handlers/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST template handlers", "description":"Describes all the REST template handlers.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the REST template handlers.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-handlers--get", "x-filename-id":"ords-rest-handlers-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create a REST template handler", "description":"Creates a REST template handler.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "template_id", "source" ], "properties":{ "template_id":{ "type":"integer", "description":"ID of the template the handler belongs to." }, "source":{ "type":"string", "description":"The source implementation for the selected HTTP method." }, "source_type":{ "type":"string", "description":"The HTTP request method for this handler. Valid values: source_type_collection_feed, source_type_collection_item, source_type_media, source_type_plsql, source_type_query || source_type_csv_query, source_type_query_one_row, source_type_feed, path/to/feed/{id}." }, "method":{ "type":"string", "description":"The HTTP method to which this handler will respond. Valid values: GET, POST, PUT, DELETE." }, "items_per_page":{ "type":"integer", "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: NULL (defers to the resource module setting)." }, "mimes_allowed":{ "type":"string", "description":"Comma-separated list of MIME types that the handler will accept. Applies to PUT and POST only." }, "comments":{ "type":"string", "description":"Comment text." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "201":{ "description":"Details of the REST template handler that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No template specified or No source parameter provided or Invalid Source Type." }, "404":{ "description":"Template does not exis" }, "409":{ "description":"Handler already exists." } }, "x-internal-id":"ords-rest-handlers--post", "x-filename-id":"ords-rest-handlers-post" } }, "/ords/rest/handlers/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST template handler", "description":"Describes a REST template handler.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific handler.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the REST template handler.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-handlers-{id}-get", "x-filename-id":"ords-rest-handlers-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update a REST template handler", "description":"Updates a REST template handler.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific handler.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "source_type", "source", "method" ], "properties":{ "source_type":{ "type":"string", "description":"The HTTP request method for this handler. Valid values: source_type_collection_feed, source_type_collection_item, source_type_media, source_type_plsql, source_type_query || source_type_csv_query, source_type_query_one_row, source_type_feed, path/to/feed/{id}." }, "source":{ "type":"string", "description":"The source implementation for the selected HTTP method." }, "method":{ "type":"string", "description":"The HTTP method to which this handler will respond. Valid values: GET, POST, PUT, DELETE." }, "items_per_page":{ "type":"integer", "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: NULL (defers to the resource module setting)." }, "mimes_allowed":{ "type":"string", "description":"Comma-separated list of MIME types that the handler will accept. Applies to PUT and POST only." }, "comments":{ "type":"string", "description":"Comment text." } } } } } }, "responses":{ "200":{ "description":"Details of the REST template handler that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No template specified or No source parameter provided or Invalid Source Type." }, "404":{ "description":"Template does not exis" }, "409":{ "description":"Handler already exists." } }, "x-internal-id":"ords-rest-handlers-{id}-put", "x-filename-id":"ords-rest-handlers-id-put" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Delete a REST template handler", "description":"Deletes a REST template handler.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific handler.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Confirmation that the REST template handler has been deleted." }, "404":{ "description":"Handler not found" } }, "x-internal-id":"ords-rest-handlers-{id}-delete", "x-filename-id":"ords-rest-handlers-id-delete" } }, "/ords/rest/handlers/{id}/source":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST handler source", "description":"Returns a REST handler source code.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific handler.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Source code of the REST handler.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-handlers-{id}-source-get", "x-filename-id":"ords-rest-handlers-id-source-get" } }, "/ords/rest/parameters/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST handler parameters", "description":"Describes all the REST handler parameters.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the REST handler parameters.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-parameters--get", "x-filename-id":"ords-rest-parameters-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create a REST handler parameter", "description":"Creates a REST handler parameter.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "handler_id", "name" ], "properties":{ "handler_id":{ "type":"integer", "description":"ID for specific module handler." }, "name":{ "type":"string", "description":"The name of the parameter, as it is named in the URI Template or HTTP Header. Used to map names that are not valid SQL parameter names." }, "bind_variable_name":{ "type":"string", "description":"The name of the parameter, as it will be referred to in the SQL. If NULL is specified, then the parameter is unbound." }, "source_type":{ "type":"string", "description":"The type identifies if the parameter originates in the URI Template or a HTTP Header. Valid values: HEADER, RESPONSE, URI." }, "param_type":{ "type":"string", "description":"The native type of the parameter. Valid values: STRING, INT, DOUBLE, BOOLEAN, LONG, TIMESTAMP." }, "access_method":{ "type":"string", "description":"The parameter access method. Indicates if the parameter is an input value, output value, or both. Valid values: IN, OUT, INOUT." }, "comments":{ "type":"string", "description":"Comment text." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "201":{ "description":"Details of the REST handler parameter that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No name parameter provided." }, "404":{ "description":"No handler specified." }, "409":{ "description":"Parameter name or bind variable already exists." } }, "x-internal-id":"ords-rest-parameters--post", "x-filename-id":"ords-rest-parameters-post" } }, "/ords/rest/parameters/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST handler parameter", "description":"Describes a REST handler parameter.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific parameter.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the REST handler parameter.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-parameters-{id}-get", "x-filename-id":"ords-rest-parameters-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update a REST handler parameter", "description":"Updates a REST handler parameter.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific parameter.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "handler_id", "name", "source_type", "param_type", "access_method" ], "properties":{ "handler_id":{ "type":"integer", "description":"ID for specific handler." }, "name":{ "type":"string", "description":"The name of the parameter, as it is named in the URI Template or HTTP Header. Used to map names that are not valid SQL parameter names." }, "bind_variable_name":{ "type":"string", "description":"The name of the parameter, as it will be referred to in the SQL. If NULL is specified, then the parameter is unbound." }, "source_type":{ "type":"string", "description":"The type identifies if the parameter originates in the URI Template or a HTTP Header. Valid values: HEADER, RESPONSE, URI." }, "param_type":{ "type":"string", "description":"The native type of the parameter. Valid values: STRING, INT, DOUBLE, BOOLEAN, LONG, TIMESTAMP." }, "access_method":{ "type":"string", "description":"The parameter access method. Indicates if the parameter is an input value, output value, or both. Valid values: IN, OUT, INOUT." }, "comments":{ "type":"string", "description":"Comment text." } } } } } }, "responses":{ "200":{ "description":"Details of the REST handler parameter that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No name parameter provided." }, "404":{ "description":"Parameter does not exist." }, "409":{ "description":"Parameter name or bind variable already exists." } }, "x-internal-id":"ords-rest-parameters-{id}-put", "x-filename-id":"ords-rest-parameters-id-put" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Delete a REST handler parameter", "description":"Deletes a REST handler parameter.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific parameter.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Confirmation that the REST handler parameter has been deleted." } }, "x-internal-id":"ords-rest-parameters-{id}-delete", "x-filename-id":"ords-rest-parameters-id-delete" } }, "/ords/rest/roles/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS roles", "description":"Describes all the ORDS roles.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the ORDS roles.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-roles--get", "x-filename-id":"ords-rest-roles-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create an ORDS role", "description":"Creates an ORDS role.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "role_name" ], "properties":{ "role_name":{ "type":"string", "description":"ORDS role for specific module" }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "200":{ "description":"Details of the ORDS role that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No role_name parameter provided." }, "409":{ "description":"A role with that name already exists." } }, "x-internal-id":"ords-rest-roles--post", "x-filename-id":"ords-rest-roles-post" } }, "/ords/rest/roles/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get an ORDS role", "description":"Describes an ORDS role.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific ORDS role.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the ORDS role.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-roles-{id}-get", "x-filename-id":"ords-rest-roles-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update an ORDS role", "description":"Updates an ORDS role.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific ORDS role.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "id", "role_name" ], "properties":{ "id":{ "type":"number", "description":"Specify the ORDS role given the ID to update." }, "role_name":{ "type":"string", "description":"New role_name for the ORDS role module." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "201":{ "description":"Details of the ORDS role that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No role_name parameter provided." }, "403":{ "description":"You do not have the permission to update this role." }, "404":{ "description":"Role not found." } }, "x-internal-id":"ords-rest-roles-{id}-put", "x-filename-id":"ords-rest-roles-id-put" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Delete an ORDS role", "description":"Deletes an ORDS role.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific ORDS role.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Confirmation that the ORDS role has been delete." } }, "x-internal-id":"ords-rest-roles-{id}-delete", "x-filename-id":"ords-rest-roles-id-delete" } }, "/ords/rest/roles/{id}/privileges/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS privileges for a specific role", "description":"Lists all the privileges for the specified role.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific ORDS role privilege.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of all the ORDS privileges with the role.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-roles-{id}-privileges--get", "x-filename-id":"ords-rest-roles-id-privileges-get" } }, "/ords/rest/privileges/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS privileges", "description":"Describes all the ORDS privileges.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the ORDS privileges.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-privileges--get", "x-filename-id":"ords-rest-privileges-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create an ORDS privilege", "description":"Creates an ORDS privilege.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Name of the ORDS privilege" }, "label":{ "type":"string", "description":"ORDS privilege label." }, "description":{ "type":"string", "description":"ORDS privilege description text." }, "roles":{ "type":"string", "description":"String of an ORDS roles list separated by the null char." }, "patterns":{ "type":"string", "description":"String of an ORDS patterns list separated by the null char." }, "modules":{ "type":"string", "description":"String of an ORDS modules list separated by the null char." }, "comments":{ "type":"string", "description":"Comments text." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "201":{ "description":"Details of the ORDS privilege that has been successfully created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No name parameter provided or Length parameter is too long." }, "404":{ "description":"A module or A module name does not existname does not exist." }, "409":{ "description":"A privilege with that name already exists." } }, "x-internal-id":"ords-rest-privileges--post", "x-filename-id":"ords-rest-privileges-post" } }, "/ords/rest/privileges/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get an ORDS privilege", "description":"Describes an ORDS privilege.", "parameters":[ { "name":"id", "in":"path", "description":"ID for ORDS specific privilege.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the ORDS privilege.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-privileges-{id}-get", "x-filename-id":"ords-rest-privileges-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update an ORDS privilege", "description":"Updates an ORDS privilege.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific ORDS privilege.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Name of the ORDS privilege" }, "label":{ "type":"string", "description":"ORDS privilege label." }, "description":{ "type":"string", "description":"ORDS privilege description text." }, "roles":{ "type":"string", "description":"String of an ORDS roles list separated by the null char." }, "patterns":{ "type":"string", "description":"String of an ORDS patterns list separated by the null char." }, "modules":{ "type":"string", "description":"String of an ORDS modules list separated by the null char." }, "comments":{ "type":"string", "description":"Comments text." } } } } } }, "responses":{ "200":{ "description":"Details of the ORDS privilege that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"No name parameter provided or Length parameter is too long or Privilege name already exists." }, "403":{ "description":"You do not have permission to update this privilege." }, "404":{ "description":"A privilege or role name or module name o does not existname does not exist." } }, "x-internal-id":"ords-rest-privileges-{id}-put", "x-filename-id":"ords-rest-privileges-id-put" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Delete an ORDS privilege", "description":"Deletes an ORDS privilege.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific ORDS privilege.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Confirmation that the ORDS privilege has been delete." } }, "x-internal-id":"ords-rest-privileges-{id}-delete", "x-filename-id":"ords-rest-privileges-id-delete" } }, "/ords/rest/privileges/{id}/modules/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST modules in a privilege", "description":"Describes all the REST modules protected by a privilege.", "parameters":[ { "name":"id", "in":"path", "description":"ID for ORDS specific privilege.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the all the REST modules protected by a privilege.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-privileges-{id}-modules--get", "x-filename-id":"ords-rest-privileges-id-modules-get" } }, "/ords/rest/privileges/{id}/patterns/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST patterns in a privilege", "description":"Describes all the REST patterns protected by a privilege.", "parameters":[ { "name":"id", "in":"path", "description":"ID for ORDS specific privilege.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of all the REST patterns protected by a privilege.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-privileges-{id}-patterns--get", "x-filename-id":"ords-rest-privileges-id-patterns-get" } }, "/ords/rest/privileges/{id}/roles/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS roles in a privilege", "description":"Describes all the ORDS roles assigned to a privilege.", "parameters":[ { "name":"id", "in":"path", "description":"ID for ORDS specific privilege.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the all the ORDS roles assigned to a privilege.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-privileges-{id}-roles--get", "x-filename-id":"ords-rest-privileges-id-roles-get" } }, "/ords/rest/privilege/modules/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all protected REST modules", "description":"Describes all the protected REST modules.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the protected REST modules.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-privilege-modules--get", "x-filename-id":"ords-rest-privilege-modules-get" } }, "/ords/rest/clients/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS OAuth clients", "description":"Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if grant_type is client_credentials; otherwise, must not be null.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the ORDS OAuth clients.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestClientCollection" } } } } }, "x-internal-id":"ords-rest-clients--get", "x-filename-id":"ords-rest-clients-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"Create an ORDS OAuth client", "description":"Creates an ORDS OAuth client.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "name", "privilege_names", "grant_type", "description", "support_email" ], "properties":{ "name":{ "type":"string", "description":"Name for the client, displayed to the end user during the approval phase of three-legged OAuth. Must be unique." }, "grant_type":{ "type":"string", "enum":[ "authorization_code", "implicit", "client_credentials" ], "description":"Must be one of authorization_code, implicit, or client_credentials." }, "description":{ "type":"string", "description":"Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if p_grant_type is client_credentials; otherwise, must not be null." }, "allowed_origins":{ "type":"string", "description":"A comma-separated list of URL prefixes. If the list is empty, any existing origins are removed." }, "redirect_uri":{ "type":"string", "description":"Client-controlled URI to which redirect containing an OAuth access token or error will be sent. May be null if p_grant_type is client_credentials; otherwise, must not be null." }, "privilege_names":{ "type":"string", "description":"List of comma-separated privileges that the client wants to access." }, "role_names":{ "type":"string", "description":"Is a string of privilege names" }, "support_email":{ "type":"string", "description":"The email where end users can contact the client for support." }, "support_uri":{ "type":"string", "description":"The URI where end users can contact the client for support." } } } } } }, "responses":{ "201":{ "description":"Details of the ORDS OAuth client that has been created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestClientCollectionItem" } } } }, "400":{ "description":"No name, description or support_email parameter provided or A role name or privilege name does not exist or The list of allowed origins or privilege name is too big or A privilege name is too long." }, "409":{ "description":"An oauth client with that name already exists." } }, "x-internal-id":"ords-rest-clients--post", "x-filename-id":"ords-rest-clients-post" } }, "/ords/rest/clients/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get an ORDS OAuth client", "description":"Describes an ORDS OAuth client.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the ORDS OAuth client.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestClientCollectionItem" } } } } }, "x-internal-id":"ords-rest-clients-{id}-get", "x-filename-id":"ords-rest-clients-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update an ORDS OAuth client", "description":"Updates an ORDS OAuth client.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "name", "privilege_names" ], "properties":{ "name":{ "type":"string", "description":"Name for the client, displayed to the end user during the approval phase of three-legged OAuth. Must be unique." }, "grant_type":{ "type":"string", "description":"Must be one of authorization_code, implicit, or client_credentials." }, "description":{ "type":"string", "description":"Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if p_grant_type is client_credentials; otherwise, must not be null." }, "allowed_origins":{ "type":"string", "description":"A comma-separated list of URL prefixes. If the list is empty, any existing origins are removed." }, "privilege_names":{ "type":"string", "description":"List of comma-separated privileges that the client wants to access." }, "role_names":{ "type":"string", "description":"Is a string of privilege names" }, "redirect_uri":{ "type":"string", "description":"Client-controlled URI to which redirect containing an OAuth access token or error will be sent. May be null if p_grant_type is client_credentials; otherwise, must not be null." }, "support_email":{ "type":"string", "description":"The email where end users can contact the client for support." }, "support_uri":{ "type":"string", "description":"The URI where end users can contact the client for support. Example: http://www.myclientdomain.com/support/" } } } } } }, "responses":{ "200":{ "description":"Details of the ORDS OAuth client that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestClientCollectionItem" } } } }, "400":{ "description":"No name, description or support_email parameter provided or A role name or privilege name does not exist or The list of allowed origins or privilege name is too big or A privilege name is too long." }, "404":{ "description":"OAuth client does not exist" }, "409":{ "description":"An oauth client with that name already exists." } }, "x-internal-id":"ords-rest-clients-{id}-put", "x-filename-id":"ords-rest-clients-id-put" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Delete an ORDS OAuth client", "description":"Deletes an ORDS OAuth client.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"Confirmation that the ORDS OAuth client has been deleted." }, "404":{ "description":"OAuth client does not exist." }, "409":{ "description":"You do not have permission to delete this oauth client." } }, "x-internal-id":"ords-rest-clients-{id}-delete", "x-filename-id":"ords-rest-clients-id-delete" } }, "/ords/rest/clients/{id}/logo/":{ "post":{ "tags":[ "ORDS REST Services" ], "summary":"Updates the ORDS OAuth client avatar image.", "description":"Updates the ORDS OAuth client avatar image.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "content_type", "body" ], "properties":{ "content_type":{ "type":"string", "description":"Under content, specify the request media type (such as image/png or application/octet-stream). Files use a type: string schema with format: binary or format: base64, depending on how the file contents will be encoded." }, "body":{ "type":"string", "format":"binary", "description":"files uploaded directly with the request content and files uploaded with multipart requests." } } } } } }, "responses":{ "201":{ "description":"Details of the ORDS OAuth avatar that has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-clients-{id}-logo--post", "x-filename-id":"ords-rest-clients-id-logo-post" } }, "/ords/rest/clients/{id}/secret/{slotid}":{ "post":{ "tags":[ "ORDS REST Services" ], "summary":"Register or Rotate the ORDS OAuth client secret.", "description":"Register or Rotate the ORDS OAuth client secret.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } }, { "name":"slotid", "in":"path", "description":"Slot ID for a specific OAuth client; it can only be 1 or 2.", "required":true, "schema":{ "type":"integer" } }, { "name":"revoke_sessions", "in":"query", "description":"Deletes the current client sessions when TRUE. Default value is FALSE.", "required":false, "schema":{ "type":"boolean" } }, { "name":"revoke_existing", "in":"query", "description":"Deletes the existing client sessions when TRUE. Default value is FALSE.", "required":false, "schema":{ "type":"boolean" } } ], "responses":{ "201":{ "description":"Details of the ORDS OAuth secret has been successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestClientSecretItem" } } } } }, "x-internal-id":"ords-rest-clients-{id}-secret-{slotid}-post", "x-filename-id":"ords-rest-clients-id-secret-slotid-post" }, "delete":{ "tags":[ "ORDS REST Services" ], "summary":"Revoke the ORDS OAuth client secret.", "description":"Revoke the ORDS OAuth client secret.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } }, { "name":"slotid", "in":"path", "description":"Slot ID for a specific OAuth client; valid values are 1 or 2, while 3 revokes all clients.", "required":true, "schema":{ "type":"integer" } }, { "name":"revoke_sessions", "in":"query", "description":"Deletes the current client sessions when TRUE. Default value is FALSE.", "required":false, "schema":{ "type":"boolean" } } ], "responses":{ "204":{ "description":"Confirmation that the ORDS OAuth secret has been successfully revoked." } }, "x-internal-id":"ords-rest-clients-{id}-secret-{slotid}-delete", "x-filename-id":"ords-rest-clients-id-secret-slotid-delete" } }, "/ords/rest/clients/{id}/privileges/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS privileges in an OAuth client", "description":"Describes all the ORDS privileges in an OAuth client.", "parameters":[ { "name":"id", "in":"path", "description":"ID for specific OAuth client.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of all the ORDS privileges in the OAuth client.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-clients-{id}-privileges--get", "x-filename-id":"ords-rest-clients-id-privileges-get" } }, "/ords/rest/clients/{id}/roles/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all ORDS roles in an OAuth client", "description":"Describes all the ORDS roles in an OAuth client.", "parameters":[ { "name":"id", "in":"path", "description":"ID of the OAuth client.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of all the ORDS roles in the OAuth client.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-clients-{id}-roles--get", "x-filename-id":"ords-rest-clients-id-roles-get" } }, "/ords/rest/autorest/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all REST enabled objects", "description":"Describes all the REST enabled objects.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of all the REST enabled objects.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-autorest--get", "x-filename-id":"ords-rest-autorest-get" }, "post":{ "tags":[ "ORDS REST Services" ], "summary":"REST enable an object", "description":"ENABLE_OBJECT enables Oracle REST Data Services access to a specified table or view in a schema.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "object_name", "object_alias", "auth" ], "properties":{ "object_name":{ "type":"string", "description":"Name of the table or view." }, "object_alias":{ "type":"string", "description":"Alias of the object." }, "auth":{ "type":"boolean", "description":"Controls whether Oracle REST Data Services should require user authorization before allowing access to the Oracle REST Data Services metadata for this object. If this value is TRUE, then the service is protected by the following roles: oracle.dbtools.autorest.any.schema, oracle.dbtools.role.autorest..." }, "run_mode":{ "type":"string", "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution." } } } } } }, "responses":{ "201":{ "description":"A REST enabled object in the schema.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "404":{ "description":"A REST Object does not exist." }, "409":{ "description":"A REST enabled object with that alias already exists." }, "403":{ "description":"You do not have permission to enable a REST object." } }, "x-internal-id":"ords-rest-autorest--post", "x-filename-id":"ords-rest-autorest-post" } }, "/ords/rest/autorest/{id}":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST enabled object", "description":"Describes a REST enabled object.", "parameters":[ { "name":"id", "in":"path", "description":"ID of the module for the REST Enabled Object.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the REST enabled object.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-autorest-{id}-get", "x-filename-id":"ords-rest-autorest-id-get" }, "put":{ "tags":[ "ORDS REST Services" ], "summary":"Update or disables a REST enabled object", "description":"Updates or disables a REST enabled object,", "parameters":[ { "name":"id", "in":"path", "description":"ID of the module for the REST Enabled Object.", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "object_alias", "auth" ], "properties":{ "object_alias":{ "type":"string", "description":"Alias of the object." }, "auth":{ "type":"boolean", "description":"Controls whether Oracle REST Data Services should require user authorization before allowing access to the Oracle REST Data Services metadata for this object. If this value is TRUE, then the service is protected by the following roles: oracle.dbtools.autorest.any.schema, oracle.dbtools.role.autorest..." }, "action":{ "type":"string", "description":"Its value can be 'DISABLE' which would make the endpoint disables a REST enabled object or 'UPDATE' which would make the endpoint update a REST enabled object." } } } } } }, "responses":{ "200":{ "description":"Details of the REST enabled object that has been successfully updated or disables.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "404":{ "description":"A REST Object does not exist." }, "403":{ "description":"You do not have permission to enable a REST object." }, "409":{ "description":"A REST enabled object with that alias already exists." } }, "x-internal-id":"ords-rest-autorest-{id}-put", "x-filename-id":"ords-rest-autorest-id-put" } }, "/ords/rest/autorest/summary":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get count of all the REST enabled objects", "description":"Summarizes all the REST enabled objects.", "responses":{ "200":{ "description":"Summary of all the REST enabled object.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-autorest-summary-get", "x-filename-id":"ords-rest-autorest-summary-get" } }, "/ords/rest/autorest/{id}/metadata":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get a REST enabled object metadata", "description":"Describes a REST enabled object metadata.", "parameters":[ { "name":"id", "in":"path", "description":"ID of specific REST enabled object.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Details of the REST enabled object metadata", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } }, "400":{ "description":"Unsupported REST object type." }, "404":{ "description":"A REST Object does not exist." } }, "x-internal-id":"ords-rest-autorest-{id}-metadata-get", "x-filename-id":"ords-rest-autorest-id-metadata-get" } }, "/ords/rest/overview/":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get current ORDS schema and count of all current schema REST objects and count of all REST modules", "description":"Describes the current ORDS schema and summarizes all the REST objects in the current schema and Summary of all the published, unpublished, fully protected, partially protected and unique protected REST modules, get current ORDS schema auto-REST authorization", "responses":{ "200":{ "description":"Details of the current ORDS schema. This includes the connection type, pattern, REST status, auto-REST authorization, operations allowed and pre hook and ummary of all the REST objects in the current schema and summarizes all the published, unpublished, fully protected, partially protected and unique protected REST modules, etails of the current ORDS schema auto-REST authorization", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceItem" } } } } }, "x-internal-id":"ords-rest-overview--get", "x-filename-id":"ords-rest-overview-get" } }, "/ords/rest/overview/objects_recent":{ "get":{ "tags":[ "ORDS REST Services" ], "summary":"Get all current schema recent REST objects", "description":"Describes the last 7 days manipulated REST objects in the current schema in UPDATED_ON descending order.", "parameters":[ { "$ref":"#/components/parameters/Limit" }, { "$ref":"#/components/parameters/Filter" } ], "responses":{ "200":{ "description":"Details of the recently manipulated REST objects in the current schema in UPDATED_ON descending order.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ItemsCollection" } } } } }, "x-internal-id":"ords-rest-overview-objects_recent-get", "x-filename-id":"ords-rest-overview-objects_recent-get" } }, "/vecdb/summary":{ "get":{ "tags":[ "Vector Database/Summary" ], "operationId":"describe_vector_database", "summary":"A summary of all of the VecDB objects present in the schema.", "description":"Provides a summary of all of the VecDB objects present in the schema.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Provides a summary of all of the VecDB objects present in the schema.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SummaryItem" } } } } }, "x-internal-id":"vecdb-summary-get", "x-filename-id":"vecdb-summary-get" } }, "/vecdb/models/":{ "get":{ "tags":[ "Vector Database/Models" ], "operationId":"list_models", "summary":"Get the ONNX models hosted in the database", "description":"Describe the ONNX models hosted in the database.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Details of the ONNX models hosted in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ModelsCollection" } } } } }, "x-internal-id":"vecdb-models--get", "x-filename-id":"vecdb-models-get" }, "post":{ "tags":[ "Vector Database/Models" ], "operationId":"load_model", "summary":"Load an ONNX model into de database.", "description":"Load an ONNX model into de database.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "modelName", "url" ], "properties":{ "modelName":{ "type":"string", "description":"The name of the model." }, "url":{ "type":"string", "description":"The PAR URL of the model." }, "modelParams":{ "type":"object", "description":"Model specific parameters.", "properties":{ "provider":{ "type":"string", "description":"The provider of the ONNX model." }, "credential":{ "type":"string", "description":"The credential to use to load the model" }, "metadata":{ "type":"object", "description":"Model specific metadata parameters" } } }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "201":{ "description":"The model details.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ModelItem" } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"Model not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-models--post", "x-filename-id":"vecdb-models-post" } }, "/vecdb/models/{model_name}":{ "parameters":[ { "name":"model_name", "in":"path", "required":true, "schema":{ "type":"string", "maxLength":128 }, "description":"Name of the ONNX model." } ], "get":{ "tags":[ "Vector Database/Models" ], "operationId":"describe_model", "summary":"Get details of an ONNX model hosted in the database", "description":"Describe an ONNX model hosted in the database.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Details of the ONNX model hosted in the database.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ModelItem" } } } }, "404":{ "description":"Model not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-models-{model_name}-get", "x-filename-id":"vecdb-models-model_name-get" }, "delete":{ "tags":[ "Vector Database/Models" ], "operationId":"drop_model", "summary":"Delete an ONNX model from de database.", "description":"Delete an ONNX model from de database.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"The model was successfully deleted from the database.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "dropped":{ "type":"string", "description":"If the model was dropped or not." }, "message":{ "type":"string", "description":"Confirmation message." } } } } } }, "400":{ "description":"The model is used in a vector table and can not be deleted.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"Model not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-models-{model_name}-delete", "x-filename-id":"vecdb-models-model_name-delete" } }, "/vecdb/vector-tables/":{ "get":{ "tags":[ "Vector Database/Vector Tables" ], "operationId":"list_vector_tables", "summary":"List vector tables.", "description":"Returns all vector tables available to the caller.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"List of vector tables.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBTableCollection" } } } } }, "x-internal-id":"vecdb-vector-tables--get", "x-filename-id":"vecdb-vector-tables-get" }, "post":{ "tags":[ "Vector Database/Vector Tables" ], "operationId":"create_vector_table", "summary":"Create a vector table.", "description":"Creates a new vector table. Exactly one of vectorType or embedParams must be provided. If both or neither are provided, the request is rejected.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "tableName" ], "properties":{ "tableName":{ "type":"string", "description":"The name of the vector table." }, "description":{ "type":"string", "description":"A brief description of the vector table." }, "autoGenerateID":{ "type":"boolean", "description":"Whether the ID column of the table should be auto generated. Defaults to false." }, "annotations":{ "type":"object", "description":"Key-value pairs added to the vector table metadata." }, "vectorType":{ "type":"string", "description":"Vector type to use for the table. For V1 only 'dense' is supported.", "enum":[ "dense" ] }, "embedParams":{ "type":"object", "description":"Embedding model parameters. Provide this instead of vectorType to create a table for a model (e.g., {\"model\":\"hosted-model-name\",\"embed_metadata_jsonpath\":\"\"}).", "properties":{ } }, "indexParams":{ "$ref":"#/components/schemas/VectorIndexParams" }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } }, "oneOf":[ { "required":[ "vectorType" ], "not":{ "required":[ "embedParams" ] } }, { "required":[ "embedParams" ], "not":{ "required":[ "vectorType" ] } } ] } } } }, "responses":{ "201":{ "description":"Vector table created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBTableNoLinks" } } } }, "400":{ "description":"The request body included invalid or missing parameters (e.g., missing tableName, invalid JSON, or providing both/neither vectorType and embedParams).", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "409":{ "description":"Conflict: A table with that name already exists.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables--post", "x-filename-id":"vecdb-vector-tables-post" } }, "/vecdb/vector-tables/{vector_table_name}":{ "parameters":[ { "name":"vector_table_name", "in":"path", "required":true, "schema":{ "type":"string", "maxLength":128, "pattern":"^[A-Za-z0-9_]+$" }, "description":"Name of the vector table. Must contain only letters, digits, and underscore (_)." } ], "get":{ "tags":[ "Vector Database/Vector Tables" ], "operationId":"describe_vector_table", "summary":"Describe a vector table.", "description":"Returns metadata for the specified vector table.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Vector table details.", "headers":{ "ETag":{ "description":"Entity tag for the resource.", "schema":{ "type":"string" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBTableNoLinks" } } } }, "404":{ "description":"Not found or precondition failed.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-get", "x-filename-id":"vecdb-vector-tables-vector_table_name-get" }, "delete":{ "tags":[ "Vector Database/Vector Tables" ], "operationId":"drop_vector_table", "summary":"Delete a vector table.", "description":"Drops the specified vector table.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Drop accepted.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string" } } } } } }, "404":{ "description":"Table not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-delete", "x-filename-id":"vecdb-vector-tables-vector_table_name-delete" }, "patch":{ "tags":[ "Vector Database/Vector Tables" ], "operationId":"update_vector_table_annotation", "summary":"Update table description and annotations.", "description":"Updates metadata for the specified table. Only description and annotations are supported. Debug flags may be provided for troubleshooting.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "annotations" ], "properties":{ "annotations":{ "type":"object", "description":"Key-value pairs to attach as user metadata." }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "202":{ "description":"Update accepted.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBTableNoLinks" } } } }, "400":{ "description":"Bad request (invalid JSON, invalid types, missing required fields).", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"Not found or precondition failed.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-patch", "x-filename-id":"vecdb-vector-tables-vector_table_name-patch" } }, "/vecdb/vector-tables/{vector_table_name}/query":{ "post":{ "tags":[ "Vector Database/Vector Search" ], "operationId":"query_vectors", "summary":"Perform a vector similarity search over the specified vector table.", "description":"Perform a vector similarity search using text, a vector or an ID returning the most similar records as well as their distance.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "queryBy", "topK" ], "properties":{ "queryBy":{ "type":"object", "description":"Query by text, vector or id." }, "topK":{ "type":"number", "description":"The topK nearest results." }, "includeVectors":{ "type":"boolean", "description":" indicates whether vector values are included in the response. Defaults to false." }, "filters":{ "type":"object", "description":" Filters to be applied over the vector table metadata." }, "advancedOptions":{ "type":"object", "description":"Additional query parameters." }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "200":{ "description":"List of vectors.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/VecDBSearchItem" } } } } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The specified vector table does not exists.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-query-post", "x-filename-id":"vecdb-vector-tables-vector_table_name-query-post" } }, "/vecdb/vector-tables/{vector_table_name}/upsert":{ "post":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"upsert_vectors", "summary":"Upsert vectors or records into a given vector table.", "description":"Insert or update records into a vector table.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "vectors" ], "properties":{ "vectors":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the vector record." }, "dense_vector":{ "type":"array", "description":"The dense vector to insert.", "items":{ "type":"number", "format":"double" } }, "metadata":{ "type":"object", "description":"The metadata associated to the vector record." } } }, "description":"The vectors to upsert" }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "201":{ "description":"List of vectors.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "upserted_count":{ "type":"number", "description":"The number of upserted records." } } } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The specified vector table does not exists.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-upsert-post", "x-filename-id":"vecdb-vector-tables-vector_table_name-upsert-post" } }, "/vecdb/vector-tables/{vector_table_name}/list":{ "post":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"list_vectors", "summary":"List the records of a given vector table.", "description":"Look up and return vectors by ID from a vector table. The returned vectors include the vector data and/or metadata.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":false, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "ids":{ "type":"array", "items":{ "type":"string" }, "description":"The IDs of the vector table records to list." }, "limit":{ "type":"number", "description":"The maximum number or records to retrieve.", "default":15 }, "offset":{ "type":"number", "description":"Row offset for pagination." }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "200":{ "description":"List of vector records.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBVectorVectorCollection" } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The specified vector table does not exists.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-list-post", "x-filename-id":"vecdb-vector-tables-vector_table_name-list-post" } }, "/vecdb/vector-tables/{vector_table_name}/delete":{ "post":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"delete_vectors", "summary":"Delete vectors with the specified IDs from the specified vector table.", "description":"Delete vectors from a vector table. ", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "ids" ], "properties":{ "ids":{ "type":"array", "items":{ "type":"string" }, "description":"The IDs of the vector table records to delete." }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "200":{ "description":"Deleted vectors count", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string", "description":"Confirmation message." } } } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The specified vector table does not exists.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-tables-{vector_table_name}-delete-post", "x-filename-id":"vecdb-vector-tables-vector_table_name-delete-post" } }, "/vecdb/vector-indexes/":{ "post":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"create_index", "summary":"Creates an IVF or HNSW vector index using create_index API.", "description":"Creates a vector index using create_index API.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "tableName" ], "properties":{ "tableName":{ "type":"string", "description":"The name of the vector table." }, "indexParams":{ "type":"object", "description":"Parameters required to create the vector index.", "properties":{ "organization":{ "type":"string" }, "advanced_params":{ "type":"object" } } }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "200":{ "description":"Description of the vector index creation job that has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobItem" } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The vector table was not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-indexes--post", "x-filename-id":"vecdb-vector-indexes-post" } }, "/vecdb/vector-indexes/jobs/":{ "get":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"list_index_jobs", "summary":"Retrieve all schedulled vector indexes jobs.", "description":"Describes all of the jobs scheduled to create or rebuild a vector index.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Description of all the jobs that have been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobCollection" } } } } }, "x-internal-id":"vecdb-vector-indexes-jobs--get", "x-filename-id":"vecdb-vector-indexes-jobs-get" } }, "/vecdb/vector-indexes/jobs/{index_job_name}/":{ "get":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"describe_index_job", "summary":"Retrieve details of an schedulled vector index job.", "description":"Describes the specified job scheduled to create a vector index.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"index_job_name", "in":"path", "description":"The name of the vector index job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of the vector index creation or rebuild job that have been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobItem" } } } }, "404":{ "description":"The specified index job was not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-indexes-jobs-{index_job_name}--get", "x-filename-id":"vecdb-vector-indexes-jobs-index_job_name-get" } }, "/vecdb/vector-indexes/jobs/{index_job_name}/jobfile":{ "get":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"get_index_job_log", "summary":"Get the logs associated to a scheduled vector index job.", "description":"Returns the log associated to a given vector index job.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"index_job_name", "in":"path", "description":"The name of the load job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of the vector index creation or rebuild jobs that have been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobLogItem" } } } }, "404":{ "description":"The specified index job was not found or the index job has not finished yet.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-indexes-jobs-{index_job_name}-jobfile-get", "x-filename-id":"vecdb-vector-indexes-jobs-index_job_name-jobfile-get" } }, "/vecdb/vector-indexes/{vector_table_name}":{ "post":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"rebuild_index", "summary":"Updates an existing IVF or HNSW vector index using the rebuild_index API.", "description":"Rebuilds the index associated to the specified vector table. A index can be rebuilded with different parameters", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table to which the vector index is associated to.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":false, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "indexParams":{ "type":"object", "description":"Parameters required to create the vector index.", "properties":{ "organization":{ "type":"string" }, "advanced_params":{ "type":"object" } } }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "200":{ "description":"Description of the index rebuild job that has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobItem" } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The vector table was not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-indexes-{vector_table_name}-post", "x-filename-id":"vecdb-vector-indexes-vector_table_name-post" }, "get":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"describe_index", "summary":"Retrieves the status of the vector index associated to the requested vector table.", "description":"Get information about the status of a vector index.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table to which the vector index is associated to.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Status of the vector index", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Index Status":{ "type":"string" } } } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The vector table was not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-indexes-{vector_table_name}-get", "x-filename-id":"vecdb-vector-indexes-vector_table_name-get" }, "delete":{ "tags":[ "Vector Database/Vector Indexes" ], "operationId":"drop_index", "summary":"Drops a vector index.", "description":"Drops the vector index associated to the specified vector table. ", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"vector_table_name", "in":"path", "description":"The name of the vector table to which the vector index is associated to.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Index dropped", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string" } } } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } }, "404":{ "description":"The vector table was not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-vector-indexes-{vector_table_name}-delete", "x-filename-id":"vecdb-vector-indexes-vector_table_name-delete" } }, "/vecdb/load":{ "post":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"load_vectors", "summary":"Load dataset in CSV format, from PAR URL or public bucket.", "description":"Schedule a Job to load data into a vector table", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "tableName", "url" ], "properties":{ "tableName":{ "type":"string", "description":"The name of the vector table." }, "url":{ "type":"string", "description":"PAR url from where the data will be sourced." }, "params":{ "type":"object", "description":"Parameters required to load the dataset into the table. " }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } } } } }, "responses":{ "200":{ "description":"Description of the load job that has been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobItem" } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-load-post", "x-filename-id":"vecdb-load-post" } }, "/vecdb/load/jobs/":{ "get":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"list_vector_load_jobs", "summary":"Retrieve all schedulled load jobs.", "description":"Describes all of the jobs scheduled to load data into a vector table.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "responses":{ "200":{ "description":"Description of all the load jobs that have been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobCollection" } } } } }, "x-internal-id":"vecdb-load-jobs--get", "x-filename-id":"vecdb-load-jobs-get" } }, "/vecdb/load/jobs/{load_job_name}/":{ "get":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"describe_vector_load_job", "summary":"Retrieve details of an schedulled load job.", "description":"Describes the specified job scheduled to load data into a vector table.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"load_job_name", "in":"path", "description":"The name of the load job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of all the load jobs that have been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobItem" } } } }, "404":{ "description":"The specified lod job was not found.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-load-jobs-{load_job_name}--get", "x-filename-id":"vecdb-load-jobs-load_job_name-get" } }, "/vecdb/load/jobs/{load_job_name}/jobfile":{ "get":{ "tags":[ "Vector Database/Vector Operations" ], "operationId":"get_vector_load_job_log", "summary":"Get the logs associated to a scheduled load job.", "description":"Returns the log associated to a given load job.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "parameters":[ { "name":"load_job_name", "in":"path", "description":"The name of the load job.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Description of all the load jobs that have been created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VecDBJobLogItem" } } } }, "404":{ "description":"The specified lod job was not found or the load job has not finished yet.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-load-jobs-{load_job_name}-jobfile-get", "x-filename-id":"vecdb-load-jobs-load_job_name-jobfile-get" } }, "/vecdb/embed":{ "post":{ "tags":[ "Vector Database/Inference Operations" ], "operationId":"generate_embedding", "summary":"Generate text embeddings", "description":"Generate vector embeddings for one or more input texts using an ONNX model hosted in the database.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VectorEmbedRequest" }, "example":{ "modelName":"TEXT_MODEL", "inputs":[ { "text":"Apple is a popular fruit known for its sweetness and crisp texture." }, { "text":"The tech company Apple is known for its innovative products like the iPhone." }, { "text":"Many people enjoy eating apples as a healthy snack." }, { "text":"Apple Inc. has revolutionized the tech industry with its sleek designs and user-friendly interfaces." }, { "text":"An apple a day keeps the doctor away, as the saying goes." }, { "text":"Apple Computer Company was founded on April 1, 1976, by Steve Jobs, Steve Wozniak, and Ronald Wayne as a partnership." } ] } } } }, "responses":{ "200":{ "description":"Embeddings generated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VectorEmbedResponse" }, "example":{ "data":[ { "text":"Apple is a popular fruit known for its sweetness and crisp texture.", "embedding":[ -0.0013012911, 0.008567206, 0.010289432, -0.031064631, -0.082377188, 0.047858458 ] } ] } } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-embed-post", "x-filename-id":"vecdb-embed-post" } }, "/vecdb/rerank":{ "post":{ "tags":[ "Vector Database/Inference Operations" ], "operationId":"rerank", "summary":"Rerank documents by query relevance", "description":"Score and order documents by relevance to a query using an ONNX reranker hosted in the database.", "security":[ { "BasicAuth":[ ] }, { "BearerAuth":[ ] }, { "OAuth2":[ ] } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VectorRerankRequest" }, "example":{ "query":"What is the capital of the United States?", "documents":[ "Carson City is the capital city of the American state of Nevada.", "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.", "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.", "Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.", "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states." ], "modelName":"reranker", "modelParams":{ "provider":"database" } } } } }, "responses":{ "200":{ "description":"Rerank scores for each input document in descending relevance.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VectorRerankResponse" }, "example":[ { "index":2, "score":8.034194946289062 }, { "index":0, "score":4.549003601074219 }, { "index":1, "score":1.1962472200393677 }, { "index":3, "score":-5.338606834411621 }, { "index":4, "score":-6.584031105041504 } ] } } }, "400":{ "description":"The request body included invalid parameters.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ORDSErrorResponse" } } } } }, "x-internal-id":"vecdb-rerank-post", "x-filename-id":"vecdb-rerank-post" } } }, "components":{ "securitySchemes":{ "BasicAuth":{ "type":"http", "scheme":"basic" }, "BearerAuth":{ "type":"http", "scheme":"bearer" }, "OAuth2":{ "type":"oauth2", "flows":{ "implicit":{ "authorizationUrl":"/oauth/auth", "scopes":{ } }, "authorizationCode":{ "authorizationUrl":"/oauth/auth", "tokenUrl":"/oauth/token", "scopes":{ } }, "clientCredentials":{ "tokenUrl":"/oauth/token", "scopes":{ } } } } }, "requestBodies":{ "createNetwork":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "tablespace_name":{ "type":"string", "description":"The name of the tablespace in which to create the RDF network" }, "options":{ "type":"string", "description":"Options to use when creating the RDF network" } } }, "examples":{ "default":{ "summary":"This is an example of basic network creation.", "value":{ "tablespace_name":"DATA" } }, "partitioned":{ "summary":"This is an example of creating a list-hash subpartitioned network with 16 subpartitions per model.", "value":{ "tablespace_name":"DATA", "options":"MODEL_PARTITIONING=BY_HASH_P MODEL_PARTITIONS=16" } } } } } }, "createModel":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "tablespace_name":{ "type":"string", "description":"The name of the tablespace in which to create the RDF model" }, "options":{ "type":"string", "description":"Options to use when creating the RDF model" } } }, "examples":{ "supplied_tbs":{ "summary":"This is an example of creating a model in a specific tablespace (MY_TBS). By default a model is created in the tablespace used for network creation.", "value":{ "tablespace_name":"MY_TBS" } }, "compression":{ "summary":"This is an example of creating a model with Advanced Row Compression (ROW STORE COMPRESS ADVANCED).", "value":{ "options":"COMPRESS=RSCA" } } } } } }, "createEntailment":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "models":{ "type":"array", "items":{ "type":"string" }, "description":"List of models to use for the entailment" }, "rulebases":{ "type":"array", "items":{ "type":"string", "example":"OWLPRIME" }, "description":"List of rulebases to use for the entailment" }, "inf_components":{ "type":"array", "items":{ "type":"string" }, "description":"List of keywords representing inference components, for performing selective or component-based inferencing (the default is all components defined by the included rulebases)" }, "options":{ "type":"string", "description":"A comma-delimited string of options to control the inference process by overriding the default inference behavior" } }, "required":[ "models", "rulebases" ] }, "examples":{ "basic_entailment":{ "summary":"This is an example of creating an entailment using an ontology model (TBOX), a data model (ABOX), and the OWL2RL rulebase.", "value":{ "models":[ "TBOX", "ABOX" ], "rulebases":[ "OWL2RL" ] } }, "entailment_with_options":{ "summary":"This is an example of creating an OWL2 RL entailment using a degree of parallelism of 16 and without generating extra assertions for individuals based on owl:sameAs.", "value":{ "models":[ "M1" ], "rulebases":[ "OWL2RL" ], "inf_components":[ "SAM-" ], "options":"DOP=16" } } } } } }, "createVirtualModel":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "models":{ "type":"array", "items":{ "type":"string", "example":"M1" }, "description":"List of models to use for the virtual model" }, "rulebases":{ "type":"array", "items":{ "type":"string" }, "description":"List of rulebases to use for the virtual model" }, "entailments":{ "type":"array", "items":{ "type":"string" }, "description":"List of entailments to use for the virtual model (only one of rulebases or entailments can be non-null)" }, "options":{ "type":"string", "description":"options for virtual model creation" } }, "required":[ "models" ] }, "examples":{ "basic_mod_vm":{ "summary":"This is an example of creating a virtual model consisting of two models. Option REPLACE=T is used for CREATE OR REPLACE behavior.", "value":{ "models":[ "M1", "M2" ], "options":"REPLACE=T" } }, "basic_rb_vm":{ "summary":"This is an example of creating a virtual model with a set of models and a rulebase. Note that an entailment must be pre-created for the model-rulebase combination.", "value":{ "models":[ "TBOX", "ABOX" ], "rulebases":[ "OWL2RL" ] } }, "baisc_ent_vm":{ "summary":"This is an example of creating a virtual model with a set of models and an entailment. Note that, unlike rulebases, there no constraints limiting model and entailment combinations.", "value":{ "models":[ "SCHEMA_MODEL", "DATA_MODEL" ], "entailments":[ "SCHEMA_ENTAILMENT" ] } } } } } }, "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" ] } } } } } } }, "data-loads":{ "description":"Data Loads to perform", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-loads" } } } }, "data-tools-job":{ "description":"Data Tools Job", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-tools-job" } } } }, "data-tools-jobs":{ "description":"Data Tools Job list", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-tools-jobs" } } } }, "live-table-feeds":{ "description":"Live Table Feeds to create", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/live-table-feeds" } } } }, "cloud-storage-links":{ "description":"Cloud Storage Links to create", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cloud-storage-links" } } } }, "credentials":{ "description":"Credentials to create", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/credentials" } } } }, "surveys":{ "description":"Surveys to perform", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/survey-requests" } } } } }, "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" } } } }, "data-load-statuses":{ "description":"Status of multiple data loads", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-load-statuses" } } } }, "data-load-job-ids":{ "description":"List of Data Loads", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-load-job-ids" } } } }, "surveys":{ "description":"Surveys of input files", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/surveys" } } } }, "data-tools-job":{ "description":"Data Tools job", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-tools-job" } } } }, "data-tools-jobs":{ "description":"Data Tools jobs", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/data-tools-jobs" } } } }, "live-table-feeds":{ "description":"Live Table Feeds", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/live-table-feeds" } } } }, "live-table-feed-key":{ "description":"Live Table Feed notification Key", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/live-table-feed-key" } } } }, "cloud-storage-links":{ "description":"Multiple Cloud Storage Links", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cloud-storage-links" } } } }, "credentials":{ "description":"Multiple Credentials", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/credentials" } } } } }, "schemas":{ "NetworkElemCollection":{ "description":"A collection of RDF networks.", "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/NetworkElem" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "NetworkElem":{ "type":"object", "description":"This object represents a network owner, network name pair.", "properties":{ "owner":{ "type":"string", "example":"RDFUSER", "description":"the owner of the RDF network" }, "network_name":{ "type":"string", "example":"NET1", "description":"the name of the RDF network" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "NetworkDetailElem":{ "description":"Metadata for an RDF network.", "type":"object", "properties":{ "owner":{ "type":"string", "example":"RDFUSER", "description":"the owner of the RDF network" }, "network_name":{ "type":"string", "example":"NET1", "description":"the name of the RDF network" }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/NetworkParameterElem" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "NetworkParameterElem":{ "type":"object", "description":"This object represents a metadata attribute and value.", "properties":{ "namespace":{ "type":"string", "example":"NETWORK", "description":"the attribute category" }, "attribute":{ "type":"string", "example":"COMPRESSION", "description":"the attribute name" }, "value":{ "type":"string", "example":"COMPRESS=RSCB", "description":"the attribute value" }, "description":{ "type":"string", "example":"Compression setting for semantic network", "description":"a description of the attribute" } } }, "ModelDetailCollection":{ "description":"A collection of RDF model metadata items.", "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ModelDetailSingle" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "ModelDetailSingle":{ "description":"Metadata for a single RDF model.", "type":"object", "properties":{ "owner":{ "type":"string", "example":"M1", "description":"the owner of the model" }, "model_id":{ "type":"string", "example":1, "description":"the ID of the model" }, "model_name":{ "type":"string", "example":"M1", "description":"the name of the model" }, "table_name":{ "type":"string", "example":null, "description":"the name of the application table associated with the model (null for schema-private networks)" }, "column_name":{ "type":"string", "example":null, "description":"the name of the SDO_RDF_TRIPLE_S column in the application table associated with the model (null for schema-private networks)" }, "model_tablespace_name":{ "type":"string", "example":"DATA", "description":"the tablespace used to store model data" }, "model_type":{ "type":"string", "example":"M", "description":"the type of model (M for regular model; V for virtual model; X for model created to store the contents of the semantic index; or D for model created on relational data)" }, "inmemory":{ "type":"string", "example":"F", "description":"indicates if the model is an in-memory virtual model (T for in-memory, or F for not in-memory)" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "EntailmentDetailCollection":{ "description":"A collection of RDF entailment metadata items.", "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntailmentDetailSingle" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "EntailmentDetailSingle":{ "type":"object", "description":"This object represents metadata about an RDF entailment.", "properties":{ "owner":{ "type":"string", "example":"RDFUSER", "description":"the owner of the entailment" }, "index_name":{ "type":"string", "example":"M1OWL", "description":"the name of the entailment" }, "index_view_name":{ "type":"string", "example":"NET1#RDFI_M1OWL", "description":"the name of the database view that contains the entailed triples" }, "status":{ "type":"string", "example":"VALID", "description":"the status of the entailment (VALID if the entailment is valid, INVALID if the entailment is not valid, INCOMPLETE if the entailment is incomplete - similar to INVALID but requiring less time to re-create, INPROGRESS if the entailment is being created, or FAILED if a system failure occurred during the creation of the entailment)" }, "model_count":{ "type":"string", "example":1, "description":"the number of models used to build the entailment" }, "rulebase_count":{ "type":"string", "example":1, "description":"the number of rulebases used to build the entailment" }, "datasets":{ "type":"string", "example":"MODEL M1, RULEBASE OWLPRIME", "description":"a comma-delimited list of the names of models and rulebases used to build the entailment" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "VirtualModelDetailCollection":{ "description":"A collection of RDF virtual model metadata items.", "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/VirtualModelDetailSingle" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "VirtualModelDetailSingle":{ "description":"Metadata for a single virtual model.", "type":"object", "properties":{ "owner":{ "type":"string", "example":"RDUSER", "description":"owner of the virtual model" }, "virtual_model_name":{ "type":"string", "example":"VM1", "description":"name of the virtual model" }, "unique_view_name":{ "type":"string", "example":"NET1#SEMU_VM1", "description":"name of the view that contains unique triples in the virtual model, or null if the view was not created" }, "duplicate_view_name":{ "type":"string", "example":"NET1#SEMV_VM1", "description":"name of the view that contains duplicate triples (if any) in the virtual model" }, "status":{ "type":"string", "example":"VALID", "description":"contains VALID if the associated entailment is valid, INVALID if the entailment is not valid, INCOMPLETE if the entailment is incomplete (similar to INVALID but requiring less time to re-create), INPROGRESS if the entailment is being created, FAILED if a system failure occurred during the creation of the entailment, or NORIDX if no entailment is associated with the virtual model. In the case of multiple entailments, the lowest status among all of the component entailments is used as the virtual model's status (INVALID < INCOMPLETE < VALID)." }, "model_count":{ "type":"string", "example":1, "description":"number of models contained in the virtual model" }, "rulebase_count":{ "type":"string", "example":1, "description":"number of rulebases contained in the virtual model" }, "rules_index_count":{ "type":"string", "example":1, "description":"number of entailments contained in the virtual model" }, "datasets":{ "type":"string", "example":"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL", "description":"a comma-delimited list of the names of models, rulebases and entailments used to build the virtual model" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "SparqlXmlResult":{ "externalDocs":{ "description":"SPARQL Query Results XML Format", "url":"https://www.w3.org/TR/2013/REC-rdf-sparql-XMLres-20130321/" }, "type":"object", "xml":{ "name":"sparql" }, "properties":{ "xmlns":{ "type":"string", "example":"http://www.w3.org/2005/sparql-results#", "xml":{ "attribute":true } }, "head":{ "type":"object", "xml":{ "name":"head" }, "properties":{ "variable":{ "type":"object", "xml":{ "name":"variable" }, "properties":{ "name":{ "type":"string", "example":"s", "xml":{ "attribute":true } } } } } }, "boolean":{ "type":"boolean", "example":true }, "results":{ "type":"object", "xml":{ "name":"results" }, "properties":{ "result":{ "type":"object", "xml":{ "name":"result" }, "properties":{ "binding":{ "type":"object", "xml":{ "name":"binding" }, "properties":{ "name":{ "type":"string", "example":"s", "xml":{ "attribute":true } }, "uri":{ "type":"string", "example":"http://www.example.oracle.com/john" }, "literal":{ "type":"object", "xml":{ "name":"literal" }, "properties":{ "xml:lang":{ "type":"string", "example":"en", "xml":{ "attribute":true } }, "datatype":{ "type":"string", "example":"http://www.w3.org/2001/XMLSchema#integer", "xml":{ "attribute":true } } }, "example":"John" }, "bnode":{ "type":"string", "example":"bn1" } } } } } } } } }, "SparqlJsonResult":{ "externalDocs":{ "description":"SPARQL Query Results JSON Format", "url":"https://www.w3.org/TR/sparql11-results-json/" }, "type":"object", "properties":{ "head":{ "type":"object", "properties":{ "vars":{ "type":"array", "items":{ "type":"string" } } } }, "boolean":{ "type":"boolean" }, "results":{ "type":"object", "properties":{ "bindings":{ "type":"array", "items":{ "type":"object", "properties":{ "var":{ "type":"object", "properties":{ "type":{ "type":"string" }, "value":{ "type":"string" }, "xml:lang":{ "type":"string" }, "datatype":{ "type":"string" } } } } } } } } } }, "RDFTextSearchResultCollection":{ "description":"A collection of RDF text search results.", "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/RDFTextSearchResultElem" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "RDFTextSearchResultElem":{ "description":"A single RDF text search result element.", "type":"object", "properties":{ "sub":{ "type":"string", "example":"", "description":"the subject resource" }, "vals":{ "type":"string", "example":"third largest software company in the world... a suite of enterprise software products", "description":"an aggregation of text snippets from object values that match the search string" }, "score":{ "type":"string", "example":14, "description":"the maximum relevance score over all matched object values" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "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." }, "workspace_description":{ "type":"string", "description":"The description for the workspace." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "APEXDatasets":{ "type":"object", "description":"This object represents data from APEX_DR_DATASETS view.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatasetItem" } }, "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" } } } }, "APEXApplications":{ "type":"object", "description":"This object represents data from APEX_APPLICATIONS view.", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/APEXApplicationsItem" } }, "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" } } } }, "DatasetItem":{ "type":"object", "description":"This object represents a single row on APEX_DR_DATASETS", "properties":{ "dataset_id":{ "type":"integer", "description":"Dataset Primary Key." }, "dataset_name":{ "type":"string", "description":"The name of this Dataset." }, "dataset_description":{ "type":"string", "description":"A description about this Dataset." }, "static_id":{ "type":"string", "description":"The static ID of the dataset" }, "workspace_display_name":{ "type":"string", "description":"The displayed name of the workspace." }, "workspace":{ "type":"string", "description":"The internal name of the workspace." }, "workspace_id":{ "type":"string", "description":"The unique ID of the workspace." }, "last_updated_by":{ "type":"string", "description":"Last updated by." }, "last_updated_on":{ "type":"string", "description":"The date and time of the last update." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "APEXApplicationsItem":{ "type":"object", "description":"This object represents a single row on APEX_APPLICATIONS.", "properties":{ "application_id":{ "type":"integer", "description":"Application Primary Key, Unique over all workspaces." }, "application_name":{ "type":"string", "description":"The name of this application." }, "application_alias":{ "type":"string", "description":"The alternate alphanumeric application identifier." }, "application_group":{ "type":"string", "description":"The alternate alphanumeric application identifier." }, "application_owner":{ "type":"string", "description":"The alternate alphanumeric application identifier." }, "page_count":{ "type":"integer", "description":"Number of application pages." }, "workspace":{ "type":"string", "description":"The internal name of the workspace." }, "availability_status":{ "type":"string", "description":"Specifies whether or not the application is available or unavailable for use." }, "last_updated_by":{ "type":"string", "description":"Last updated by." }, "last_updated_on":{ "type":"string", "description":"The date and time of the last update." }, "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" } } } }, "RestClientCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestClientCollectionItem" } }, "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" } } } }, "RestClientCollectionItem":{ "type":"object", "description":"ORDS OAuth clients", "properties":{ "id":{ "type":"integer", "description":"The original generated client identifier." }, "name":{ "type":"string", "description":"The name for the client." }, "grant_type":{ "type":"string", "description":"OAuth grant type. Must be one of: authorization_code, implicit, or client_credentials." }, "description":{ "type":"string", "description":"Description of the purpose of the client." }, "auth_flow":{ "type":"string", "description":"OAuth flow type." }, "response_type":{ "type":"string", "description":"OAuth response type" }, "client_id":{ "type":"string", "description":"A unique string identifier of a client." }, "client_secret":{ "type":"string", "description":"The client secret for slot 1." }, "client_secret_issued_on":{ "type":"string", "description":"Date and time when the client secret was generated or issued." }, "client_secret_2":{ "type":"string", "description":"The client secret for slot 2." }, "client_secret_2_issued_on":{ "type":"string", "description":"Date and time when the client secret was generated or issued." }, "token_duration":{ "type":"string", "description":"Duration of the access token in seconds. " }, "refresh_duration":{ "type":"string", "description":"Duration of refresh token in seconds. NULL duration fallsback to the value in the ORDS instance." }, "code_duration":{ "type":"string", "description":"Duration of the code token in seconds applicable only when authorization code is authorization_code." }, "redirect_uri":{ "type":"string", "description":"Client-controlled URI to which redirect containing an OAuth access token or error is sent." }, "support_email":{ "type":"string", "description":"The URI to contact the client for support." }, "support_uri":{ "type":"string", "description":"The URI where to contact the client for support." }, "allowed_origins":{ "type":"string", "description":"The comma-separated list of URL prefixes." }, "about_url":{ "type":"string", "description":"The URL that provides more information for the client" }, "logo_content_type":{ "type":"string", "description":"The content type of the logo." }, "logo_image":{ "type":"string", "description":"The logo of the OAuth client." }, "schema_id":{ "type":"string", "description":"The schema registration id." }, "created_by":{ "type":"string", "description":"The user who created the client" }, "created_on":{ "type":"string", "description":"Date and time when the client was created." }, "updated_by":{ "type":"string", "description":"The user who updated the client" }, "updated_on":{ "type":"string", "description":"Date and time when the client was updated." }, "privilege_names":{ "type":"string", "description":"List of comma-separated privileges that the client wants to access." }, "role_names":{ "type":"string", "description":"The names of the roles that was granted." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "RestClientSecretItem":{ "type":"object", "description":"This object represents a new client secret .", "properties":{ "id":{ "type":"integer", "description":"The original generated client identifier." }, "name":{ "type":"string", "description":"The name for the client." }, "client_secret":{ "type":"string", "description":"The client secret for slot 1." }, "client_secret_2":{ "type":"string", "description":"The client secret for slot 2." }, "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." }, "constraint_type":{ "type":"string", "description":"Type of constraint." }, "table_name":{ "type":"string", "description":"Name associated with the table (or view) with the constraint definition." }, "r_owner":{ "type":"string", "description":"Owner of the table referred to in a referential constraint." }, "r_constraint_name":{ "type":"string", "description":"Owner of the constraint definition." }, "columns":{ "type":"object", "description":"Describes all the columns that make reference to owner, constraint_name.", "properties":{ "r_column_name":{ "type":"string", "description":"Name of the column referred to in a referential constraint." }, "r_table_name":{ "type":"string", "description":"Name of the table referred to in a referential constraint." }, "column_name":{ "type":"string", "description":"Name of the column or attribute of the object type column specified in the constraint definition." }, "position":{ "type":"integer", "description":"The position of the column_name and referenced r_column_name." } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "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" } } } }, "DatabasePluggableSnapshots":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabasePluggableSnapshotItem" } }, "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" } } } }, "DatabasePluggableSnapshotItem":{ "type":"object", "description":"This object describes Pluggable Database Snapshots associated with the current instance.", "properties":{ "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "con_uid":{ "type":"integer", "description":"Unique identifier associated with the PDB." }, "con_name":{ "type":"string", "description":"Name of the PDB." }, "snapshot_name":{ "type":"string", "description":"Snapshot name of the PDB." }, "snapshot_scn":{ "type":"integer", "description":"SCN at which the snapshot was taken." }, "previous_snapshot_scn":{ "type":"integer", "description":"SCN at which the previous snapshot for the PDB was taken" }, "snapshot_time":{ "type":"integer", "description":"Timestamp at which the snapshot was taken." }, "previous_snapshot_time":{ "type":"integer", "description":"Timestamp of the previous snapshot for this PDB." }, "full_snapshot_path":{ "type":"string", "description":"Full path for the snapshot." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabasePluggableSnapshotWithFileItem":{ "type":"object", "description":"This object describes Pluggable Database Snapshots and snapshot files associated with the current instance.", "properties":{ "con_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "con_uid":{ "type":"integer", "description":"Unique identifier associated with the PDB." }, "con_name":{ "type":"string", "description":"Name of the PDB." }, "snapshot_name":{ "type":"string", "description":"Snapshot name of the PDB." }, "snapshot_scn":{ "type":"integer", "description":"SCN at which the snapshot was taken." }, "previous_snapshot_scn":{ "type":"integer", "description":"SCN at which the previous snapshot for the PDB was taken" }, "snapshot_time":{ "type":"integer", "description":"Timestamp at which the snapshot was taken." }, "previous_snapshot_time":{ "type":"integer", "description":"Timestamp of the previous snapshot for this PDB." }, "full_snapshot_path":{ "type":"string", "description":"Full path for the snapshot." }, "snapshot_files":{ "type":"string", "description":"The snapshot files." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "DatabasePluggableSnapshotModeItem":{ "type":"object", "description":"This object describes Pluggable Database Snapshot mode associated with the current instance.", "properties":{ "pdb_id":{ "type":"integer", "description":"The ID of the container to which the data pertains." }, "pdb_name":{ "type":"string", "description":"Name of the PDB." }, "snapshot_mode":{ "type":"string", "description":"AUTO, MANUAL or NONE." }, "snapshot_interval":{ "type":"integer", "description":"Pluggable database snapshot interval, in minutes." }, "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" } } }, "VecDBVectorVectorCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/VecDBVectorVectorItem" } }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "count":{ "type":"number" } } }, "VecDBVectorVectorItem":{ "type":"object", "properties":{ "id":{ "type":"string" }, "dense_vector":{ "type":"array", "items":{ "type":"number", "format":"double" } }, "metadata":{ "type":"object", "nullable":true } } }, "VecDBSearchItem":{ "type":"object", "properties":{ "id":{ "type":"string" }, "metadata":{ "type":"object" }, "vector":{ "type":"array", "items":{ "type":"number", "format":"double" } }, "distance":{ "type":"number", "format":"double" } } }, "ModelsCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ModelItemWithLinks" } }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "count":{ "type":"number" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "ModelItem":{ "type":"object", "properties":{ "model_name":{ "type":"string" }, "algorithm":{ "type":"string" }, "mining_function":{ "type":"string" }, "creation_date":{ "type":"string" }, "attributes":{ "type":"array", "items":{ "$ref":"#/components/schemas/ModelAttributeItem" } } } }, "ModelItemWithLinks":{ "allOf":[ { "$ref":"#/components/schemas/ModelItem" }, { "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } } ] }, "ModelAttributeItem":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "data_type":{ "type":"string" }, "data_length":{ "type":"number" }, "vector_info":{ "type":"string", "nullable":true } } }, "SummaryItem":{ "type":"object", "properties":{ "total_tables":{ "type":"number" }, "total_vectors":{ "type":"number" }, "total_models":{ "type":"number" } } }, "VecDBJobItem":{ "type":"object", "properties":{ "job_name":{ "type":"string" }, "job_creator":{ "type":"string" }, "job_type":{ "type":"string" }, "operation":{ "type":"string" }, "state":{ "type":"string" }, "start_date":{ "type":"string", "nullable":true }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "VecDBJobLogItem":{ "type":"object", "properties":{ "log_date":{ "type":"string" }, "job_name":{ "type":"string" }, "status":{ "type":"string" }, "error#":{ "type":"integer" }, "additional_info":{ "type":"string", "nullable":true }, "actual_start_date":{ "type":"string" }, "run_duration":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "VecDBJobCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/VecDBJobItem" } }, "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" } } } }, "VecDBTableCollection":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/VecDBTableItem" } }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "count":{ "type":"number" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "VecDBTableItem":{ "allOf":[ { "$ref":"#/components/schemas/VecDBTableNoLinks" }, { "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } } ] }, "VecDBTableNoLinks":{ "type":"object", "properties":{ "table_name":{ "type":"string", "description":"The name of the table" }, "description":{ "type":"string", "description":"Description of the vector table", "nullable":true }, "auto_generate_id":{ "type":"integer", "description":"Whether the ID column of the table should be auto generated. Defaults to false." }, "owner":{ "type":"string" }, "status":{ "type":"string", "description":"Population status of the vector table." }, "vector_type":{ "type":"string", "enum":[ "dense" ] }, "vector_table_type":{ "type":"string", "enum":[ "BYOV", "MODEL" ], "description":"Creation mode of the table." }, "index_params":{ "description":"Index configuration for the table.", "type":"object", "properties":{ "indexing":{ "type":"string" }, "organization":{ "type":"string" }, "distance_metric":{ "type":"string" }, "accuracy":{ "type":"integer" }, "advanced_params":{ "type":"object", "properties":{ "partitions":{ "type":"number", "nullable":true }, "efConstruction":{ "type":"number", "nullable":true }, "neighbors":{ "type":"number", "nullable":true } } } }, "nullable":true }, "annotations":{ "description":"User metadata attached to the table.", "type":"object", "nullable":true }, "embed_params":{ "description":"Embedding model configuration (MODEL tables).", "nullable":true, "properties":{ "model":{ "type":"string" }, "embed_metadata_jsonpath":{ "type":"string" } } }, "dense_idx_name":{ "type":"string", "description":"The name of the vector index associated to the vector table.", "nullable":true }, "stats":{ "type":"object", "description":"Statistics of the vector table", "nullable":true, "properties":{ "total_vectors":{ "type":"number", "nullable":true } } }, "created":{ "type":"string", "format":"date-time", "description":"Creation timestamp of the vector table." }, "updated":{ "type":"string", "format":"date-time", "description":"Creation timestamp of the vector table.", "nullable":true } } }, "VectorEmbedRequest":{ "type":"object", "required":[ "modelName", "inputs" ], "properties":{ "modelName":{ "type":"string", "description":"The name of the text embedding model hosted in the database." }, "inputs":{ "type":"array", "description":"Array of input items to embed.", "minItems":1, "items":{ "$ref":"#/components/schemas/VectorEmbedInputItem" } }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } }, "VectorEmbedResponse":{ "type":"object", "required":[ "data" ], "properties":{ "data":{ "type":"array", "description":"List of generated embeddings.", "items":{ "$ref":"#/components/schemas/VectorEmbedItem" } } } }, "VectorEmbedInputItem":{ "type":"object", "required":[ "text" ], "properties":{ "text":{ "type":"string", "description":"Input text to embed." } } }, "VectorEmbedItem":{ "type":"object", "required":[ "text", "embedding" ], "properties":{ "text":{ "type":"string", "description":"Echo of the input text." }, "embedding":{ "type":"array", "description":"Embedding vector for the input text.", "items":{ "type":"number", "format":"double" } } } }, "VectorRerankRequest":{ "type":"object", "required":[ "query", "documents", "modelName" ], "properties":{ "query":{ "type":"string", "description":"Natural language query to use for reranking." }, "documents":{ "type":"array", "description":"Array of raw document strings to score.", "minItems":1, "items":{ "type":"string" } }, "modelName":{ "type":"string", "description":"The name of the ONNX reranking model hosted in the database." }, "modelParams":{ "type":"object", "description":"Model-specific parameters.", "additionalProperties":true, "properties":{ "provider":{ "type":"string", "description":"Optional model provider (e.g., 'database')." } } }, "debugFlags":{ "$ref":"#/components/schemas/VectorDebugFlags" } } }, "VectorRerankItem":{ "type":"object", "required":[ "index", "score" ], "properties":{ "index":{ "type":"integer", "format":"int32", "description":"Zero-based index of the input document in the request payload." }, "score":{ "type":"number", "format":"double", "description":"Relevance score for the document (higher is more relevant)." } } }, "VectorRerankResponse":{ "type":"array", "description":"List of rerank results sorted by descending relevance.", "items":{ "$ref":"#/components/schemas/VectorRerankItem" } }, "VectorDebugFlags":{ "type":"object", "description":"Debug flags to be used to trace vector modules", "properties":{ "VECTOR_INDEX":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_GRAPH":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_GRAPH_BUILD":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_GRAPH_MEM":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_GRAPH_SEARCH":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_GRAPH_APPCHNG":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_GRAPH_STATS":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_NEIGHBOR_PARTITIONS":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_INDEX_FIXED_VIEW":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS_COM":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS_PJ":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS_PJ_DWNGRD":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS_PJ_GROW":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS_SJ":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECIDX_TRANS_SJ_BG":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VEC_INDEX_CALIBRATION":{ "type":"string", "enum":[ "low", "medium", "high" ] }, "VECTOR_TRACE":{ "type":"string", "enum":[ "low", "medium", "high" ] } } }, "VectorIndexParams":{ "description":"Index configuration for the table.", "type":"object", "properties":{ "indexing":{ "type":"string", "enum":[ "manual", "auto" ], "default":"auto" }, "organization":{ "type":"string", "enum":[ "PARTITIONS", "INMEMORY GRAPH" ], "default":"PARTITIONS" }, "distance_metric":{ "type":"string", "enum":[ "COSINE", "MANHATTAN", "HAMMING", "JACCARD", "DOT", "EUCLIDEAN", "L2_SQUARED", "EUCLIDEAN_SQUARED" ] }, "accuracy":{ "type":"integer", "minimum":0, "maximum":100 }, "advanced_params":{ "type":"object" } } }, "ORDSErrorResponse":{ "type":"object", "required":[ "code", "message", "type", "instance" ], "properties":{ "code":{ "type":"string" }, "message":{ "type":"string" }, "type":{ "type":"string" }, "instance":{ "type":"string" }, "diagnosticTrace":{ "type":"string" }, "stackTrace":{ "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" } } }, "data_load_name":{ "type":"string", "example":"MY_LOAD_OF_SALES", "description":"Descriptive name for data load" }, "table_name":{ "type":"string", "example":"SALES", "description":"Table name to load" }, "schema_name":{ "type":"string", "example":"SH", "description":"Database object schema" }, "data_load_job_id":{ "type":"string", "example":"SALES-LOAD-20220529-112233-4567", "description":"Name of data load job" }, "survey_name":{ "type":"string", "example":"SALES-SURVEY-20220605-112233-4567", "description":"Name of input data survey" }, "column_name":{ "type":"string", "example":"UNITS", "description":"Column name in table" }, "storage_link_name":{ "type":"string", "example":"MY-BUCKET", "description":"Name of Cloud Storage Link" }, "object_filter":{ "type":"string", "example":"*.csv", "description":"Filter to select subset of files" }, "object_filter_type":{ "type":"string", "description":"Type of matching for object_filter", "example":"GLOB", "enum":[ "GLOB", "REGEX" ] }, "column":{ "type":"object", "properties":{ "column_name":{ "$ref":"#/components/schemas/column_name" }, "field_name":{ "type":"string", "example":"customer name", "description":"Name of column in input file" }, "column_id":{ "type":"integer", "example":2, "description":"Column position in input file" }, "data_type":{ "type":"string", "example":"NUMBER", "description":"Data type of column", "enum":[ "VARCHAR2", "CLOB", "NUMBER", "INTEGER", "FLOAT", "BINARY_FLOAT", "BINARY_DOUBLE", "DATE", "TIMESTAMP", "TIMESTAMP WITH TIME ZONE", "TIMESTAMP WITH LOCAL TIME ZONE", "NVARCHAR2", "NCLOB", "BOOLEAN", "VECTOR" ] }, "data_length":{ "type":"integer", "example":40, "description":"Length or precision of column" }, "data_precision":{ "type":"integer", "example":10, "description":"Precision of data for certain column types" }, "data_scale":{ "type":"integer", "example":2, "description":"Scale of data for certain column types" }, "data_format":{ "type":"string", "example":"YYYY-MM-DD", "description":"Data format for certain column types" }, "skip_column":{ "type":"boolean", "example":false, "description":"Set to true to not load this column" }, "column_expression":{ "type":"string", "example":"SYSTIMESTAMP", "description":"Populate this column with data about the load", "enum":[ "FILE$NAME", "PATH$NAME", "SYSTIMESTAMP" ] }, "column_expression_type":{ "type":"string", "example":"SDO_LENGTH", "description":"Populate this column intelligently from another column", "enum":[ "SDO_AREA", "SDO_LENGTH", "SENTIMENT", "TRANSLATION", "KEY_PHRASE_EXTRACTION", "LANGUAGE_DETECTION" ] }, "source_path":{ "type":"string", "example":"$.EmpNo", "description":"The JSON path expression for this column" }, "merge_key":{ "type":"boolean", "description":"If true, use this column as a merge key for merge operations" }, "primary_key":{ "type":"boolean", "description":"Set this column to be the primary key for the table" }, "geojson_tolerance":{ "type":"number", "example":0.5, "description":"Level of precision for GEOJSon data" }, "geojson_unit":{ "type":"string", "example":"KM", "description":"Unit of GEOJson data for column from SDO_UNITS_OF_MEASURE table" } } }, "columns":{ "type":"array", "items":{ "$ref":"#/components/schemas/column" }, "example":[ { "column_name":"RECEIVED_DATE", "datatype":"DATE", "columnId":1, "format":"YYYY-MM-DD" }, { "column_name":"UNITS", "datatype":"NUMBER", "columnId":2, "length":38 } ] }, "sql_statements":{ "type":"array", "items":{ "description":"SQL statement", "type":"string" }, "description":"SQL statements to perform database operation", "example":[ "CREATE TABLE \"MYSCHEMA\".\"EXAMPLE_TABLE\"(\"ID\" NUMBER, \"DATE_RECV\" DATE);" ] }, "format":{ "type":"object", "example":{ "delimiter":",", "blankasnull":true, "characterset":"AL32UTF8" }, "description":"DBMS_CLOUD.COPY_DATA formatting options" }, "data_load_object":{ "type":"object", "properties":{ "object_name":{ "type":"string", "description":"Name of object to load", "example":"sales.csv" } } }, "data_load_objects":{ "type":"array", "items":{ "$ref":"#/components/schemas/data_load_object" }, "example":[ { "object_name":"sales1976.csv" }, { "object_name":"sales2009.csv" }, { "object_name":"sales2013.csv" } ] }, "data-load":{ "type":"object", "properties":{ "data_load_name":{ "$ref":"#/components/schemas/data_load_name" }, "data_load_job_id":{ "$ref":"#/components/schemas/data_load_job_id" }, "table_name":{ "$ref":"#/components/schemas/table_name" }, "table_schema":{ "$ref":"#/components/schemas/schema_name" }, "objects":{ "$ref":"#/components/schemas/data_load_objects" }, "storage_link_name":{ "$ref":"#/components/schemas/storage_link_name" }, "columns":{ "$ref":"#/components/schemas/columns" }, "object_filter":{ "$ref":"#/components/schemas/object_filter" }, "object_filter_type":{ "$ref":"#/components/schemas/object_filter_type" }, "partition_column_name":{ "type":"string", "example":"FISCAL_YEAR", "description":"Column name to partition table on" }, "format":{ "$ref":"#/components/schemas/format" }, "sql_statements":{ "$ref":"#/components/schemas/sql_statements" }, "merge_keys":{ "type":"array", "items":{ "type":"string", "description":"Column name to merge on" }, "example":"[ 'RECORD_ID' ]" }, "table_exists_action":{ "type":"string", "example":"APPEND", "description":"Action to take when there is an existing table.", "enum":[ "SKIP", "APPEND", "TRUNCATE", "MERGE", "REPLACE" ] }, "target_type":{ "type":"string", "example":"TABLE", "description":"Type of database object to create.", "enum":[ "TABLE", "EXTERNAL_TABLE" ] } } }, "data-loads":{ "type":"object", "properties":{ "data_loads":{ "type":"array", "items":{ "$ref":"#/components/schemas/data-load" } } } }, "data-load-job-id":{ "type":"object", "description":"ID of data load job", "properties":{ "data_load_job_id":{ "$ref":"#/components/schemas/data_load_job_id" } } }, "data-load-job-ids":{ "type":"object", "description":"List of data load job IDs", "properties":{ "data_load_job_ids":{ "type":"array", "items":{ "$ref":"#/components/schemas/data-load-job-id" } } } }, "data-load-status":{ "type":"object", "description":"Status of a data load job", "properties":{ "data_load_job_id":{ "$ref":"#/components/schemas/data_load_job_id" }, "progress":{ "type":"integer", "example":42, "description":"Percentage complete" }, "rows_loaded":{ "type":"integer", "example":10342, "description":"Rows loaded so far" }, "rows_rejected":{ "type":"integer", "example":3, "description":"Rows rejected so far" }, "rows_total":{ "type":"integer", "example":16572, "description":"Total rows for completed job" }, "rows_total_estimate":{ "type":"integer", "example":15000, "description":"Estimated total rows for in-progress job" }, "state":{ "type":"string", "enum":[ "RUNNING", "COMPLETE", "INPROGRESS", "WAITING" ] }, "timestamp":{ "type":"string", "example":"2022-06-05 07:30:00" }, "time_completion":{ "type":"string", "example":"2022-05-29 01:30:00" }, "exception_details":{ "type":"object", "description":"Exception details for failed job" } } }, "data-load-statuses":{ "type":"object", "description":"Status of data load jobs", "properties":{ "data_load_statuses":{ "type":"array", "items":{ "$ref":"#/components/schemas/data-load-status" } } } }, "data_tools_step":{ "type":"object", "description":"Step of a Data Tools job", "discriminator":{ "propertyName":"type", "mapping":{ "data_load":"data_tools_step_data_load", "smart_table":"data_tools_step_smart_table", "procedure":"data_tools_step_procedure", "live_feed":"data_tools_step_live_feed", "http":"data_tools_step_http" } }, "properties":{ "type":{ "type":"string", "example":"data_load", "description":"Type of step", "enum":[ "data_load", "smart_table", "procedure", "live_feed", "http" ] }, "step_name":{ "type":"string", "example":"LOAD_MY_TABLE", "description":"Optional name of step" }, "on_errors":{ "type":"string", "example":"continue", "description":"Action when encountering step error", "enum":[ "stop", "continue" ] } }, "required":[ "type" ] }, "data_tools_step_data_load":{ "allOf":[ { "$ref":"#/components/schemas/data_tools_step" }, { "type":"object", "description":"Data load step of a Data Tools job", "properties":{ "data_load_name":{ "type":"string", "example":"SALES_LOAD", "description":"Name of data load to invoke for data_load step" } }, "required":[ "data_load_name" ], "example":{ "type":"data_load", "step_name":"Load the SALES table", "data_load_name":"SALES_LOAD", "on_errors":"stop" } } ] }, "data_tools_step_smart_table":{ "allOf":[ { "$ref":"#/components/schemas/data_tools_step" }, { "type":"object", "description":"Smart table AI assist step of a Data Tools job", "properties":{ "recipe_name":{ "type":"string", "example":"EXTRACT_BIRTH_YEAR_FROM_DATE", "description":"Name of smart table AI assist recipe to invoke" } }, "required":[ "recipe_name" ], "example":{ "type":"smart_table", "step_name":"Get the birth year from the date", "recipe":"EXTRACT_BIRTH_YEAR_FROM_DATE", "on_errors":"continue" } } ] }, "data_tools_step_procedure":{ "allOf":[ { "$ref":"#/components/schemas/data_tools_step" }, { "type":"object", "description":"Data load step of a Data Tools job", "properties":{ "procedure":{ "type":"string", "example":"MY_PACKAGE.RUN_MY_SPECIAL_PLSQL", "description":"Name of PL/SQL procedure to invoke for procedure step" }, "arguments":{ "type":"array", "example":[ "A string!", 14, true ], "description":"Name of data load to invoke for data_load step", "items":{ "oneOf":[ { "type":"number" }, { "type":"string" }, { "type":"boolean" } ] } } }, "required":[ "procedure" ], "example":{ "type":"procedure", "procedure":"DBMS_OUTPUT.PUT_LINE", "arguments":[ "Print this!" ] } } ] }, "data_tools_step_live_feed":{ "allOf":[ { "$ref":"#/components/schemas/data_tools_step" }, { "type":"object", "description":"Live feed trigger step of a Data Tools job", "properties":{ "live_feed":{ "type":"string", "example":"LEDGER_FEED", "description":"Name of Live Table Feed to invoke" } }, "required":[ "live_feed" ], "example":{ "type":"live_feed", "live_feed":"LEDGER_FEED" } } ] }, "data_tools_step_http":{ "allOf":[ { "$ref":"#/components/schemas/data_tools_step" }, { "type":"object", "description":"HTTP/REST step of a Data Tools job", "properties":{ "url":{ "type":"string", "example":"https://myendpoint.oracleoci.com/let/me/know/", "description":"URL of endpoint to query" }, "method":{ "type":"string", "example":"GET", "description":"HTTP Verb for endpoint", "enum":[ "GET", "PUT", "PATCH", "POST", "HEAD" ] }, "credential_name":{ "type":"string", "example":"MYCRED", "description":"Credential name for to authenticate to endpoint" }, "body":{ "type":"string", "example":{ "action":"inform", "status":"completed" }, "description":"Body to send to endpoint" } }, "required":[ "url" ], "example":{ "type":"http", "url":"https://data-tools-enthusiast.adb.us-ashburn-1.oraclecloudapps.com/my-endpoint", "method":"POST", "credential_name":"MYAUTHTOKEN", "body":"{ \"status\": \"done\" }" } } ] }, "email-array":{ "type":"array", "example":[ "data_studio_user@oracle.com", "oci_enthusiast@oracle.com" ], "items":{ "description":"Email address to notify", "type":"string", "example":"data_studio_user@oracle.com" } }, "data-tools-job-reporting-options":{ "type":"object", "properties":{ "smtp":{ "$ref":"#/components/schemas/email-array" } } }, "data-tools-job-reporting":{ "type":"object", "properties":{ "completed":{ "$ref":"#/components/schemas/data-tools-job-reporting-options" }, "errors":{ "$ref":"#/components/schemas/data-tools-job-reporting-options" }, "failed":{ "$ref":"#/components/schemas/data-tools-job-reporting-options" } } }, "data-tools-job":{ "type":"object", "properties":{ "job_name":{ "$ref":"#/components/schemas/data_tools_job_name" }, "owner":{ "$ref":"#/components/schemas/schema_name" }, "description":{ "type":"string", "example":"My job to load and manipulate data", "description":"Descrip1tion of the Data Tools job" }, "steps":{ "type":"array", "items":{ "$ref":"#/components/schemas/data_tools_step" }, "example":[ { "type":"data_load", "step_name":"Load the SALES table", "data_load_name":"SALES_LOAD", "on_errors":"stop" }, { "type":"smart_table", "step_name":"Get the birth year from the date", "recipe":"EXTRACT_BIRTH_YEAR_FROM_DATE", "on_errors":"continue" }, { "type":"procedure", "procedure":"DBMS_OUTPUT.PUT_LINE", "arguments":[ "Print this!" ] }, { "type":"http", "url":"https://data-tools-enthusiast.adb.us-ashburn-1.oraclecloudapps.com/my-endpoint", "method":"POST", "credential_name":"MYAUTHTOKEN", "body":"{ \"status\": \"done\" }" } ] }, "start_date":{ "$ref":"#/components/schemas/live_feed_timestamp", "example":"2009-08-12T07:47:21.212121000-04:00" }, "repeat_interval":{ "type":"string", "example":"FREQ=DAILY;BYHOUR=9;BYMINUTE=30;BYDAY=MON,TUE,WED,THU,FRI", "description":"DBMS_SCHEDULER interval for Data Tools job" }, "end_date":{ "$ref":"#/components/schemas/live_feed_timestamp", "example":"2013-06-05T06:36:21.212121000-04:00" }, "reporting":{ "$ref":"#/components/schemas/data-tools-job-reporting" } } }, "data-tools-jobs":{ "type":"object", "properties":{ "data_loads":{ "type":"array", "items":{ "$ref":"#/components/schemas/data-tools-job" } } } }, "data_tools_job_name":{ "type":"string", "example":"LOAD_AND_MODIFY_SALES" }, "live-table-feed":{ "type":"object", "properties":{ "live_table_feed_name":{ "$ref":"#/components/schemas/live_table_feed_name" }, "table_name":{ "$ref":"#/components/schemas/table_name" }, "table_schema":{ "$ref":"#/components/schemas/schema_name" }, "column_list":{ "$ref":"#/components/schemas/columns" }, "object_type":{ "$ref":"#/components/schemas/live_feed_object_type" }, "object_format":{ "$ref":"#/components/schemas/loader_format" }, "storage_link_name":{ "$ref":"#/components/schemas/storage_link_name" }, "object_filter":{ "$ref":"#/components/schemas/object_filter" }, "object_filter_type":{ "$ref":"#/components/schemas/object_filter_type" }, "scheduled":{ "type":"boolean", "example":true, "description":"Is the Live Table Feed scheduler job enabled?" }, "scheduler_interval":{ "type":"string", "example":"FREQ=DAILY;BYHOUR=9;BYMINUTE=30;BYDAY=MON,TUE,WED,THU,FRI", "description":"DBMS_SCHEDULER interval for Live Table Feed job" }, "notifications":{ "type":"boolean", "example":false, "description":"Is the Live Table Feed enabled for notifications?" }, "job_class":{ "$ref":"#/components/schemas/job_class" }, "start_date":{ "$ref":"#/components/schemas/live_feed_timestamp", "example":"2009-08-12T07:47:21.212121000-04:00" }, "end_date":{ "$ref":"#/components/schemas/live_feed_timestamp", "example":"2013-06-05T06:36:21.212121000-04:00" }, "sql_statements":{ "$ref":"#/components/schemas/sql_statements" } } }, "live-table-feed-key":{ "type":"object", "properties":{ "live_table_feed_key":{ "type":"string", "example":"x17sSGjaXrCgy2QQKKIpMdMi1zESM_kRX9g4#f5Y6ZUNi#SYo4Y4qjJRyXKiOlTyWnU01vx#vF1lBS#bTzC4gNeZZ1Zih#iK3Qoo", "description":"Key for notification services to trigger the Live Feed" } } }, "live-table-feeds":{ "type":"object", "properties":{ "live_table_feeds":{ "type":"array", "items":{ "$ref":"#/components/schemas/live-table-feed" } } } }, "live_table_feed_name":{ "type":"string", "example":"SALES_FEED" }, "live_feed_object_type":{ "type":"string", "enum":[ "CSV", "JSON", "XLSX", "IMAGE", "ICEBERG" ] }, "live_feed_timestamp":{ "type":"string", "example":"2009-08-12T07:47:21.212121000-04:00", "description":"A data and time of the format YYYY-MM-DDTHH24:MI:SS.FFTZH:TZM" }, "job_class":{ "type":"string", "example":"HIGH", "description":"Scheduler job class" }, "loader_format":{ "type":"object", "description":"SQL Loader options", "example":{ "ignoreblanklines":true, "ignoremissingcolumns":true, "blankasnull":true, "rejectlimit":10000, "trimspaces":"lrtrim", "characterset":"AL32UTF8", "skipheaders":1 } }, "cloud-storage-link":{ "type":"object", "properties":{ "storage_link_name":{ "$ref":"#/components/schemas/storage_link_name" }, "storage_link_description":{ "type":"string", "example":"My bucket for CSV files", "description":"Description of Cloud Storage Link" }, "credential_name":{ "type":"string", "example":"MYCRED", "description":"Credential name used to access bucket" }, "uri":{ "type":"string", "example":"https://objectstorage.us-ashburn-1.oraclecloud.com/n/kdnmfs3kdj2x/b/my-bucket/o/", "description":"URI of bucket for Cloud Storage Links" }, "sql_statements":{ "$ref":"#/components/schemas/sql_statements" } } }, "cloud-storage-links":{ "type":"object", "properties":{ "cloud_storage_links":{ "type":"array", "items":{ "$ref":"#/components/schemas/cloud-storage-link" } } } }, "survey-request":{ "type":"object", "properties":{ "survey_name":{ "$ref":"#/components/schemas/survey_name" }, "objects":{ "$ref":"#/components/schemas/data_load_objects" }, "storage_link_name":{ "$ref":"#/components/schemas/storage_link_name" }, "format":{ "$ref":"#/components/schemas/format" } } }, "survey-requests":{ "type":"object", "properties":{ "surveys":{ "type":"array", "items":{ "$ref":"#/components/schemas/survey-request" } } } }, "survey":{ "type":"object", "properties":{ "survey_name":{ "$ref":"#/components/schemas/survey_name" }, "objects":{ "$ref":"#/components/schemas/data_load_objects" }, "storage_link_name":{ "$ref":"#/components/schemas/storage_link_name" }, "format":{ "$ref":"#/components/schemas/format" }, "columns":{ "$ref":"#/components/schemas/columns" } } }, "surveys":{ "type":"object", "properties":{ "surveys":{ "type":"array", "items":{ "$ref":"#/components/schemas/survey" } } } }, "credential":{ "type":"object", "properties":{ "owner":{ "type":"string", "description":"Owner of the credential.", "example":"SCOTT" }, "credential_name":{ "type":"string", "description":"Name of the credential.", "example":"MYCRED" }, "username":{ "type":"string", "example":"CLOUDUSER" }, "password":{ "type":"string", "example":"trustno1" }, "windows_domain":{ "type":"string", "example":"MYCOMPANY" }, "comments":{ "type":"string", "example":"Created via DBMS_CLOUD.create_credential" }, "enabled":{ "type":"string", "example":"TRUE" } } }, "credentials":{ "type":"object", "properties":{ "credentials":{ "type":"array", "items":{ "$ref":"#/components/schemas/credential" } } } }, "SchedulerJobs":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/SchedulerJobsItem" } }, "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" } } } }, "SchedulerJobsItem":{ "description":"Represents a row in ALL_SCHEDULER_JOBS or DBA_SCHEDULER_JOBS views. See Oracle Database Reference documenation for more details.", "type":"object", "properties":{ "owner":{ "type":"string", "description":"Owner of the Scheduler job." }, "job_name":{ "type":"string", "description":"Name of the Scheduler job." }, "job_subname":{ "type":"string", "description":"Subname of the Scheduler job (for a job running a chain step)." }, "job_style":{ "type":"string", "description":"Job style: REGULAR, LIGHTWEIGHT, IN_MEMORY_RUNTIME, IN_MEMORY_FULL." }, "job_creator":{ "type":"string", "description":"Original creator of the job." }, "client_id":{ "type":"string", "description":"Client identifier of the user creating the job." }, "global_uid":{ "type":"string", "description":"Global user identifier of the user creating the job." }, "program_owner":{ "type":"string", "description":"Owner of the program associated with the job." }, "program_name":{ "type":"string", "description":"Name of the program associated with the job." }, "job_type":{ "type":"string", "description":"Inline job action type." }, "schedule_owner":{ "type":"string", "description":"Owner of the schedule that the job uses (can be a window or a window group)" }, "schedule_name":{ "type":"string", "description":"Name of the schedule that the job uses (can be a window or a window group)" }, "schedule_type":{ "type":"string", "description":"Type of the schedule that the job uses." }, "start_date":{ "type":"string", "description":"Original scheduled start date of the job (for an inline schedule)." }, "repeat_interval":{ "type":"string", "description":"Inline schedule PL/SQL expression or calendar string." }, "event_queue_owner":{ "type":"string", "description":"Owner of the source queue into which the event will be raised." }, "event_queue_name":{ "type":"string", "description":"Name of the source queue into which the event will be raised." }, "event_queue_agent":{ "type":"string", "description":"Name of the AQ agent used by the user on the event source queue (if it is a secure queue)." }, "event_condition":{ "type":"string", "description":"Boolean expression used as the subscription rule for the event on the source queue." }, "event_rule":{ "type":"string", "description":"Name of the rule used by the coordinator to trigger the event-based job." }, "file_watcher_owner":{ "type":"string", "description":"Owner of the file watcher on which this job is based." }, "file_watcher_name":{ "type":"string", "description":"Name of the file watcher on which this job is based." }, "end_date":{ "type":"string", "description":"Date after which the job will no longer run (for an inline schedule)." }, "job_class":{ "type":"string", "description":"Name of the job class associated with the job." }, "enabled":{ "type":"string", "description":"Indicates whether the job is enabled (TRUE) or disabled (FALSE)." }, "auto_drop":{ "type":"string", "description":"Indicates whether the job will be dropped when it has completed (TRUE) or not (FALSE)." }, "restart_on_recovery":{ "type":"string", "description":"Indicates whether the step should be restarted on database recovery (TRUE) or not (FALSE)." }, "restart_on_failure":{ "type":"string", "description":"Indicates whether the step should be restarted on application failure (TRUE) or not (FALSE)." }, "state":{ "type":"string", "description":"Current state of the job." }, "job_priority":{ "type":"integer", "description":"Priority of the job relative to other jobs in the same class." }, "run_count":{ "type":"integer", "description":"Number of times the job has run." }, "uptime_run_count":{ "type":"integer", "description":"Number of runs since the database last restarted. For in-memory jobs, this column is populated, but the RUN_COUNT column is not populated. For all other jobs, this column is NULL." }, "max_runs":{ "type":"integer", "description":"Maximum number of times the job is scheduled to run." }, "failure_count":{ "type":"integer", "description":"Number of times the job has failed to run." }, "uptime_failure_count":{ "type":"integer", "description":"Number of failures since the database last restarted. For in-memory jobs, this column is populated, but the FAILURE_COUNT column is not populated. For all other jobs, this column is NULL." }, "max_failures":{ "type":"integer", "description":"Number of times the job will be allowed to fail before being marked broken." }, "retry_count":{ "type":"integer", "description":"Number of times the job has retried, if it is retrying." }, "last_start_date":{ "type":"string", "description":"Last date on which the job started running." }, "last_run_duration":{ "type":"string", "description":"Amount of time the job took to complete during the last run." }, "next_run_date":{ "type":"string", "description":"Next date on which the job is scheduled to run." }, "schedule_limit":{ "type":"string", "description":"Time after which a job which has not run yet will be rescheduled." }, "max_run_duration":{ "type":"string", "description":"Maximum amount of time for which the job will be allowed to run." }, "logging_level":{ "type":"string", "description":"Amount of logging that will be done pertaining to the job." }, "store_output":{ "type":"string", "description":"Indicates whether all job output messages for the job are stored in the OUTPUT column of the *_JOB_RUN_DETAILS views for job runs that are logged." }, "stop_on_window_close":{ "type":"string", "description":"Indicates whether the job will stop if a window associated with the job closes (TRUE) or not (FALSE)." }, "instance_stickiness":{ "type":"string", "description":"Indicates whether the job is sticky (TRUE) or not (FALSE)." }, "raise_events":{ "type":"string", "description":"List of job events to raise for the job." }, "system":{ "type":"string", "description":"Indicates whether the job is a system job (TRUE) or not (FALSE)." }, "job_weight":{ "type":"integer", "description":"Weight of the job." }, "nls_env":{ "type":"string", "description":"NLS environment of the job." }, "source":{ "type":"string", "description":"Source global database identifier." }, "number_of_destinations":{ "type":"integer", "description":"Number of destinations associated with this job." }, "destination_owner":{ "type":"string", "description":"Owner of the destination object (if used), else NULL." }, "destination":{ "type":"string", "description":"Destination that this job will run on." }, "credential_owner":{ "type":"string", "description":"Owner of the credential to be used for an external job." }, "credential_name":{ "type":"string", "description":"Name of the credential to be used for an external job." }, "instance_id":{ "type":"integer", "description":"Instance on which the user requests the job to run." }, "deferred_drop":{ "type":"string", "description":"Indicates whether the job will be dropped when completed due to user request (TRUE) or not (FALSE)." }, "allow_runs_in_restricted_mode":{ "type":"string", "description":"Indicates whether the job is allowed to run in restricted session mode (TRUE) or not (FALSE)." }, "comments":{ "type":"string", "description":"Comments on the job." }, "flags":{ "type":"integer", "description":"This column is for internal use." }, "restartable":{ "type":"string", "description":"Indicates whether the job can be restarted (TRUE) or not (FALSE)." }, "has_constraints":{ "type":"string", "description":"Indicates whether the job (not including the program of the job) is part of a resource constraint or incompatibility (TRUE) or not (FALSE)." }, "connect_credential_owner":{ "type":"string", "description":"Owner of connect credential." }, "connect_credential_name":{ "type":"string", "description":"Name of connect credential." }, "fail_on_script_error":{ "type":"string", "description":"Indicates whether this job fails on script error (TRUE) or not (FALSE)." }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/LinkRelation" } } } }, "TransactionResponse":{ "type":"object", "properties":{ "gtrid":{ "type":"string" }, "status":{ "type":"string" } } } }, "parameters":{ "NetworkOwner":{ "name":"network_owner", "in":"path", "required":true, "example":"RDFUSER", "description":"The owner of the RDF network.", "schema":{ "type":"string" } }, "NetworkName":{ "name":"network_name", "in":"path", "required":true, "example":"NET1", "description":"The name of the RDF network.", "schema":{ "type":"string" } }, "ModelName":{ "name":"model_name", "in":"path", "required":true, "example":"M1", "description":"The name of the RDF model.", "schema":{ "type":"string" } }, "DefaultGraphUri":{ "in":"query", "name":"default-graph-uri", "required":false, "example":"http%3A%2F%2Fwww.example.oracle.com%2Fg1", "description":"A URL-encoded IRI identifying a named graph that should be included in the DEFAULT graph of the query dataset.", "schema":{ "type":"string" } }, "NamedGraphUri":{ "in":"query", "name":"named-graph-uri", "required":false, "example":"http%3A%2F%2Fwww.example.oracle.com%2Fg2", "description":"A URL-encoded IRI identifying a named graph that should be included in the set of named graphs for the query dataset.", "schema":{ "type":"string" } }, "SparqlOptions":{ "in":"query", "name":"options", "required":false, "description":"A URL-encoded options string.", "example":"ALLOW_DUP=T ALL_LINK_HASH", "schema":{ "externalDocs":{ "description":"See the options argument of SEM_MATCH", "url":"https://docs.oracle.com/en/database/oracle/oracle-database/26/rdfrm/using-sem_match-table-function-query-rdf-data.html#GUID-71464CC4-1C03-48A4-9A4C-0E671FF8F16E" }, "type":"string" } }, "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" } } } } } }