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 technologies you can use to interact with the API. Additionally, you can use HTTP enabled software, such as curl, to access the API.

Use the API to interact with Oracle Prime Projects

The Oracle Prime Projects API exposes access to application functionality through a set of endpoint URLs. All Oracle Prime Projects API endpoints follow a consistent pattern. Use the following URL pattern to send requests to the API:

https://localhost:7001/primeapi/restapi/project<task-category>/<task>

For example, to view all integrated projects in the application, send an HTTP GET request to the following URL:

https://localhost:7001/primeapi/restapi/project/project/externallySourced

Path Parameters and Query Parameters

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

https://localhost:7001/primeapi/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://localhost:7001/primeapi/restapi/project<task-category>/<task>?{parameter}={values}

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

Sync APIs

Create and Update operations require the sourceID to be passed when integrating external data.

Update Keys

Update keys are a set of keys which can be used to find and update an object. The update keys for an object are specified in the object's description.

For example, in the description for Change Order, the following update keys are provided:

• projectId, itemCode, type
• workspaceCode, projectCode, itemCode, type
• changeOrderId

You can use any one of these three key combinations provided to update a change order.