| Panel |
|---|
...
The sp:JobUpdateRequest API method can be used to update a job's priority, importance, access hours and customer information.
...
On This Page: |
...
Related Pages: |
...
| Panel |
|---|
The |
Description
The sp:JobUpdateRequest API method allows a job’s priority, importance, access hours and customer information to be updated without the need for the job to be re-booked.
The changes allowed to a job's access hours are:
- to use the existing access hours that overlap the operative day that the job is already scheduled on;
- to use the existing access hours that overlap the operative day that the job is already scheduled on plus a single supplied closed period; or
- to replace the existing access hours with one or more open access hours overrides.
If any of these changes are made to the job’s access hours, all of its existing other access hours will be permanently removed. If they are subsequently required, the job should be rebooked.
In all cases, the job’s existing ETA (and ETF if it’s a call-to-fix job) must lie within the resulting access hours, otherwise SP_ETA_OUTSIDE_ACC_HOURS (447) will be returned. The job is never moved as a result of a call to sp:JobUpdateRequest, so that it remains in a position in the schedule where it fits in with the other jobs. Allowing the ETA to be outside the supplied access hours would mean that the job would immediately be in jeopardy with no guarantee that it could be re-scheduled to be done within those access hours. In such a situation, the job should be re-booked to determine if it can be re-scheduled within the required access hours.
Definition
The definition of this API is:
| Include Page | ||||
|---|---|---|---|---|
|
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are:
| Include Page | ||||
|---|---|---|---|---|
|