REST API for Oracle Big Data Preparation Cloud Service

Send Requests

Use the following guidelines when sending requests using the Oracle Big Data Preparation Cloud Service REST API.

URL Structure

Access the Oracle Big Data Preparation Cloud Service REST resources using the following URL structure:

https://example.com/appapi/v1/schedules/

Where:

example.com is the host where Oracle Big Data Preparation Cloud Service is running.

The Service URL listed in the welcome email you receive with your trial or purchased subscription contains this host. Here is an example Service URL:
```
https://bdpinstance1-bdppm2.bigdatapreparation.us.oraclecloud.com/appui/
```
The host in this case is
```
bdpinstance1-bdppm2.bigdatapreparation.us.oraclecloud.com
```
You use the same host to access the Oracle Big Data Preparation Cloud Service REST API as you do to access Oracle Big Data Preparation Cloud Service itself.
All the examples in this document use
```
example.com
```
as the host for brevity.
appapi/v1/schedules/ Fixed prefix for Oracle Big Data Preparation Cloud Service REST resources. For a complete list of resources, see All REST Endpoints.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on Oracle Big Data Preparation Cloud Service using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
`GET`	Retrieve information about one scheduled policy or list all policies.
`POST`	Run a specific policy.

Media Types

The following media types are supported by the Oracle Big Data Preparation Cloud Service REST API:

application/json
application/xml
application/octet-stream
multipart/form-data

Supported Headers

The Oracle Big Data Preparation Cloud Service REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header	Description	Example
`Content-Type`	Media type of the body of the request. Required for POST and PUT requests.	`Content-Type: application/json`
`X-ID-TENANT-NAME`	Identity domain name of the Oracle Big Data Preparation Cloud Service instance, used for authentication.	`X-ID-TENANT-NAME:ExampleIdentityDomain`

Compression

Use compression on the Oracle Big Data Preparation Cloud Service REST resource request and response for improved performance. To use compression, include one of the following HTTP headers in the request: Accept-Encoding or Content-Encoding.