How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Database Documents API

Document CRUD operations (get, insert, update, delete)

Oracle Database Documents API is one of 29 APIs that Oracle Database publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, an API reference, and 5 JSON Schemas.

This API exposes 7 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{host}:{port}/ords/{schema}/soda/{version}.

7 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://{host}:{port}/ords/{schema}/soda/{version}
Authentication
OAuth 2.0, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Oracle Database Documents API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 2 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 7

Document CRUD operations (get, insert, update, delete)

GET
/{collection}/
Oracle Database Get documents from a collection
getCollection 10 params → 200400401404
POST
/{collection}/
Oracle Database Insert a new document
insertDocument 1 param body → 201202401405501
PUT
/{collection}/
Oracle Database Insert or replace document (no key in URL)
putDocumentNoKey 1 param body → 200401405
GET
/{collection}/{key}
Oracle Database Get a document by key
getDocument 4 params → 200204304401404
PUT
/{collection}/{key}
Oracle Database Replace or insert a document by key
putDocument 2 params body → 200201401405
PATCH
/{collection}/{key}
Oracle Database Patch a document using JSON Patch
patchDocument 2 params body → 200401404405
DELETE
/{collection}/{key}
Oracle Database Delete a document by key
deleteDocument 2 params → 200401404405

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Document (7 properties), DocumentList (7 properties), DocumentMetadata (4 properties), JsonPatchOperation (4 properties). Each schema is shown below with its type and property counts.

InsertResponse
object
2 properties
Error
object
2 properties
DocumentList
object
7 properties
JsonPatchOperation
object
4 properties 2 required
DocumentMetadata
object
4 properties
Link
object
3 properties
Document
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-database-documents-api-openapi.yml Raw ↑

Other APIs Oracle Database publishes across the network.

Oracle Database API for MongoDB
Oracle Database JDBC
Oracle Call Interface (OCI)
Oracle SQL Developer REST API
Oracle Transactional Event Queues (TxEventQ)
Oracle Database APEX API
Oracle Database Autonomous Databases API
Oracle Database Backups API
Oracle Database Bulk Operations API
Oracle Database Collections API
Oracle Database Data Dictionary API
Oracle Database Data Guard API
Where this information came from

This is an independent, third-party profile of Oracle Database Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.