StageCustomFieldCollection class

inherits members from ClientObjectCollection

Represents a collection of StageCustomField objects, which are custom fields in a workflow stage.

Syntax

CSOM

class StageCustomFieldCollection 

JSOM

PS.StageCustomFieldCollection

REST Interface

Supported.

PS.StageCustomFieldCollection

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

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name .NET JSOM REST Type Description
[Integer] StageCustomField Gets a StageCustomField from the collection at the specified index.
Item StageCustomField Gets a StageCustomField from the collection at the specified index.

Methods

Name .NET JSOM REST Return Type Description
'{StageCustomFieldId}' StageCustomField Gets a StageCustomField from the collection with the specified StageCustomFieldId.
Add(StageCustomFieldCreationInformation creationInfo) StageCustomField Adds the StageCustomField that is specified by the StageCustomFieldCreationInformation object to the collection.
GetByGuid(Guid uid) StageCustomField Gets a StageCustomField from the collection with the Guid value.
GetById(String objectId) StageCustomField Gets a StageCustomField from the collection with the Id value.
Remove(StageCustomField field) Boolean Removes the specified StageCustomField from the collection.


Method Details

'{StageCustomFieldId}'

Gets a StageCustomField from the collection with the specified StageCustomFieldId.

Syntax
StageCustomField http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages('{stageid}')/CustomFields('{StageCustomFieldId}')
Parameters
Name Type Description
StageCustomFieldId String the id of the StageCustomField
Return Value

StageCustomField

Add(StageCustomFieldCreationInformation creationInfo)

Adds the StageCustomField that is specified by the StageCustomFieldCreationInformation object to the collection.

Syntax
StageCustomField Add(StageCustomFieldCreationInformation creationInfo)
Parameters
Name Type Description
creationInfo StageCustomFieldCreationInformation The properties that can be set when creating a stage custom field.
Return Value

StageCustomField

GetByGuid(Guid uid)

Gets a StageCustomField from the collection with the Guid value.

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

StageCustomField

GetById(String objectId)

Gets a StageCustomField from the collection with the Id value.

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

StageCustomField

Remove(StageCustomField field)

Removes the specified StageCustomField from the collection.

Syntax
Boolean Remove(StageCustomField field)
Parameters
Name Type Description
field StageCustomField The StageCustomField to remove.
Return Value

Boolean

See Also

Stage
StageCustomField
StageCustomFieldCreationInformation