Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

PS namespace (ps.js)

Office 2013

Published: March 5, 2013

Learn about the objects in the JavaScript object model and the resources in the REST interface for Project Server 2013 that you can use to develop cross-browser web apps, task pane apps for Project Professional 2013, and apps for non-Windows devices that access Project Server 2013 and Project Online.

The objects in the PS namespace represent the JavaScript object model for Project Server 2013. The PS namespace is defined in the PS.js JavaScript library in the %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\PS.js file. If you're using the JavaScript object model, use the ProjectContext object as the entry point for Project Server functionality.

Note Note

To browse the JavaScript object model and to help with debugging, you can use the PS.debug.js file in the same directory. To help with development on a remote computer, the Project 2013 SDK download also includes the PS.js and PS.debug.js files.

The REST interface corresponds to the JavaScript object model, so REST resources are described with the corresponding members of the JavaScript object model. If you're using the REST interface, use the ProjectServer resource as the entry point for Project Server functionality. For information about ProjectServer properties and methods, see ProjectServer resources in the REST interface.

Note Note

APIs that are for internal use only have been removed from this reference. In the PS namespace, the following items are removed:

  • The ProjectServer object. In the JavaScript object model, you use the ProjectContext object to access Project Server 2013 and SharePoint 2013 functionality. (For information about ProjectServer REST endpoints, see ProjectServer resources in the REST interface.)

  • Constructors that are not intended to be used in your code. This includes constructors for objects that you create by using the corresponding ObjectCreationInformation object with the collection's add method.

  • Object PropertyNames objects and ObjectObjectPropertyNames objects.

  • Methods such as initPropertiesFromJson and writeToXml, and properties such as typeId and childItemType are removed from the Table of Contents.

The PS namespace contains the following objects and enumerations.

Objects

Object

Description

Assignment

Contains the common properties for draft assignments and published assignments.

AssignmentCreationInformation

Contains the properties that can be set when creating an assignment.

BaseCalendarException

Represents a base calendar exception.

Calendar

Represents a Project Server calendar.

CalendarCollection

Represents a collection of calendars objects.

CalendarCreationInformation

Represents information that is used to create a new calendar.

CalendarException

Represents a difference (an exception) from the base calendar.

CalendarExceptionCollection

Represents a collection of calendar exceptions.

CalendarExceptionCreationInformation

Provides information for the creation of a calendar exception.

CustomField

Contains the properties and methods that are used to create an enterprise custom field.

CustomFieldCollection

Represents a collection of custom fields.

CustomFieldCreationInformation

Provides information that is used in the creation of a custom field.

DraftAssignment

Enables the creation of a draft assignment for a project.

DraftAssignmentCollection

Represents a collection of draft assignments.

DraftProject

Represents the draft version of a project, which is a published project that is checked out.

DraftProjectResource

Represents an enterprise resource in a checked-out project.

DraftProjectResourceCollection

Represents a collection of draft project resources.

DraftTask

Represents a task in a checked-out project.

DraftTaskCollection

Represents a collection of draft tasks.

DraftTaskLink

Represents a task link in a checked-out project.

DraftTaskLinkCollection

Represents a collection of draft task links.

EnterpriseProjectType

Represents an enterprise project type (EPT).

EnterpriseProjectTypeCollection

Represents a collection of enterprise project types (EPTs).

EnterpriseProjectTypeCreationInformation

Provides information for the creation of an enterprise project type (EPT).

EnterpriseResource

Represents a resource that is managed by Project Server 2013 in a project.

EnterpriseResourceCollection

Represents a collection of enterprise resources.

EnterpriseResourceCreationInformation

Represents a resource that is managed by Project Server 2013 in a project.

EntityType

Represents a type of Project Server 2013 entity.

EntityTypes

Represents the types of Project Server 2013 entities that are exposed through client APIs.

Event

Represents and identifies activity that occurs in Project Server 2013 when there are changes in business object data.

EventCollection

Represents a collection of events.

EventHandler

Represents the identification and location of a Project Server 2013 event handler.

EventHandlerCollection

Represents a collection of event handlers.

EventHandlerCreationInformation

Provides information for the creation of an event handler.

