/
_API GetJobStatisticsRequest Response
Document toolboxDocument toolbox

_API GetJobStatisticsRequest Response

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

Web Service

Type                   

Description

Req?

Val?

<sp:GetJobStatsResponse>

 

 

 

 

 

<result>

 A structure containing details of the success or failure of the API call.  
  <type>?</type>stringThe Return Code name, representing the result of the API call.  
  <code>?</code>intThe Return Code number, representing the result of the API call.  
 </result>    
 <JobStatsResponse> 

One or more JobStatsResponse structures will be present, with each describing the statistics for the relevant FRU in ServiceScheduling.

  • This structure is only returned when the API call does not return an error Return Code.
  
  <FRU>?</FRU>FRUIDThe ID of the FRU to which the parent JobStatsResponse structure relates to.  
  <JobStatPerDate> One or more JobStatPerDate structures will be present, with each describing the statistics for the relevant date.  
   <Date>?</Date>spDateThe date for which the parent JobStatPerDate structure relates to.  
   <JobStats> 
A structure to contain the job statistics for the date. If there are no job statistics for the date, then the JobStats structure will not be present.
  
    <Total_Jobs>?</Total_Jobs>intTotal number of all jobs for the date.  
    <Completed_Jobs>?</Completed_Jobs>intThe number of "completed" (i.e. Logged Off/Cleared) jobs.  
    <Ontrack_Jobs>?</Ontrack_Jobs>intThe number of "on track" (i.e. not in Jeopardy) jobs.  
    <Jeopardy_Jobs>?</Jeopardy_Jobs>intThe number of in Jeopardy jobs.  
    <Unresourced_Jobs>?</Unresourced_Jobs>intThe number of unresourced jobs.  
    <HCBroken_Jobs>?</HCBroken_Jobs>intThe number of jobs with broken hard constrains.  
    <ManuallySch_Jobs>?</ManuallySch_Jobs>intThe number of manually scheduled jobs.  
    <TechnicianOn_Jobs>?</TechnicianOn_Jobs>intThe number of technicians on all the jobs for the date.  
    <overlapDay_Jobs>?</overlapDay_Jobs>intThe number of jobs that overlap the day boundary.  
    <overlapDay_UnresJobs>?</overlapDay_UnresJobs>intThe number of unresourced jobs that overlap the day boundary.  
     <JobType> One or more JobType structures will be present, each containing a summary of job statistics by job type for the date.  
      <jobTypeId>?</jobTypeId>JobTypeIDThe JobTypeID for which the parent JobType summary relates to.  
      

<Description>?</Description>

varchar2(30)

A text description of the job type.  
      <NumOfJobs>?</NumOfJobs>int

Total number of jobs for the date that are jobs with the associated JobTypeID.

  
     </JobType>    
   </JobStats>    
  </JobStatPerDate>    
 </JobStatsResponse>    
</sp:GetJobStatsResponse>