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 Data Flow API

The DataFlow API from Oracle — 26 operation(s) for dataflow.

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

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

This API exposes 43 operations across 26 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 20200129.

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

43 operations 26 paths 51 schemas 6 DELETE18 GET14 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20200129
Base URL
https://{host}:{port}/ords/
License
Oracle Corporation
Resource Areas
1

Paths & Operations 43

Across 26 paths, the API surfaces 43 operations — 6 DELETE, 18 GET, 14 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

DataFlow 43
GET
/applications
List the applications.
ListApplications 9 params → 200400401403404409412429
POST
/applications
Create an application.
CreateApplication 2 params body → 200400401403404409412429
DELETE
/applications/{applicationId}
Delete the application.
DeleteApplication 3 params → 204400401403404409412429
GET
/applications/{applicationId}
Get the application.
GetApplication 2 params → 200400401403404409412429
PUT
/applications/{applicationId}
Update the application.
UpdateApplication 3 params body → 200400401403404409412429
POST
/applications/{applicationId}/actions/cascadingDeleteApplication
Delete the application and terminate related Runs.
CascadingDeleteApplication 3 params → 202400401404409412429500
POST
/applications/{applicationId}/actions/changeCompartment
Moves an application into a different compartment.
ChangeApplicationCompartment 4 params body → 204400401403409404412429
GET
/pools
List the pools.
ListPools 10 params → 200400401404429500default
POST
/pools
Create a pool to be used by dataflow runs or applications.
CreatePool 2 params body → 201400401404409429500default
DELETE
/pools/{poolId}
Deletes a pool using a poolId.
DeletePool 3 params → 204400401404409412429500
GET
/pools/{poolId}
Get a pool.
GetPool 2 params → 200400401404429500default
PUT
/pools/{poolId}
Updates a pool for provided poolId.
UpdatePool 3 params body → 202400401404409412429500
POST
/pools/{poolId}/actions/changeCompartment
Moves a pool into a different compartment.
ChangePoolCompartment 4 params body → 204400401404409412429500
POST
/pools/{poolId}/actions/start
Starts a dataflow pool.
StartPool 4 params → 202400401404409412429500
POST
/pools/{poolId}/actions/stop
Stops a dataflow pool.
StopPool 4 params → 202400401404409412429500
GET
/privateEndpoints
List the private endpoints.
ListPrivateEndpoints 10 params → 200400401404429500default
POST
/privateEndpoints
Create a private endpoint to be used by an application.
CreatePrivateEndpoint 2 params body → 201400401404409429500default
DELETE
/privateEndpoints/{privateEndpointId}
Delete a private endpoint.
DeletePrivateEndpoint 3 params → 202400401404409412429500
GET
/privateEndpoints/{privateEndpointId}
Get a private endpoint.
GetPrivateEndpoint 2 params → 200400401404429500default
PUT
/privateEndpoints/{privateEndpointId}
Update a private endpoint.
UpdatePrivateEndpoint 3 params body → 202400401404409412429500
POST
/privateEndpoints/{privateEndpointId}/actions/changeCompartment
Moves a private endpoint into a different compartment.
ChangePrivateEndpointCompartment 3 params body → 202400401404409412429500
GET
/runs
List the runs.
ListRuns 13 params → 200400401403404409412429
POST
/runs
Create a run.
CreateRun 2 params body → 200400401403404409412429
DELETE
/runs/{runId}
Cancels the specified run.
DeleteRun 3 params → 204400401403404409412429
GET
/runs/{runId}
Get the run.
GetRun 2 params → 200400401403404409412429
PUT
/runs/{runId}
Update the run.
UpdateRun 3 params body → 200400401403404409412429
POST
/runs/{runId}/actions/changeCompartment
Moves a run into a different compartment.
ChangeRunCompartment 4 params body → 204400401403404409412429
GET
/runs/{runId}/logs
List the run log summaries.
ListRunLogs 4 params → 200400401404429500default
GET
/runs/{runId}/logs/{name}
Get the gzipped content of the run log.
GetRunLog 3 params → 200400401404429500default
GET
/runs/{runId}/statements
List the statements for a Session run.
ListStatements 7 params → 200400401404409429500default
POST
/runs/{runId}/statements
Execute a statement for a Session Run.
CreateStatement 2 params body → 200400401404409429500default
DELETE
/runs/{runId}/statements/{statementId}
Cancels the specified statement for a Session run.
DeleteStatement 4 params → 204400401404409412429500
GET
/runs/{runId}/statements/{statementId}
Get the specific statement for a Session run.
GetStatement 3 params → 200400401404409429500default
GET
/sqlEndpoints
Gets a list of all Sql Endpoints in a compartment.
ListSqlEndpoints 9 params → 200400401404429500default
POST
/sqlEndpoints
Creates a new Sql Endpoint.
CreateSqlEndpoint 2 params body → 201400401404409429500default
DELETE
/sqlEndpoints/{sqlEndpointId}
Delete a provisioned Sql Endpoint.
DeleteSqlEndpoint 3 params → 202400401404409412429500
GET
/sqlEndpoints/{sqlEndpointId}
Retrieves a SQL Endpoint using a sqlEndpointId.
GetSqlEndpoint 2 params → 200400401404429500default
PUT
/sqlEndpoints/{sqlEndpointId}
Update a provisioned Sql Endpoint.
UpdateSqlEndpoint 3 params body → 202400401404409412429500
POST
/sqlEndpoints/{sqlEndpointId}/actions/changeCompartment
Moves a resource into a different compartment.
ChangeSqlEndpointCompartment 4 params body → 202401404409412429500default
GET
/workRequests
List Work Requests
ListWorkRequests 4 params → 200400401404429500default
GET
/workRequests/{workRequestId}
Get Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 4 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 4 params → 200400401404429500default

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Run (42 properties), Application (32 properties), CreateApplicationDetails (26 properties), SqlEndpointSummary (26 properties). Each schema is shown below with its type and property counts.

