StatusAssignmentCollection class
inherits members from ClientObjectCollection
Represents a collection of StatusAssignment objects, which are assignments in a status update.
Syntax
CSOM
class StatusAssignmentCollection
JSOM
PS.StatusAssignmentCollection
REST Interface
Supported.
PS.StatusAssignmentCollection
http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/EnterpriseResources('{resourceid}')/Assignments
Members
✓ - Read Support ✓ʷ - Write Support
Properties
| Name | .NET | JSOM | REST | Type | Description |
|---|---|---|---|---|---|
| [Integer] | ✓ | StatusAssignment | Gets a StatusAssignment from the collection at the specified index. | ||
| Item | ✓ | StatusAssignment | Gets a StatusAssignment from the collection at the specified index. |
Methods
| Name | .NET | JSOM | REST | Return Type | Description |
|---|---|---|---|---|---|
| '{StatusAssignmentId}' | ✓ | StatusAssignment | Gets a StatusAssignment from the collection with the specified StatusAssignmentId. | ||
| Add(StatusAssignmentCreationInformation parameters) | ✓ | ✓ | ✓ | StatusAssignment | Adds the StatusAssignment that is specified by the StatusAssignmentCreationInformation object to the collection. |
| GetByGuid(Guid uid) | ✓ | ✓ | ✓ | StatusAssignment | Gets a StatusAssignment from the collection with the Guid value. |
| GetById(String objectId) | ✓ | ✓ | ✓ | StatusAssignment | Gets a StatusAssignment from the collection with the Id value. |
| GetTimePhase(DateTime start, DateTime end) | ✓ | ✓ | TimePhase | Reads the timephased data for assignments that are within the specified start date and end date. | |
| GetTimePhaseByUrl(String start, String end) | ✓ | TimePhase | |||
| Remove(StatusAssignment assignment) | ✓ | ✓ | Boolean | Removes the specified StatusAssignment from the collection. | |
| SubmitAllStatusUpdates(String comment) | ✓ | ✓ | ✓ | void | Submit all updates to assignments in the StatusAssignmentCollection for approval. |
| Update() | ✓ | ✓ | void | Updates the status assignment collection. |
#### Method Details
'{StatusAssignmentId}'
Gets a StatusAssignment from the collection with the specified StatusAssignmentId.
Syntax
StatusAssignment http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/EnterpriseResources('{resourceid}')/Assignments('{StatusAssignmentId}')
Parameters
| Name | Type | Description |
|---|---|---|
| StatusAssignmentId | String | the id of the StatusAssignment |
Return Value
Add(StatusAssignmentCreationInformation parameters)
Adds the StatusAssignment that is specified by the StatusAssignmentCreationInformation object to the collection.
Syntax
StatusAssignment Add(StatusAssignmentCreationInformation parameters)
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | StatusAssignmentCreationInformation | The properties that can be set when creating a status assignment. |
Return Value
GetByGuid(Guid uid)
Gets a StatusAssignment from the collection with the Guid value.
Syntax
StatusAssignment GetByGuid(Guid uid)
Parameters
| Name | Type | Description |
|---|---|---|
| uid | Guid | The Guid of the StatusAssignment |
Return Value
GetById(String objectId)
Gets a StatusAssignment from the collection with the Id value.
Syntax
StatusAssignment GetById(String objectId)
Parameters
| Name | Type | Description |
|---|---|---|
| objectId | String | The id of the StatusAssignment. |
Return Value
GetTimePhase(DateTime start, DateTime end)
Reads the timephased data for assignments that are within the specified start date and end date.
Syntax
TimePhase GetTimePhase(DateTime start, DateTime end)
Parameters
| Name | Type | Description |
|---|---|---|
| start | DateTime | The start date. |
| end | DateTime | The end date. |
Return Value
GetTimePhaseByUrl(String start, String end)
Reads the timephased data for assignments that are within the specified start date and end date.
Syntax
TimePhase GetTimePhaseByUrl(String start, String end)
Parameters
| Name | Type | Description |
|---|---|---|
| start | DateTime | The start date. |
| end | DateTime | The end date. |
Return Value
Remove(StatusAssignment assignment)
Removes the specified StatusAssignment from the collection.
Syntax
Boolean Remove(StatusAssignment assignment)
Parameters
| Name | Type | Description |
|---|---|---|
| assignment | StatusAssignment | The StatusAssignment to remove. |
Return Value
Boolean
SubmitAllStatusUpdates(String comment)
Submit all updates to assignments in the StatusAssignmentCollection for approval.
Syntax
void SubmitAllStatusUpdates(String comment)
Parameters
| Name | Type | Description |
|---|---|---|
| comment | String | The text comment for the status submission. |
Return Value
void
Update()
Updates the status assignment collection.
Syntax
void Update()
Parameters
None
Return Value
void
See Also
EnterpriseResource
StatusAssignment
StatusAssignmentCreationInformation
TimePhase