StageCollection class

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 .NET JSOM REST Type Description
[Integer] Stage Gets a Stage from the collection at the specified index.
Item Stage Gets a Stage from the collection at the specified index.

Methods

Name .NET JSOM REST Return Type Description
'{StageId}' Stage Gets a Stage from the collection with the specified StageId.
Add(StageCreationInformation parameters) Stage Adds the Stage that is specified by the StageCreationInformation object to the collection.
GetByGuid(Guid uid) Stage Gets a Stage from the collection with the Guid value.
GetById(String objectId) Stage Gets a Stage from the collection with the Id value.
Remove(Stage stage) Boolean Removes the specified Stage from the collection.
Update() void Updates 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
Name Type Description
StageId String the 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
Name Type Description
parameters StageCreationInformation The properties that can be set when creating a stage.
Return Value

Stage

GetByGuid(Guid uid)

Gets a Stage from the collection with the Guid value.

Syntax
Stage GetByGuid(Guid uid)
Parameters
Name Type Description
uid Guid The Guid of the Stage
Return Value

Stage

GetById(String objectId)

Gets a Stage from the collection with the Id value.

Syntax
Stage GetById(String objectId)
Parameters
Name Type Description
objectId String The id of the Stage.
Return Value

Stage

Remove(Stage stage)

Removes the specified Stage from the collection.

Syntax
Boolean Remove(Stage stage)
Parameters
Name Type Description
stage Stage The 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