Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:JobHistoryRequest>

<jobId>?</jobId>

JobID

The identifier of the job for which the job history is required. The error SP_JOBID_INVALID (1) will be returned if the supplied JobID does not exist in the ServicePower database.

<options>?</options>

HistoryOptions

An optional field which can be used to restrict the type of changes returned.

When set to All:

As per HistoryOptions, system and manual history changes will be returned.
Any supplied filterUserList values in the API call will be ignored.
Results will be filtered by any supplied filterActionList values in the API call.

When set to Manual:

As per HistoryOptions, only manual history changes will be returned.
Results will be filtered by any supplied filterUserList values in the API call.
Results will be filtered by any supplied filterActionList values in the API call.

When set to System:

As per HistoryOptions, only system history changes will be returned.
Any supplied filterUserList values in the API call will be ignored.
Results will be filtered by any supplied filterActionList values in the API call.

When not supplied, the options field will use a default value of All - however, in this situation, the inclusion of any supplied filter options via the filterUserList and filterActionList structures will result in the SP_NO_OPTIONS_SET (807) error being returned.

<filterUserList>

An optional structure containing one or more filterUser values. When supplied (and not ignored, depending on the value supplied for the options parameter), the job history changes returned will be filtered to only those changes performed by the user(s) that match the value(s) supplied.

If any filterUser value supplied is invalid, then the SP_USERID_DOES_NOT_EXIST (703) error will be returned.
If any filterUser value supplied is valid, but the user is not enabled, then the SP_USER_NOT_VALID (808) error will be returned.
If any filterUser value is duplicated in the filterUserList, then the SP_FILTER_USER_DUPLICATE (809) error will be returned.
If the filterUserList structure is supplied but ignored, then the SP_OK_FILTERLIST_IGNORED (810) warning will be returned.

<filterUser>?</filterUser> string(1-50) A string matching an entry from the SP088_USERS_UNITS table, representing a user.

</filterUserList>

<filterActionList>

An optional structure containing one or more filterAction values. When supplied (and not ignored, depending on the value supplied for the options parameter), the job history changes returned will be filtered to only those changes that match the action value(s) supplied.

If any filterAction value supplied is invalid, then the SP_FILTER_ACTION_DOES_NOT_EXIST (805) error will be returned.
- An invalid value means:
  - A value supplied does not match one of the valid values listed below;
  - The options field has been set to Manual, but a value supplied corresponds to a SP598_SYSTEM_ACTIONS table action; or
  - The options field has been set to System, but a value supplied corresponds to a SP501_GANTT_ACTIONS table action.
If any filterAction value is duplicated in the filterActionList, then the SP_FILTER_ACTION_DUPLICATE (806) error will be returned.
If the filterActionList structure is supplied but ignored, then the SP_OK_FILTERLIST_IGNORED (810) warning will be returned.

<filterAction>?</filterAction>

string(1-255)

A string matching an entry from either the SP501_GANTT_ACTIONS table or the SP598_SYSTEM_ACTIONS table, representing a type of change to the job (i.e. action).

Valid values are:

`SP501_GANTT_ACTIONS` Table Action	Description
`Call.Confirm`	The job's confirmed state was changed.
`FJ.Alloc`	The job was allocated via the ServiceGANTT "Find Job" function.
`FJ.Move`	The job was moved via the ServiceGANTT "Move Job" function.
`Job.Alloc`	The job was allocated.
`Job.Book`	The job was booked to the "intray".
`Job.ChAccess`	The job's Access Hours were changed.
`Job.ChAttrib`	The job's attributes were changed.
`Job.ChFixed`	The job's Fixed Status was changed.
`Job.ChStatus`	The job's Dispatch Status was changed.
`Job.Dealloc`	The job was Deallocated.
`Job.Move`	The job was moved.
`Job.Resize`	The job was resized.
`Job.RestoreAHP`	The job's Access Hours Pattern was restored.
`SP598_SYSTEM_ACTIONS` Table Action	Description
`act.move`	The job was moved.
`BookAppt`	The job was booked from an external system.
`BookApptExecute`	The job was booked from an external system.
`BookDependencyGroupFromSlots`	The job was booked as a group of dependent jobs.
`BookJobFromSlot`	The job was booked as an SLA job from an external system.
`BookJobFromSlotExecute`	The job was booked as an SLA job from an external system.
`CancelAppt`	The job was cancelled from an external system.
`CancelDependencyGroup`	The job's dependency group was cancelled.
`ChangeJobArrivalTime`	The job's Arrival Time was changed.
`ChangeJobDateTimes`	The job's Date Time was changed.
`ChangeJobFinishTime`	The job's Finish Time was changed.
`ChangeJobPriority`	The job's Priority was changed.
`ChangeJobStartTime`	The job's Start Date was changed.
`ChangeJobStatus`	The job's Status was changed from an external system.
`DBTidy`	The job was changed by the DBTidy process.
`DeleteJob`	The job was deleted.
`DeleteJobExecute`	The job was deleted.
`FindNextJob`	The system action recorded when the job was allocated via the ServiceGANTT "Find Job" function.
`GetSlotForBookJobWithReassign`	The job was moved to make space for an SLA job.
`job.alloc`	The job was allocated.
`job.book`	The job was booked to the "intray".
`job.chaccess`	The job's Access Hours were changed.
`job.chappt`	The job's Appointment Hours were changed.
`job.chattrib`	The job's attributes were changed.
`job.chstatus`	The job's Dispatch Status was changed.
`job.dealloc`	The job was Deallocated.
`job.gnjexecute`	The system action recorded when the job was moved via the ServiceGANTT "Move Job" function.
`job.restoreahp`	The job's Access Hours Pattern was restored.
`JobForceFix`	The job was moved and fixed.
`main`	The job was changed during FRU initialization tidy up.
`OfferApptsWithReassign`	The job was moved to make space for an appointment.
`ru.overlaps`	The job was moved to fix a schedule overlap issue.
`SetJobCleared`	The job was marked as cleared by an external system.
`UpdateJob`	The job details were changed by an external system.

</filterActionList>

</sp:JobHistoryRequest>

Browser not supported