LookupCost

Represents a data value of type Cost for a lookup table.

LookupDate

Represents a data value of type Date for a lookup table.

LookupDuration

Represents a data value of type Duration for a lookup table.

LookupEntry

Represents a lookup table entry.

LookupEntryCollection

Represents a collection of lookup entries for a lookup table.

LookupEntryCreationInformation

Provides information for the creation of a lookup table entry.

LookupEntryValue

Represents the value of a lookup table entry.

LookupMask

Represents a mask definition for the levels of a hierarchical lookup table.

LookupNumber

Represents a data value of type Number for a lookup table.

LookupTable

Represents a lookup table.

LookupTableCollection

Represents a collection of lookup tables.

LookupTableCreationInformation

Provides methods and property settings for the creation of a lookup table.

LookupTables

Represents lookup table definitions.

LookupText

Represents a data value of type Text for a lookup table.

Phase

Represents a collection of stages that are grouped to identify a common set of activities in the project life cycle.

PhaseCollection

Represents a collection of workflow phases.

PhaseCreationInformation

Contains the properties that can be set when creating a workflow phase.

PlanAssignment

Provides information about an assignment in a project plan.

PlanAssignmentCollection

Represents a collection of plan assignments.

PlanAssignmentCreationInformation

Provides information for the creation of a plan assignment.

PlanAssignmentInterval

Represents a time interval for a project plan assignment.

PlanAssignmentIntervalCollection

Represents a collection of time intervals for project plan assignments.

PlanAssignmentIntervalCreationInformation

Provides information that is used for the creation of time intervals for plan assignments.

Project

Contains the common properties for draft projects and published projects.

ProjectCollection

Represents a collection of published projects.

ProjectContext

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.

ProjectCreationInformation

Provides the properties that can be set when creating a project.

ProjectDetailPage

Represents a project detail page (PDP), which is a Web Part page for creating, viewing, or managing the properties of projects in Project Web App.

ProjectDetailPageCollection

Represents a collection of project detail pages (PDPs).

ProjectDetailPageCreationInformation

Contains the properties that can be set when creating a project detail page (PDP) for an enterprise project type.

ProjectResource

Represents information about a project resource.

ProjectResourceCreationInformation

Provides information for the creation of a project resource entity.

PublishedAssignment

Represents the assignment that is in a published project.

PublishedAssignmentCollection

Represents a collection of published assignments.

PublishedProject

Represents a project that is published on Project Server 2013.

PublishedProjectResource

Represents an enterprise resource that is published on Project Server 2013.

PublishedProjectResourceCollection

Represents a collection of resources in a published project.

PublishedTask

Represents a task in a published project.

PublishedTaskCollection

Represents a collection of tasks in a published project.

PublishedTaskLink

Represents a dependency relationship between the start and finish dates of two tasks.

PublishedTaskLinkCollection

Represents a collection of task links in a published project.

QueueJob

Represents a project that is queued for publishing.

QueueJobCollection

Represents a collection of queued projects.

ResourceCalendarException

Represents a resource calendar exception.

ResourcePlan

Represents a high-level look at resources that might be needed for a project.

ServiceStatus

Provides information about the status of the Project Server 2013 service.

Stage

Represents a stage in a project workflow.

StageCollection

Represents a collection of workflow stages.

StageCreationInformation

Provides information for the creation of a project workflow stage.

StageCustomField

Represents a custom field for a project stage.

StageCustomFieldCollection

Represents a collection of custom fields in a project workflow stage.

StageCustomFieldCreationInformation

Provides information for the creation of a custom field for a project stage.

StageDetailPage

Represents a project detail page (PDP) for a workflow stage.

StageDetailPageCollection

Represents a collection of project detail pages (PDPs) that are visible in a workflow stage.

StageDetailPageCreationInformation

Provides information for the creation of a project detail page (PDP) for a workflow stage.

StatusAssignment

Represents an assignment in a status update.

StatusAssignmentCollection

Represents a collection of status assignments in a status update.

StatusAssignmentCreationInformation

Provides information for the creation of a status assignment.

StatusTask

Represents the progress of a task.

StatusTaskCreationInformation

