Data: rest-data

• Namespace: http://rest.rsb.openanalytics.eu/types
• XML Schema File: rest-data.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

• catalog
• directory
• errorResult
• jobToken
• nodeInformation
• result
• results
• rServiPools

The following types are members of this namespace:

• catalogDirectory
• catalogFileType
• catalogType
• directoryType
• errorResultType
• fileType
• jobTokenType
• nodeInformationType
• resultsType
• resultType
• rServiPoolsType
• rServiPoolType

Element catalog

• Type: catalogType

Java class for catalogType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}catalogDirectory" maxOccurs="4" minOccurs="4" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://rest.rsb.openanalytics.eu/types">
  <directory type="..." path="...">
    <file name="..." dataUri="..." />
    <file name="..." dataUri="...">
      <!--...-->
    </file>
    <!--...more "file" elements...-->
  </directory>
  <directory type="..." path="...">
    <!--...-->
  </directory>
  <!--...more "directory" elements...-->
</catalog>

Example JSON

{
  "directory":[
    {
       "type":"...",
       "path":"...",
       "file":[
          {
             "name":"...",
             "dataUri":...
          },
          ...
       ]
    },
    ...
  ]
}

Element directory

• Type: directoryType

Java class for directoryType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="directoryType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}directoryType" maxOccurs="unbounded" minOccurs="0" />
        <element name="file" type="{http://rest.rsb.openanalytics.eu/types}fileType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="uri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="empty" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<directory xmlns="http://rest.rsb.openanalytics.eu/types" path="..." name="..." uri="..." empty="...">
  <directory>
    <!--...-->
  </directory>
  <directory path="..." name="..." uri="..." empty="...">
    <!--...-->
  </directory>
  <!--...more "directory" elements...-->
  <file path="..." name="..." />
  <file path="..." name="...">
    <!--...-->
  </file>
  <!--...more "file" elements...-->
</directory>

Example JSON

{
  "path": "...",
  "name": "...",
  "uri": "...",
  "empty": false,
  "directory": 
  [    
    {
      "...": "..."
    },
    "..."
  ],
  "file": 
  [    
    {
      "path": "...",
      "name": "..."
    },
    "..."
  ]
}

Element errorResult

• Type: errorResultType

