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

StageCustomFieldCollection class

Nadin Merali|Last Updated: 5/6/2017

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.NETJSOMRESTTypeDescription
[Integer]StageCustomFieldGets a StageCustomField from the collection at the specified index.
ItemStageCustomFieldGets a StageCustomField from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{StageCustomFieldId}'StageCustomFieldGets a StageCustomField from the collection with the specified StageCustomFieldId.
Add(StageCustomFieldCreationInformation creationInfo)StageCustomFieldAdds the StageCustomField that is specified by the StageCustomFieldCreationInformation object to the collection.
GetByGuid(Guid uid)StageCustomFieldGets a StageCustomField from the collection with the Id value.
GetById(String objectId)StageCustomFieldGets a StageCustomField from the collection with the Guid value.
Remove(StageCustomField field)BooleanRemoves 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
NameTypeDescription
StageCustomFieldIdStringthe 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
NameTypeDescription
creationInfoStageCustomFieldCreationInformationThe 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 Id value.

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

StageCustomField

GetById(String objectId)

Gets a StageCustomField from the collection with the Guid value.

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

StageCustomField

Remove(StageCustomField field)

Removes the specified StageCustomField from the collection.

Syntax
Boolean Remove(StageCustomField field)
Parameters
NameTypeDescription
fieldStageCustomFieldThe StageCustomField to remove.
Return Value

Boolean

See Also

Stage
StageCustomField
StageCustomFieldCreationInformation

© 2018 Microsoft