Provides information for the creation of a status task object.

Task

Represents a task.

TaskCreationInformation

Provides information for the creation of a task.

TaskLink

Represents the dependency relationship between the start and finish dates of two tasks.

TaskLinkCreationInformation

Provides information for the creation of a task link.

TimePhase

Represents assignment progress information that is distributed over time.

TimeSheet

Represents a timesheet.

TimeSheetLine

Represents a line in a timesheet.

TimeSheetLineCollection

Represents a collection of timesheet lines.

TimeSheetLineCreationInformation

Provides information for the creation of a timesheet line.

TimeSheetPeriod

Represents a defined period of time on a timesheet.

TimeSheetPeriodCollection

Represents a collection of timesheet periods.

TimeSheetWork

Represents the different types of work on a timesheet.

TimeSheetWorkCollection

Represents a collection of actual work entries for a timesheet.

TimeSheetWorkCreationInformation

Provides information for the creation of a timesheet work object.

WorkflowActivities

Represents workflow activities and methods.

WorkflowDesigner

Represents an object that can be used to design a workflow.

WorkflowDesignerField

Represents a field that is created in a workflow designer.

WorkflowDesignerFieldCollection

Represents a filtered collection of enterprise project custom fields that can be used in a workflow designer.

Enumerations

Enumeration

Description

AccrueAt

Specifies the cost accrual mode, which defines how and when resource costs are charged to the cost of a task.

BookingType

Specifies how resources are booked for assignments.

CalendarRecurrenceDays

Represents the days of the week for recurring calendar exceptions.

CalendarRecurrenceType

Specifies the recurrence types for a calendar exception.

CalendarRecurrenceWeek

Specifies one week of a month that is used to set up a schedule.

CommittedDecisionResult

Specifies whether an item is included in an optimizer function or a planner function for project portfolio analysis.

ConstraintType

Specifies the constraint type for a task.

CurrencySymbolPosition

Specifies the placement of the currency symbol.

CustomFieldRollupType

Specifies the summary roll-up type for a custom field.

CustomFieldType

Specifies the type for an enterprise custom field.

DependencyType

Specifies the type of dependency to establish between two tasks.

EnterpriseResourceType

Represents the different types of enterprise resources.

FixedCostAccrual

Specifies how and when fixed costs are to be charged to the cost of a task.

JobState

Specifies the status of a queue job.

LookupTableConstants

Specifies maximum values and minimum values for lookup table entities.

LookupTableMaskSequence

Specifies the mask sequence, which is the type of data for a lookup table.

LookupTableSortOrder

Specifies the sort order for a lookup table.

OvertimeRateFormat

Specifies the time unit of the resource overtime rate; that is, the rate per time unit, such as dollars per hour.

ProjectDetailPageType

Specifies the type of project detail page (PDP).

ProjectType

Specifies the type of project.

QueueMsgType

Specifies the queue message type, for sending a job to the Project Server Queue System.

ReadyToLeaveProjectStageValue

Specifies the project stage requirements in a Project Server workflow, to help determine whether the workflow is ready to leave the stage.

ResourceType

Specifies the types of resources.

StandardRateFormat

Specifies the time unit of the resource rate; that is, the rate per time unit, such as dollars per hour.

StrategicImpactBehavior

Specifies how strategic impact values behave in a Project Server workflow stage.

TaskType

Specifies whether the task type in a project is fixed units, fixed work, or fixed duration.

TimeScale

Specifies the scale of the time-phased data.

TimeSheetEntryMode

Specifies timesheet entry modes.

TimeSheetLineClass

Specifies classifications that define the different uses of a timesheet line.

TimeSheetLineStatus

Specifies status settings that can be applied to a timesheet line.

TimeSheetStatus

Represents status settings that can be applied to a timesheet.

TimeSheetValidationType

Specifies the set of validation types for timesheet lines.

TrackingMode

Specifies the modes for tracking task progress.

UpdateProjectStageStatusFieldValue

Specifies the status of the project stage in a Project Server workflow.

UtilizationType

Specifies the type of resource use for the current resource plan.

WorkFormat

Specifies a value that represents a work format.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.