Scheduled Job Collection

From n² wiki

Jump to: navigation, search

Nearby: Platform API, Job, Job Request

URI Pattern
http://api.talis.com/stores/{store}/jobs
Allowed Methods
GET


This URI identifies a store's collection of scheduled jobs. Jobs are tasks or actions that can be scheduled to execute after specific times. Generally they are long-running processes that have indeterminent durations

[edit] GET

GETs to the scheduled job collection require the full update capability.

The response is an RDF document containing a list of Jobs that have been scheduled with the store.

<rdf:RDF
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:bf="http://schemas.talis.com/2006/bigfoot/configuration#" > 
  <bf:ScheduledJobCollection rdf:about="http://api.talis.com/stores/mystore/jobs">
    <bf:job rdf:resource="http://api.talis.com/stores/mystore/jobs/d03885bb-1603-4a14-b18c-b382fe31ebe7"/>
    <bf:job rdf:resource="http://api.talis.com/stores/mystore/jobs/70bee6fc-4b67-47a9-8075-2d19edf168a2"/>
  </bf:ScheduledJobCollection>
</rdf:RDF>

Note: when a job is executed it is currently removed from the job collection. This behaviour will be changed in the future so that job's that have been executed remain in the collection so you can discover status information about their operation

[edit] POST

POSTing to the scheduled job collection requires the full update capability.

The behaviour of a POST request depends on its content-type header:

application/rdf+xml
The body of the post is treated as the RDF description of a Job Request to be added to the collection
Personal tools