Oracle Data Flow API

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

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-dataflow-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'Use the Data Flow APIs to run any Apache Spark application at any scale without deploying or managing any infrastructure.

    '
  license:
    name: Oracle Corporation
  title: Data Flow API
  version: '20200129'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/073c6ddbe388e3bb7984f9c13c7172166cb5a1063c9e2251c3c7dd3f7d49bd2e.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Data Flow API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/073c6ddbe388e3bb7984f9c13c7172166cb5a1063c9e2251c3c7dd3f7d49bd2e.yaml
    what: the harvested document for Data Flow API
servers:
- url: /20200129
tags:
- name: DataFlow
paths:
  /applications:
    get:
      description: 'Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

        '
      operationId: ListApplications
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/PageQueryParam'
      - $ref: '#/components/parameters/ApplicationSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/OwnerPrincipalIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameStartsWithQueryParam'
      responses:
        200:
          description: 'Returns a list of applications.

            '
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response,

                additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'Retrieves the previous page of results.

                When this header appears in the response, previous pages of results exist.

                See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApplicationSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List the applications.
      tags:
      - DataFlow
      x-example: 'GET /applications?compartmentId=<var>&lt;compartmentId&gt;</var> HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Creates an application.

        '
      operationId: CreateApplication
      parameters:
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Returns the created application.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control.

                See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create an application.
      tags:
      - DataFlow
      x-example: "POST /applications HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <var>&lt;content-sha256&gt;</var>\ncontent-type: application/json\ncontent-length: <var>&lt;content-length&gt;</var>\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"test_wordcount_app\",\n  \"compartmentId\": \"<var>&lt;compartmentId&gt;</var>\",\n  \"type\": \"BATCH\",\n  \"language\": \"JAVA\",\n  \"file\": \"oci://.../wordcount-examples-jar-with-dependencies.jar\",\n  \"className\": \"org.apache.spark.examples.JavaWordCount\",\n  \"sparkVersion\": \"2.4\",\n  \"driverShape\": \"VM.Standard2.1\",\n  \"executorShape\": \"VM.Standard2.1\",\n  \"numExecutors\": 1,\n  \"arguments\": [ \"oci://.../WordCount.txt\" ],\n  \"parameters\": [],\n  \"configuration\": {}\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicationDetails'
        description: 'Details to create an application.

          '
        required: true
  /applications/{applicationId}:
    delete:
      description: 'Deletes an application using an `applicationId`.

        '
      operationId: DeleteApplication
      parameters:
      - $ref: '#/components/parameters/ApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: 'The application was successfully deleted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete the application.
      tags:
      - DataFlow
      x-example: 'DELETE /applications/<var>&lt;applicationId&gt;</var> HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Application'
    get:
      description: 'Retrieves an application using an `applicationId`.

        '
      operationId: GetApplication
      parameters:
      - $ref: '#/components/parameters/ApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Returns an application.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control.

                See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get the application.
      tags:
      - DataFlow
      x-example: 'GET /applications/<var>&lt;applicationId&gt;</var> HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
    put:
      description: 'Updates an application using an `applicationId`.

        '
      operationId: UpdateApplication
      parameters:
      - $ref: '#/components/parameters/ApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: 'The application was successfully updated.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control.

                See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update the application.
      tags:
      - DataFlow
      x-example: "PUT /applications/<var>&lt;applicationId&gt;</var> HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <var>&lt;content-sha256&gt;</var>\ncontent-type: application/json\ncontent-length: <var>&lt;content-length&gt;</var>\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\":\"test_wordcount_app_updated\",\n  \"type\":\"BATCH\",\n  \"language\":\"JAVA\",\n  \"file\":\"oci://.../wordcount-example-jar-with-dependencies.jar\",\n  \"className\":\"org.apache.spark.examples.JavaWordCount\",\n  \"sparkVersion\":\"2.4\",\n  \"driverShape\" : \"VM.Standard2.1\",\n  \"executorShape\" : \"VM.Standard2.1\",\n  \"numExecutors\" : 1,\n  \"arguments\" : [ \"oci://.../WordCount2.txt\" ],\n  \"parameters\" : [ ],\n  \"configuration\": {}\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApplicationDetails'
        description: 'Details for updating an application.

          '
        required: true
  /applications/{applicationId}/actions/cascadingDeleteApplication:
    post:
      description: 'Deletes an application using an `applicationId` and terminates related runs. This operation will timeout in approximate 30 minutes if any related Runs are not terminated successfully.

        '
      operationId: CascadingDeleteApplication
      parameters:
      - $ref: '#/components/parameters/ApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'Request accepted to cascade delete Application and Runs.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle assigned identifier for a work request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete the application and terminate related Runs.
      tags:
      - DataFlow
      x-example: 'POST /applications/<var>&lt;applicationId&gt;</var>/actions/cascadingDeleteApplication HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Application'
  /applications/{applicationId}/actions/changeCompartment:
    post:
      description: 'Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.

        Associated resources, like runs, will not be automatically moved.

        '
      operationId: ChangeApplicationCompartment
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/ApplicationIdPathParam'
      responses:
        204:
          description: 'The application was successfully moved to the specified compartment.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        409:
          $ref: '#/components/responses/409'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Moves an application into a different compartment.
      tags:
      - DataFlow
      x-example: "POST /applications/<var>&lt;applicationId&gt;</var>/actions/changeCompartment HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <var>&lt;content-sha256&gt;</var>\ncontent-type: application/json\ncontent-length: <var>&lt;content-length&gt;</var>\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"<var>&lt;compartmentId&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/Application'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeApplicationCompartmentDetails'
        description: 'Details for changing an application''s compartment.

          '
        required: true
  /pools:
    get:
      description: 'Lists all pools in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.

        '
      operationId: ListPools
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/PageQueryParam'
      - $ref: '#/components/parameters/PoolLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PoolSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/OwnerPrincipalIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameStartsWithQueryParam'
      responses:
        200:
          description: 'Returns a list of pools.

            '
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response,

                additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'Retrieves the previous page of results.

                When this header appears in the response, previous pages of results exist.

                See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PoolCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List the pools.
      tags:
      - DataFlow
      x-example: 'GET /pools?compartmentId=<var>&lt;compartmentId&gt;</var> HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Pool'
    post:
      description: 'Create a pool to be used by dataflow runs or applications.

        '
      operationId: CreatePool
      parameters:
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        201:
          description: 'Returns the created pool metadata and a work request Id to track the

            progress of this operation.

            '
          headers:
            Location:
              description: 'Provides information about the location of a newly created resource.

                '
              schema:
                type: string
            etag:
              description: 'For optimistic concurrency control.

                See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle assigned identifier for a work request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a pool to be used by dataflow runs or applications.
      tags:
      - DataFlow
      x-example: "POST /pools HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <var>&lt;content-sha256&gt;</var>\ncontent-type: pool/json\ncontent-length: <var>&lt;content-length&gt;</var>\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\" : \"<var>&lt;compartmentId&gt;</var>\",\n  \"displayName\": \"myPool\",\n}\n"
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePoolDetails'
        description: 'The parameter required to create a pool.

          '
        required: true
  /pools/{poolId}:
    delete:
      description: 'Deletes a pool using a `poolId`.

        '
      operationId: DeletePool
      parameters:
      - $ref: '#/components/parameters/PoolIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: 'Returns the opc request Id.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Deletes a pool using a `poolId`.
      tags:
      - DataFlow
      x-example: 'DELETE /pools/<var>&lt;poolId&gt;</var> HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Pool'
    get:
      description: 'Retrieves a pool using a `poolId`.

        '
      operationId: GetPool
      parameters:
      - $ref: '#/components/parameters/PoolIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Returns a pool.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control.

                See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get a pool.
      tags:
      - DataFlow
      x-example: 'GET /pools/<var>&lt;poolId&gt;</var> HTTP/1.1

        Host: dataflow.us-phoenix-1.oci.oraclecloud.com

        User-Agent: curl/7.54.0

        Accept: */*

        date: Mon, 07 Oct 2019 14:50:46 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
    put:
      description: 'Updates a pool using a `poolId`.If changes to a pool doesn''t match

        a previously defined pool,then a 409 status code will be returned.This indicates

        that a conflict has been detected.

        '
      operationId: UpdatePool
      parameters:
      - $ref: '#/components/parameters/PoolIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'Returns the pool metadata and a work request Id to track the progress of

            this operation.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle assigned identifier for a work request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Updates a pool for provided `poolId`.
      tags:
      - DataFlow
      x-example: "PUT /pool/<var>&lt;poolId&gt;</var> HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <var>&lt;content-sha256&gt;</var>\ncontent-type: pool/json\ncontent-length: <var>&lt;content-length&gt;</var>\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\":\"updatedPool\"\n}\n"
      x-related-resource: '#/definitions/Pool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePoolDetails'
        description: 'Details for updating a pool.

          '
        required: true
  /pools/{poolId}/actions/changeCompartment:
    post:
      description: 'Moves a pool into a different compartment. When provided, If-Match is checked against ETag

        values of the resource. Associated resources, like historical metrics, will not be

        automatically moved. The pool must be in a terminal state (STOPPED, FAILED) in

        order for it to be moved to a different compartment

        '
      operationId: ChangePoolCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/PoolIdPathParam'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        204:
          description: 'Returns opc-request-id for this operation.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle assigned identifier for the request.

                If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Moves a pool into a different compartment.
      tags:
      - DataFlow
      x-example: "POST /pool/<var>&lt;poolId&gt;</var>/actions/changeCompartment HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <var>&lt;content-sha256&gt;</var>\ncontent-type: pool/json\ncontent-length: <var>&lt;content-length&gt;</var>\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"<var>&lt;compartmentId&gt;</var>\"\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Pool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePoolCompartmentDetails'
        description: 'Details for changing a pool''s compartment.

          '
        required: true
  /pools/{poolId}/actions/start:
    post:
      description: 'Starts the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: StartPool
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/PoolIdPathParam'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $re

# --- truncated at 32 KB (257 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-dataflow-api-openapi.yml