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

PlanAssignmentCollection class

Nadin Merali|Last Updated: 5/6/2017

inherits members from ClientObjectCollection

Represents a collection of plan assignment objects.

Syntax

CSOM

class PlanAssignmentCollection 

JSOM

PS.PlanAssignmentCollection

REST Interface

Supported.

PS.PlanAssignmentCollection

http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Projects('{projectid}')/GetResourcePlanByUrl(start='{yyyy-MM-dd}',end='{yyyy-MM-dd}',scale='{timescale}')/Assignments

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name.NETJSOMRESTTypeDescription
[Integer]PlanAssignmentGets a PlanAssignment from the collection at the specified index.
ItemPlanAssignmentGets a PlanAssignment from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{PlanAssignmentId}'PlanAssignmentGets a PlanAssignment from the collection with the specified PlanAssignmentId.
Add(PlanAssignmentCreationInformation parameters)PlanAssignmentAdds the PlanAssignment that is specified by the PlanAssignmentCreationInformation object to the collection.
GetByGuid(Guid uid)PlanAssignmentGets a PlanAssignment from the collection with the Id value.
GetById(String objectId)PlanAssignmentGets a PlanAssignment from the collection with the Guid value.
Remove(PlanAssignment assignment)BooleanRemoves the specified PlanAssignment from the collection.


Method Details

'{PlanAssignmentId}'

Gets a PlanAssignment from the collection with the specified PlanAssignmentId.

Syntax
PlanAssignment http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/Projects('{projectid}')/GetResourcePlanByUrl(start='{yyyy-MM-dd}',end='{yyyy-MM-dd}',scale='{timescale}')/Assignments('{PlanAssignmentId}')
Parameters
NameTypeDescription
PlanAssignmentIdStringthe id of the PlanAssignment
Return Value

PlanAssignment

Add(PlanAssignmentCreationInformation parameters)

Adds the PlanAssignment that is specified by the PlanAssignmentCreationInformation object to the collection.

Syntax
PlanAssignment Add(PlanAssignmentCreationInformation parameters)
Parameters
NameTypeDescription
parametersPlanAssignmentCreationInformationThe properties that can be set when creating a plan assignment.
Return Value

PlanAssignment

GetByGuid(Guid uid)

Gets a PlanAssignment from the collection with the Id value.

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

PlanAssignment

GetById(String objectId)

Gets a PlanAssignment from the collection with the Guid value.

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

PlanAssignment

Remove(PlanAssignment assignment)

Removes the specified PlanAssignment from the collection.

Syntax
Boolean Remove(PlanAssignment assignment)
Parameters
NameTypeDescription
assignmentPlanAssignmentThe PlanAssignment to remove.
Return Value

Boolean

See Also

PlanAssignment
PlanAssignmentCreationInformation
ResourcePlan

© 2018 Microsoft