JobScheduler REST Web Services

Scope

• The JobScheduler REST Web Services replace the retired XML Interface.
• The REST Web Services are used by the JOC Cockpit and by external applications for interaction with a JobScheduler Master:
  • The REST Web Services offer access to objects such as jobs, job chains and orders and their respective operations, e.g. to add an order to a job chain.
  • Access to REST Web Services is restricted by permissions, see Authentication and Authorization - Permissions for the JobScheduler REST Web Services

Architecture

Usage

• The REST Web Services are 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 
    • 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 Services will return the respective XML 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

The documentation is available from http://test.sos-berlin.com/JobScheduler/raml-doc/JobScheduler-REST-web-services/ and includes the RAML specification.

XML Commands

Find the list of XML Commands from the Reference Documentation.

The following table states the available XML commands for JobScheduler REST Web Services.

Examples

Example for authentication request

As the REST Web Services require authentication therefore the first request should look like this:

POST /joc/api/jobscheduler/command HTTP/1.1
Host: localhost:4446
access_token: ce31fb8f-9f5a-4e3e-805d-72c71d0547ce
Content-Type: application/xml
Cache-Control: no-cache
Postman-Token: 88bd687a-586d-fd93-d203-bcd7e71a6a85
<jobscheduler_command jobschedulerId='scheduler111'><show_state/></jobscheduler_command>

Explanations

• The JobScheduler REST Web Services (and the JOC Cockpit) are operated on the localhost with port 4446.
• The URL in use is http://localhost:4446/joc/api/jobscheduler/command
• The access_token has been retrieved from a previous authentication request

Example for retrieval of status information

x

POST /joc/api/jobscheduler/command HTTP/1.1
Host: localhost:4446
access_token: ce31fb8f-9f5a-4e3e-805d-72c71d0547ce
Content-Type: application/xml
Cache-Control: no-cache
Postman-Token: 88bd687a-586d-fd93-d203-bcd7e71a6a85
<jobscheduler_command jobschedulerId='scheduler111'><show_state/></jobscheduler_command>

Explanations

• The JobScheduler REST Web Services (and the JOC Cockpit) are operated on the localhost with port 4446.
• The URL in use is http://localhost:4446/joc/api/jobscheduler/command
• The access_token has been retrieved from a previous authentication request

Example for adding an order

x

POST /joc/api/jobscheduler/command HTTP/1.1
Host: localhost:4446
access_token: ce31fb8f-9f5a-4e3e-805d-72c71d0547ce
Content-Type: application/xml
Cache-Control: no-cache
Postman-Token: 88bd687a-586d-fd93-d203-bcd7e71a6a85
<jobscheduler_command jobschedulerId='scheduler111'><show_state/></jobscheduler_command>

Explanations

• The JobScheduler REST Web Services (and the JOC Cockpit) are operated on the localhost with port 4446.
• The URL in use is http://localhost:4446/joc/api/jobscheduler/command
• The access_token has been retrieved from a previous authentication request

References

Change Management References

Documentation

• Authentication and Authorization
  • Authentication and Authorization - Permissions for the JobScheduler REST Web Services
• JobScheduler Reference Documentation:
  • XML commands
• JobScheduler REST Web Services
  • REST Web Services Technical Documentation (RAML Specification)