Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 8 Next »

The current value of a work item’s dispatch status (be it a job or standard activity) can be obtained by calling the function GetWorkItemStatusRequest.

On This Page:

Related Pages:

 

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

(tick)

(tick)

 

<workItemType>?</workItemType>

WorkItemType

Identifies whether a job or standard activity

(tick)

 

</sp:GetWorkItemStatusRequest>

 

 

 

 

Return Structure

The API returns a non-standard return structure.

Web Service

Type

Description

Req?

Val?

<sp:GetWorkItemStatusResponse>

 

 

 

 

 

<currentStatus>?</currentStatus>

dispatchStatus

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>

 

 

 

 

Return Codes

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

  • SP_OK (0)
  • SP_JOBID_INVALID (1)
  • SP_UNRESOURCED_JOB (148)
  • SP_WORKITEMTYPE_INVALID (671)

  • No labels