Changes between Version 9 and Version 10 of RemoteJobs

Timestamp:

Jul 23, 2011, 11:18:25 PM (13 years ago)

Author:

davea

Comment:

--

RemoteJobs

@@ -2 +2 @@
 = Remote job submission =
 
-This document describes interfaces for remotely submitting batches of jobs
+This document describes APIs for remotely submitting jobs
 to a BOINC server.
+These APIs can be used, for example, to create web interfaces for job submission,
+such as might be found in a science portal web site:
+
+[[Image(submit.png)]]
+
+BOINC provides a PHP library that implements the API.
+The underlying web services are implemented as HTTP/XML RPCs,
+and it is easy to create bindings in other languages.
+
+The APIs are designed for the submission of large '''batches''' of jobs,
+such as parameter sweeps.
 
 Users can submit jobs only if they have been given access
 (via a web interface) by project administrators.
-
-In addition, project admins can restrict the apps for which
+In addition, admins can restrict the apps for which
 each user is allowed to submit jobs.
+The BOINC admin web pages provide an interface for this access control.
 
 == PHP interface ==
@@ -56 +67 @@
 
 === boinc_query_batches() ===
+
+Argument: a request objects with '''project''' and '''authenticator''' fields as above.
+
+Result: a 2-element array.  The first element is an array of objects describing batches,
+with the following fields:
+ * '''id''': batch ID
+ * '''fraction_done''': a number 0..1 giving the fraction of the batch that has been completed
+ * '''create_time''': when the batch was submitted
+ * '''est_completion_time''': an updated estimate of completion time
+ * '''njobs''': the number of jobs in the batch
+
 === boinc_query_batch() ===
+
+Argument: a request objects with '''project''' and '''authenticator''' fields as above,
+and a '''batch_id''' element specifying a batch.
+
+Result: a 2-element array.  The first element is an array of objects describing jobs
+within the batch, with the following fields:
+
+ * '''id''': the job ID
+ * '''canonical_result_id''': if the job has been completed and validated, the ID of a valid instance
+ * '''n_outfiles''': the number of output files
+
 === boinc_abort_batch() ===
+
+Argument: a request objects with '''project''' and '''authenticator''' fields as above,
+and a '''batch_id''' element specifying a batch.
+
+Result: an error message, null if successful
+
+=== boinc_get_output_file() ===
+
+Argument: a request objects with '''project''' and '''authenticator''' fields as above,
+a '''job_id''' element specifying a job, and a '''file_num''' field giving the
+ordinal number of one of the output files.
+
+Result: A URL from which the output file can be downloaded.
+
+=== boinc_get_output_files() ===
+
+Argument: a request objects with '''project''' and '''authenticator''' fields as above,
+and a '''batch_id''' element specifying a batch.
+
+Result: A URL from which a zipped archive of all output files from the batch can be downloaded.
 
 == HTTPS/XML interface ==