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 Oda API

The oda API from Oracle — 11 operation(s) for oda.

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

Tagged areas include oda. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 17 operations across 11 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 20190506.

Requests are made against a single base URL, /20190506.

17 operations 11 paths 19 schemas 2 DELETE8 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20190506
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

oda 17
GET
/odaInstances
Get Compartment's Digital Assistant Instances
ListOdaInstances 8 params → 200400401404429500default
POST
/odaInstances
Create Digital Assistant Instance
CreateOdaInstance 3 params body → 201400401404409429500default
DELETE
/odaInstances/{odaInstanceId}
Delete Digital Assistant Instance
DeleteOdaInstance 5 params → 202400401404412429500default
GET
/odaInstances/{odaInstanceId}
Get Digital Assistant Instance
GetOdaInstance 2 params → 200400401404429500default
PUT
/odaInstances/{odaInstanceId}
Update Digital Assistant Instance
UpdateOdaInstance 4 params body → 200400401404412429500default
POST
/odaInstances/{odaInstanceId}/actions/changeCompartment
Moves an Digital Assistant instance into a different compartment.
ChangeOdaInstanceCompartment 4 params body → 202400401404409412429500
POST
/odaInstances/{odaInstanceId}/actions/start
Starts an inactive Digital Assistant instance.
StartOdaInstance 4 params → 202400401404409412429500
POST
/odaInstances/{odaInstanceId}/actions/stop
Stops an active Digital Assistant instance.
StopOdaInstance 4 params → 202400401404409412429500
GET
/odaInstances/{odaInstanceId}/attachments
Gets a list of all attachments to an ODA instance
ListOdaInstanceAttachments 8 params → 200400401404429500default
POST
/odaInstances/{odaInstanceId}/attachments
Create Digital Assistant Instance Attachment
CreateOdaInstanceAttachment 3 params body → 202400401404409429500default
DELETE
/odaInstances/{odaInstanceId}/attachments/{attachmentId}
Delete a Digital Assistant instance attachment
DeleteOdaInstanceAttachment 4 params → 202400401404412429500default
GET
/odaInstances/{odaInstanceId}/attachments/{attachmentId}
Get ODA instance attachment information
GetOdaInstanceAttachment 4 params → 200400401404429500default
PUT
/odaInstances/{odaInstanceId}/attachments/{attachmentId}
Update the ODA instance attachment identified by the ID
UpdateOdaInstanceAttachment 4 params body → 202400401404409412429500
GET
/workRequests
List Compartment's Work Requests
ListWorkRequests 7 params → 200400401404429500default
GET
/workRequests/{workRequestId}
Get Work Request
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
List Work Request Errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
List Work Request Log Messages
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are OdaInstance (23 properties), OdaInstanceSummary (16 properties), OdaInstanceAttachmentSummary (12 properties), OdaInstanceAttachment (12 properties). Each schema is shown below with its type and property counts.

OdaInstanceAttachmentCollection
object
Results of a Oda instance attachment search. Contains OdaInstanceAttachment items.
1 property 1 required
UpdateOdaInstanceAttachmentDetails
object
ODA attachment details to be updated.
5 properties 3 required
UpdateOdaInstanceDetails
object
The Digital Assistant instance information to be updated.
4 properties
CreateOdaInstanceAttachmentDetails
object
Properties required to create an ODA instance attachment.
7 properties 3 required
OdaInstanceAttachmentSummary
object
Description of an ODA instance attachment.
12 properties 5 required
WorkRequestError
object
Description of the unexpected error that prevented completion of the request.
3 properties 3 required
WorkRequestSummary
object
A description of the work request's status.
6 properties 6 required
WorkRequest
object
The description of work request, including its status.
11 properties 8 required
OdaInstanceSummary
object
Summary of the Digital Assistant instance.
16 properties 3 required
ChangeOdaInstanceCompartmentDetails
object
Properties required to move a Digital Assistant instance from one compartment to another.
1 property 1 required
OdaInstance
object
Description of OdaServiceInstance object.
23 properties 3 required
OdaInstanceOwner
object
Details about an ODA instance owner
2 properties 2 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
OdaInstanceAttachment
object
Description of an ODA instance attachment.
12 properties 5 required
CreateOdaInstanceDetails
object
Properties that are required to create a Digital Assistant instance.
8 properties 2 required
ErrorBody
object
Error Information.
2 properties 2 required
RestrictedOperation
object
Summary of a restricted operation for a Digital Assistant instance.
2 properties 2 required
WorkRequestResource
object
A resource created or operated on by a work request.
6 properties 4 required
OdaInstanceAttachmentOwner
object
Details about an attachment owner
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-oda-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Oda 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.