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

StatusAssignmentCollection class

Nadin Merali|Last Updated: 5/6/2017

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.NETJSOMRESTTypeDescription
[Integer]StatusAssignmentGets a StatusAssignment from the collection at the specified index.
ItemStatusAssignmentGets a StatusAssignment from the collection at the specified index.

Methods

Name.NETJSOMRESTReturn TypeDescription
'{StatusAssignmentId}'StatusAssignmentGets a StatusAssignment from the collection with the specified StatusAssignmentId.
Add(StatusAssignmentCreationInformation parameters)StatusAssignmentAdds the StatusAssignment that is specified by the StatusAssignmentCreationInformation object to the collection.
GetByGuid(Guid uid)StatusAssignmentGets a StatusAssignment from the collection with the Id value.
GetById(String objectId)StatusAssignmentGets a StatusAssignment from the collection with the Guid value.
GetTimePhase(DateTime start, DateTime end)TimePhaseReads the timephased data for assignments that are within the specified start date and end date.
GetTimePhaseByUrl(String start, String end)TimePhase
Remove(StatusAssignment assignment)BooleanRemoves the specified StatusAssignment from the collection.
SubmitAllStatusUpdates(String comment)voidSubmit all updates to assignments in the StatusAssignmentCollection for approval.
Update()voidUpdates 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
NameTypeDescription
StatusAssignmentIdStringthe id of the StatusAssignment
Return Value

StatusAssignment

Add(StatusAssignmentCreationInformation parameters)

Adds the StatusAssignment that is specified by the StatusAssignmentCreationInformation object to the collection.

Syntax
StatusAssignment Add(StatusAssignmentCreationInformation parameters)
Parameters
NameTypeDescription
parametersStatusAssignmentCreationInformationThe properties that can be set when creating a status assignment.
Return Value

StatusAssignment

GetByGuid(Guid uid)

Gets a StatusAssignment from the collection with the Id value.

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

StatusAssignment

GetById(String objectId)

Gets a StatusAssignment from the collection with the Guid value.

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

StatusAssignment

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
NameTypeDescription
startDateTimeThe start date.
endDateTimeThe end date.
Return Value

TimePhase

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
NameTypeDescription
startDateTimeThe start date.
endDateTimeThe end date.
Return Value

TimePhase

Remove(StatusAssignment assignment)

Removes the specified StatusAssignment from the collection.

Syntax
Boolean Remove(StatusAssignment assignment)
Parameters
NameTypeDescription
assignmentStatusAssignmentThe 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
NameTypeDescription
commentStringThe 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

© 2018 Microsoft