| <?xml version="1.0" encoding="UTF-8"?> <!-- $Revision: 3660 $ $Date: 2016-10-24 16:42:22 +0100 (Mon, 24 Oct 2016) $ $HeadURL: https://volute.g-vo.org/svn/trunk/projects/grid/uws/doc/UWS.xsd $ --> <!-- UWS schema - Paul Harrison May 2008 --> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.ivoa.net/xml/UWS/v1.0" version="1.1-REC-20161024" xmlns:uws="http://www.ivoa.net/xml/UWS/v1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://www.w3.org/1999/xlink" schemaLocation="http://docs.g-vo.org/schemata/xlink.xsd"/> <xs:sequence> <xs:annotation> <xs:documentation> the execution phase - returned at /{jobs}/{job-id}/phase </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The instant at which the job was created. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:annotation> <xs:documentation> standard xlink references </xs:documentation> </xs:annotation> </xs:attributeGroup> <xs:annotation> <xs:documentation> Enumeration of possible phases of job execution </xs:documentation> </xs:annotation> <xs:enumeration value="PENDING"> <xs:annotation> <xs:documentation> The first phase a job is entered into - this is where a job is being set up but no request to run has occurred. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="QUEUED"> <xs:annotation> <xs:documentation> A job has been accepted for execution but is waiting in a queue </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="EXECUTING"> <xs:annotation> <xs:documentation>A job is running</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="COMPLETED"> <xs:annotation> <xs:documentation> A job has completed successfully </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="ERROR"> <xs:annotation> <xs:documentation> Some form of error has occurred </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="UNKNOWN"> <xs:annotation> <xs:documentation> The job is in an unknown state. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="HELD"> <xs:annotation> <xs:documentation> The job is HELD pending execution and will not automatically be executed - can occur after a PHASE=RUN request has been made (cf PENDING). </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="SUSPENDED"> <xs:annotation> <xs:documentation> The job has been suspended by the system during execution </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="ABORTED"> <xs:annotation> <xs:documentation> The job has been aborted, either by user request or by the server because of lack or overuse of resources. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="ARCHIVED"> <xs:annotation> <xs:documentation> The job has been archived by the server at destruction time. An archived job may have deleted the results to reclaim resources, but must have job metadata preserved. This is an alternative that the server may choose in contrast to completely destroying all record of the job. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:annotation> <xs:documentation> The complete representation of the state of a job </xs:documentation> </xs:annotation> <xs:sequence> <xs:annotation> <xs:documentation> this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> the execution phase - returned at /{jobs}/{job-id}/phase </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A Quote predicts when the job is likely to complete - returned at /{jobs}/{job-id}/quote "don't know" is encoded by setting to the XML null value xsi:nil="true" </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The instant at which the job was created. </xs:documentation> <xs:documentation> Note that the version 1.1 of the specification requires that this element be present. It is optional only in versions 1.x of the schema for backwards compatibility. 2.0+ versions of the schema will make this formally mandatory in an XML sense. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The instant at which the job started execution. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The instant at which the job finished execution </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The duration (in seconds) for which the job should be allowed to run - a value of 0 is intended to mean unlimited - returned at /{jobs}/{job-id}/executionduration </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The time at which the whole job + records + results will be destroyed. returned at /{jobs}/{job-id}/destruction </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The parameters to the job (where appropriate) can also be retrieved at /{jobs}/{job-id}/parameters </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The results for the job - can also be retrieved at /{jobs}/{job-id}/results </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> This is arbitrary information that can be added to the job description by the UWS implementation. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:any maxOccurs="unbounded" minOccurs="0" namespace="##any" processContents="lax"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> <xs:annotation> <xs:documentation> note that this attribute is actually required by the 1.1 specification - however remains optional in the schema for backwards compatibility. It will be formally required in the next major revision. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:annotation> <xs:documentation> The identifier for the job </xs:documentation> </xs:annotation> </xs:simpleType> <xs:annotation> <xs:documentation> The version of the UWS standard that the server complies with. </xs:documentation> </xs:annotation> </xs:simpleType> <xs:annotation> <xs:documentation> This is the information that is returned when a GET is made for a single job resource - i.e. /{jobs}/{job-id} </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The list of job references returned at /(jobs) </xs:documentation> <xs:documentation> The list presented may be affected by the current security context and may be filtered </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> </xs:sequence> <xs:annotation> <xs:documentation> note that this attribute is actually required by the 1.1 specification - however remains optional in the schema for backwards compatibility. It will be formally required in the next major revision. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:annotation> <xs:documentation> A reference to a UWS result. </xs:documentation> </xs:annotation> <xs:anyAttribute namespace="urn:uwscustom" processContents="lax"/> </xs:complexType> <xs:annotation> <xs:documentation> The element returned for /{jobs}/{job-id}/results </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> </xs:sequence> </xs:complexType> </xs:element> <xs:annotation> <xs:documentation> A short summary of an error - a fuller representation of the error may be retrieved from /{jobs}/{job-id}/error </xs:documentation> </xs:annotation> <xs:sequence> </xs:sequence> <xs:annotation> <xs:documentation> characterization of the type of the error </xs:documentation> </xs:annotation> </xs:attribute> <xs:annotation> <xs:documentation> if true then there is a more detailed error message available at /{jobs}/{job-id}/error </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:enumeration value="transient"/> <xs:enumeration value="fatal"/> </xs:restriction> </xs:simpleType> <xs:annotation> <xs:documentation> the list of input parameters to the job - if the job description language does not naturally have parameters, then this list should contain one element which is the content of the original POST that created the job. </xs:documentation> </xs:annotation> <xs:annotation> <xs:documentation> if this attribute is true then the content of the parameter represents a URL to retrieve the actual parameter value. </xs:documentation> <xs:documentation> It is up to the implementation to decide if a parameter value cannot be returned directly as the content - the basic rule is that the representation of the parameter must allow the whole job element to be valid XML. If this cannot be achieved then the parameter value must be returned by reference. </xs:documentation> </xs:annotation> </xs:attribute> <xs:annotation> <xs:documentation> the identifier for the parameter </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType> <xs:sequence> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> <!-- --> |
| This XML schema documentation has been generated with DocFlex/XML RE 1.8.0 using DocFlex/XML XSDDoc 2.2.0 template set. DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML. DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future). A commercial license for "DocFlex/XML XSDDoc" will allow you:
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required! But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own! Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us! To buy a license, please follow this link: http://www.filigris.com/shop/ |