PlanAssignmentCollection class
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 | .NET | JSOM | REST | Type | Description |
|---|---|---|---|---|---|
| [Integer] | ✓ | PlanAssignment | Gets a PlanAssignment from the collection at the specified index. | ||
| Item | ✓ | PlanAssignment | Gets a PlanAssignment from the collection at the specified index. |
Methods
| Name | .NET | JSOM | REST | Return Type | Description |
|---|---|---|---|---|---|
| '{PlanAssignmentId}' | ✓ | PlanAssignment | Gets a PlanAssignment from the collection with the specified PlanAssignmentId. | ||
| Add(PlanAssignmentCreationInformation parameters) | ✓ | ✓ | ✓ | PlanAssignment | Adds the PlanAssignment that is specified by the PlanAssignmentCreationInformation object to the collection. |
| GetByGuid(Guid uid) | ✓ | ✓ | ✓ | PlanAssignment | Gets a PlanAssignment from the collection with the Guid value. |
| GetById(String objectId) | ✓ | ✓ | ✓ | PlanAssignment | Gets a PlanAssignment from the collection with the Id value. |
| Remove(PlanAssignment assignment) | ✓ | ✓ | Boolean | Removes 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
| Name | Type | Description |
|---|---|---|
| PlanAssignmentId | String | the id of the PlanAssignment |
Return Value
Add(PlanAssignmentCreationInformation parameters)
Adds the PlanAssignment that is specified by the PlanAssignmentCreationInformation object to the collection.
Syntax
PlanAssignment Add(PlanAssignmentCreationInformation parameters)
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | PlanAssignmentCreationInformation | The properties that can be set when creating a plan assignment. |
Return Value
GetByGuid(Guid uid)
Gets a PlanAssignment from the collection with the Guid value.
Syntax
PlanAssignment GetByGuid(Guid uid)
Parameters
| Name | Type | Description |
|---|---|---|
| uid | Guid | The Guid of the PlanAssignment |
Return Value
GetById(String objectId)
Gets a PlanAssignment from the collection with the Id value.
Syntax
PlanAssignment GetById(String objectId)
Parameters
| Name | Type | Description |
|---|---|---|
| objectId | String | The id of the PlanAssignment. |
Return Value
Remove(PlanAssignment assignment)
Removes the specified PlanAssignment from the collection.
Syntax
Boolean Remove(PlanAssignment assignment)
Parameters
| Name | Type | Description |
|---|---|---|
| assignment | PlanAssignment | The PlanAssignment to remove. |
Return Value
Boolean
See Also
PlanAssignment
PlanAssignmentCreationInformation
ResourcePlan