Simple HTTP API is deprecated. Use REST API instead.

Help

Returns text based help for all HTTP API operations.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/help

Help

Sandbox List

Returns list of all sandbox text ID's.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/sandbox_list

Get Sandbox List

Sandbox Content

Returns list of all elements in specified sandbox. Each element is specified as file path relative to sandbox root.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/sandbox_content?sandbox=default&verbose=MESSAGE

Graph Run

Executes specified job and returns runID, which is usable as parameter for another operations.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/graph_run?sandbox=default&graphID=graph%2Ftest.grf&nodeID=node1&verbose=MESSAGE

Server Jobs

Returns list of runID which are currently running. New line character is used as separator.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/server_jobs

Get Server Jobs

Graph Status

Returns status of specified job. It may be number code, text code or complex description in dependence of optional parameter returnType. In dependence on waitForStatus parameter may return result immediately or wait for specified status, but if job is in some of the final status (FINISHED_OK | ERROR | ABORTED), returns current status at once.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/graph_status?runID=10&returnType=STATUS_TEXT&waitForStatus=READY&waitTimeout=1000&verbose=MESSAGE

Graph Kill

Returns status of specified job after attempt to kill it. It may be number code, text code or complex description in dependence of optional parameter.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/graph_kill?runID=10&returnType=STATUS_TEXT&verbose=MESSAGE

Kill jobs by name

Kills running jobs specified by name of job file. Returns number of successfully killed jobs.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/graph_kill?&sandboxCode=default&jobFile=graph%2Ftest.grf&verbose=MESSAGE

Kill jobs by execution group

Kills running jobs specified by execution group. Returns num of successfully killed jobs.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/graph_kill?&executionGroup=group1&verbose=MESSAGE

Executions History

Returns list of executions stored in DB. Optional filtering criteria are applied.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/executions_history?from=2012-02-05 11:30&to=2013-01-30 15:30&stopFrom=2012-02-05 11:40&stopTo=2013-01-30 16:30&status=FINISHED_OK&sandbox=default&graphID=graph%2Ftest.grf&orderBy=id&orderDescend=true&index=1&records=10&returnType=IDs&verbose=MESSAGE

Suspend Sandbox/Server

Suspends server or sandbox (if specified). Server won't execute jobs on whole server or in particular sandbox.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/suspend?sandbox=default&atonce=true&verbose=MESSAGE

Resume Sandbox/Server

Resume suspended server or sandbox (if specified).

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/resume?sandbox=default&verbose=MESSAGE

Create Sandbox

Creates specified sandbox. If it is a sandbox of "partitioned" or "local" type, create also locations by "sandbox_add_location" operation.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/sandbox_create?sandbox=default&path=newBox&type=shared&createDirs=true&verbose=MESSAGE

Cluster Status

Display cluster node list.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/cluster_status

Server Configuration Export

Export server configuration as an XML document.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/export_server_config?include=all

Server Configuration Import

Import server configuration from an XML document.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/import_server_config

Download Sandbox ZIP

Downloads sandbox content as a ZIP archive.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/download_sandbox_zip?sandbox=default

Upload Sandbox ZIP

Uploads sandbox content from a ZIP archive.

https://prod-clover.maxwellhealth.com:443/clover/simpleHttpApi/upload_sandbox_zip