Workflow.ReadWorkflowStatus method

Reads the workflow status of the specified project.

Namespace:  WebSvcWorkflow
Assembly:  ProjectServerServices (in ProjectServerServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/Workflow/ReadWorkflowStatus", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/Workflow/",  _
    ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/Workflow/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadWorkflowStatus ( _
    projUid As Guid, _
    readAllStagesAndPhases As Boolean _
) As WorkflowDataSet
'Usage
Dim instance As Workflow
Dim projUid As Guid
Dim readAllStagesAndPhases As Boolean
Dim returnValue As WorkflowDataSet

returnValue = instance.ReadWorkflowStatus(projUid, _
    readAllStagesAndPhases)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/Workflow/ReadWorkflowStatus", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/Workflow/", 
    ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/Workflow/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public WorkflowDataSet ReadWorkflowStatus(
    Guid projUid,
    bool readAllStagesAndPhases
)

Parameters

• projUid
  Type: System.Guid

  The GUID of the project.

• readAllStagesAndPhases
  Type: System.Boolean

  If True, read the status and additional information of the workflow stage and phase. If False, read only the current status and the active workflow for the project.

Return value

Type: WebSvcWorkflow.WorkflowDataSet

Remarks

If readAllStagesAndPhases = True, the WorkflowDataSet includes information about the following: workflow status, workflow instance, phase, stage, stage custom fields, project detail pages (PDPs) for the stage, and the strategic effect of the stage.

Project Server Permissions

Permission	Description
Non-Standard	The user must have the OpenProject category permission for the specified project.

See also

Reference

Workflow class

Workflow members

WebSvcWorkflow namespace