ResourcePlan.ReadResourcePlan Method

Reads resource plan data for the specified project using an optional filter or date range. Optionally checks out the resource plan for modification.

Namespace:  WebSvcResourcePlan
Assembly:  ProjectServerWebServices (in ProjectServerWebServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/office/project/server/webservices/ResourcePlan/ReadResourcePlan", RequestNamespace := "http://schemas.microsoft.com/office/project/server/webservices/ResourcePlan/",  _
    ResponseNamespace := "http://schemas.microsoft.com/office/project/server/webservices/ResourcePlan/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadResourcePlan ( _
    filter As String, _
    projectUid As Guid, _
    startDate As DateTime, _
    endDate As DateTime, _
    timeScale As Short, _
    timephasedFTE As Boolean, _
    autoCheckOut As Boolean _
) As ResourcePlanDataSet

'Usage
Dim instance As ResourcePlan
Dim filter As String
Dim projectUid As Guid
Dim startDate As DateTime
Dim endDate As DateTime
Dim timeScale As Short
Dim timephasedFTE As Boolean
Dim autoCheckOut As Boolean
Dim returnValue As ResourcePlanDataSet

returnValue = instance.ReadResourcePlan(filter, _
    projectUid, startDate, endDate, timeScale, _
    timephasedFTE, autoCheckOut)

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/office/project/server/webservices/ResourcePlan/ReadResourcePlan", RequestNamespace = "http://schemas.microsoft.com/office/project/server/webservices/ResourcePlan/", 
    ResponseNamespace = "http://schemas.microsoft.com/office/project/server/webservices/ResourcePlan/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public ResourcePlanDataSet ReadResourcePlan(
    string filter,
    Guid projectUid,
    DateTime startDate,
    DateTime endDate,
    short timeScale,
    bool timephasedFTE,
    bool autoCheckOut
)

Parameters

• filter
  Type: System.String
  XML filter to limit data returned. For more information, see How to: Use a Filter Parameter with PSI Methods.

• projectUid
  Type: System.Guid
  Project GUID.

• startDate
  Type: System.DateTime
  Start date.

• endDate
  Type: System.DateTime
  End date.

• timeScale
  Type: System.Int16
  Time scale specified by the TimeScaleClass.TimeScale enumeration.

• timephasedFTE
  Type: System.Boolean
  If true, return the full time equivalent resources.

• autoCheckOut
  Type: System.Boolean
  If true, check out the resource plan for editing.

Return Value

Type: WebSvcResourcePlan.ResourcePlanDataSet
ResourcePlanDataSet with the data specified by the filter or date parameters.

Remarks

The primary DataTable in a ResoucePlanDataSet is the PlanResourcesDataTable.

Note

The filter parameter works with the Criteria operators to filter rows only in the primary PlanResourcesDataTable. For example, you cannot use filter with the ReadResourcePlan method to filter rows in the PlanAssignmentCustomFieldsDataTable. If you try to filter rows in a secondary DataTable, the PSI returns a FilterInvalid exception.

However, you can use the Fields.Add method to filter columns in the primary CalendarsDataTable and in any secondary DataTable.

See Also

Reference

ResourcePlan Class

ResourcePlan Members

WebSvcResourcePlan Namespace

Other Resources

How to: Use a Filter Parameter with PSI Methods