Table of contents
API
TOC
Collapse the table of content
Expand the table of content

PublishedProject class

Nadin Merali|Last Updated: 5/6/2017

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.NETJSOMRESTTypeDescription
[]✓ʷDictionary<string, Object>Gets or sets an item in the published project.
AssignmentsPublishedAssignmentCollectionGets the collection of assignments in the project.
CalendarCalendarGets the project calendar.
CurrencyCodeStringGets the currency code of the project, as defined in ISO 4217.
CurrencyDigitsIntegerGets the number of decimal digits in currency values.
CurrencyPositionCurrencySymbolPositionGets the placement of the currency symbol in relation to the currency value.
CurrencySymbolStringGets the currency symbol that represents the type of currency that is used in the project.
CurrentDateDateTimeGets the current date for the project.
DaysPerMonthIntegerGets the default number of working days per month.
DefaultEffortDrivenBooleanGets a value that indicates whether the scheduling of new tasks is effort-driven.
DefaultEstimatedDurationBooleanGets a value that indicates whether new tasks have estimated durations.
DefaultFixedCostAccrualFixedCostAccrualGets a value that indicates which default fixed-cost accrual method to use on new tasks.
DefaultOvertimeRateDoubleGets the default overtime rate for local resources.
DefaultStandardRateDoubleGets the default standard rate for local resources.
DefaultTaskTypeTaskTypeGets the default type for tasks in the project.
DefaultWorkFormatWorkFormatGets the default format for work duration.
DescriptionStringGets the project description.
DraftDraftProjectGets a DraftProject object if it is not already checked out.
EnterpriseProjectTypeIdGuidGets the GUID of the enterprise project type.
FieldValuesDictionary<string, Object>Gets the collection of custom fields that have values set for the published project.
FinishDateDateTimeGets the project finish date.
FiscalYearStartMonthIntegerGets the number of the first month in the fiscal year.
IdGuidGets the GUID of the project. (Inherited fromProject.)
IncludeCustomFieldsPublishedProjectGets a PublishedProject object that includes custom fields.
IsCheckedOutBooleanGets a value that indicates whether the project is checked out. (Inherited fromProject.)
IsEnterpriseProject✓ʷ✓ʷ✓ʷBooleanGets 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.
MinutesPerDayIntegerGets the default number of minutes per day.
MinutesPerWeekIntegerGets the default number of minutes per week.
NameStringGets the name of the project.
NewTasksAreManualBooleanGets a value that indicates whether new tasks are manually scheduled.
NumberFiscalYearFromStartBooleanGets a value that indicates whether to use the project start year for fiscal year numbering.
Owner✓ʷ✓ʷ✓ʷSPUserGets the owner of the project.
ProjectIdentifierStringGets the project identifer.
ProjectResourcesPublishedProjectResourceCollectionGets the collection of resources for a project.
ProjectSiteUrlStringGets the URL of the project site. (Inherited fromProject.)
ProtectedActualsSynchBooleanGets whether the project actuals are synchronized with the protected actuals.
ShowEstimatedDurationsBooleanGets a value that indicates whether a question mark is displayed after an estimated duration for a task.
StartDateDateTimeGets the project start date.
StatusDateDateTimeGets the status date for the project.
SummaryTaskIdGuidGets the GUID for the hidden project summary task. (Inherited fromProject.)
TaskLinksPublishedTaskLinkCollectionGets the collection of task links for the project.
TasksPublishedTaskCollectionGets the collection of tasks for the project.
TrackingModeTrackingModeGets the default tracking method for all assignments in the project.
UtilizationDateDateTimeGets the date and time of resource utilization for the current project.
UtilizationTypeProjectUtilizationTypeGets the derivation source(s) of the summary resource assignments of a project.
WeekStartDayIntegerGets the day of the week on which a work week starts.
WinprojVersionDecimalGets the version of Project Professional that created the published project.

Methods

Name.NETJSOMRESTReturn TypeDescription
CheckOut()DraftProjectChecks out the draft version of the project.
CreateProjectSite(String siteName)voidCreates the project site for the project.
DeleteObject()QueueJobDeletes the published project object.
SubmitToWorkflow()voidCauses the workflow to run.
UpdateVisibilityCustomFields()QueueJobUpdates 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
NameTypeDescription
siteNameStringName 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

QueueJob

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:

  1. Use the PublishedProjectCheckOut method.
  2. Edit the DraftProject object.
  3. Check in the edited project using the DraftProject CheckIn method.

See Also

ProjectCollection
ProjectCreationInformation
SPUser
StatusAssignment
Task

© 2018 Microsoft