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

StageDetailPageCollection class

Nadin Merali|Last Updated: 5/6/2017

inherits members from ClientObjectCollection

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

Syntax

CSOM

class StageDetailPageCollection 

JSOM

PS.StageDetailPageCollection

REST Interface

Supported.

PS.StageDetailPageCollection

http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages('{stageid}')/ProjectDetailPages

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name.NETJSOMRESTTypeDescription
[Integer]StageDetailPageGets a StageDetailPage from the collection at the specified index.
ItemStageDetailPageGets a StageDetailPage from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{StageDetailPageId}'StageDetailPageGets a StageDetailPage from the collection with the specified StageDetailPageId.
Add(StageDetailPageCreationInformation parameters)StageDetailPageAdds the StageDetailPage that is specified by the StageDetailPageCreationInformation object to the collection.
GetByGuid(Guid uid)StageDetailPageGets a StageDetailPage from the collection with the Id value.
GetById(String objectId)StageDetailPageGets a StageDetailPage from the collection with the Guid value.
Remove(StageDetailPage pdp)BooleanRemoves the specified StageDetailPage from the collection.


Method Details

'{StageDetailPageId}'

Gets a StageDetailPage from the collection with the specified StageDetailPageId.

Syntax
StageDetailPage http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages('{stageid}')/ProjectDetailPages('{StageDetailPageId}')
Parameters
NameTypeDescription
StageDetailPageIdStringthe id of the StageDetailPage
Return Value

StageDetailPage

Add(StageDetailPageCreationInformation parameters)

Adds the StageDetailPage that is specified by the StageDetailPageCreationInformation object to the collection.

Syntax
StageDetailPage Add(StageDetailPageCreationInformation parameters)
Parameters
NameTypeDescription
parametersStageDetailPageCreationInformationThe properties that can be set when creating a stage detail page.
Return Value

StageDetailPage

GetByGuid(Guid uid)

Gets a StageDetailPage from the collection with the Id value.

Syntax
StageDetailPage GetByGuid(Guid uid)
Parameters
NameTypeDescription
uidGuidThe Guid of the StageDetailPage
Return Value

StageDetailPage

GetById(String objectId)

Gets a StageDetailPage from the collection with the Guid value.

Syntax
StageDetailPage GetById(String objectId)
Parameters
NameTypeDescription
objectIdStringThe id of the StageDetailPage.
Return Value

StageDetailPage

Remove(StageDetailPage pdp)

Removes the specified StageDetailPage from the collection.

Syntax
Boolean Remove(StageDetailPage pdp)
Parameters
NameTypeDescription
pdpStageDetailPageThe StageDetailPage to remove.
Return Value

Boolean

See Also

Stage
StageDetailPage
StageDetailPageCreationInformation

© 2018 Microsoft