Processing on Demand REST API

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the Swagger UI provided for this API.

name path methods description
JobRestService
  • /jobService/jobs
  • /jobService/job/update
  • /jobService/job/{jobId}
  • /jobService/jobs/count
  • /jobService/job/kill/{jobId}
  • /jobService/job/resume/{jobId}
  • /jobService/job/submit/{process}
  • /jobService/job/suspend/{jobId}
  • /jobService/job/{jobId}/parameters
  • /jobService/job/{jobId}/runs
  • /jobService/jobrun/kill/{jobRunId}
  • /jobService/jobrun/resume/{jobRunId}
  • /jobService/jobrun/suspend/{jobRunId}
  • /jobService/jobrun/{jobRunId}/actions
  • /jobService/jobrun/{jobRunId}/parameters
  • /jobService/jobrun/{jobRunId}/results
  • GET
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
This service allows to submit and query processing jobs.
ProcessRestService
  • /processService/processes
  • /processService/parameterdefaults/{processIdentifier}
  • /processService/parameters/{processIdentifier}
  • /processService/process/{processIdentifier}
  • /processService/parameterdefaults/reset/{processIdentifier}
  • /processService/parameterdefaults/update/{processIdentifier}
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
This service provides information about available processes.

Data Types

JSON

type description
JobRunResult
PDFJobRunResult
Status
Status
Status
Type
WMSJobRunResult
job
jobparameter
jobrun
jobrunaction
jobrunparameter
process
processparameter