PublishedProject class
inherits members from Project
Represents a project that is published on the Project Service.
Syntax
CSOM
class PublishedProject
JSOM
PS.PublishedProject
REST Interface
Supported.
PS.PublishedProject
http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Projects('{projectid}')
Members
✓ - Read Support ✓ʷ - Write Support
Properties
| Name | .NET | JSOM | REST | Type | Description |
|---|---|---|---|---|---|
| [] | ✓ʷ | Dictionary<string, Object> | Gets or sets an item in the published project. | ||
| Assignments | ✓ | ✓ | ✓ | PublishedAssignmentCollection | Gets the collection of assignments in the project. |
| Calendar | ✓ | ✓ | ✓ | Calendar | Gets the project calendar. |
| CurrencyCode | ✓ | ✓ | ✓ | String | Gets the currency code of the project, as defined in ISO 4217. |
| CurrencyDigits | ✓ | ✓ | ✓ | Integer | Gets the number of decimal digits in currency values. |
| CurrencyPosition | ✓ | ✓ | ✓ | CurrencySymbolPosition | Gets the placement of the currency symbol in relation to the currency value. |
| CurrencySymbol | ✓ | ✓ | ✓ | String | Gets the currency symbol that represents the type of currency that is used in the project. |
| CurrentDate | ✓ | ✓ | ✓ | DateTime | Gets the current date for the project. |
| DaysPerMonth | ✓ | ✓ | ✓ | Integer | Gets the default number of working days per month. |
| DefaultEffortDriven | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the scheduling of new tasks is effort-driven. |
| DefaultEstimatedDuration | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether new tasks have estimated durations. |
| DefaultFixedCostAccrual | ✓ | ✓ | ✓ | FixedCostAccrual | Gets a value that indicates which default fixed-cost accrual method to use on new tasks. |
| DefaultOvertimeRate | ✓ | ✓ | ✓ | Double | Gets the default overtime rate for local resources. |
| DefaultStandardRate | ✓ | ✓ | ✓ | Double | Gets the default standard rate for local resources. |
| DefaultTaskType | ✓ | ✓ | ✓ | TaskType | Gets the default type for tasks in the project. |
| DefaultWorkFormat | ✓ | ✓ | ✓ | WorkFormat | Gets the default format for work duration. |
| Description | ✓ | ✓ | ✓ | String | Gets the project description. |
| Draft | ✓ | ✓ | ✓ | DraftProject | Gets a DraftProject object if it is not already checked out. |
| EnterpriseProjectTypeId | ✓ | Guid | Gets the GUID of the enterprise project type. | ||
| FieldValues | ✓ | ✓ | Dictionary<string, Object> | Gets the collection of custom fields that have values set for the published project. | |
| FinishDate | ✓ | ✓ | ✓ | DateTime | Gets the project finish date. |
| FiscalYearStartMonth | ✓ | ✓ | ✓ | Integer | Gets the number of the first month in the fiscal year. |
| Id | ✓ | ✓ | ✓ | Guid | Gets the GUID of the project. (Inherited fromProject.) |
| IncludeCustomFields | ✓ | ✓ | ✓ | PublishedProject | Gets a PublishedProject object that includes custom fields. |
| IsCheckedOut | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the project is checked out. (Inherited fromProject.) |
| IsEnterpriseProject | ✓ʷ | ✓ʷ | ✓ʷ | Boolean | Gets or sets a value that indicates whether the published project is an enterprise project (managed by Project Server). |
| Item | ✓ʷ | Dictionary<string, Object> | Gets or sets an item in the published project. | ||
| MinutesPerDay | ✓ | ✓ | ✓ | Integer | Gets the default number of minutes per day. |
| MinutesPerWeek | ✓ | ✓ | ✓ | Integer | Gets the default number of minutes per week. |
| Name | ✓ | ✓ | ✓ | String | Gets the name of the project. |
| NewTasksAreManual | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether new tasks are manually scheduled. |
| NumberFiscalYearFromStart | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether to use the project start year for fiscal year numbering. |
| Owner | ✓ʷ | ✓ʷ | ✓ʷ | SPUser | Gets the owner of the project. |
| ProjectIdentifier | ✓ | ✓ | ✓ | String | Gets the project identifer. |
| ProjectResources | ✓ | ✓ | ✓ | PublishedProjectResourceCollection | Gets the collection of resources for a project. |
| ProjectSiteUrl | ✓ | ✓ | ✓ | String | Gets the URL of the project site. (Inherited fromProject.) |
| ProtectedActualsSynch | ✓ | ✓ | ✓ | Boolean | Gets whether the project actuals are synchronized with the protected actuals. |
| ShowEstimatedDurations | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether a question mark is displayed after an estimated duration for a task. |
| StartDate | ✓ | ✓ | ✓ | DateTime | Gets the project start date. |
| StatusDate | ✓ | ✓ | ✓ | DateTime | Gets the status date for the project. |
| SummaryTaskId | ✓ | ✓ | ✓ | Guid | Gets the GUID for the hidden project summary task. (Inherited fromProject.) |
| TaskLinks | ✓ | ✓ | ✓ | PublishedTaskLinkCollection | Gets the collection of task links for the project. |
| Tasks | ✓ | ✓ | ✓ | PublishedTaskCollection | Gets the collection of tasks for the project. |
| TrackingMode | ✓ | ✓ | ✓ | TrackingMode | Gets the default tracking method for all assignments in the project. |
| UtilizationDate | ✓ | ✓ | ✓ | DateTime | Gets the date and time of resource utilization for the current project. |
| UtilizationType | ✓ | ✓ | ✓ | ProjectUtilizationType | Gets the derivation source(s) of the summary resource assignments of a project. |
| WeekStartDay | ✓ | ✓ | ✓ | Integer | Gets the day of the week on which a work week starts. |
| WinprojVersion | ✓ | ✓ | ✓ | Decimal | Gets the version of Project Professional that created the published project. |
Methods
| Name | .NET | JSOM | REST | Return Type | Description |
|---|---|---|---|---|---|
| CheckOut() | ✓ | ✓ | ✓ | DraftProject | Checks out the draft version of the project. |
| CreateProjectSite(String siteName) | ✓ | ✓ | ✓ | void | Creates the project site for the project. |
| DeleteObject() | ✓ | ✓ | ✓ | QueueJob | Deletes the published project object. |
| SubmitToWorkflow() | ✓ | ✓ | ✓ | void | Causes the workflow to run. |
| UpdateVisibilityCustomFields() | ✓ | ✓ | ✓ | QueueJob | Updates the custom fields for a project in visibility mode. |
#### Method Details
CheckOut()
Checks out the draft version of the project.
Syntax
DraftProject CheckOut()
Parameters
None
Return Value
DraftProject
The draft version of the project.
CreateProjectSite(String siteName)
Creates the project site for the project.
Syntax
void CreateProjectSite(String siteName)
Parameters
| Name | Type | Description |
|---|---|---|
| siteName | String | Name of the new project site. If empty, the site name will be the same as the project name. |
Return Value
void
DeleteObject()
Deletes the published project object.
Syntax
Deletes the PublishedProject object.
QueueJob DeleteObject()
Parameters
None
Return Value
Remarks
If the queue job is successful, the Project Server Queuing Service deletes the published version of the project. The draft version is also deleted.
SubmitToWorkflow()
Causes the workflow to run.
Syntax
void SubmitToWorkflow()
Parameters
None
Return Value
void
UpdateVisibilityCustomFields()
Updates the custom fields for a project in visibility mode.
Syntax
QueueJob UpdateVisibilityCustomFields()
Parameters
None
Return Value
QueueJob
A QueueJob object that contains information about the queued job. If the queue job is successful, the Project Server Queuing Service saves the published version of the project.
Remarks
To set the value of properties in an existing project:
- Use the PublishedProject CheckOut method.
- Edit the DraftProject object.
- Check in the edited project using the DraftProject CheckIn method.
See Also
ProjectCollection
ProjectCreationInformation
SPUser
StatusAssignment
Task