Using the Primavera Administration API

Select a client technology

Technologies that can form and send valid HTTP requests can access the Primavera Administration 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 Primavera Administration

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

		https://<hostName>:<portNumber>/cloudapi/restapi/<service>/<task>
		

For example, to update the user status of a set of users, send a HTTP PUT request to the following URL:

		https://<hostName>:<portNumber>/cloudapi/restapi/user/change-status
		

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://<hostName>:<portNumber>/cloudapi/restapi/<service>/<task>/{parameter}
		

For example, to view a status on a user's job with a jobId of 99694, you must specify the jobId as a parameter in the requested endpoint URL:

		https://<hostName>:<postNumber>/cloudapi/restapi/user/status/99694
		

Notes:

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

All PUT requests require an "<objectName>id" parameter, where <objectName> is the name of the object, that contains the target object to update's unique system generated identifier. Create requests do not require this parameter. If an object is created using a unique identifier that already exists for an object of the same type, the system will use an autogenerated unique value instead.