Scheduled Job Collection

From n² wiki

Jump to: navigation, search

This is the Platform API documentation for the Scheduled Jobs Collection

A Store may have a number of processing jobs associated with it. This URI provides access to the current list 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. Examples of a Job include taking a Snapshot, clearing out a store, etc.

Contents

[edit] URI Pattern

http://api.talis.com/stores/{storename}/jobs

[edit] Resource Operations

URI Pattern Method Request Body Semantics Capability required
/jobs GET View the scheduled jobs full update
POST application/rdf+xml Add a job full update

[edit] Request Parameters

None

[edit] Managing Scheduled Jobs

[edit] View Scheduled Jobs

Performing a GET request on the scheduled job collection will retrieve the list of currently scheduled jobs. This operation requires 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:config="http://schemas.talis.com/2006/bigfoot/configuration#" > 
  <config:ScheduledJobCollection rdf:about="http://api.talis.com/stores/mystore/jobs">
    <config:job rdf:resource="http://api.talis.com/stores/mystore/jobs/d03885bb-1603-4a14-b18c-b382fe31ebe7"/>
    <config:job rdf:resource="http://api.talis.com/stores/mystore/jobs/70bee6fc-4b67-47a9-8075-2d19edf168a2"/>
  </config:ScheduledJobCollection>
</rdf:RDF>

Note: currently, when a job begins execution it is immediately removed from the job collection. This behaviour will be changed in the future so that jobs that have been executed will remain in the collection so that clients can discover status information about their operation, e.g. whether they are active, have been completed, etc.

[edit] Adding A Job

Adding a job to the collection, via a POST request, requires the full update capability.

The body of the POST should be an RDF/XML document that describes the the Job to be added to the collection. See the list of job types for further information.

[edit] Viewing A Job

To view the metadata associated with a specific Job, client's should perform a GET request on the job URI. See Job for a full list of supported operations.

[edit] Deleting a Job

See Job.

Retrieved from "http://n2.talis.com/wiki/Scheduled_Job_Collection"
Personal tools