JobScheduler REST Web Service Interface

Scope

The JobScheduler comes with two powerful Web Service interfaces:

• The JobScheduler REST Web Service is a replacement for the retired XML Interface
  • This interface is used by external applications for tasks such as adding orders and retrieving job and order status information.
  • This API is considered stable along minor releases for use by external applications.
• The JOC Cockpit REST Web Service is used by the JOC Cockpit for interaction with a JobScheduler Master:
  • The web service offers access to the job inventory and the job history as well as individual objects such as jobs, job chains and orders.
  • This API might change over minor releases with the requirements of future JOC Cockpit development.

• Authentication and Authorization
  
  • Access to the JobScheduler REST Web Service is restricted by permissions, see Authentication and Authorization - Permissions for the JobScheduler REST Web Service
  • Access to the JOC Cockpit REST Web Service is restricted by permissions, see Authentication and Authorization - Permissions for the JOC Cockpit Web Service

Architecture

Usage

• The REST Web Service is called by using an HTTP client.
• The following REST Web Service requests are supported:
  • URL joc/api/security/login
    • The first operation of a client should be call to this URL in order to authenticate and to retrieve an access token.
    • A valid account and password have to be provided by the client for HTTP authentication. The account and permissions for the command(s) to be executed are configured with the shiro.ini configuration file. See the Authentication and Authorization - Configuration article and the example api_user configuration for further information.
    • Use the joc/api/security/joc_cockpit_permissions URL to retrieve the permissions for the current user.
  • URL joc/api/jobscheduler/command 
    • This URL is used by the JobScheduler REST Web Service
    • Subsequent XML Commands can be sent by use of this URL. 
    • The XML command is added to the body of the web service request.
    • The JobScheduler REST Web Service will return the respective XML Response.
  • URL  joc/api/* 
    • This URL is used by the JOC Cockpit REST Web Service
    • Subsequent calls to URLs can retrieve the job inventory and current information about jobs and job chains.
    • The JOC Cockpit REST Web Service will return the respective JSON response.
  • URL joc/api/security/logout
    • The last operation of a client should be a call to this URL in order to logout from the web service.
• Requirements
  • All REST Web Service requests should use an HTTP POST operation.
  • Should an idle timeout of 15 minutes between two web service requests be exceeded then the current session is invalidated and a login has to be performed.

Specification

• JobScheduler REST Web Service
  • The specification is available from https://www.sos-berlin.com/JOC/latestJS1/raml-doc/JOC-API/index.html and includes the RAML specification.

  • Find the list of XML Commands from the Reference Documentation.

• JOC Cockpit REST Web Service
  • The specification is available from https://www.sos-berlin.com/JOC/latestJS1/raml-doc/JOC-API/index.html and includes the RAML specification.

References

Change Management References

Documentation

• JobScheduler REST Web Services
  
  • Authentication and Authorization: Permissions for the JobScheduler REST Web Service
  • Specification: JobScheduler REST Web Services Technical Documentation (RAML Specification)
  • Reference Documentation: XML commands
• JOC Cockpit REST Web Services
  
  • Authentication and Authorization: Permissions for the JOC Cockpit Web Service
  • Specification https://www.sos-berlin.com/JOC/latestJS1/raml-doc/JOC-API/index.html