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

StageCollection class

Nadin Merali|Last Updated: 5/6/2017

inherits members from ClientObjectCollection

Represents a collection of workflow Stage objects.

Syntax

CSOM

class StageCollection 

JSOM

PS.StageCollection

REST Interface

Supported.

PS.StageCollection

http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name.NETJSOMRESTTypeDescription
[Integer]StageGets a Stage from the collection at the specified index.
ItemStageGets a Stage from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{StageId}'StageGets a Stage from the collection with the specified StageId.
Add(StageCreationInformation parameters)StageAdds the Stage that is specified by the StageCreationInformation object to the collection.
GetByGuid(Guid uid)StageGets a Stage from the collection with the Id value.
GetById(String objectId)StageGets a Stage from the collection with the Guid value.
Remove(Stage stage)BooleanRemoves the specified Stage from the collection.
Update()voidUpdates the stage collection.


Method Details

'{StageId}'

Gets a Stage from the collection with the specified StageId.

Syntax
Stage http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages('{StageId}')
Parameters
NameTypeDescription
StageIdStringthe id of the Stage
Return Value

Stage

Add(StageCreationInformation parameters)

Adds the Stage that is specified by the StageCreationInformation object to the collection.

Syntax
Stage Add(StageCreationInformation parameters)
Parameters
NameTypeDescription
parametersStageCreationInformationThe properties that can be set when creating a stage.
Return Value

Stage

GetByGuid(Guid uid)

Gets a Stage from the collection with the Id value.

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

Stage

GetById(String objectId)

Gets a Stage from the collection with the Guid value.

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

Stage

Remove(Stage stage)

Removes the specified Stage from the collection.

Syntax
Boolean Remove(Stage stage)
Parameters
NameTypeDescription
stageStageThe Stage to remove.
Return Value

Boolean

Update()

Updates the stage collection.

Syntax
void Update()
Parameters

None

Return Value

void

See Also

Phase
ProjectContext
Stage
StageCreationInformation

© 2018 Microsoft