StatementSummary
object
Summary of the statement.
5 properties 3 required
UpdateRunDetails
object
The update run details. Only a limited set of properties of a run can be updated.
4 properties
PoolConfig
object
An object containing the details about the compute shapes and number of compute instances to provison.
4 properties
WorkRequestSummary
object
A Data Flow work request summary object.
9 properties 5 required
CreateSqlEndpointDetails
object
The information about a new SQL Endpoint.
17 properties 11 required
ApplicationParameter
object
The parameter of an application.
2 properties 2 required
Application
object
A Data Flow application object.
32 properties 13 required
WorkRequestCollection
object
Results of a query for a list of work requests. Contains WorkRequestSummary items.
1 property 1 required
UpdateApplicationDetails
object
The update application details.
25 properties
PrivateEndpointCollection
object
The results of a query for a list of private endpoints. It contains PrivateEndpointSummary items.
1 property 1 required
UpdatePrivateEndpointDetails
object
The details required to update a private endpoint.
7 properties
PrivateEndpointSummary
object
A Data Flow private endpoint object used in bulk listings.
14 properties 11 required
ApplicationSummary
object
A Data Flow application object used in bulk listings.
12 properties 10 required
WorkRequestErrorCollection
object
Results of a query for a list of work request errors. Contains WorkRequestError items.
1 property 1 required
WorkRequestError
object
A Data Flow work request error object.
5 properties 3 required
ChangeRunCompartmentDetails
object
The change run compartment details.
1 property 1 required
StatementOutputData
object
An object representing execution output of a statement.
1 property 1 required
ChangePoolCompartmentDetails
object
The details required to change a pool compartment.
1 property 1 required
StatementOutput
object
The execution output of a statement.
5 properties
ChangeApplicationCompartmentDetails
object
The change application compartment details.
1 property 1 required
ChangeSqlEndpointCompartmentDetails
object
Details for changing the compartment of a SQL Endpoint.
1 property 1 required
CreatePoolDetails
object
The details required to create a pool.
8 properties 3 required
UpdateSqlEndpointDetails
object
The information about all updatable parameters of a SQL Endpoint.
2 properties
ChangePrivateEndpointCompartmentDetails
object
The details required to change a private endpoint compartment.
1 property 1 required
SqlEndpointSummary
object
A summary of the Sql Endpoint.
26 properties 12 required
ShapeConfig
object
This is used to configure the shape of the driver or executor if a flexible shape is used.
3 properties
PoolMetrics
object
A collection of metrics related to a particular pool.
6 properties
SqlEndpointCollection
object
The results of a Sql Endpoint search. It contains the objects in a SqlEndpointSummary.
1 property 1 required
Statement
object
A statement object.
8 properties 4 required
PoolCollection
object
The results of a query for a list of pools. It contains PoolSummary items.
1 property 1 required
WorkRequestLogCollection
object
Results of a query for a list of work request logs. Contains WorkRequestLog items.
1 property 1 required
WorkRequest
object
A Data Flow work request object.
9 properties 6 required
PoolSummary
object
A pool object used in bulk listings.
10 properties 10 required
UpdatePoolDetails
object
The details required to update a given pool with poolId.
7 properties
WorkRequestLog
object
A Data Flow work request log object.
4 properties 2 required
PoolSchedule
object
Definition of when pool auto start or stop for a given day of a week.
3 properties
StatementCollection
object
The results of a query for a list of statements of a Session Run. It contains StatementSummary items.
1 property 1 required
WorkRequestResource
object
A resource related to a Data Flow work request.
6 properties 3 required
CreateRunDetails
object
The create run details. The following properties are optional and override the default values set in the associated application: - applicationId - archiveUri -…
22 properties 1 required
RunSummary
object
A summary of the run.
19 properties 9 required
CreateApplicationDetails
object
The create application details.
26 properties 7 required
RunLogSummary
object
A summary of a log associated with a particular run.
6 properties 4 required
Pool
object
A Data Flow pool object.
16 properties 10 required
NodeCount
object
An object with a logical shape and count of the number of nodes with that shape.
2 properties
SqlEndpoint
object
The description of a SQL Endpoint.
26 properties 12 required
CreateStatementDetails
object
The details required to create a statement.
1 property 1 required
CreatePrivateEndpointDetails
object
The details required to create a private endpoint.
9 properties 3 required
Error
object
The error object.
2 properties 2 required
SqlEndpointNetworkConfiguration
object
The network configuration of a SQL Endpoint.
1 property 1 required
PrivateEndpoint
object
A Data Flow private endpoint object.
16 properties 11 required
Run
object
A run object.
42 properties 12 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-dataflow-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 Data Flow 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.