Java class for errorResultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="errorResultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="errorMessage" type="{http://www.w3.org/2001/XMLSchema}string" />
      </sequence>
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<errorResult xmlns="http://rest.rsb.openanalytics.eu/types" jobId="..." applicationName="..." submissionTime="...">
  <errorMessage>...</errorMessage>
</errorResult>

Example JSON

{
  "jobId": "...",
  "applicationName": "...",
  "submissionTime": "...",
  "errorMessage": "..."
}

Element jobToken

• Type: jobTokenType

Java class for jobTokenType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="jobTokenType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="applicationResultsUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="resultUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<jobToken xmlns="http://rest.rsb.openanalytics.eu/types" jobId="..." applicationName="..." submissionTime="..." applicationResultsUri="..." resultUri="..." />

Example JSON

{
  "jobId": "...",
  "applicationName": "...",
  "submissionTime": "...",
  "applicationResultsUri": "...",
  "resultUri": "..."
}

Element nodeInformation

• Type: nodeInformationType

Java class for nodeInformationType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="nodeInformationType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="healthy" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="uptime" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="uptimeText" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="servletContainerInfo" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="rsbVersion" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="jvmMaxMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="jvmFreeMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="osLoadAverage" use="required" type="{http://www.w3.org/2001/XMLSchema}double" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<nodeInformation xmlns="http://rest.rsb.openanalytics.eu/types" name="..." healthy="..." uptime="..." uptimeText="..." servletContainerInfo="..." rsbVersion="..." jvmMaxMemory="..." jvmFreeMemory="..." osLoadAverage="..." />

Example JSON

{
  "name": "...",
  "healthy": false,
  "uptime": "...",
  "uptimeText": "...",
  "servletContainerInfo": "...",
  "rsbVersion": "...",
  "jvmMaxMemory": "...",
  "jvmFreeMemory": "...",
  "osLoadAverage": "..."
}

Element result

• Type: resultType

Java class for resultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="resultTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="success" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="selfUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="dataUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<result xmlns="http://rest.rsb.openanalytics.eu/types" jobId="..." applicationName="..." resultTime="..." success="..." type="..." selfUri="..." dataUri="..." />

Example JSON

{
  "jobId": "...",
  "applicationName": "...",
  "resultTime": "...",
  "success": false,
  "type": "...",
  "selfUri": "...",
  "dataUri": "..."
}

Element results

• Type: resultsType

Java class for resultsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="result" type="{http://rest.rsb.openanalytics.eu/types}resultType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://rest.rsb.openanalytics.eu/types">
  <result jobId="..." applicationName="..." resultTime="..." success="..." type="..." selfUri="..." dataUri="..." />
  <result jobId="..." applicationName="..." resultTime="..." success="..." type="..." selfUri="..." dataUri="...">
    <!--...-->
  </result>
  <!--...more "result" elements...-->
</results>

Example JSON

{
  "result": 
  [    
    {
      "jobId": "...",
      "applicationName": "...",
      "resultTime": "...",
      "success": false,
      "type": "...",
      "selfUri": "...",
      "dataUri": "..."
    },
    "..."
  ]
}

Element rServiPools

• Type: rServiPoolsType

Java class for rServiPoolsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="rServiPoolsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="rServiPool" type="{http://rest.rsb.openanalytics.eu/types}rServiPoolType" maxOccurs="unbounded" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<rServiPools xmlns="http://rest.rsb.openanalytics.eu/types">
  <rServiPool poolUri="..." applicationNames="..." default="..." />
  <rServiPool poolUri="..." applicationNames="..." default="...">
    <!--...-->
  </rServiPool>
  <!--...more "rServiPool" elements...-->
</rServiPools>

Example JSON

{
  "rServiPool": 
  [    
    {
      "poolUri": "...",
      "applicationNames": "...",
      "default": false
    },
    "..."
  ]
}

Type catalogDirectory

Java class for catalogDirectory complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogDirectory">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="file" type="{http://rest.rsb.openanalytics.eu/types}catalogFileType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
      <attribute name="type" use="required">
        <simpleType>
          <restriction base="{http://www.w3.org/2001/XMLSchema}NMTOKEN">
            <enumeration value="EMAIL_REPLIES" />
            <enumeration value="JOB_CONFIGURATIONS" />
            <enumeration value="R_SCRIPTS" />
            <enumeration value="SWEAVE_FILES" />
          </restriction>
        </simpleType>
      </attribute>
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
type	string	(no documentation provided)
path	string	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
file (catalogFileType)	0/unbounded	(no documentation provided)

Type catalogFileType

Java class for catalogFileType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogFileType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="dataUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
name	string	(no documentation provided)
dataUri	anyURI	(no documentation provided)

Type catalogType

Java class for catalogType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}catalogDirectory" maxOccurs="4" minOccurs="4" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
directory (catalogDirectory)	1/unbounded	(no documentation provided)

Type directoryType

Java class for directoryType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="directoryType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}directoryType" maxOccurs="unbounded" minOccurs="0" />
        <element name="file" type="{http://rest.rsb.openanalytics.eu/types}fileType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="uri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="empty" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
path	string	(no documentation provided)
name	string	(no documentation provided)
uri	anyURI	(no documentation provided)
empty	boolean	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
directory (directoryType)	0/unbounded	(no documentation provided)
file (fileType)	0/unbounded	(no documentation provided)

Type errorResultType

Java class for errorResultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="errorResultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="errorMessage" type="{http://www.w3.org/2001/XMLSchema}string" />
      </sequence>
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
jobId	string	(no documentation provided)
applicationName	string	(no documentation provided)
submissionTime	dateTime	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
errorMessage (string)	1/1	(no documentation provided)

Type fileType

Java class for fileType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="fileType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
path	string	(no documentation provided)
name	string	(no documentation provided)

Type jobTokenType

Java class for jobTokenType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="jobTokenType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="applicationResultsUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="resultUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
jobId	string	(no documentation provided)
applicationName	string	(no documentation provided)
submissionTime	dateTime	(no documentation provided)
applicationResultsUri	anyURI	(no documentation provided)
resultUri	anyURI	(no documentation provided)

Type nodeInformationType

Java class for nodeInformationType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="nodeInformationType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="healthy" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="uptime" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="uptimeText" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="servletContainerInfo" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="rsbVersion" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="jvmMaxMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="jvmFreeMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="osLoadAverage" use="required" type="{http://www.w3.org/2001/XMLSchema}double" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
healthy	boolean	(no documentation provided)
uptime	long	(no documentation provided)
uptimeText	string	(no documentation provided)
servletContainerInfo	string	(no documentation provided)
rsbVersion	string	(no documentation provided)
jvmMaxMemory	long	(no documentation provided)
jvmFreeMemory	long	(no documentation provided)
osLoadAverage	double	(no documentation provided)

Type resultsType

Java class for resultsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="result" type="{http://rest.rsb.openanalytics.eu/types}resultType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
result (resultType)	0/unbounded	(no documentation provided)

Type resultType

Java class for resultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="resultTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="success" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="selfUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="dataUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
jobId	string	(no documentation provided)
applicationName	string	(no documentation provided)
resultTime	dateTime	(no documentation provided)
success	boolean	(no documentation provided)
type	string	(no documentation provided)
selfUri	anyURI	(no documentation provided)
dataUri	anyURI	(no documentation provided)

Type rServiPoolsType

Java class for rServiPoolsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="rServiPoolsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="rServiPool" type="{http://rest.rsb.openanalytics.eu/types}rServiPoolType" maxOccurs="unbounded" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
rServiPool (rServiPoolType)	1/unbounded	(no documentation provided)

Type rServiPoolType

Java class for rServiPoolType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="rServiPoolType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="poolUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="applicationNames" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="default" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
poolUri	anyURI	(no documentation provided)
applicationNames	string	(no documentation provided)
default	boolean	(no documentation provided)