On This Page:

Related Pages:

The sp:GetWorkItemStatusRequest API method can be used to get the current dispatch status value of a work item (a job or standard activity).

Description

The sp:GetWorkItemStatusRequest API method allows the current dispatch status of a work item (a job or standard activity) to be obtained.

Definition

The definition of this API is:

Web Service		Type	Description	Req?	Val?
`<sp:GetWorkItemStatusRequest>`
	`<workItemID>?</workItemID>`	`WorkItemID`	is the identifier of the job whose status is being investigated
	`<workItemType>?</workItemType>`	`WorkItemType`	Identifies whether a job or standard activity
`</sp:GetWorkItemStatusRequest>`

The API returns a non-standard return structure.

Web Service		Type	Description	Req?	Val?
`<sp:GetWorkItemStatusResponse>`
	`<currentStatus>?</currentStatus>`	`DisStatus`	The current status of the job or standard activity.
	`<fixedFlag>?</fixedFlag>`	`boolean`	Whether the item is fixed, or not (only valid for jobs).
`</sp:GetWorkItemStatusResponse>`

In addition to the Standard Return Codes, the possible Return Codes from this API are: