Pass Through Call to ServiceScheduling's "Update Job Finish Time" APIThis RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Update Job Finish Time" API (when configured). URL| Panel |
|---|
| borderColor | grey |
|---|
| bgColor | whitesmoke |
|---|
| borderStyle | solid |
|---|
| PUT /up/v5/rest/scheduling/ChangeJobFinishTime
|
HTTP Request BodyThis request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceScheduling "Update Job Finish Time" APi. | Code Block |
|---|
| language | js |
|---|
| title | UpdateJobFinishTime JSON |
|---|
| collapse | true |
|---|
| {
"Id": "JobId",
"ChangeTime": "DateTime",
"Options": {
"SetStatusBack": false
}
} |
UpdateJobFinishTime Object Properties| Property | Type | Length | Description | Req? | Field Mapping: ServiceScheduling |
|---|
Id | string | SS: JobID (string)
| SS: 50 | Pass through parameter to the ServiceScheduling "Update Job Finish Time" the ServiceScheduling 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. | SS Field: Yes | jobID | Yes | ChangeTime | string
SS: spDateTime (string)
| SS: 16 | Pass through parameter to the ServiceScheduling "Update Job Finish Time" the ServiceScheduling Update Job Arrival Time API. The job's new finish date-time. Example: "2023-03-30T14:15" SS Field: finishTime | YesYes | finishTime
| Options | object |
| Pass through parameter to the ServiceScheduling "Update Job Finish Time" API. | | Property | Type | Description | Req? |
|---|
SetStatusBack | Boolean | If setStatusBack is set then the current status of the job is set back to Tentative. SS Field: options.setStatusBack | No | | FixJob | Boolean | If FixJob is set the job is marked as Fixed. If, also, the job’s status is (now) Tentative, then it is positioned exactly at the times specified. If FixJob is not set, the job’s new Start/Arrival/Finish time will determine the sequence position. SS Field: options.fixJob | No | | AllowSpanDays | Boolean | If the new position of the job would span a day, the call will fail and return SP_WOULD_SPAN_DAYS (374), unless AllowSpanDays is set SS Field: options.allowSpanDays | No | Nothe ServiceScheduling Update Job Arrival Time API. See UpdateJobFinishTime Options Object.
No | See UpdateJobFinishTime Options Object.
|
HTTP Response SuccessOn success, a JSON-formatted version of the ServiceScheduling "Update Job Finish Time" API response will be returned. | Code Block |
|---|
| {
"Success": true,
"Code": "0",
"Message": "",
"Payload": {
"result": {
"type": "OK",
"code": "0"
}
}
} |
Error On error, a JSON-formatted version of the ServiceScheduling "Update Job Finish Time" API response will be returned. | Code Block |
|---|
| {
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"code": "SCH Error Code"
}
}
} |
Return CodesIn addition to the Standard Return Codes, the possible Return Codes from this API are: | Expand |
|---|
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
|
| 