Oracle Partitioning ORDS REST Services API
Custom Oracle REST Data Services built with SQL & PL/SQL.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-partitioning-ords-rest-services-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: '<p>Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.</p><p>To install and configure Oracle REST Data Services refer to the <a href=https://docs.oracle.com/pls/topic/lookup?ctx=ords-latest&id=ORDIG> Oracle® REST Data Services Installation and Configuration Guide</a>.</p>
<p>An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration. <p><p>The pattern for the API document URL is: </p>
<code>https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path> </code>
<p>Where, the <code><my database></code> and <code><my schema></code> variables can be optional, depending on the ORDS configuration and the service invoked.'
version: 2026.03.26
title: Oracle REST Data Services ORDS REST 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.
tags:
- name: ORDS REST Services
description: Custom Oracle REST Data Services built with SQL & PL/SQL.
paths:
/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:
applicatio
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-partitioning/refs/heads/main/openapi/oracle-partitioning-ords-rest-services-api-openapi.yml