Quick Start

Set up your environment and use the REST API to communicate with Oracle Data Transforms by performing the following tasks.

  • Setting the prerequisites
  • Sending the first request

Prerequisites

Prerequisite More Information
Ensure your Data Transforms deployment is running and accessible.

Autonomous AI Database: https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/access-adp-odt.html

Marketplace: https://docs.oracle.com/en/database/data-integration/data-transforms/using/access-oracle-data-transforms.html
Know your Data Transforms host URL

URL for Data Transforms hosted on Autonomous AI Database:

  1. From the Oracle Cloud Infrastructure left navigation menu click Oracle AI Database, select Autonomous AI Database, select the instance from the list, and navigate to the Details page.
  2. Select the Tool configuration tab.
  3. Under Data Transforms, copy the URL from the Public access URL field, including the odi at the end. For example, https://<tenant>-<dbname>.adb.<region>.oraclecloudapps.com/odi

    Note:

    If your database is Private Endpoint enabled, use the Private endpoint URL instead.

URL for Data Transforms launched from Marketplace:

  1. From the Oracle Cloud Infrastructure left navigation menu click Compute, select Instances, select the instance from the list, and navigate to the Networking page.
  2. Use the IPv4 address with the port 9999 as the base URL. For example, https://<ip_address>:9999/
Know your Tenant OCID and database OCID.

https://docs.oracle.com/en-us/iaas/Content/GSG/Tasks/contactingsupport_topic-Locating_Oracle_Cloud_Infrastructure_IDs.htm
For Marketplace deployments you need the base 64 encoding of your Data Transforms username and password For example, user123:pass456 becomes dXNlcjEyMzpwYXNzNDU2

Send your first request

To make your first request try getting an authentication token for your deployment type.

Keep in mind that any requests using the POST/PUT HTTP methods require the Content-Type header, and it should always be set to ‘application/json’.

Autonomous AI Database Deployments

  1. Request a token by calling the odi/broker/pdbcs/public/v1/token endpoint.

    Example using cURL on Linux/Unix based OS:

    curl 'https://<host-url>/odi/broker/pdbcs/public/v1/token' -H 'Content-Type: application/json' -d '{"username":"<username>","password":"<password>","tenant_name":"<tenant OCID>","database_name":"<database name>","cloud_database_name":"<database OCID>","grant_type":"password"}'

    Example using cURL on Windows OS:

    curl.exe 'https://<host-url>/odi/broker/pdbcs/public/v1/token' -H 'Content-Type: application/json' -d '{\"username\":\"<username>\",\"password\":\"<password>\",\"tenant_name\":\"<tenant OCID>\",\"database_name\":\"<database name>\",\"cloud_database_name\":\"<database OCID>\",\"grant_type\":\"password\"}'

  2. Use the obtained access_token in the response as your Bearer token in the Authorization header to call any other endpoints.

    Example using cURL on Linux/Unix based OS:

    curl 'https://<host-url>/odi/dt-rest/v2/about' -H 'Authorization: Bearer <access_token>'

    Example using cURL on Windows OS:

    curl.exe 'https://<host-url>/odi/dt-rest/v2/about' -H 'Authorization: Bearer <access_token>'

Marketplace Deployments

  1. Request a token by calling /dt-rest/v2/authentication/token endpoint using Basic Authentication.

    Example using cURL on Linux/Unix based OS:

    curl 'https://<host_ip>:9999/dt-rest/v2/authentication/token' -H 'Authorization: Bearer <access_token>'

    Example using cURL on Windows OS:

    curl.exe 'https://<host_ip>:9999/dt-rest/v2/authentication/token' -H 'Authorization: Bearer <access_token>'

  2. Use the obtained access token as your Bearer token in the Authorization header to call any other endpoints.

    Example using cURL on Linux/Unix based OS:

    curl 'https://<host_ip>:9999/dt-rest/v2/about' -H 'Authorization: Bearer <access_token>'

    Example using cURL on Windows OS:

    curl.exe 'https://<host_ip>:9999/dt-rest/v2/about' -H 'Authorization: Bearer <access_token>'