REST Style Architecture

The Oracle Primavera Cloud API employs web-based technology to handle requests from external client programs. Clients access the API by sending HTTP requests that include standard HTTP methods. Some requests, such as a POST request to the /project endpoint, require additional request data in JSON format. When you provide additional data with a request, you must specify a content-type in the request header. For example, a request that includes JSON data must include a content-type of application/json in its request header.

The API supports the following HTTP request methods:

Method	Description
GET	Returns objects or values.
DELETE	Deletes objects or values.
POST	Creates objects or values.
PUT	Updates objects or values.

Upon receiving a request, Oracle Primavera Cloud invokes business and security logic to service the request and provide an appropriate response.

Select a Client Technology

Technologies that can form and send valid HTTP requests can access the API. Programming languages that provide HTTP libraries and methods, such as Java and JavaScript, are examples of the technologies you can use to interact with the API. Additionally, you can use HTTP enabled software, such as curl, to access the API.

Path Parameters and Query Parameters

You must specify the URL path parameters to access some API endpoints. Endpoints that require path parameters match the following URL pattern:

https://<SERVER_URL>/api/restapi/project<task-category>/<task>/{parameter}

Other endpoints require one or more ampersand-separated query parameter values. Endpoints that require query parameters match the following URL pattern:

https://<SERVER_URL>/api/restapi/project<task-category>/<task>?{parameter}={values}

If a query parameter does not have a default value, make sure you refer to the query parameter description to see if the value is mandatory.

Note: Some endpoints require you to provide additional JSON data with your request.