/
_API JobHistoryRequest Response
Document toolboxDocument toolbox

_API JobHistoryRequest Response

Owned by Matthew Wren (Unlicensed)
Nov 24, 2022
 Click here to expand...

Web Service

Type                   

Description

Req?

Val?

<sp:JobHistoryResponse>

 

 

 

 

 

<result>

 A structure containing details of the success or failure of the API call.  
  <type>?</type>ReturnCodeTypeThe type of return code, indicating if the result is success, success with a warning, or failure.  
  <code>?</code>intThe Return Code number, representing the result of the API call.  
  <errNote>?</errNote>stringOptional note about any error(s).(error) 
 </result>    
 <auditStatus> 

A optional structure describing the level of job history auditing that is currently enabled in ServiceScheduling.

  • This structure is only returned when the API call does not return an error Return Code.
  
  <ganttAuditing>?</ganttAuditing>AuditStatusIndicates if job history auditing of changes made via ServiceGANTT is enabled or not enabled.  
  <systemAuditing>?</systemAuditing>AuditStatus Indicates if job history auditing of changes made via the API and/or ServiceOptimizer system is enabled, not enabled, or partially enabled.  
  <auditSetup> 

An optional structure, which may be returned multiple times, providing further details on the level of API and/or ServiceOptimizer system job history auditing, when this is only partially enabled.

  • This structure is only returned when the systemAuditing value above is PARTIAL.
  
   <auditName>?</auditName>string

The name of the relevant SP083_SYSTEM_PARAMETERS table entry that the auditUsage structure is providing details on. One of:

  • gantt_audit_trail
  • sp100_audit
  • sp108_audit
  • sp111_audit
  
   <auditStatusValue>?</auditStatusValue>AuditStatus Indicates if job history auditing via the relevant parameter defined by the auditName value in the auditUsage structure is enabled or not enabled.  
  </auditSetup>    
 </auditStatus>    
 <transaction> 

An optional structure, which may be returned multiple times, containing the details of the relevant job history records, given the API call input values.

  • This structure is only returned when the API call does not return an error Return Code.
  • This structure is only returned if there any relevant job history records to be returned.
  
  <timestamp>?</timestamp>timestamp

The date and time of the job history record. Times are in the time zone of the database server (SYSDATE) with no conversion applied.

  
  <sequence>?</sequence> A sequence number, where multiple records are recorded for the same transaction.  
  <transaction>?</transaction> The job history transaction number.  
  <action>?</action>string(1-20)

Either:

  • A string matching an entry from the SP501_GANTT_ACTIONS table, representing a type of change made by a user (i.e. see details in the description of the filterAction input field); or

  • A string matching an entry from the SP598_SYSTEMS_ACTIONS table, representing a change made by the ServiceOptimizer system.

  
  <user>?</user>string(1-50)The username of the user who performed the change to the job, if relevant.  
  <field> 

An optional structure, which may be returned multiple times, containing the details of fields changed as part of the overall change to the job being described in the transaction structure.

  • This structure is only returned if one or more field values were changed as part of the transaction.
  
   <name>?</name> The name of the job field that was changed as part of the transaction.  
   <old_value>?</old_value> The value of the field prior to the change.  
   <new_value>?</new_value> The new value of the field as set by the change performed.  
  </field>    
 </transaction>    
</sp:JobHistoryResponse>