Using the P6 REST API

Installing the P6 REST API on-premises

The API is installed as part of P6 EPPM Web Services.

Refer to the P6 EPPM Installation and Configuration Guide for On-Premises for information on installing P6 EPPM Web Services.

Select a client technology

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

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>/p6ws/restapi/<service>
		

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

		https://<hostName>:<portNumber>/p6ws/restapi/project
		

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>/p6ws/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>/p6ws/restapi/project?Fields=Name,ObjectId