QueueSystem.ReadProjectJobStatus Method
Gets the status of jobs for the specified projects, job types, and completion states from the Project Server Queuing Service.
Namespace: [QueueSystem Web service]
Service reference: http://ServerName:32843/[Project Service Application GUID]/PSI/QueueSystem.svc
Web service reference: http://ServerName/ProjectServerName/_vti_bin/PSI/QueueSystem.asmx?wsdl
Syntax
'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/ReadProjectJobStatus", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", _
ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", _
Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadProjectJobStatus ( _
projectGUIDs As Guid(), _
messageTypes As QueueMsgType(), _
JobCompletionStates As JobState(), _
fromDate As DateTime, _
toDate As DateTime, _
maxRows As Integer, _
includeWaitTime As Boolean, _
sortColumn As SortColumn, _
sortOrder As SortOrder _
) As QueueStatusDataSet
'Usage
Dim instance As QueueSystem
Dim projectGUIDs As Guid()
Dim messageTypes As QueueMsgType()
Dim JobCompletionStates As JobState()
Dim fromDate As DateTime
Dim toDate As DateTime
Dim maxRows As Integer
Dim includeWaitTime As Boolean
Dim sortColumn As SortColumn
Dim sortOrder As SortOrder
Dim returnValue As QueueStatusDataSet
returnValue = instance.ReadProjectJobStatus(projectGUIDs, _
messageTypes, JobCompletionStates, _
fromDate, toDate, maxRows, includeWaitTime, _
sortColumn, sortOrder)
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/ReadProjectJobStatus", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",
ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public QueueStatusDataSet ReadProjectJobStatus(
Guid[] projectGUIDs,
QueueMsgType[] messageTypes,
JobState[] JobCompletionStates,
DateTime fromDate,
DateTime toDate,
int maxRows,
bool includeWaitTime,
SortColumn sortColumn,
SortOrder sortOrder
)
Parameters
- projectGUIDs
Type: []
Array of project GUIDs.
- messageTypes
Type: []
Array of QueueMsgType enumeration values.
- JobCompletionStates
Type: []
Array of JobState enumeration values.
- fromDate
Type: System.DateTime
Minimum date and time of queue jobs.
- toDate
Type: System.DateTime
Maximum date and time of queue jobs.
- maxRows
Type: System.Int32
Maximum number of job status rows to return.
- includeWaitTime
Type: System.Boolean
If true, include the expected job wait time.
- sortColumn
Type: [QueueSystem Web service].SortColumn
Specifies which field to sort in the list of jobs.
- sortOrder
Type: [QueueSystem Web service].SortOrder
Specifies whether to sort and in what order.
Return Value
Type: [QueueSystem Web service].QueueStatusDataSet
Status of the requested jobs, with the QueueStatusDataSet.StatusRow data for each job.
Remarks
For examples of job status requests and resulting data, see ReadJobStatus and ReadJobStatusSimple.
Project Server Permissions
One of the following permissions is required.
Permission |
Description |
|---|---|
Allows the user to manage the Project Server queue. Global permission. |
|
Allows the user to delete or move projects. Global permission. |
|
Allows the user to delete the specified projects. Category permission. |
|
Allows the user to publish the specified projects. Category permission. |
|
Allows the user to save the specified projects. Category permission. |
|
Allows the user to assign resources from the resource pool to the specified project. Category permission. |
|
Allows the user to edit a resource plan. Category permission. |
|
Allows the user to edit the specified projects. Category permission. |