5.4.0

A pass-through API to Scheduling (when configured) which allows the Scheduling 's "Confirm Dispatched Job" API to be called.

Description

When a client application has found the details of the next Work Item to be dispatched by a call to the Get Dispatchable Jobs and Activities SOAP API it will normally then attempt to send those details to the operative concerned.

Whether or not that attempt was successful needs to be indicated back to ServiceOptimizer. Once the success of job dispatch has been confirmed, the job won’t be dispatched again.

In this context, the Scheduling "Confirm Dispatched Job" API is the sp:DispResultRequest API.

On this page:

Related pages:

Resource URL Summary

Pass Through Call to Scheduling 's "Confirm Dispatched Job" API

PUT /up/v5/rest/scheduling/DispResult

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Pass Through Call to Scheduling 's "Confirm Dispatched Job" API

This RESTified API will perform a pass-through call to the Scheduling sub-system's "Confirm Dispatched Job" API (when configured).

URL

PUT /up/v5/rest/scheduling/DispResult

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Scheduling "Confirm Dispatched Job" APi.

ConfirmDispatchedJob Object Format

ConfirmDispatchedJob JSON

{
    "ResultCode": 0
}

ConfirmDispatchedJob Object Properties

Property Type Description Req?

ResultCode

Integer

If the job was successfully dispatched, this should be set to 0. If any other result is returned, ServiceOptimizer will re-dispatch the job until 0 is returned for it, or disp_expiry_time is reached. ServiceOptimizer does not do any special processing for non-zero responses, but it will be logged in the log file.

SS Field: resultCode

Yes

HTTP Response

Success

On success, a JSON-formatted version of the Scheduling "Confirm Dispatched Job" API response will be returned.

{
	"Success": true,
	"Code": "0",
	"Message": "",
	"Payload": {
    	"result": {
      		"type": "OK",
      		"code": "0"
    	}
  	}
}

Error

On error, a JSON-formatted version of the Scheduling "Confirm Dispatched Job" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "code": "SCH Error Code"
        }
    }
}

Return Codes

In addition to the Standard Return Codes, and the Scheduling Error codes, the possible Return Codes from this API are:

Click here to expand...

SP_OK (0)
SP_DISP_INIT_EXPECTED (262)
SP_DISP_REQ_EXPECTED (263)

ServiceBroker 5

ConfirmDispatchedJob RESTified API

Analytics