Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Has details on the various job API calls as well as samples of returned data. See the attachments for a PDF of the documentation. The PDF is paginated properly.

Purpose and Intended Audience/Use

 

This is intended for Shoplogix and customer Information Technology staff to review and understand the capabilities of using Shoplogix's Job API query to pull job data from Shoplogix.   This data includes counts,  uptime, performance,  downtime and other data.   Data can be rolled up on a job name basis or each individual run can be its own record.  

...

The document will provide details of the syntax of the query and show detail examples of the data returned.     Please note that the focus of this document is specific to job API calls.     There are additional API calls to pull specific metrics based on shift and job.    However,  that data is usually a subset of the data shown.    The job API was create to provide a simpler way to retrieve data for a job with one query.     There is additional documentation for those API calls. 

Future Enhancements

Enhancements for the job API are subject to review by the Shoplogix Product Team prior to escalation and the dedication of development time.   Please communicate such to your Shoplogix Professional Services or Customer Success Staff.    

...