/[volute]/trunk/projects/grid/uws/doc/UWS.html
ViewVC logotype

Contents of /trunk/projects/grid/uws/doc/UWS.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2774 - (show annotations)
Wed Nov 5 11:03:03 2014 UTC (5 years, 9 months ago) by harripa@gmail.com
File MIME type: application/xhtml+xml
File size: 145940 byte(s)
make it clearer that parameters can only be changed in the PENDING state
1 <?xml version="1.0" encoding="UTF-8"?><!-- $Id$
2 Universal Worker Service WD
3 Note that this file should be xhtml with div to mark sections so that it can be updated with xslt.
4 Paul Harrison -->
5 <!DOCTYPE html
6 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xml:lang="en" lang="en" xsi:schemalocation="http://www.w3.org/1999/xhtml http://www.w3.org/2002/08/xhtml/xhtml1-transitional.xsd" xml:space="preserve">
8 <head profile="http://www.w3.org/1999/xhtml/vocab"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
9
10 <title>Universal Worker Service Pattern 1.1 - IVOA Working Draft 3 November 2014</title>
11 <meta name="Title" content="IVOA WG Internal Draft" />
12 <meta name="author" content="Paul Harrison, paul.harrison@manchester.ac.uk" />
13 <meta name="maintainedBy" content="Paul Harrison, paul.harrison@manchester.ac.uk" />
14 <link href="http://www.ivoa.net/misc/ivoa_a.css" rel="stylesheet" type="text/css" />
15 <link href="http://volute.googlecode.com/svn/trunk/projects/ivoapub/ivoadoc/XMLPrint.css" rel="stylesheet" type="text/css" />
16 <link href="http://volute.googlecode.com/svn/trunk/projects/ivoapub/ivoadoc/ivoa-extras.css" rel="stylesheet" type="text/css" />
17 <link rel="stylesheet" type="text/css" href="http://www.ivoa.net/misc/ivoa_wd.css" />
18 </head>
19 <body><div class="head">
20 <div id="titlehead" style="position:relative;height:170px;width: 500px">
21 <div id="logo" style="position:absolute;width:300px;height:169px;left: 50px;top: 0px;">
22 <img src="http://www.ivoa.net/pub/images/IVOA_wb_300.jpg" alt="IVOA logo" /></div>
23 <div id="logo-title" style="position: absolute; width: 200px; height: 115px; left: 320px; top: 5px; font-size: 14pt; color: #005A9C; font-style: italic;">
24 <p style="position: absolute; left: 0px; top: 0px;"><span style="font-weight: bold;">I</span> nternational</p>
25 <p style="position: absolute; left: 15pt; top: 25pt;"><span style="font-weight: bold;">V</span> irtual</p>
26 <p style="position: absolute; left: 15pt; top: 50pt;"><span style="font-weight: bold;">O</span> bservatory</p>
27 <p style="position: absolute; left: 0px; top: 75pt;"><span style="font-weight: bold;">A</span> lliance</p>
28 </div>
29 </div>
30 <h1>Universal Worker Service Pattern<br clear="none" />
31 Version <span class="docversion">1.1</span></h1>
32 <h2 class="subtitle">IVOA Working Draft 3 November 2014</h2>
33 <dl><dt>Working Group:</dt><dd><a href="http://www.ivoa.net/twiki/bin/view/IVOA/IvoaGridAndWebServices" shape="rect">http://www.ivoa.net/twiki/bin/view/IVOA/IvoaGridAndWebServices</a></dd>
34 <dt><b>This version:</b></dt><dd><a href="http://www.ivoa.net/Documents/UWS/20140930/" shape="rect">http://www.ivoa.net/Documents/UWS/20140930/</a></dd>
35 <dt><b>Latest Recommendation:</b></dt><dd><a href="http://www.ivoa.net/Documents/UWS/" shape="rect">http://www.ivoa.net/Documents/UWS/</a></dd>
36 <dt><b>Previous version(s):</b></dt><dd> Proposed Recommendation v1.0, 2009-09-09<br clear="none" />
37 <a href="http://www.ivoa.net/documents/UWS/20101010/" shape="rect">Recommendation v1.0 2010-10-10</a><br clear="none" />
38 <a href="http://www.ivoa.net/documents/UWS/20140527/" shape="rect">Working Draft v1.1 2014-05-27</a><br clear="none" />
39 </dd>
40 <dt>
41 </dt>
42 <dt> <br clear="none" />
43 </dt><dd>&nbsp;</dd><dt><b>Author(s):</b></dt><dd> P.
44 Harrison, G. Rixon</dd></dl>
45
46 <h2>Abstract</h2>
47 <p>The Universal Worker Service (UWS) pattern
48 defines how to manage asynchronous execution of jobs on a
49 service. Any application of the pattern defines a family of related
50 services with a common service contract. Possible uses of the pattern are also described.</p>
51 <h2> Status of This Document</h2>
52 <p id="statusdecl"><em>
53 This is an IVOA Working Draft for review by IVOA members
54 and other interested parties. It is a draft document and
55 may be updated, replaced, or obsoleted by other documents
56 at any time. It is inappropriate to use IVOA Working Drafts
57 as reference materials or to cite them as other than "work
58 in progress".
59 </em></p>
60 <p> <em>A list of </em><span style="background: transparent"><a href="http://www.ivoa.net/Documents/" shape="rect"><i>current
61 IVOA Recommendations and other technical documents</i></a></span><em> can be found at http://www.ivoa.net/Documents/.</em></p>
62 <p>The words "MUST", "SHALL", "SHOULD", "MAY", "RECOMMENDED", and "OPTIONAL" (in upper or lower case) used in this document are to be interpreted as described in IETF standard, RFC 2119 <cite>[<a href="#std:rfc2119">std:rfc2119</a>]</cite>.</p>
63 <h2 class="prologue-heading-western">Acknowledgements</h2>
64 <p>The need for the UWS pattern was
65 inspired by AstroGrid’s Common Execution Architecture and
66 particularly by discussions with Noel Winstanley. The ideas about
67 statefulness are distilled from debates in the Global Grid Forum in
68 respect of the Open Grid Services Infrastructure that was the
69 fore-runner of Web Services Resource Framework. The REST binding came
70 initially from suggestions by Norman Gray. Enhancements introduced in version 1.1 were as a result of feedback from implementors, particularly Pat Dowler, Dave Morris, Mark Taylor and Petr Škoda.</p>
71 </div><h2>Contents</h2><div><!--The contents of this div are automatically generated from the following processing instruction when processed with ivoarestructure.xsl-->
72 <?toc?><div id="toc" class="toc"><ul><li><a href="#Introduction"><span class="secnum">1. </span>Introduction (informative)</a><ul><li><a href="#SynchronousStateless"><span class="secnum">1.1. </span>Synchronous, stateless services</a></li><li><a href="#AsynchronousServices"><span class="secnum">1.2. </span>Asynchronous and stateful services</a></li><li><a href="#JDL"><span class="secnum">1.3. </span>Job description language, service contracts and universality</a></li><li><a href="#IVOARCH"><span class="secnum">1.4. </span>UWS in the IVOA Architecture</a></li></ul></li><li><a href="#UWSpattern"><span class="secnum">2. </span>Universal Worker Service Pattern (normative)</a><ul><li><a href="#UWSObjects"><span class="secnum">2.1. </span>Objects within a UWS</a><ul><li><a href="#Joblist"><span class="secnum">2.1.1. </span>Job list</a></li><li><a href="#Job"><span class="secnum">2.1.2. </span>Job</a></li><li><a href="#ExecutionPhase"><span class="secnum">2.1.3. </span>Execution Phase</a></li><li><a href="#ExecutionDuration"><span class="secnum">2.1.4. </span>Execution Duration</a></li><li><a href="#DestructionTime"><span class="secnum">2.1.5. </span>Destruction Time</a></li><li><a href="#Quote"><span class="secnum">2.1.6. </span>Quote</a></li><li><a href="#Error"><span class="secnum">2.1.7. </span>Error</a></li><li><a href="#Error2"><span class="secnum">2.1.8. </span>Owner</a></li><li><a href="#Error3"><span class="secnum">2.1.9. </span>RunId</a></li><li><a href="#ResultsList"><span class="secnum">2.1.10. </span>Results List</a></li><li><a href="#ResultsList2"><span class="secnum">2.1.11. </span>Parameter List</a></li></ul></li><li><a href="#RESTbinding"><span class="secnum">2.2. </span>The REST Binding</a><ul><li><a href="#d1e834"><span class="secnum">2.2.1. </span>Resources and URIs</a><ul><li><a href="#blocking"><span class="secnum">2.2.1.1. </span>Blocking Behaviour</a></li></ul></li><li><a href="#d1e603"><span class="secnum">2.2.2. </span>Representations of resources</a><ul><li><a href="#jobList"><span class="secnum">2.2.2.1. </span>Job List</a></li><li><a href="#d1e1040"><span class="secnum">2.2.2.2. </span>Job</a></li><li><a href="#resultList"><span class="secnum">2.2.2.3. </span>Results List</a></li><li><a href="#d1e1353"><span class="secnum">2.2.2.4. </span>Parameters List</a></li><li><a href="#d1e1556"><span class="secnum">2.2.2.5. </span>Error</a></li></ul></li><li><a href="#jobcontrol"><span class="secnum">2.2.3. </span>State changing requests</a><ul><li><a href="#jobCreation"><span class="secnum">2.2.3.1. </span>Creating a Job</a><ul><li><a href="#d2e1612"><span class="secnum">2.2.3.1.1. </span>Inline Parameters</a></li></ul></li><li><a href="#d1e1390"><span class="secnum">2.2.3.2. </span>Deleting a Job</a></li><li><a href="#d1e1402"><span class="secnum">2.2.3.3. </span>Changing the Destruction Time</a></li><li><a href="#d1e1420"><span class="secnum">2.2.3.4. </span>Changing the Execution Duration</a></li><li><a href="#d1e1439"><span class="secnum">2.2.3.5. </span>Starting a Job</a></li><li><a href="#d1e1448"><span class="secnum">2.2.3.6. </span>Aborting a Job</a></li></ul></li></ul></li></ul></li><li><a href="#security"><span class="secnum">3. </span>Security Considerations (normative)</a></li><li><a href="#ApplicationsOfUWS"><span class="secnum">4. </span>Applications of UWS (informative)</a><ul><li><a href="#Imageservice"><span class="secnum">4.1. </span>Image service with data staging</a></li><li><a href="#ADQLservice"><span class="secnum">4.2. </span>ADQL service with cursor</a></li><li><a href="#ParameterizedApplications"><span class="secnum">4.3. </span>Parameterised applications</a></li></ul></li><li><a href="#SynchronousService"><span class="secnum">5. </span>Implementing a Synchronous Service on top of UWS (informative)</a></li><li><a href="#Updates"><span class="secnum">A. </span>Updates from previous versions</a><ul><li><a href="#d1e1112"><span class="secnum">A.1. </span>At Version 0.5</a></li><li><a href="#d1e1775"><span class="secnum">A.2. </span>At Version 1.0</a></li><li><a href="#ver11"><span class="secnum">A.3. </span>At Version 1.1</a></li></ul></li><li><a href="#UWSSchema"><span class="secnum">B. </span>UWS Schema</a></li></ul></div>
73 <!--end of autogenerated content--></div><div class="body">
74 <div class="section"><h2><a id="Introduction" shape="rect"><span class="secnum">1. </span>Introduction (informative)</a></h2>
75 <p>The Universal Worker Service (UWS)
76 pattern defines how to build <i>asynchronous</i>, <i>stateful</i>, <i>job-oriented</i> services<i> </i>(the italicised terms are defined
77 in sub-sections of this introduction). It does so in a way that
78 allows for wide-scale reuse of software and support from software
79 toolkits.</p>
80 <p>Section <span class="xref"><a href="#UWSpattern">2</a></span>
81 of this document describes
82 the pattern and lists the aspects that are common to all its
83 applications. Any such application would involve a service contract
84 that embodies the pattern and fixes the issues left undefined in the
85 pattern itself (see section <span class="xref"><a href="#JDL">1.3</a></span>). The contract might include the XML schemata which form a "job description language" or JDL for the application, or simply a description of the input parameters for the service which are conveyed via typical HTML form encodings. It is intended that each such contract
86 cover a family of related applications, such that the implementations
87 may be widely reused.</p>
88 <p>Section <a href="#ApplicationsOfUWS" shape="rect">4</a> outlines several possible
89 applications of the pattern. These use-cases may be expanded into
90 full IVOA standards that are siblings of the current document.</p>
91 <p>Section <a class="xref" href="#SynchronousService" shape="rect">5</a> describes the preferred
92 method of creating a synchronous facade to a UWS system.</p>
93 <div class="section"><h3><a id="SynchronousStateless" shape="rect"><span class="secnum">1.1. </span>Synchronous, stateless services</a></h3>
94 <p>Simple web services are <i>synchronous</i> and <i>stateless</i>. Synchronous means that the client waits for
95 each request to be fulfilled; if the client disconnects from the
96 service then the activity is abandoned. <i>Stateless</i> means that
97 the service does not remember results of a previous activity (or, at
98 least, the client cannot ask the service about them).</p>
99 <p>Synchronous, stateless services work
100 well when two criteria apply.</p>
101 <ol><li>
102 <p>The length of each activity is
103 less than the “attention span” of the connection.</p>
104 </li><li>
105 <p>The results of each activity are
106 compact enough to be easily passed back to the client via the
107 connection on which the request was made (and possibly pushed back
108 to the service as parameters of the next activity).</p>
109 </li></ol>
110 <p>There are various limits to the
111 attention span.</p>
112 <ul><li>
113 <p>HTTP assumes that the start of a
114 reply quickly follows its request, even if the body of the reply
115 takes a long time to stream. If the service takes too long to
116 compute the results and to start the reply, then HTTP times out and
117 the request is lost.</p>
118 </li><li>
119 <p>A client runs on a computer which
120 will not stay on-line indefinitely.</p>
121 </li><li>
122 <p>A network with finite
123 reliability will eventually break communications during an activity.</p>
124 </li><li>
125 <p>A service is sometimes shut down
126 for maintenance.</p>
127 </li></ul>
128 <p>Synchronous, stateless services, in
129 short, do not scale well. The following examples illustrate situations in the VO in which synchronous, stateless services are inadequate.</p>
130 <ol><li>
131 <p>An ADQL <cite>[<a href="#std:adql">std:adql</a>]</cite> service gives access
132 to a large object-catalogue. Most queries run in less than a minute,
133 but some legitimate queries involve a full-table traverse and take
134 hours or days. The service needs to run these special cases in a
135 low-priority queue.</p>
136 </li><li>
137 <p>An object-finding service runs
138 the SExtractor <cite>[<a href="#sextractor">sextractor</a>]</cite> application on a list of images. Normally, the list
139 is short and the request is quickly satisfied. Occasionally, a list
140 of 10,000 images is sent in the expectation that the work will be
141 finished over the weekend.</p>
142 </li><li>
143 <p>A cone-search <cite>[<a href="#std:scs">std:scs</a>]</cite> request on a
144 rich catalogue raises 10,000,000 rows of results, but the client is
145 connected via a slow link and cannot read all the results in a
146 reasonable time. The client needs the service to send the results
147 into storage over a faster link. This could mean sending them to
148 VOSpace <cite>[<a href="#std:vospace">std:vospace</a>]</cite>, or simply holding them temporarily at the service until the user can
149 retrieve them on a fast link. UWS provides a pattern for doing the latter.</p>
150 </li><li>
151 <p>An ADQL service allows users to
152 save query results into new tables such that they can be the target
153 of later queries. However, space is limited and the results tables
154 can only be kept for a short time. The client and service negotiate
155 the lifetime of the results tables.</p>
156 </li><li>
157 <p>A service performs image
158 stacking on a list of fields. Each field can be processed by a
159 synchronous service but the list is long and the user wants to
160 retrieve the results of the early fields before the last fields are
161 processed.</p>
162 </li></ol>
163 </div>
164 <div class="section"><h3><a id="AsynchronousServices" shape="rect"><span class="secnum">1.2. </span>Asynchronous and stateful services</a></h3>
165 <p>Services can be made to scale better
166 by making them <i>asynchronous</i> and <i>stateful</i>. Asynchronous
167 means that a client makes two or more separate requests to the
168 service in the course of one activity, and that the client and
169 service may be disconnected, possibly for days or more, in between
170 those requests. Stateful means that the service stores state
171 information about the activity and the client addresses requests to
172 this state.</p>
173 <p>Web services that are asynchronous
174 are almost always stateful. Most of the special extra arrangements for
175 asynchronous activities are actually managing the state of the
176 activity.</p>
177 <p>There is an important class of
178 stateful services where the state is peculiar to one job or session
179 and the job is “owned” by one user. These, for the purpose of
180 this document, are called <i>job-oriented</i> services. There are
181 stateful services that are not job-oriented (e.g. a service managing
182 a shared, client-writeable DB table), but UWS does not apply to
183 these.</p>
184 <p>For the purpose of this discussion,
185 let the term <i>job</i> refer to the work specified by the JDL
186 instructions and the term <i>resource</i> refer to the state of the
187 job as recorded by the service. Both have a finite duration. The <i>lifetime</i> of the resource – i.e. the time from inception
188 until the service forgets the state – is generally finite and must
189 be at least as long the duration of the job.</p>
190 </div>
191 <div class="section"><h3><a id="JDL" shape="rect"><span class="secnum">1.3. </span>Job description language, service contracts and universality</a></h3>
192 <p>Consider the web-service operation
193 that starts off a job. This operation must express what is to be done
194 in the activity: it must carry parameters in some form.</p>
195 <p>The parameters may be expressed as a
196 list. For example, a cone search service takes a list of three parameters:
197 RA, DEC, RADIUS. Alternatively, the parameters may be arranged as an
198 XML document (e.g. ADQL, CEA <cite>[<a href="#harrison05">harrison05</a>]</cite>). The rules for setting and arranging
199 the parameters for a job are called the<i> Job-Description Language </i>(JDL).</p>
200 <p>The combination of the UWS pattern, a
201 JDL and details of the job state visible to the client defines a
202 service contract. Changing the JDL changes the contract. Thus, it is not
203 meaningful to “implement UWS” in isolation; any implementation
204 standard must specify the rest of the contract.</p>
205 <p>If the JDL is very general, a single
206 service-contract can be reused for many kinds of service. AstroGrid’s
207 CEA<cite>[<a href="#harrison05">harrison05</a>]</cite>exploits this: one JDL covers all services offering parameterised
208 applications and even ADQL services. In the limit, a
209 sufficiently-general JDL turns a specialized worker service into a
210 universal worker service.</p>
211 </div>
212 <div class="section"><h3><a id="IVOARCH" shape="rect"><span class="secnum">1.4. </span>UWS in the IVOA Architecture</a></h3>
213 <p><img src="ivoaarchitecture.png" alt="ivoa architectures" /></p>
214 <p>With the IVOA Architecture above, UWS is a VO infrastructure standard, being used by other standards and services to enable the development of VO applications managing asynchronous and stateless execution of jobs on VO services. Examples of such jobs include the case where the response must be computed, and that computation time takes longer than the normal expectation in an interactive web session. Additionally the UWS pattern allows a simple form of data sharing of the results of a job that is suitable for "workflow" situations and can be used by Data Access Services (currently Table Access Protocol <cite>[<a href="#std:tap">std:tap</a>]</cite>, but potentially by other DAL standards). It utilizes IVOA standards for security <cite>[<a href="#std:ssoauth">std:ssoauth</a>]</cite> if it is desired that a non-public UWS be created. </p>
215 </div>
216 </div>
217 <div class="section"><h2><a id="UWSpattern" shape="rect"><span class="secnum">2. </span>Universal Worker Service Pattern (normative)</a></h2>
218 <div class="section"><h3><a id="UWSObjects" shape="rect"><span class="secnum">2.1. </span>Objects within a UWS</a></h3>
219 <p>A UWS consists logically of a set of
220 objects that may be read and written to in order to control jobs. The objects are represented by elements within the XML schema detailed in <span class="xref"><a href="#UWSSchema">B</a></span>. In a REST binding, these objects are addressed as distinct web-resources each with its own URI. </p>
221 <p> The following sub-sections explain the semantics of the objects. The
222 UML diagram below shows the relationships more succinctly.</p>
223 <p><img src="Class_Diagram__UWS__UWSObjects.png" alt="UWS Objects Class Diagram" width="460" height="390" id="graphics2" /></p>
224 <div class="section"><h4><a id="Joblist" shape="rect"><span class="secnum">2.1.1. </span>Job list</a></h4>
225 <p>The Job List is the outermost object:
226 it contains all the other objects in the UWS. The immediate children
227 of the job list are Job objects (see next sub-section).</p>
228 <p>The job list may be read to find the
229 extant jobs.</p>
230 <p>The job list may be updated to add a
231 new job.</p>
232 <p>The job list itself does not allow
233 jobs to be deleted. Instead, when a job is destroyed by an action on
234 its job object, then the list updates itself accordingly.</p>
235 </div>
236 <div class="section"><h4><a id="Job" shape="rect"><span class="secnum">2.1.2. </span>Job</a></h4>
237 <p>A Job object contains the state of
238 one job. The state is a collection of other objects. Each Job
239 contains:</p>
240 <ul><li>
241 <p>Exactly one Execution Phase.</p>
242 </li><li>
243 <p>Exactly one Execution Duration.</p>
244 </li><li>
245 <p>Exactly one Deletion Time</p>
246 </li><li>
247 <p>Exactly one Quote.</p>
248 </li><li>
249 <p>Exactly one Results List.</p>
250 </li><li><p>Exactly one Owner.</p></li><li>
251 <p>Zero or one Run Identifier.</p>
252 </li><li>
253 <p>Zero or one Error.</p>
254 </li></ul>
255 </div>
256 <div class="section"><h4><a id="ExecutionPhase" shape="rect"><span class="secnum">2.1.3. </span>Execution Phase</a></h4>
257 <p>The job is treated as a state machine
258 with the Execution Phase naming the state. The phases are:</p>
259 <ul><li>
260 <p>PENDING: the job is accepted by
261 the service but not yet committed for execution by the client. In
262 this state, the job quote can be read and evaluated. This is the
263 state into which a job enters when it is first created.</p>
264 </li><li>
265 <p>QUEUED: the job is committed for
266 execution by the client but the service has not yet assigned it to a
267 processor. No Results are produced in this phase.</p>
268 </li><li>
269 <p>EXECUTING: the job has been
270 assigned to a processor. Results may be produced at any time during
271 this phase.</p>
272 </li><li>
273 <p>COMPLETED: the execution of the
274 job is over. The Results may be collected.</p>
275 </li><li>
276 <p>ERROR: the job failed to
277 complete. No further work will be done nor Results produced. Results
278 may be unavailable or available but invalid; either way the Results
279 should not be trusted.</p>
280 </li><li>
281 <p>ABORTED: the job has been
282 manually aborted by the user, or the system has aborted the job due
283 to lack of or overuse of resources.</p>
284 </li><li><p>UNKNOWN: The job is in an unknown state.</p></li><li>
285 <p>HELD: The job is HELD pending execution and
286 will not automatically be executed (cf, PENDING)</p>
287 </li><li><p>SUSPENDED: The job has been suspended by the system during execution. This might be because of temporary lack of resource. The UWS will automatically resume the job into the EXECUTING phase without any intervention when resource becomes available.</p></li><li>ARCHIVED: At destruction time the results associated with a job have been deleted to free up resource, but the metadata associated with the job is retained.</li></ul>
288 <p>A successful job will normally progress through the PENDING, QUEUED, EXECUTING, COMPLETED phases in that order. At any time before the COMPLETED phase a job may either be ABORTED or may suffer an ERROR. If the UWS reports an UNKNOWN phase, then all the client can do is re-query the phase until a known phase is reported. A UWS may place a job in a HELD phase on receipt of a PHASE=RUN request if for some reason the job cannot be immediately queued - in this case it is the responsibility of the client to request PHASE=RUN again at some later time.</p>
289 <p class="issue">TODO - Add ARCHIVED to diagram</p>
290 <p><img src="UWSStates.png" alt="UWS state diagram" width="487" height="332" /></p>
291
292 </div>
293 <div class="section"><h4><a id="ExecutionDuration" shape="rect"><span class="secnum">2.1.4. </span>Execution Duration</a></h4>
294 <p>An Execution Duration object defines
295 the duration for which a job shall run. This represents the
296 “computation time” that a job is to be allowed, although because
297 a specific measure of CPU time may not be available in all
298 environments, this duration is defined in real clock seconds. An
299 execution duration of 0 implies unlimited execution duration.</p>
300 <p>When the execution duration has been
301 exceeded the service should automatically abort the job, which has the
302 same effect as when a manual “Abort” is requested.</p>
303 <p>Specifically, when a job is aborted:</p>
304 <ul><li>
305 <p>if the job is still executing,
306 the execution is aborted.</p>
307 </li><li>
308 <p>any previously generated results
309 of the job are retained.</p>
310 </li></ul>
311 <p>When a job is created, the service
312 sets the initial execution duration. The client may write to an
313 Execution Duration to try to change the job's cpu time allocation.
314 The service may forbid changes, or may set limits on the allowed
315 execution duration.</p>
316 </div>
317 <div class="section"><h4><a id="DestructionTime" shape="rect"><span class="secnum">2.1.5. </span>Destruction Time</a></h4>
318 <p>The Destruction Time object
319 represents the instant when the job shall be destroyed. The
320 Destruction Time is an absolute time.</p>
321 <p>Destroying a job implies:</p>
322 <ul><li>
323 <p>if the job is still executing,
324 the execution is aborted.</p>
325 </li><li>
326 <p>any results from the job are
327 destroyed and storage reclaimed.</p>
328 </li><li>
329 <p>the service forgets that
330 the job existed.</p>
331 </li></ul>
332 <p>The Destruction Time should be viewed as
333 a measure of the amount of time that a service is prepared to
334 allocate storage for a job – typically this will be a longer
335 duration that the amount of CPU time that a service would allocate.</p>
336 <p>When a job is created the service
337 sets the initial Destruction Time. The client may write to the
338 Destruction Time to try to change the life expectancy of the job. The
339 service may forbid changes, or may set limits on the allowed
340 destruction time. If there is no destruction time set by the service then this should be indicated in the job XML as a Nill element and as a null string in the returned value for the resource.</p>
341 </div>
342 <div class="section"><h4><a id="Quote" shape="rect"><span class="secnum">2.1.6. </span>Quote</a></h4>
343 <p>A Quote object predicts when the job
344 is likely to complete. The intention is that a client creates the
345 same job on several services, compares the quotes and then accepts
346 the best quote. From the server perspective it is possible to indicate that a job will not be run by specifying a Quote that is greater than the Destruction time.</p>
347 <p>Quoting for a computational job is
348 notoriously difficult. A UWS implementation must always provide a
349 quote object, in order that the two-phase committal of jobs be
350 uniform across all UWS, but it may supply a “don't know” answer
351 for the completion time, indicated by a negative value or an XML nil element in an XML representation of the quote object.</p>
352 </div>
353 <div class="section"><h4><a id="Error" shape="rect"><span class="secnum">2.1.7. </span>Error</a></h4>
354 <p>The error object gives a human-readable error message for the underlying job. This object
355 is intended to be a detailed error message, and consequently might be
356 a large piece of text such as a stack trace. When there is an error
357 running a job, a summary of the error should also be given using the
358 optional errorSummary element of the Job element.</p>
359 </div>
360 <div class="section"><h4><a id="Error2" shape="rect"><span class="secnum">2.1.8. </span>Owner</a></h4>
361 <p>The owner object represents the identifier for the creator of the job. This object will not exist for all invocations of a UWS conformant protocol, but only in cases where the access to the service is authenticated as discussed more thoroughly in section
362 <span class="xref"><a href="#security">3</a></span>. </p>
363 </div>
364 <div class="section"><h4><a id="Error3" shape="rect"><span class="secnum">2.1.9. </span>RunId</a></h4>
365 <p>The RunId object represents an identifier that the job creator uses to identify the job. Note that this is distinct from the Job Identifier that the UWS system itself assigns to each job. The UWS system should do no parsing or processing of the RunId, but merely pass back the value (if it exists) as it was passed to the UWS at job creation time. In particular it may be the case that multiple jobs have the same RunId, as this is a mechanism by which the calling process can identify jobs that belong to a particular group. The exact mechanism of setting the RunId is not specified here, but will be part of the specification of the protocol using the UWS pattern.</p>
366 </div>
367 <div class="section"><h4><a id="ResultsList" shape="rect"><span class="secnum">2.1.10. </span>Results List</a></h4>
368 <p>The Results List object is a
369 container for formal results of the job. Its children may be any
370 objects resulting from the computation that may be fetched from the
371 service when the job has completed.</p>
372 <p>Reading the Results List itself
373 enumerates the available or expected result objects.</p>
374 <p>The children of the Results List may
375 be read but not updated or deleted. The client cannot add anything
376 to the Results List.</p>
377 </div>
378 <div class="section"><h4><a id="ResultsList2" shape="rect"><span class="secnum">2.1.11. </span>Parameter List</a></h4>
379 <p>The Parameter List is an
380 enumeration of the Job parameters. The form that the parameters take will depend on the JDL of the implementing service - for instance if the JDL is expressed as a single XML document, then there would be a single "parameter" that was that XML document. For services where the JDL consists of a list of name/value pairs (typical of the standard IVOA "simple" access protocols), then these would naturally be expressed in the parameter list. Each parameter value may be expressed either directly as the content of the parameter element, or the value expressed "by reference", where there returned parameter value is a URL that points to the location where the actual parameter value is stored.</p>
381 <p>A particular implementation of UWS may choose to allow the parameters to be updated (but not created) after the initial job creation step, whilst the PHASE is in the PENDING state. It is up to the individual implementation to specify exactly how these parameters may be updated, but good practice (in the REST binding) would be to choose one of the following options.</p>
382 <ol><li>HTTP POST an <i>application/x-www-form-urlencoded</i><b> </b>parameter name, value pair to either
383 <ol><li>/{jobs}/{job-id}</li><li>/{jobs}/{job-id}/parameters</li></ol>
384 </li><li>HTTP PUT the parameter value to /{jobs}/{job-id}/parameters/(parameter-name)</li></ol>
385 <p>Additionally a particular implementation of UWS may allow the "job control" parameters (see section <span class="xref"><a href="#jobcontrol">2.2.3</a></span>) to be specified as part of the JDL. If doing this then the implementation must document the possibility and must use the standard parameter names (which may cause a conflict with parameters in the JDL, which is one of the reasons for the two stage job creation pattern of UWS).</p>
386 </div>
387 </div>
388 <div class="section"><h3><a id="RESTbinding" shape="rect"><span class="secnum">2.2. </span>The REST Binding</a></h3>
389 <p>In order to create a usable service the objects discussed in the section above must be exposed in a particular interface which can be addressed over a particular transport mechanism - this combination is known as a "binding". In this first version of the UWS pattern only a REST (Representational State
390 Transfer) style binding <cite>[<a href="#fielding00">fielding00</a>]</cite>is presented, however, future versions of this document will add other bindings such as SOAP. <cite>[<a href="#std:soap">std:soap</a>]</cite>. It should be noted that REST is based on HTTP <cite>[<a href="#std:http">std:http</a>]</cite> and as such the REST binding inherits standard HTTP behaviours. In particular it should be noted that the REST binding makes use of HTTP status codes to control the behaviour of the client, especially the "300" class redirection codes to ensure that the client requests particular resources after state changing operations. If a request is made to a resource that does not exist (e.g. an non-existant job-id) then a 404 error should be returned, or if a request is made that is illegal for the current state of the UWS then a 403 status should be returned. If for some reason there is a complete failure in the underlying UWS machinery then a 500 "internal server error" status should be returned. However individual job failures are indicated by setting the appropriate parts of the job representation to error statuses and a request for the individual job object representation at /(jobs)/(jobid) should have a normal 200 status code response.</p>
391
392 <div class="section"><h4><a id="d1e834" shape="rect"><span class="secnum">2.2.1. </span>Resources and URIs</a></h4>
393 <p>In a REST (Representational State
394 Transfer) binding of UWS, each of the objects defined above is
395 available as a web resource with its own URI. These URIs must form a
396 hierarchy as shown in the table below:</p>
397 <table border="1" cellpadding="2" cellspacing="0">
398 <tr>
399 <th scope="col" rowspan="1" colspan="1">URI</th>
400 <th scope="col" rowspan="1" colspan="1">Description</th>
401 <th scope="col" rowspan="1" colspan="1">Representation</th>
402 </tr>
403 <tr>
404 <td rowspan="1" colspan="1">/{jobs}</td>
405 <td rowspan="1" colspan="1">the Job List</td>
406 <td rowspan="1" colspan="1">the <span class="xmlelement">&lt;jobs&gt;</span>
407 element in the UWS schema </td>
408 </tr>
409 <tr>
410 <td rowspan="1" colspan="1">/{jobs}/(job-id)</td>
411 <td rowspan="1" colspan="1">a Job</td>
412 <td rowspan="1" colspan="1"><p>
413 the <span class="xmlelement">&lt;job&gt;</span> element in the
414 UWS schema<br clear="none" />
415 </p></td>
416 </tr>
417 <tr>
418 <td rowspan="1" colspan="1">/{jobs}/(job-id)/phase</td>
419 <td rowspan="1" colspan="1">the Phase of job (job-id)</td>
420 <td rowspan="1" colspan="1">One of the fixed strings</td>
421 </tr>
422 <tr>
423 <td rowspan="1" colspan="1">/{jobs}/(job-id)/executionduration</td>
424 <td rowspan="1" colspan="1">the maximum execution duration
425 of (job-id)</td>
426 <td rowspan="1" colspan="1">Integer number of seconds.</td>
427 </tr>
428 <tr>
429 <td rowspan="1" colspan="1">/{jobs}/(job-id)/destruction</td>
430 <td rowspan="1" colspan="1">the destruction instant for
431 (job-id)</td>
432 <td rowspan="1" colspan="1"><cite>[<a href="#std:iso8601">std:iso8601</a>]</cite>. If no destruction time then return empty string.</td>
433 </tr>
434 <tr>
435 <td rowspan="1" colspan="1">/{jobs}/(job-id)/error</td>
436 <td rowspan="1" colspan="1">any error message associated
437 with (job-id)</td>
438 <td rowspan="1" colspan="1">any representation appropriate
439 to the implementing service</td>
440 </tr>
441 <tr>
442 <td rowspan="1" colspan="1">/{jobs}/(job-id)/quote</td>
443 <td rowspan="1" colspan="1">the Quote for (job-id)</td>
444 <td rowspan="1" colspan="1"><cite>[<a href="#std:iso8601">std:iso8601</a>]</cite> If no quote available then return empty string.</td>
445 </tr>
446 <tr>
447 <td rowspan="1" colspan="1">/{jobs}/(job-id)/results</td>
448 <td rowspan="1" colspan="1">any results of the job (job-id)</td>
449 <td rowspan="1" colspan="1">the <span class="xmlelement">&lt;results&gt;</span>
450 element in the UWS schema. </td>
451 </tr>
452 <tr>
453 <td rowspan="1" colspan="1">/{jobs}/(job-id)/parameters</td>
454 <td rowspan="1" colspan="1">any parameters for the job
455 (job-id)</td>
456 <td rowspan="1" colspan="1">the <span class="xmlelement">&lt;parameters&gt;</span>
457 element in the UWS schema. </td>
458 </tr>
459 <tr>
460 <td rowspan="1" colspan="1">/{jobs}/(job-id)/owner</td>
461 <td rowspan="1" colspan="1">the owner of the job (job-id)</td>
462 <td rowspan="1" colspan="1">an appropriate identifier as
463 discussed in section <span class="xref"><a href="#security">3</a></span> </td>
464 </tr>
465 </table>
466 <p>The service implementer is free to
467 choose the names given in parentheses above, i.e. the root of the URI tree, and the form that the job identifier takes (though note that it should be a legal URI path element) - the other names are part
468 of the UWS standard.</p>
469 <p>The URI for the Job List, in its
470 absolute form is the root URI for the whole UWS. This URI should be
471 given as the access URL in the UWS registration.</p>
472 <div class="section"><h4><a id="blocking" shape="rect"><span class="secnum">2.2.1.1. </span>Blocking Behaviour</a></h4>
473 <p>UWS 1.1 introduces blocking behaviour where the server may defer returning the result of a request (i.e. block) under certain circumstances. The purpose of this functionality is to allow the client to be able to do a
474 "slow poll" of the Job status whilst the job is running. The advantage for the client is that it can know almost immediately when a job has results without having to execute polling
475 with a very short timescale - this also has advantages for the server in terms of reduced network traffic. The blocking behaviour is restricted to the <code> /{jobs}/(job-id) </code>endpoint, and is invoked by adding a <code>?WAIT</code> query parameter to the GET request to that endpoint. When the server receives such a request it should not return a response (i.e. block)
476 until there is some significant change in the job status, which means that, at a minimum, it must return when the Job Phase changes. The server, however, may block only when in one of the "active" phases (PENDING, QUEUED or EXECUTING), and otherwise must return immediately, even if a blocking request is made, to avoid the possibility of a client waiting indefinitely. The <code>?WAIT</code> query parameter may be assigned an integer value e.g. <code>?WAIT=60</code> which is be interpreted as a maximum time to block in seconds - in this case the server must return after the given value of seconds whether there has been a significant change of Job status or not. A <code>?WAIT=0</code> should be interpreted as equivalent to <code>?WAIT</code> - i.e. a wait value of 0 seconds means block indefinitely until Job status change.</p>
477 <p>The server must support an additional mechanism which uses a ?PHASE query parameter to avoid any possible race conditions where the job has changed PHASE from what the client last polled before issuing a blocking request. If the client uses a ?PHASE query parameter in the blocking request e.g. <code>/{jobs}/(job-id)?WAIT&amp;PHASE=QUEUED</code> then the server must return immediately (i.e. not block intentionally) if the PHASE is not in specified state.</p>
478 <p>As one of the primary goals of UWS is to provide support for long running processes that might outlive the typical TCP connection timeouts (see section <span class="xref"><a href="#Introduction">1</a></span>),
479 a UWS server should respond to a blocking request within the typical TCP connection timeout even when an indefinite wait time has been specified. In addition the UWS server may impose a maximum blocking time (which it does by simply returning when this time is reached whatever the request) if it detects that it is running out of resouces because of a high load imposed by a large number of clients - i.e. a client must not assume that the server will definitely block unitl there is a PHASE change, it may return earlier.</p>
480 <p>A client that is UWS1.1 compliant should also be aware that it will receive immediate responses if it attempts to
481 perform this operation on a UWS 1.0 server. A client may determine the UWS protocol version of the server using VOSI mechanisms (see <cite>[<a href="#std:vosi">std:vosi</a>]</cite> and <cite>[<a href="#std:stdregext">std:stdregext</a>]</cite>). When a service is using UWS as part of its protocol (e.g. VOSpace <cite>[<a href="#std:vospace">std:vospace</a>]</cite>) <span class="issue">it is not clear exactly how a client determines which version of UWS is in force - TBD.</span></p>
482 </div>
483 <p>&nbsp;</p>
484 </div>
485 <div class="section"><h4><a id="d1e603" shape="rect"><span class="secnum">2.2.2. </span>Representations of resources</a></h4>
486 <p>Each of the UWS objects is mapped to a resource URI as detailed in the table above, and for each URI, a HTTP GET
487 fetches a representation of that resource. In general where an object is a container for other objects (Job List, Job, Result List, Parameter List) then an XML representation of the object should be returned, otherwise for simple atomic types (Quote, Execution Duration etc.) a textual (mime type "text/plain") representation should be returned. The XML schema for the various objects described above is
488 detailed in appendix
489 <span class="xref"><a href="#UWSSchema">B</a></span>
490 of this specification. This schema is the definitive description of the exact form of the XML returned by a UWS and must not vary between implementations.</p>
491 <p>HTTP allows multiple representations
492 of a resource distinguished by their MIME types and selected by the
493 HTTP "Accept" headers of a GET request. A UWS implementation can exploit this to support both web
494 browsers and rich clients in the same tree of resources. Although the default behaviour is to return XML, a UWS could return HTML or XHTML to
495 clients that accept these types. These clients are assumed to be web
496 browsers and the UWS is generating its own user interface. The HTML
497 interface generated should allow full control of the UWS via the use
498 of HTML forms and appropriate links.</p>
499 <p>Clients which are assumed to be part
500 of remote applications that drive UWS without showing the details to
501 their users should accept only "application/xml,text/plain". A UWS must therefore
502 return XML representations of the resources in preference to the HTML representation. A technique that may be used to always return XML that modern browsers can transform on the client-side to HTML is via the <span class="xmlelement">&lt;?xml-stylesheet ?&gt;</span> processing instruction, which can be used to point to a suitable XSL resource to perform the transformation. </p>
503 <p>More detail for some of the UWS objects is provided below.</p>
504 <div class="section"><h4><a id="jobList" shape="rect"><span class="secnum">2.2.2.1. </span>Job List</a></h4>
505 <p>The representation of the Job List is
506 a list of links to extant jobs. The service should return a list (which may be empty) of all the jobs (except for jobs in the "ARCHIVED" phase for backward compatibility) that the client can see in the current security context (see section <span class="xref"><a href="#security">3</a></span>), however large the number of jobs. In order possibly to reduce such a large number of jobs in the job list,
507 the server should respond to a request from the client to filter the jobs shown by using URL query parameter on the PHASE for example</p>
508 <pre xml:space="preserve"><code>/{jobs}?PHASE=EXECUTING</code>
509 </pre>
510 <p>would list only the jobs in an EXECUTING state. If the PHASE filtering parameter is repeated, then the service should list all the jobs in the union of the enumerated PHASEs.
511 The only way to list any jobs in the "ARCHIVED" phase is to use this mechanism.</p>
512 <p>Other filters that that server should recognise on the job list are</p>
513 <ul>
514 <li><code>/{jobs}?AFTER=2014-09-10T10:01:02.000Z</code> The server should only list jobs with start times after the given time.</li>
515 <li><code>/{jobs}?LAST=100</code> The server should list only the given number of most recent jobs ordered by start times.</li>
516 </ul>
517 <p>If multiple filters are specified by the client, then the server should return a jobs list which is the result of a logical AND of the various filter conditions. A server may use the LAST filter in a 303 redirection response if it is desired to limit the size of the default returned list after operations that result in a return to the job list (see section <span class="xref"><a href="#RESTbinding">2.2</a></span>). The size of the returned list should be large enough that all active jobs are likely to be returned. A client can deduce that there might be further jobs in the job list by parsing this returned URL.</p>
518 </div>
519 <div class="section"><h4><a id="d1e1040" shape="rect"><span class="secnum">2.2.2.2. </span>Job</a></h4>
520 <p>The representation of a Job is as specified by the <span class="xmlelement">&lt;job&gt;</span> element in the UWS schema as detailed in appendix <span class="xref"><a href="#UWSSchema">B</a></span>.
521 An example of such a job instance is shown below</p>
522 <div><!--The contents of this div are automatically generated from the following processing instruction when processed with ivoarestructure.xsl-->
523 <?incxml href="../UWSJobInstance.xml" ?><h:div xmlns:h="http://www.w3.org/1999/xhtml" class="viewxml"><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:job</span> <span class="attribute-name">xsi:schemaLocation</span><span class="markup">=</span><span class="attribute-value">"http://www.ivoa.net/xml/UWS/v1.1 UWS.xsd"</span> <span class="attribute-name">xmlns:xml</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/XML/1998/namespace"</span> <span class="attribute-name">xmlns:uws</span><span class="markup">=</span><span class="attribute-value">"http://www.ivoa.net/xml/UWS/v1.1"</span> <span class="attribute-name">xmlns:xlink</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/1999/xlink"</span> <span class="attribute-name">xmlns:xsi</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="attribute-name">xmlns:uwsc</span><span class="markup">=</span><span class="attribute-value">"urn:uwscustom"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:jobId</span><span class="markup">&gt;</span><span class="text">cea-agdevel.jb.man.ac.uk-130.88.24.18-1242749568029-508182314</span><span class="markup">&lt;/</span><span class="end-tag">uws:jobId</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:ownerId</span> <span class="attribute-name">xsi:nil</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:phase</span><span class="markup">&gt;</span><span class="text">COMPLETED</span><span class="markup">&lt;/</span><span class="end-tag">uws:phase</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:startTime</span><span class="markup">&gt;</span><span class="text">2009-05-19T17:12:48.038+01:00</span><span class="markup">&lt;/</span><span class="end-tag">uws:startTime</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:endTime</span><span class="markup">&gt;</span><span class="text">2009-05-19T17:12:48.041+01:00</span><span class="markup">&lt;/</span><span class="end-tag">uws:endTime</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:executionDuration</span><span class="markup">&gt;</span><span class="text">86400</span><span class="markup">&lt;/</span><span class="end-tag">uws:executionDuration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:destruction</span><span class="markup">&gt;</span><span class="text">2009-05-29T17:12:48.035+01:00</span><span class="markup">&lt;/</span><span class="end-tag">uws:destruction</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:parameters</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:parameter</span> <span class="attribute-name">id</span><span class="markup">=</span><span class="attribute-value">"scaleFactor"</span><span class="markup">&gt;</span><span class="text">1.8</span><span class="markup">&lt;/</span><span class="end-tag">uws:parameter</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:parameter</span> <span class="attribute-name">id</span><span class="markup">=</span><span class="attribute-value">"image"</span> <span class="attribute-name">byReference</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><span class="text">
524 http://myserver.org/uws/jobs/jobid123/param/image</span><span class="markup">&lt;/</span><span class="end-tag">uws:parameter</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">uws:parameters</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:results</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:result</span> <span class="attribute-name">id</span><span class="markup">=</span><span class="attribute-value">"correctedImage"</span> <span class="attribute-name">xlink:href</span><span class="markup">=</span><span class="attribute-value">"http://myserver.org/uws/jobs/jobid123/result/image"</span> <span class="attribute-name">size</span><span class="markup">=</span><span class="attribute-value">"3000960"</span> <span class="attribute-name">mime-type</span><span class="markup">=</span><span class="attribute-value">"image/fits"</span> <span class="attribute-name">uwsc:anyattribute</span><span class="markup">=</span><span class="attribute-value">"a custom attribute"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">uws:results</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:errorSummary</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"transient"</span> <span class="attribute-name">hasDetail</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:message</span><span class="markup">&gt;</span><span class="text">we have problem</span><span class="markup">&lt;/</span><span class="end-tag">uws:message</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">uws:errorSummary</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">uws:jobInfo</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">any</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xml</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">thatyouwant</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xml</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">any</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">uws:jobInfo</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">uws:job</span><span class="markup">&gt;</span></div></h:div>
525 <!--end of autogenerated content--></div>
526
527
528
529
530
531
532
533 <p>The <span class="xmlelement">&lt;job&gt;</span> element has placeholders of all of the standard UWS objects, and in addition there is a <span class="xmlelement">&lt;uws:jobinfo&gt;</span> element which can be used by implementations to include any extra information within the job description.</p>
534 </div>
535 <div class="section"><h4><a id="resultList" shape="rect"><span class="secnum">2.2.2.3. </span>Results List</a></h4>
536 <p>The representation of a Results List
537 is a list of links to the resources representing the results
538 element. The linked
539 resources may have any URI and any MIME type. A sensible default for
540 their URIs is to make them children of /{jobs}/(job-id)/results, but
541 this is not required. It may sometimes be easier for a service
542 implementer to point to a resource on some web server separate from
543 that running the UWS. Therefore, a client must always parse the
544 Results List to find the results. Each result in a result list must be given a unique identifier. Where a protocol applying UWS
545 specifies standard results it must do so fixing the identifier for those results and fixing the result URIs, however the UWS must still return a valid Results List at /{jobs}/(job-id)/results, even though in this case the identifiers and URIs could be precomputed by the client.</p>
546 </div>
547 <div class="section"><h4><a id="d1e1353" shape="rect"><span class="secnum">2.2.2.4. </span>Parameters List</a></h4>
548 The representation of the parameters list is a list of
549 <span class="xmlelement">&lt;parameter&gt;</span> elements. Each of these elements can either represent the value of the parameter directly, where the content of the element is a textual representation of the parameter, or in the case where the parameter value cannot be represented legally within XML (e.g. the parameter is a binary type such as a FITS file) then the content of the parameter is a URL to the parameter value - to indicate this case the attribute byReference is set to "true".</div>
550 <div class="section"><h4><a id="d1e1556" shape="rect"><span class="secnum">2.2.2.5. </span>Error</a></h4>
551 <p>When an error occurs in a job the UWS must signal this at a minimum by setting the PHASE to error. In addition the <span class="xmlelement">&lt;errorSummary&gt;</span> element, giving a brief summary of the error, should be included within the <span class="xmlelement">&lt;job&gt;</span> element. The UWS may include a more detailed error message for example an execution log or stack trace by providing such a resource at the /{jobs}/(jobid)/error URI. It is the responsibility of the implementing service to specify the form that such an error message may take.</p>
552 </div>
553 </div>
554 <div class="section"><h4><a id="jobcontrol" shape="rect"><span class="secnum">2.2.3. </span>State changing requests</a></h4>
555 <p>Certain of the UWS' resources accept
556 HTTP POST and DELETE messages to change the state of the service –
557 This is the fundamental way that a client controls the execution of a
558 job. In most of the cases where a job sub-object is set the response
559 will have a http 303 “See other” status and a Location header
560 that points back to the main job summary obtained at the <span style="font-weight: medium">/{jobs}/(job-id)
561 URI. The job summary contains the values of (or links to) all the UWS objects
562 within the returned XML (or XHTML). This mode of operation was chosen
563 (as opposed to returning only the sub-object being altered) as it
564 makes for a more natural user interface – especially in the case of
565 the XHMTL interface. A client that wants to obtain only the value of
566 a particular sub-object can at any time request that sub-object with
567 a HTTP GET.</span></p>
568 <div class="section"><h4><a id="jobCreation" shape="rect"><span class="secnum">2.2.3.1. </span>Creating a Job</a></h4>
569 <p>POSTing a request to the Job List
570 creates a new job (unless the service rejects the request). The
571 response when a job is accepted must have code 303 “See other”
572 and the Location header of the response must point to the created
573 job. The response when the job is rejected should be a HTTP 403 Forbidden status style response.</p>
574 <p>This initial POST will in most cases
575 carry parameters for the protocol that is using the UWS pattern, as
576 detailed in <span class="xref"><a href="#ApplicationsOfUWS">4</a></span>
577 .In addition for the initial post may contain job control parameters if allowed by the implementing protocol
578 (i.e. if UWS job control parameter names do not clash with the implementing protocol parameters). One use of this
579 facility might be to have the job placed into a potentially running state by adding ?PHASE=RUN query part to the job creation URL.</p>
580 <div class="section"><h4><a id="d2e1612" shape="rect"><span class="secnum">2.2.3.1.1. </span>Inline Parameters</a></h4>
581 <p>The JDL may allow parameter values to be uploaded in-line - in this case the UWS should accept the parameter content as multipart/form-data encoded in the POST with the formal value of the parameter being a "byReference" type using the special URI scheme "param" with the path part of the URI matching the name attribute of the multipart/form-data encoding content part. The content of such an in-line parameter should be made available as part of the job resource tree at /{jobs}/{job-id}/parameters/{parameter-name}, and then described as a "byReference" parameter in the <span class="xmlelement">&lt;job&gt;</span> XML description.</p>
582 </div>
583 <p>&nbsp;</p>
584 </div>
585 <div class="section"><h4><a id="d1e1390" shape="rect"><span class="secnum">2.2.3.2. </span>Deleting a Job</a></h4>
586 <p>Sending a HTTP DELETE to a Job
587 resource destroys that job, with the meaning noted in the definition
588 of the Job object, above. No other resource of the UWS may be
589 directly deleted by the client. The response to this request must
590 have code 303 “See other” and the Location header of the response
591 must point to the Job List at the /{jobs} URI.</p>
592 <p>Posting a request with a parameter
593 ACTION=DELETE to the Job also destroys the job, the response being as
594 for a deletion. This action supports web browsers which typically
595 cannot send DELETE requests.</p>
596 </div>
597 <div class="section"><h4><a id="d1e1402" shape="rect"><span class="secnum">2.2.3.3. </span>Changing the Destruction Time</a></h4>
598 <p>The Destruction Time may be changed
599 by POSTing to /{jobs}/(job-id)/destruction. In this case, the body
600 of the posted request is of type <i>application/x-www-form-urlencoded</i><b> </b><span style="font-weight: medium">and
601 contains the parameter named DESTRUCTION whose value is the new
602 destruction time in ISO8601 format; i.e. this request is what an HTML
603 form sends.</span></p>
604 <p style="font-weight: medium">The
605 response to this request must have code 303 “See other” and the
606 Location header of the response must point to the /{jobs}/(job-id)
607 URI so that the client receives the value that the service has
608 actually set the Destruction Time to within the Job summary response. The service may override the requested Destruction Time and substitute a value of its choosing e.g. a job owner may have reached his storage quota and so the service only allows further data to be stored for shorter times than requested.</p>
609 </div>
610 <div class="section"><h4><a id="d1e1420" shape="rect"><span class="secnum">2.2.3.4. </span>Changing the Execution Duration</a></h4>
611 <p>The Execution Duration may be changed
612 by POSTing to /{jobs}/(job-id)/executionduration. In this case, the body
613 of the posted request is of type <i>application/x-www-form-urlencoded</i><b> </b><span style="font-weight: medium">and
614 contains the parameter named EXECUTIONDURATION whose value is the new
615 executionduration in seconds.</span></p>
616 <p style="font-weight: medium">The
617 response to this request must have code 303 “See other” and the
618 Location header of the response must point to the
619 /{jobs}/(job-id) so that the client receives the value that the
620 service has actually set the Execution Duration to. The service may to override the request and substitute a value of its choosing</p>
621 </div>
622 <div class="section"><h4><a id="d1e1439" shape="rect"><span class="secnum">2.2.3.5. </span>Starting a Job</a></h4>
623 <p style="font-weight: medium">A
624 job may be started by POSTing to the /{jobs}/(job-id)/phase URI. The
625 POST contains a single parameter PHASE=RUN which instructs the UWS to
626 attempt to start the job. The response to this request must have code
627 303 “See other” and the Location header of the response must
628 point to the /{jobs}/(job-id) URI so that the client receives the
629 phase that the job has been set to. Typically a UWS will put a job
630 into a QUEUED state on receipt of this command, but depending on how
631 busy the server is, the job might be put almost immediately (and
632 without client intervention) into an EXECUTING state.</p>
633 </div>
634 <div class="section"><h4><a id="d1e1448" shape="rect"><span class="secnum">2.2.3.6. </span>Aborting a Job</a></h4>
635 <p style="font-weight: medium">A
636 job may be aborted by POSTing to the /{jobs}/(job-id)/phase URI. The
637 POST contains a single parameter PHASE=ABORT which instructs the UWS
638 to attempt to abort the job. Aborting a job has the effect of stopping a job executing, but the resources associated with a job remain intact. The response to this request must have
639 code 303 “See other” and the Location header of the response must
640 point to the /{jobs}/(job-id) URI so that the client receives the
641 phase that the job has been set to.</p>
642 </div>
643 </div>
644 <div><span class="section"><h4><a id="d1e708" shape="rect"><span class="secnum">2.2.4. </span>Message pattern</a></h4>
645 <p>The REST binding results in the
646 message pattern shown in figure 2.</p>
647 <p><i>Illustration 2:
648 Typical calling sequence for the REST binding of UWS</i></p>
649 <p><img src="Sequence_Diagram__UWS__Rest_Message_Pattern__Rest_Message_Pattern__Rest_Message_Pattern.png" width="100%" id="graphics3" alt="rest message pattern" /></p>
650 Note that UWS 1.1 introduces a blocking behavior on the polling (step 11 in the diagram) that is described further in section </span><span class="xref"><a href="#blocking">2.2.1.1</a></span><span class="section">.<br style="clear: both;" clear="none" />
651 </span></div>
652 </div>
653 </div>
654 <div class="section"><h2><a id="security" shape="rect"><span class="secnum">3. </span>Security Considerations (normative)</a></h2>
655 <p>A UWS should follow IVOA standards for security <cite>[<a href="#std:ssoauth">std:ssoauth</a>]</cite> if it is desired that a non-public UWS be created. It is possible to imagine many different authorization policies that might be employed in an authenticated UWS, where particular groups of users have different permissions to create and view different types of jobs. A full discussion of such authorization policies is beyond the scope of this document, but a UWS should behave as described in section <span class="xref"><a href="#RESTbinding">2.2</a></span>
656 for any individual authenticated user, although it is clear that a user without sufficient privileges might only obtain a restricted list of jobs within the joblist at /{jobs}. Any attempt to retrieve a job for which the user does not have sufficient privilege should result in a 403 Forbidden HTTP status being returned.</p>
657 <p>When an authentication mechanism is used in the UWS, then the implementation should set the owner object to the identity obtained by the authentication. </p>
658 </div>
659 <div class="section"><h2><a id="ApplicationsOfUWS" shape="rect"><span class="secnum">4. </span>Applications of UWS (informative)</a></h2>
660 <p>The UWS pattern leaves undefined two
661 essential parts of the service contract: the content that must be
662 posted to create a job; and the pattern of results made available by
663 a completed job. An application of UWS completes a service contract
664 by defining these matters.</p>
665 <p>There follow some use cases applying
666 the UWS pattern. The descriptions are neither formal nor complete.
667 The intention is to show a range of ways that the pattern can be
668 applied without burdening the reader with the level of detail needed
669 for a standard implementation.</p>
670 <p>Any of these cases could be worked up
671 into a full IVOA standard by formalizing the description, adding
672 detail and generally making the specification more
673 exact and complete.</p>
674 <div class="section"><h3><a id="Imageservice" shape="rect"><span class="secnum">4.1. </span>Image service with data staging</a></h3>
675 <p>Consider a service that computes
676 images from archive data. The computation takes significant time, so
677 the service is asynchronous. The service keeps the computed images in
678 its own storage until the user downloads them; this is essentially
679 the model of SIAP <cite>[<a href="#std:siap">std:siap</a>]</cite>.</p>
680 <p>The asynchronous image-service is a
681 logical extension of a synchronous SIA service. Therefore it uses the
682 REST binding of UWS.</p>
683 <p>The parameters for posting a new job
684 are as for SIAP 1.0:</p>
685 <ul><li>
686 <p>POS, the position on the sky to
687 be searched.</p>
688 </li><li>
689 <p>SIZE, the size of the search
690 box.</p>
691 </li><li>
692 <p>FORMAT: the type of images to be
693 computed.</p>
694 </li></ul>
695 <p>Particular implementations are free
696 to add extra parameters.</p>
697 <p>These parameters are posted in a
698 document of type <i>application/x-www-form-urlencoded</i><span style="font-style: normal">:
699 i.e. they can be sent from an HTML form.</span></p>
700 <p style="font-style: normal">The
701 images generated by the job are accessible as results. Each
702 image has its own URI and can be downloaded over HTTP at any time
703 until the destruction time of the job. The URIs for the images may be
704 discovered from the Results List in the normal UWS way.</p>
705 <p style="font-style: normal">SIAP
706 1.0 produces, for each query, a table of metadata describing the
707 images. The asynchronous image-service produces a table to the same
708 schema as a result with a fixed identifier, called “table”.</p>
709 <p><span style="font-style: normal">Image
710 results are added to the results list, and to the “table” result,
711 as they are generated. Hence, a client that polls the service can
712 discover, download and use some of the images before the job is
713 finished. </span>If the client is satisfied with
714 these early images, the client can cancel the rest of the job by
715 destroying the job. However, destroying the job deletes the cached
716 images so the client has to download them <i>first</i>.</p>
717 </div>
718 <div class="section"><h3><a id="ADQLservice" shape="rect"><span class="secnum">4.2. </span>ADQL service with cursor</a></h3>
719 <p>ADQL [1] can serve as a JDL. Consider
720 an ADQL service that supports long-running queries as asynchronous
721 operations. In general, the results of the query may be a large set
722 of data. They may be too large to download comfortably. We might like
723 to cache these results on the service and to operate a cursor,
724 drawing down from the resource a few rows of the table at a time.</p>
725 <p>The parameters of a job are as
726 follows:</p>
727 <ul><li>
728 <p>ADQL: the query text</p>
729 </li><li>
730 <p>FORMAT: the format for the
731 results</p>
732 </li></ul>
733 <p>These parameters are posted in a
734 document of type <i>application/x-www-form-urlencoded</i><span style="font-style: normal">:
735 i.e. they can be sent from an HTML form.</span></p>
736 <p style="font-style: normal">A
737 successful query generates the following results:</p>
738 <ul><li>
739 <p style="font-style: normal"><i>table</i>:
740 the whole result set as one file resource.</p>
741 </li><li>
742 <p style="font-style: normal"><i>header</i>:
743 the metadata for the output table.</p>
744 </li><li>
745 <p style="font-style: normal"><i>cursor</i>:
746 a selection of rows of output.</p>
747 </li></ul>
748 <p>The <i>cursor</i> result is
749 parameterised by the query parameters FIRST and LAST in the query
750 string of its URI: these parameters state the index of the first and
751 last row to be returned; e.g.</p>
752 <p> http://whatever.org/adlqService/results/cursor?FIRST=1&amp;LAST=100</p>
753 <p>If the parameters are missing, the
754 service decides which rows to return.</p>
755 </div>
756 <div class="section"><h3><a id="ParameterizedApplications" shape="rect"><span class="secnum">4.3. </span>Parameterised applications</a></h3>
757 <p>There is a class of applications on
758 which a job may be defined by a list of simple parameters. “Simple”
759 here means unstructured: a scalar value such as a number, a string of
760 text or a boolean value. If the parameters are allowed to be file name,
761 so that structured data are passed indirectly, then the class of
762 applications is very large indeed. Almost any non-interactive
763 application can be driven in this way.</p>
764 <p>Turning each application of choice
765 into a service (with or without UWS semantics) would be onerous.
766 However, if the application’s interface is entirely characterized,
767 through the JDL, in terms of typed input and output parameters, then
768 one service contract will work for all the applications and a single
769 implementation of the contract can be reused for all cases.</p>
770 <p>AstroGrid’s Common Execution
771 Architecture (CEA) <cite>[<a href="#harrison05">harrison05</a>]</cite> works in this way. It has just one service
772 contract for all applications (including ADQL services; the ADQL
773 query is passed in the list of parameters). It has four
774 implementations, one for each of the possible interfaces between the
775 service and a kind of job (jobs can be implemented with Java classes,
776 command-line applications, HTTP-get services or JDBC databases). CEA
777 also specifies stateful, asynchronous services and makes use of
778 VOSpace.</p>
779 <p>Consider a CEA reworked to use the
780 UWS pattern for consistency with other (future) IVOA standards. Call
781 it CEA v2 to distinguish it from CEA v1 as currently maintained by
782 AstroGrid. For this example, consider the particular kind of CEA
783 service that runs applications supplied as executable binaries.</p>
784 <p>A binary application-server has a
785 library of applications co-located with its service and defined in
786 the service configuration set by the service provider. It does not
787 accept code from the client for local execution.</p>
788 <p>The JDL in CEA v2 is similar to that
789 in CEA v1 It is a formal, XML vocabulary for expressing choice
790 of application and parameter lists <cite>[<a href="#std:vocea">std:vocea</a>]</cite>. Parameters may be inputs or
791 outputs of the job.</p>
792 <p>To start a job, a document in this
793 JDL is posted to the UWS. The document is sent in its native
794 MIME-type, application/xml, so this is not an interface that can be
795 driven directly from an HTML form, although it can be driven from the
796 emerging XForms technology<cite>[<a href="#std:xform">std:xform</a>]</cite>.</p>
797 <p>The results of the job depend on the
798 choice of application. They are all results whose identifiers and
799 types are defined in the definition of the application. That
800 application-definition is registered, so the client knows before
801 running the job what results to expect.</p>
802 <p>CEA input-parameters may be indirect:
803 i.e. they may refer to data in on-line storage. In this case, the JDL
804 document contains the URIs for those data objects Alternatively, the
805 parameters may be direct, in which case the JDL contains the actual
806 value of the parameters.</p>
807 <p>Similarly, CEA results may be made
808 indirect. In this case, the results are named as parameters in the
809 JDL where the values are the URIs to which the results are delivered.
810 The application server can then stream the results to the specified
811 destination as they become available and need not cache them locally.
812 If a job result is indirect, then the server can choose whether or
813 not to keep a local copy. If it chooses not to cache locally, then
814 the result URI in the UWS is set to the external location named in
815 the URI.</p>
816 </div>
817 </div>
818 <div class="section"><h2><a id="SynchronousService" shape="rect"><span class="secnum">5. </span>Implementing a Synchronous Service on top of UWS (informative)</a></h2>
819 <p>Whilst the provision of synchronous
820 services is not one of the design aims of the UWS pattern, there is
821 clearly a desire in second generation IVOA services still to allow a
822 simple synchronous calling pattern to be available to simple clients.
823 What follows is a recommended recipe for putting a synchronous facade
824 on UWS;</p>
825 <p>It is assumed that the core of the
826 service does provide a true UWS compliant set of endpoints rooted at
827 /async (equivalent to the /{jobs} endpoint in the nomenclature used
828 above). The desired synchronous service is to be rooted at /sync.</p>
829 <ol><li>
830 <p>The job is started by either a
831 GET (for compatibility with existing IVOA standards) or a POST
832 (preferably) of form encoded parameters to the /sync endpoint.</p>
833 </li><li>
834 <p>Internally the service creates a
835 job in the standard UWS system with the given parameters and sets
836 the PHASE to RUN, noting the returned job identifier which we will
837 call {job-id}. The /sync endpoint then responds with a STATUS 303
838 (redirection) response to the URL /sync/{job-id}.</p>
839 </li><li>
840 <p>The /sync/{job-id} endpoint then
841 blocks until it detects that the underlying job has finished at
842 which point it responds with a STATUS 303 (redirection) to the
843 /{jobs}/{job-id}/results/mainresult URL, where “mainresult” is
844 the name of the primary result of the job.</p>
845 </li></ol>
846 <p>In this way the service appears to be
847 a synchronous to the original client – assuming it obeys standard
848 HTTP redirection semantics, so a simple client like a web browser
849 could obtain the result with a single “click”. At the same time a
850 more sophisticated, UWS aware, client could control the same job from
851 the standard /{jobs} endpoint – indeed if the synchronous call
852 timed out for some reason, then it would be possible for the original
853 client to retrieve the results by looking at the /{jobs}/{job-id} URL
854 tree, because it could make the association of the job-Id from the
855 URL it receives in step 2 above.</p>
856 <p>The purely synchronous client is
857 restricted compared with the full UWS pattern in that there can only
858 be one result directly returned to the client, as noted in stage 3
859 above. This is usually not a problem for compatibility with existing
860 version 1.0 DAL services as they typically return a single VOTable
861 containing references to the desired data.</p>
862 </div>
863
864 <div class="appendices"><h2><a name="Appendices" id="Appendices" shape="rect"></a>Appendices</h2>
865
866 <div class="section"><h2><a id="Updates" shape="rect"><span class="secnum">A. </span>Updates from previous versions</a></h2>
867 <div class="section"><h3><a id="d1e1112" shape="rect"><span class="secnum">A.1. </span>At Version 0.5</a></h3>
868 <ul><li>
869 changed the POST parameter names
870 to be the same as the resource paths.
871 </li><li>
872 added synchronous section.
873 </li><li>
874 updated SOAP binding section
875 </li></ul>
876 </div>
877 <div class="section"><h3><a id="d1e1775" shape="rect"><span class="secnum">A.2. </span>At Version 1.0</a></h3>
878 <ul><li>Removed all SOAP binding - deferred to later version.</li><li>Added parameterList</li><li>Added ownerId and jobId as subsidiary job object</li></ul>
879 </div>
880 <div class="section"><h3><a id="ver11" shape="rect"><span class="secnum">A.3. </span>At Version 1.1</a></h3>
881 <p>This version is intended to clarify use, and add a small number of facilities that should not break existing 1.0 clients.
882 The Enhancements that have been added are</p>
883 <ul><li>Informative section on how to start a job in a
884 running state <span class="xref"><a href="#jobCreation">2.2.3.1</a></span>
885 </li><li>Added the ability to filter on the job list <span class="xref"><a href="#jobList">2.2.2.1</a></span></li><li>Added a new phase "ARCHIVED" <span class="xref"><a href="#ExecutionPhase">2.1.3</a></span> and <span class="xref"><a href="#jobList">2.2.2.1</a></span></li>
886 <li>Added blocking behaviour to allow "slow poll" by clients <span class="xref"><a href="#blocking">2.2.1.1</a></span>.</li>
887 </ul>
888 </div>
889 </div>
890
891 <div class="section"><h2><a id="UWSSchema" shape="rect"><span class="secnum">B. </span>UWS Schema</a></h2>
892 <p>Note that this schema can be found on-line at <a href="http://www.ivoa.net/xml/UWS/v1.0" shape="rect">http://www.ivoa.net/xml/UWS/v1.0</a> (i.e. the target namespace
893 can also be used as a URL for the schema.) This location should
894 represent the definitive source, the schema is reproduced below only for
895 completeness of this document.</p>
896 <div><!--The contents of this div are automatically generated from the following processing instruction when processed with ivoarestructure.xsl-->
897 <?incxml href="../UWS.xsd"?><h:div xmlns:h="http://www.w3.org/1999/xhtml" class="viewxml"><div class="comment">&lt;!-- $Revision$ $Date$ $HeadURL$ --&gt;</div><div class="comment">&lt;!-- UWS schema - Paul Harrison May 2008 --&gt;</div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:schema</span> <span class="attribute-name">targetNamespace</span><span class="markup">=</span><span class="attribute-value">"http://www.ivoa.net/xml/UWS/v1.1"</span> <span class="attribute-name">elementFormDefault</span><span class="markup">=</span><span class="attribute-value">"qualified"</span> <span class="attribute-name">attributeFormDefault</span><span class="markup">=</span><span class="attribute-value">"unqualified"</span> <span class="attribute-name">xmlns:xml</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/XML/1998/namespace"</span> <span class="attribute-name">xmlns:xs</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/2001/XMLSchema"</span> <span class="attribute-name">xmlns:uws</span><span class="markup">=</span><span class="attribute-value">"http://www.ivoa.net/xml/UWS/v1.1"</span> <span class="attribute-name">xmlns:xlink</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/1999/xlink"</span><span class="markup">&gt;</span><div class="indent"><div class="comment">&lt;!--
898 &lt;xs:import namespace="http://www.w3.org/1999/xlink"
899 schemaLocation="../../../stc/STC/v1.30/XLINK.xsd" /&gt;
900 --&gt;</div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:import</span> <span class="attribute-name">namespace</span><span class="markup">=</span><span class="attribute-value">"http://www.w3.org/1999/xlink"</span> <span class="attribute-name">schemaLocation</span><span class="markup">=</span><span class="attribute-value">"http://www.ivoa.net/xml/Xlink/xlink.xsd"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"ShortJobDescription"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"phase"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:ExecutionPhase"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> the execution phase - returned at
901 /(jobs)/(jobid)/phase</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"id"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:JobIdentifier"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attributeGroup</span> <span class="attribute-name">ref</span><span class="markup">=</span><span class="attribute-value">"uws:reference"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attributeGroup</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"reference"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">standard xlink references
902 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">ref</span><span class="markup">=</span><span class="attribute-value">"xlink:type"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"optional"</span> <span class="attribute-name">default</span><span class="markup">=</span><span class="attribute-value">"simple"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">ref</span><span class="markup">=</span><span class="attribute-value">"xlink:href"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"optional"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:attributeGroup</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:simpleType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"ExecutionPhase"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
903 Enumeration of possible phases of job execution
904 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:restriction</span> <span class="attribute-name">base</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"PENDING"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
905 The first phase a job is entered into - this is where
906 a job is being set up but no request to run has
907 occurred.
908 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"QUEUED"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
909 A job has been accepted for execution but is waiting
910 in a queue
911 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"EXECUTING"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">A job is running</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"COMPLETED"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
912 A job has completed successfully
913 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"ERROR"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
914 Some form of error has occurred
915 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"UNKNOWN"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
916 The job is in an unknown state.
917 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"HELD"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
918 The job is HELD pending execution and will not
919 automatically be executed - can occur after a
920 PHASE=RUN request has been made (cf PENDING).
921 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"SUSPENDED"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
922 The job has been suspended by the system during
923 execution
924 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"ABORTED"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
925 The job has been aborted, either by user request or by
926 the server because of lack or overuse of resources.
927 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"ARCHIVED"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
928 The job has been archived by the server at destruction time. An archived job
929 may have deleted the results to reclaim resources, but must have job metadata preserved.
930 This is an alternative that the server may choose in contrast to completely destroying all record of the job.
931 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:enumeration</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:restriction</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:simpleType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"JobSummary"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">The complete representation of the state
932 of a job</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"jobId"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:JobIdentifier"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"runId"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"1"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> this is a client supplied identifier -
933 the UWS system does nothing other than to return it as
934 part of the description of the job</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"ownerId"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span> <span class="attribute-name">nillable</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">the owner (creator) of the job -
935 this should be expressed as a string that can be
936 parsed in accordance with IVOA security standards. If
937 there was no authenticated job creator then this
938 should be set to NULL.</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"phase"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:ExecutionPhase"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> the execution phase - returned at
939 /(jobs)/(jobid)/phase</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"quote"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:dateTime"</span> <span class="attribute-name">nillable</span><span class="markup">=</span><span class="attribute-value">"true"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"1"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> A Quote predicts when the job is likely to complete - returned at /(jobs)/(jobid)/quote
940 "don't know" is encoded by setting to the XML null value xsi:nil="true"</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"startTime"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:dateTime"</span> <span class="attribute-name">nillable</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">The instant at which the job started execution.</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"endTime"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:dateTime"</span> <span class="attribute-name">nillable</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">The instant at which the job finished execution</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"executionDuration"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:int"</span> <span class="attribute-name">nillable</span><span class="markup">=</span><span class="attribute-value">"false"</span><span class="markup">&gt;</span><div class="indent"><div class="comment">&lt;!-- TODO look if xs:duration here has any benefits --&gt;</div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> The duration (in seconds) for which
941 the job should be allowed to run - a value of 0 is
942 intended to mean unlimited - returned at
943 /(jobs)/(jobid)/executionduration</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"destruction"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:dateTime"</span> <span class="attribute-name">nillable</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> The time at which the whole job +
944 records + results will be destroyed. returned at
945 /(jobs)/(jobid)/destruction</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">ref</span><span class="markup">=</span><span class="attribute-value">"uws:parameters"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"1"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">The parameters to the job (where appropriate)
946 can also be retrieved at /(jobs)/(jobid)/parameters</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">ref</span><span class="markup">=</span><span class="attribute-value">"uws:results"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">The results for the job - can also be retrieved at /(jobs)/(jobid)/results</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"errorSummary"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:ErrorSummary"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"1"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">&gt;</span><span class="text">
947 </span><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"jobInfo"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"1"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> This is arbitrary information that can
948 be added to the job description by the UWS
949 implementation.</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:any</span> <span class="attribute-name">namespace</span><span class="markup">=</span><span class="attribute-value">"##any"</span> <span class="attribute-name">processContents</span><span class="markup">=</span><span class="attribute-value">"lax"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"unbounded"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:simpleType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"JobIdentifier"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> The identifier for the job
950 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:restriction</span> <span class="attribute-name">base</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:simpleType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"job"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:JobSummary"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> This is the information that is returned
951 when a GET is made for a single job resource - i.e.
952 /(jobs)/(jobid)</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"jobs"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> The list of job references returned at
953 /(jobs)</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> ISSUE - do we want to have any sort of
954 paging or selection mechanism in case the job list gets
955 very large? Or is that an unnecessary complication...
956 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"jobref"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:ShortJobDescription"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"unbounded"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"ResultReference"</span> <span class="attribute-name">mixed</span><span class="markup">=</span><span class="attribute-value">"false"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> A reference to a UWS result. If the
957 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"id"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attributeGroup</span> <span class="attribute-name">ref</span><span class="markup">=</span><span class="attribute-value">"uws:reference"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"size"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:long"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"mime-type"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:anyAttribute</span> <span class="attribute-name">namespace</span><span class="markup">=</span><span class="attribute-value">"urn:uwscustom"</span> <span class="attribute-name">processContents</span><span class="markup">=</span><span class="attribute-value">"lax"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"results"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> The element returned for
958 /(jobs)/(jobid)/results</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"result"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:ResultReference"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"unbounded"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"ErrorSummary"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
959 A short summary of an error - a fuller representation of the
960 error may be retrieved from /(jobs)/(jobid)/error
961 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"message"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"type"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:ErrorType"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">
962 characterization of the type of the error
963 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:attribute</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"hasDetail"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:boolean"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text">if true then there is a more detailed error message available at /(jobs)/(jobid)/error</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:attribute</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:simpleType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"ErrorType"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:restriction</span> <span class="attribute-name">base</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"transient"</span><span class="markup">/&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:enumeration</span> <span class="attribute-name">value</span><span class="markup">=</span><span class="attribute-value">"fatal"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:restriction</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:simpleType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"Parameter"</span> <span class="attribute-name">mixed</span><span class="markup">=</span><span class="attribute-value">"true"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> the list of input parameters to the job - if
964 the job description language does not naturally have
965 parameters, then this list should contain one element which
966 is the content of the original POST that created the job.
967 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"byReference"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:boolean"</span> <span class="attribute-name">default</span><span class="markup">=</span><span class="attribute-value">"false"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> if this attribute is true then the
968 content of the parameter represents a URL to retrieve the
969 actual parameter value.</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> It is up to the implementation to decide
970 if a parameter value cannot be returned directly as the
971 content - the basic rule is that the representation of
972 the parameter must allow the whole job element to be
973 valid XML. If this cannot be achieved then the parameter
974 value must be returned by reference.</span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:attribute</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"id"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:string"</span> <span class="attribute-name">use</span><span class="markup">=</span><span class="attribute-value">"required"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:annotation</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:documentation</span><span class="markup">&gt;</span><span class="text"> the identifier for the parameter
975 </span><span class="markup">&lt;/</span><span class="end-tag">xs:documentation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:annotation</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:attribute</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:attribute</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"isPost"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"xs:boolean"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"parameters"</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:complexType</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:sequence</span><span class="markup">&gt;</span><div class="indent"><div class="element"><span class="markup">&lt;</span><span class="start-tag">xs:element</span> <span class="attribute-name">name</span><span class="markup">=</span><span class="attribute-value">"parameter"</span> <span class="attribute-name">type</span><span class="markup">=</span><span class="attribute-value">"uws:Parameter"</span> <span class="attribute-name">maxOccurs</span><span class="markup">=</span><span class="attribute-value">"unbounded"</span> <span class="attribute-name">minOccurs</span><span class="markup">=</span><span class="attribute-value">"0"</span><span class="markup">/&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:sequence</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:complexType</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:element</span><span class="markup">&gt;</span></div></div><span class="markup">&lt;/</span><span class="end-tag">xs:schema</span><span class="markup">&gt;</span></div><div class="comment">&lt;!-- --&gt;</div></h:div>
976 <!--end of autogenerated content--></div>
977
978
979
980
981
982
983
984 </div>
985 </div>
986 <div class="section-nonum'"><h2><a name="References" id="References" shape="rect"></a>References</h2>
987 <div>
988 <!-- <?bibliography ivoadoc/refs.bib ?> -->
989
990
991 <dl><dt><a name="std:rfc2119" id="std:rfc2119" shape="rect">[std:rfc2119] Bradner, S. </a></dt><dd>
992 <a href="http://www.ietf.org/rfc/rfc2119.txt" shape="rect">Key words for use in RFCs to Indicate Requirement Levels</a>, IETF RFC 2119, 1997</dd><dt><a name="std:xform" id="std:xform" shape="rect">[std:xform] John M. Boyer, editor.</a></dt><dd>
993 <a href="http://www.w3.org/TR/xforms11/" shape="rect">Xforms 1.1</a>, 2007.
994 </dd><dt><a name="std:http" id="std:http" shape="rect">[std:http] R. Fielding, J. Gettys, J. Mogul, H. Frystyk,
995 L. Masinter, P. Leach, and T. Berners-Lee.</a></dt><dd>
996 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.html" shape="rect">Hypertext
997 transfer protocol -- http/1.1</a>.
998 {rfc2616}, June 1999.
999 </dd><dt><a name="std:vospace" id="std:vospace" shape="rect">[std:vospace] Matthew Graham, Dave Morris, and Guy
1000 Rixon.</a></dt><dd> <a href="http://www.ivoa.net/Documents/VOSpace/" shape="rect">Vospace specification</a>.
1001 {IVOA Recommendation}, 2009. </dd><dt><a name="std:tap" id="std:tap" shape="rect">[std:tap] Patrick Dowler, Guy Rixon, Doug Tody.</a></dt><dd> <a href="http://www.ivoa.net/Documents/VOSpace/" shape="rect">Table Access Protocol</a>.
1002 {IVOA Recommendation}, 2010. </dd><dt>&nbsp;</dt><dt><a name="fielding00" id="fielding00" shape="rect">[fielding00] Roy Thomas Fielding.</a></dt><dd>
1003 <a href="http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm" shape="rect"><em>Architectural Styles and the Design of Network-based Software
1004 Architectures</em></a>.
1005 PhD thesis, University of California, Irvine, 2000.
1006 </dd><dt><a name="std:soap" id="std:soap" shape="rect">[std:soap] Don Box, David Ehnebuske, Gopal Kakivaya,
1007 Andrew Layman, Noah Mendelsohn, Henrik Frystyk Nielsen, Satish Thatte, and
1008 Dave Winer.</a></dt><dd>
1009 <a href="http://www.w3.org/TR/2000/NOTE-SOAP-20000508/" shape="rect">Simple object access
1010 protocol (soap) 1.1</a>, 2000.
1011 </dd><dt><a name="std:iso8601" id="std:iso8601" shape="rect">[std:iso8601] ISO 8601:2004 Data elements and interchange formats - Information interchange - Representation of dates and times</a></dt><dd>
1012 International Organization for
1013 Standardization, 2004.
1014 </dd><dt><a name="std:ssoauth" id="std:ssoauth" shape="rect">[std:ssoauth] {Grid and Web Services Working Group},
1015 Guy Rixon and Matthew Graham, editors.</a></dt><dd>
1016 <a href="http://www.ivoa.net/Documents/latest/SSOAuthMech.html" shape="rect">Ivoa
1017 single-sign-on profile: Authentication mechanisms version 1.01</a>, 2008.
1018 </dd><dt><a name="harrison05" id="harrison05" shape="rect">[harrison05] P. Harrison.</a></dt><dd>
1019 <a href="http://www.ivoa.net/Documents/latest/CEA.html" shape="rect">A proposal for a
1020 common execution architecture</a>.
1021 {IVOA Note}, May 2005.
1022 </dd><dt><a name="std:vocea" id="std:vocea" shape="rect">[std:vocea] Paul Harrison.</a></dt><dd>
1023 VOCEA - an xml schema for registering cea.</dd><dt><a name="sextractor" id="sextractor" shape="rect">[sextractor]
1024 http://astromatic.iap.fr/software/sextractor/.</a></dt><dd>
1025 <a href="http://astromatic.iap.fr/software/sextractor/" shape="rect">Sextractor</a>.
1026 [Online].
1027 </dd><dt><a name="std:adql" id="std:adql" shape="rect">[std:adql] Iñaki Ortiz, Jeff Lusted, Pat Dowler,
1028 Alexander Szalay, Yuji Shirasaki, Maria A. Nieto-Santisteba, Masatoshi
1029 Ohishi, William O'Mullane, Pedro Osuna, the VOQL-TEG, and the VOQL
1030 Working Group, Pedro Osuna and Iñaki Ortiz, editors.</a></dt><dd>
1031 <a href="http://www.ivoa.net/Documents/latest/ConeSearch.html" shape="rect">Ivoa
1032 astronomical data query language</a>.
1033 {IVOA Recommendation}, 2008.
1034 </dd><dt><a name="std:siap" id="std:siap" shape="rect">[std:siap] Doug Tody and Ray Plant, Paul Harrison,
1035 editor.</a></dt><dd>
1036 <a href="http://www.ivoa.net/Documents/latest/SIA.html" shape="rect">Simple image access
1037 specification</a>.
1038 {IVOA Recommendation}, 2009.
1039 </dd><dt><a name="std:scs" id="std:scs" shape="rect">[std:scs] Roy Williams, Robert Hanisch, Alex Szalay, and
1040 Raymond Plante, Raymond Plante, editor.</a></dt><dd>
1041 <a href="http://www.ivoa.net/Documents/latest/ConeSearch.html" shape="rect">Simple cone
1042 search</a>.
1043 {IVOA Recommendation}, 2008.
1044 </dd>
1045 <dt><a name="std:vosi" id="std:vosi" shape="rect">[std:vosi] {Grid and Web Services Working Group},
1046 Guy Rixon and Matthew Graham, editors.</a></dt>
1047 <dd> <a href="http://www.ivoa.net/documents/VOSI/" shape="rect">IVOA Support Interfaces Version 1.0</a>, 2008. </dd>
1048 <dt><a name="std:stdregext" id="std:stdregext" shape="rect">[std:regext] Paul Harrison, Douglas Burke, Ray Plante, Guy Rixon and Dave Morris</a></dt>
1049 <dd> <a href="http://www.ivoa.net/Documents/StandardsRegExt/" shape="rect">StandardsRegExt: a VOResource Schema Extension for Describing IVOA Standards, Version 1.0</a>, 2012. </dd>
1050 <dt>&nbsp;</dt>
1051 </dl>
1052 </div>
1053 </div>
1054 </div><p style="text-align: right; font-size: x-small; color: #888;">
1055 $Revision$ $Date$ $HeadURL$</p></body></html>

Properties

Name Value
svn:keywords LastChangedDate LastChangedRevision HeadURL Id
svn:mime-type application/xhtml+xml

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26