Integration ServiceOptimizer Get Work Item Status SOAP API
- Andrew Hill (Deactivated)
- Matthew Wren (Unlicensed)
- Debbie Roycroft (Deactivated)
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? | |
|
|
|
|
| |
|
|
| is the identifier of the job whose status is being investigated |
|
|
|
|
| Identifies whether a job or standard activity |
|
|
|
|
|
|
| |
Return Structure
The API returns a non-standard return structure.
Web Service | Type | Description | Req? | Val? | |
|
|
|
|
| |
|
|
| The current status of the job or standard activity |
|
|
|
|
| whether the item is fixed or not (only valid for jobs). |
|
|
|
|
|
|
| |
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)