PS.ProjectContext object (ps.js)

Article
07/24/2014

Maintains the client-side context for development with a Project Web App instance, and contains the enterprise-wide collections of Project Server objects that exist in Project Web App.

Applies to: Project Professional 2013 | Project Server 2013

In this article
Remarks
Members
ProjectServer resources in the REST interface

var object = new PS.ProjectContext(url)

Remarks

The ProjectContext object is the entry point for accessing Project Server functionality in the JavaScript object model, and the ProjectServer resource is the entry point in the Representational State Transfer (REST) interface. See ProjectServer resources in the REST interface for information about ProjectServer properties and methods.

Note

ProjectContext derives from the SP.ClientContext object (sp.js), so you can also use it to access the SharePoint JavaScript object model. You can initialize a new instance of ProjectContext by using the constructor or the current property.

Members

See the SP.ClientContext object (sp.js) for inherited members that are not described in the following tables.

ProjectContext methods

The ProjectContext object has the following methods.

Method	Description
executeQueryAsync	Executes the current pending request asynchronously on the server.
load	Retrieves the properties of a client object from the server.
loadQuery	Retrieves an enumerable sequence of the child client objects from a collection.
waitForQueueAsync	Waits for the specified queue job to complete, or waits for a maximum number of seconds.

ProjectContext properties

The ProjectContext object has the following properties.

Property	Description
calendars	Gets the collection of calendars in the Project Web App instance.
current	Gets the current client context of the Project Server 2013 client-side runtime.
customFields	Gets the collection of enterprise custom field definitions in the Project Web App instance.
enterpriseProjectTypes	Gets the collection of enterprise project types (EPTs) in the Project Web App instance.
enterpriseResources	Gets the collection of enterprise resources in the Project Web App instance.
entityTypes	Gets the collection of entity types that are exposed through the CSOM for the Project Web App instance.
eventHandlers	Gets the collection of event handlers that are defined in the Project Web App instance.
events	Gets the collection of events in the Project Web App instance.
lookupTables	Gets the collection of lookup tables in the Project Web App instance.
phases	Gets the collection of Project Server workflow phases in the Project Web App instance.
projectDetailPages	Gets the collection of project detail pages in the Project Web App instance.
projects	Gets the collection of published projects in the Project Web App instance.
serviceStatus	Gets information about the status of the Project Server service.
stages	Gets the collection of Project Server workflow stages in the Project Web App instance.
timeSheetPeriods	Gets the collection of timesheet periods in the Project Web App instance.
workflowActivities	Gets the methods that Project Server workflows can call at run time.
workflowDesigner	Gets a workflow designer that developers can call at design time.

ProjectServer resources in the REST interface

The ProjectServer resource is the entry point to Project Server functionality from the REST interface. The endpoint URI for the ProjectServer resource is https://ServerName/pwaName/_api/ProjectServer (replace ServerName and pwaName in the URI). For example, https://ServerName/pwaName/_api/ProjectServer/Projects('263fc8d7-427c-e111-92fc-00155d3ba208')/Assignments gets the assignments in the project that's specified by the GUID in the URI.

ProjectServer methods

The ProjectServer resource has the following methods.

Method	Description
stopDelegation	Stops the current delegation session.

ProjectServer properties

The ProjectServer resource has the following properties.

Property	Description
calendars	Gets the collection of calendars in the Project Web App instance.
customFields	Gets the collection of enterprise custom field definitions in the Project Web App instance.
enterpriseProjectTypes	Gets the collection of enterprise project types (EPTs) in the Project Web App instance.
enterpriseResources	Gets the collection of enterprise resources in the Project Web App instance.
entityTypes	Gets the collection of entity types that are exposed through the CSOM for the Project Web App instance.
eventHandlers	Gets the collection of event handlers that are defined in the Project Web App instance.
events	Gets the collection of events in the Project Web App instance.
isDelegate	Gets a value that indicates whether the current user has started a delegation session in Project Web App.
isReadOnly	Gets a value that indicates whether the Project Server database is in read-only mode.
lookupTables	Gets the collection of lookup tables in the Project Web App instance.
phases	Gets the collection of Project Server workflow phases in the Project Web App instance.
projectDetailPages	Gets the collection of project detail pages in the Project Web App instance.
projects	Gets the collection of published projects in the Project Web App instance.
stages	Gets the collection of Project Server workflow stages in the Project Web App instance.
timeSheetPeriods	Gets the collection of timesheet periods in the Project Web App instance.
workflowActivities	Gets the methods that Project Server workflows can call at run time.
workflowDesigner	Gets a workflow designer that developers can call at design time.

PS.ProjectContext object (ps.js)

Remarks

Members

ProjectContext methods

ProjectContext properties

ProjectServer resources in the REST interface

ProjectServer methods

ProjectServer properties

See also

Reference

Other resources

Additional resources