How to implement a client for REST web services

Scope

Jobs can be implemented to access RESTful web services.
A REST web service client is available for Scripting of Jobs and Monitors that are implemented with Java or JavaScript.
This feature is provided with JITL-213 - Getting issue details... STATUS

Implementation

JITL provides a static Java class that can be used with Java and JavaScript. This class accepts a URL and returns an object in JSON syntax.
For use with JavaScript the JSON object can be converted to a JavaScript object.

Methods

Method	Arguments	Description
com.sos.jitl.restclient.JobSchedulerRestClient.executeRestService		execute a GET operation and return the result object
	url	a URL that includes host and port of the web service, e.g. http://localhost:44445/jobscheduler/agent/api/
com.sos.jitl.restclient.JobSchedulerRestClient.executeRestServiceCommand		execute a configurable operation and return the result object
	operation	one of the HTTP verbs: `GET, POST, PUT, DELETE`
	url	a URL that includes host and port of the web service, e.g. http://localhost:44445/jobscheduler/agent/api/
com.sos.jitl.restclient.JobSchedulerRestClient.getRestService		retrieve the web service object using GET
	host	hostname or ip address of the web service, e.g. `localhost`
	port	port for which the web service is accessible, e.g. 4445
	path	path and query string of the web service URL, e.g. `/jobscheduler/agent/api/`
	protocol	protocol in use including `http, https`
com.sos.jitl.restclient.JobSchedulerRestClient.postRestService		retrieve the web service object using POST
	host	hostname or ip address of the web service, e.g. `localhost`
	port	port for which the web service is accessible, e.g. 4445
	path	path and query string of the web service URL, e.g. `/jobscheduler/agent/api/`

Integration with JavaScript

Basically a web service call is implemented by executing one of the above methods from the JITL Java class:

var response = com.sos.jitl.restclient.JobSchedulerRestClient.executeRestService( "http://localhost:44445/jobscheduler/agent/api/" );

same as

var response = com.sos.jitl.restclient.JobSchedulerRestClient.executeRestServiceCommand("get", "http://localhost:44445/jobscheduler/agent/api/" );

The result object returned by the web service can be converted to a JavaScript JSON object by use of the eval() function:
```
eval ( "var jsonObject = " + response + ";" );
```
Properties of the JSON object can be accessed with the object hierarchy as provided by the web service like this:
```
jsonObject.system.hostname
```

Example

JavaScript example for use with a job: this job requests the status information from the JobScheduler Universal Agent and returns the total number of tasks that have been executed during the Agents' lifetime. This job reads the web service URL from a job parameter.
Download: rest_client.job.xml

Job rest_client

<job  stop_on_error="no" >
    <params >
        <param  name="agent_service" value="localhost:4445/jobscheduler/agent/api/"/>
    </params>

    <script  language="java:javascript">
        <![CDATA[
function spooler_process() {

    var parameters = spooler.create_variable_set();
    parameters.merge( spooler_task.params );

    var agent_service = parameters.value( "agent_service" );
    var response = com.sos.jitl.restclient.JobSchedulerRestClient.executeRestService( agent_service );

//  alternative REST methods
//  var response = com.sos.jitl.restclient.JobSchedulerRestClient.executeRestService( "http://localhost:44445/jobscheduler/agent/api/" );
//  var response = com.sos.jitl.restclient.JobSchedulerRestClient.executeRestServiceCommand("get", "http://localhost:4445/jobscheduler/agent/api/" );
//  var response = com.sos.jitl.restclient.JobSchedulerRestClient.getRestService( "localhost", 4445, "/jobscheduler/agent/api/", "http" );

    if (response) {
        eval ( "var jsonObject = " + response + ";" ); 
        spooler_log.info( jsonObject.totalTaskCount + " tasks on Agent [" + agent_service + "]: " + jsonObject.system.hostname );
    } else {
        spooler_log.error( "no response from Agent web service at: " + agent_service );
    }

    return (response != "");
}
        ]]>
    </script>

    <run_time />
</job>

References

Change Management References

T	Key	Linked Issues	Fix Version/s	Status	P	Summary	Updated

Loading...

Refresh

Documentation

R EST (Representational State Transfer)

Space shortcuts

Page tree

Scope

Implementation

Methods

Integration with JavaScript

Example

References

Change Management References

Documentation