Pass Through Call to Scheduling's "Update Job Finish Time" API

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

URL

PUT /up/v5/rest/scheduling/ChangeJobFinishTime

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 "Update Job Finish Time" APi.

UpdateJobFinishTime Object Format

UpdateJobFinishTime JSON

js

UpdateJobFinishTime Object Properties

Property

Type

Length

Description

Req?

Field Mapping: Scheduling

Id

string

SS: 50

Pass through parameter to the Scheduling Update Job Arrival Time API.

The identifier of the job to be updated. The error SP_JOBID_INVALID (1) will be returned if the supplied JobID does not exist in the ServicePower database.

Yes

jobID

ChangeTime

string

SS: spDateTime (string)

SS: 16

Pass through parameter to the Scheduling Update Job Arrival Time API.

The job's new finish date-time.

Example: "2023-03-30T14:15"

Yes

finishTime

Options

object

Pass through parameter to the Scheduling Update Job Arrival Time API. See UpdateJobFinishTime Options Object.

No

See UpdateJobFinishTime Options Object.

HTTP Response

Success

On success, a JSON-formatted version of the Scheduling "Update Job Finish Time" API response will be returned.

js

Error

On error, a JSON-formatted version of the Scheduling "Update Job Finish Time" API response will be returned.

js

Return Codes

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

SP_OK (0)
SP_JOBID_INVALID (1)
SP_DURATION_INVALID (12)
SP_END_NOT_GT_START_TIME (31)
SP_OUTSIDE_HORIZON (53)
SP_OPTIONS_INVALID (80)
SP_UNRESOURCED_JOB (148)
SP_OUTSIDE_FRU_POSTING (264)
SP_OK_WITH_OVERLAPS (373)
SP_WOULD_SPAN_DAYS (374)
SP_DST_TIME_INVALID (379)
SP_START_MOVED_TOO_FAR (386)
SP_ARRIVES_ON_ANOTHER_DAY (387)
SP_JOB_TOO_LONG (388)
SP_DATETIME_INVALID (538)

Note:

SP_DURATION_INVALID (12) is returned if the job’s new Finish time would be the same as or before its Arrival time.

SP_END_NOT_GT_START_TIME (31) is returned if:

- the job’s Arrival time would be earlier than its Start time, or
- the job’s Finish time would be earlier than its Start time

Browser not supported