/
_API JobHistoryRequest Definition
Document toolboxDocument toolbox

_API JobHistoryRequest Definition

Owned by Matthew Wren (Unlicensed)
Nov 24, 2022
 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.

(tick)

(tick)

 <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.

  
  <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 ActionDescription

Call.Confirm

The job's confirmed state was changed.
FJ.AllocThe job was allocated via the ServiceGANTT "Find Job" function.
FJ.MoveThe job was moved via the ServiceGANTT "Move Job" function.
Job.AllocThe job was allocated.
Job.BookThe job was booked to the "intray".
Job.ChAccessThe job's Access Hours were changed.
Job.ChAttribThe job's attributes were changed.
Job.ChFixedThe job's Fixed Status was changed.
Job.ChStatusThe job's Dispatch Status was changed.
Job.DeallocThe job was Deallocated.
Job.MoveThe job was moved.
Job.ResizeThe job was resized.
Job.RestoreAHPThe job's Access Hours Pattern was restored.
SP598_SYSTEM_ACTIONS Table ActionDescription
act.moveThe job was moved.
BookApptThe job was booked from an external system.
BookApptExecuteThe job was booked from an external system.
BookDependencyGroupFromSlotsThe job was booked as a group of dependent jobs.
BookJobFromSlotThe job was booked as an SLA job from an external system.
BookJobFromSlotExecuteThe job was booked as an SLA job from an external system.
CancelApptThe job was cancelled from an external system.
CancelDependencyGroupThe job's dependency group was cancelled.
ChangeJobArrivalTimeThe job's Arrival Time was changed.
ChangeJobDateTimesThe job's Date Time was changed.
ChangeJobFinishTimeThe job's Finish Time was changed.
ChangeJobPriorityThe job's Priority was changed.
ChangeJobStartTimeThe job's Start Date was changed.
ChangeJobStatusThe job's Status was changed from an external system.
DBTidyThe job was changed by the DBTidy process.
DeleteJobThe job was deleted.
DeleteJobExecuteThe job was deleted.
FindNextJobThe system action recorded when the job was allocated via the ServiceGANTT "Find Job" function.
GetSlotForBookJobWithReassignThe job was moved to make space for an SLA job.
job.allocThe job was allocated.
job.bookThe job was booked to the "intray".
job.chaccessThe job's Access Hours were changed.
job.chapptThe job's Appointment Hours were changed.
job.chattribThe job's attributes were changed.
job.chstatusThe job's Dispatch Status was changed.
job.deallocThe job was Deallocated.
job.gnjexecuteThe system action recorded when the job was moved via the ServiceGANTT "Move Job" function.
job.restoreahpThe job's Access Hours Pattern was restored.
JobForceFixThe job was moved and fixed.
mainThe job was changed during FRU initialization tidy up.
OfferApptsWithReassignThe job was moved to make space for an appointment.
ru.overlapsThe job was moved to fix a schedule overlap issue.
SetJobClearedThe job was marked as cleared by an external system.
UpdateJobThe job details were changed by an external system.
  
 </filterActionList>    
</sp:JobHistoryRequest>