Resource URL Summary

Pass Through Call to ServiceScheduling's "Cancel Job" API

PUT /up/v5/rest/scheduling/CancelJob

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

.

Pass Through Call to ServiceScheduling's "Cancel Job" API

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

URL

PUT /up/v5/rest/scheduling/CancelJob

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 ServiceScheduling "Cancel Job" APi.

CancelJob Object Format

CancelJob JSON

{
	"Id": "Dep-1306",
	"CancelReason": {
		"cancelReasonId": 1,
    	"cancelReasonDesc": ""
	}
}

CancelJob Object Properties (Bold property names indicate the field is required)

Property Type Length Description Req? Mapping Field: Service Scheduling

Id

string

SS: 50

Pass through parameter to the ServiceScheduling Cancel Job API.

Yes

jobID

CancelReason

object

Pass through parameter to the ServiceScheduling Cancel Dependency Group Jobs API.

No

see cancelReason.objects

Cancellation reason details were added to the ServiceScheduling "Cancel Job" API in version 11.3. When cancellation reason details are provided in a call to the ServiceBroker CancelJob RESTified API endpoint, and the ServiceScheduling version in use is prior to 11.3, the cancellation details will not be passed through to the underlying ServiceScheduling instance.

HTTP Response

Success

On success, a JSON-formatted version of the ServiceScheduling "Cancel 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 ServiceScheduling "Cancel 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 general ServiceScheduling Return Codes, the specfic ones for this API are:

Click here to expand...

SP_OK (0)
SP_JOBID_INVALID (1)