REST API for CRISTAL

This is a JAX-RS wrapper for the CRISTAL Client API as specified on the Google Doc

The included Main may be invoked as a CRISTAL Client with -conf and -connect parameters, and will launch a Jersey http server on the URI specified in the CRISTAL property REST.URI, which defaults to http://localhost:8081/. Note that this property is not used outside of this example Main class.

Usage of this API requires a login cookie generated by /login. You can disable this by setting the boolean CRISTAL property REST.requireLoginCookie to false.

Settings

The REST API used several CRISTAL properties (as provided in the clc or conf files, or directly to Gateway.init as a java.util.Properties object):

REST.requireLoginCookie (boolean) - require a login cookie set at /login to access all methods. If this is false, then a login cookie may still be used, but it is not required to call any methods. If absent, job query and execution will require an 'agentName' query parameter identifying the calling agent.
REST.loginCookieLife (integer) - the number of seconds that the login cookie is valid. The cookie is set to expire at this time, but the cookie also contains a timestamp which will invalidate it after this time.
REST.allowWeakKey (boolean) - If true, then the session key generation will fall back to a 128-bit AES key if 256-bit is not available, as with default Java installations.
REST.DefaultBatchSize (integer) - If no batch size parameter is given for Job, Event and Path queries, then this value will be used. Batch sizes for each object type may be individually set using REST.Job.DefaultBatchSize, REST.Event.DefaultBatchSize and REST.Path.DefaultBatchSize. If these parameters are not set, then the internal default for Paths is 75, while Job and Event are 20 each.

Trying it out with curl

Some useful example curl commands:

Get a login cookie and store it in the local file cookies.txt

`curl -c cookies.txt http://{host:port}/login?user={user}\&pass={pass}`

Get a login cookie using POST method and store it in the local file cookies.txt (username and password must be Base64 encoded)

`curl -c cookies.txt -H 'Content-Type: application/json' -d '{"username":"{Base64 encoded username}","password":"{Base64 encoded password}"}' http://{host:port}/api/login`

Root listing of the item directory

`curl -b cookies.txt http://{host:port}/domain`

Listing of the item directory with offset and batch

`curl -b cookies.txt http://{host:port}/domain/<path>?start=<offset>&batch=<limit>`

Search domain tree for a given name and type

`curl -b cookies.txt http://{host:port}/domain/<path>?search=Name:<name>,Type:<type>`

List jobs available in the given item for the logged in user

`curl -b cookies.txt -X GET -D - http://pcuwe04:8081/item/{uuid}/job`

Create a new Schema by executing the 'CreateNewSchema' activity of the CristalDev SchemaFactory item.

`curl -b cookies.txt -H "Content-Type: text/xml" -X POST -d '<NewDevObjectDef><ObjectName>SchemaFromRest</ObjectName><SubFolder/></NewDevObjectDef>' -D - http://pcuwe04:8081/item/{uuid of SchemaFactory}/workflow/domain/CreateNewSchema?done`

Use `Accept:text/xml` header to retrieve XML outcome

`curl -H Accept:text/xml http://{host:port}/item/{uuid}/data/{schema}/last`

Use `Accept:application/json` header to retrieve JSON outcome

`curl -H Accept:application/json http://{host:port}/item/{uuid}/data/{schema}/last` 
* JSON or XML Accept header is also available for /item/{uuid}/history/{eventId}/data resources as well