[#ftl] [#-- Copyright © 2006-2016 Web Cohesion (info@webcohesion.com) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --] [#-- @ftlvariable name="resourceApis" type="java.util.List" --] [#-- @ftlvariable name="serviceApis" type="java.util.List" --] [#-- @ftlvariable name="data" type="java.util.List" --] [#-- @ftlvariable name="downloads" type="java.util.List" --] [#-- @ftlvariable name="title" type="java.lang.String" --] [#-- @ftlvariable name="indexPageName" type="java.lang.String" --] [#-- @ftlvariable name="disableMountpoint" type="java.lang.Boolean" --] [#-- @ftlvariable name="disableResourceLinks" type="java.lang.Boolean" --] [#-- @ftlvariable name="apiRelativePath" type="java.lang.String" --] [#-- @ftlvariable name="cssFile" type="java.lang.String" --] [#-- @ftlvariable name="additionalCssFiles" type="java.util.List" --] [#-- @ftlvariable name="copyright" type="java.lang.String" --] [#-- @ftlvariable name="apiDoc" type="java.lang.String" --] [#-- @ftlvariable name="swaggerUI" type="com.webcohesion.enunciate.api.InterfaceDescriptionFile" --] [#-- @ftlvariable name="favicon" type="java.lang.String" --] [#-- @ftlvariable name="includeApplicationPath" type="java.lang.Boolean" --] [#-- @ftlvariable name="includeDataTypesHomeIndex" type="java.lang.Boolean" --] [#--set up the subnavigation menus--] [#assign nav_sections = { } /] [#if resourceApis?size > 0] [#assign nav_sections = nav_sections + { "Resources" : "resources.html" }/] [/#if] [#if serviceApis?size > 0] [#assign nav_sections = nav_sections + { "Services" : "services.html" }/] [/#if] [#if data?size > 0] [#list data as syntax] [#assign nav_sections = { syntax.label : syntax.slug + ".html" } /] [/#list] [/#if] [#if downloads?size > 0] [#assign nav_sections = nav_sections + { "Files and Libraries" : "downloads.html"} /] [/#if] [#--Basic boilerplate macro.--] [#macro boilerplate title=title breadcrumbs=[{"title" : "Home", "href" : indexPageName}] pagenav=[] codeblocks=true] ${title} [#if cssFile??] [/#if] [#list additionalCssFiles as additionalCssFile] [/#list] [#if favicon??] [/#if]
D4Science D4Science Don't have a D4Science account? Create one Could not find what you are looking for? Contact us.
[#nested/]

[#if copyright??]Copyright © ${copyright}. [/#if]Generated by Enunciate.

[/#macro] [#--Macro that wraps its text in a deprecated tag if the element is deprecated.--] [#macro deprecation element] [#assign deprecated=(element?? && element.deprecated??)/] [#if deprecated][/#if][#nested/][#if deprecated][/#if] [/#macro] [@file name=indexPageName] [#assign pagenav=[]/] [#if resourceApis?size > 0] [#assign pagenav=pagenav + [{ "href" : "#resources", "title" : "Resources" }]/] [/#if] [#if serviceApis?size > 0] [#assign pagenav=pagenav + [{ "href" : "#services", "title" : "Services" }]/] [/#if] [#list data as syntax] [#assign pagenav=pagenav + [{ "href" : "#" + syntax.slug, "title" : syntax.label }]/] [/#list] [@boilerplate pagenav=pagenav] [#if apiDoc??]
${apiDoc}
[/#if] [#if resourceApis?size > 0]

Resources

[#list resourceApis as resourceApi] [#if downloads?size > 0]

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

[/#if] [#if resourceApi.wadlFile??]

There is a WADL document available that describes the resources API.

[/#if] [#if swaggerUI??]

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

[/#if] [#if resourceApi.includeResourceGroupName!false] [/#if] [#list resourceApi.resourceGroups as resourceGroup] [@processResourceGroup resourceGroup=resourceGroup/] [#if resourceApi.includeResourceGroupName!false] [/#if] [/#list]
namepath methods description
[@deprecation element=resourceGroup]${resourceGroup.label}[/@deprecation]
    [#list resourceGroup.paths as path]
  • [@deprecation element=resourceGroup][#if ((includeApplicationPath!false) && (resourceGroup.relativeContextPath?has_content))]/${resourceGroup.relativeContextPath}[/#if]${path.path}[/@deprecation]
    • [/#list]
    [#list resourceGroup.paths as path]
  • [@deprecation element=resourceGroup][#list path.methods as method]${method} [/#list][/@deprecation]
    • [/#list]
 [@deprecation element=resourceGroup]${resourceGroup.description!" "}[/@deprecation]
[/#list] [/#if] [#if serviceApis?size > 0]

Services

[#list serviceApis as serviceApi] [#list serviceApi.serviceGroups as serviceGroup] [#list serviceGroup.services as service] [@processService service=service/] [/#list]
Namespace ${serviceGroup.namespace!"(Default)"}[#if serviceGroup.wsdlFile??] (wsdl)[/#if]
name description
[@deprecation element=service]${service.label}[/@deprecation] [@deprecation element=service]${service.description!" "}[/@deprecation]
[/#list] [/#list] [#if downloads?size > 0]

The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.

[/#if] [/#if] [#if data?size > 0 && includeDataTypesHomeIndex]

Data Types

[#list data as syntax] [@processDataSyntax syntax=syntax/]

${syntax.label}

[#list syntax.namespaces as ns] [#if ns.types?size > 0] [#if ns.uri??] [#if ns.uri?length > 0] [#else] [/#if] [/#if] [#list ns.types as type] [/#list]
Namespace ${ns.uri}[#if ns.schemaFile??] (schema)[/#if]Default Namespace [#if ns.schemaFile??] (schema)[/#if]
type description
[@deprecation element=type]${type.label}[/@deprecation] [@deprecation element=type]${type.description}[/@deprecation]
[/#if] [/#list] [/#list] [#elseif data?size > 0] [#list data as syntax] [@processDataSyntax syntax=syntax/] [/#list] [/#if] [/@boilerplate] [/@file] [@file name="data.html"] [#assign pagenav=[]/] [#list data as syntax] [#assign pagenav=pagenav + [{ "href" : "#" + syntax.slug, "title" : syntax.label }]/] [/#list] [@boilerplate title=title + ": Data Types" breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : "Data Types" , "href" : "data.html"}] pagenav=pagenav]

Data Types

[#list data as syntax]

${syntax.label}

[#list syntax.namespaces as ns] [#if ns.types?size > 0] [#if ns.uri??] [#if ns.uri?length > 0] [#else] [/#if] [/#if] [#list ns.types as type] [/#list]
Namespace ${ns.uri}[#if ns.schemaFile??] (schema)[/#if]Default Namespace [#if ns.schemaFile??] (schema)[/#if]
type description
[@deprecation element=type]${type.label}[/@deprecation] [@deprecation element=type]${type.description}[/@deprecation]
[/#if] [/#list] [/#list] [/@boilerplate] [/@file] [#if downloads?size > 0] [@file name="downloads.html"] [#assign pagenav=[]/] [#list downloads as download] [#assign pagenav=pagenav + [{ "href" : "#" + download.slug, "title" : download.name }]/] [/#list] [@boilerplate title=title + ": Files and Libraries" breadcrumbs=[{"title" : "Home", "href" : indexPageName}, { "title" : "Files and Libraries" , "href" : "downloads.html"}] codeblocks=true pagenav=pagenav]

Files and Libraries

[#list downloads as download]

${download.name}

[#if download.created??]

Created ${download.created?date?string.long}

[/#if] [#if download.artifactId??]
[#if download.groupId??]
groupId
${download.groupId}
[/#if] [#if download.artifactId??]
artifactId
${download.artifactId}
[/#if] [#if download.version??]
version
${download.version}
[/#if] [/#if] [#if download.description??]

${download.description}

[/#if] [#list download.files as file] [/#list]
Files
name size description
${file.name} ${file.size} ${file.description!download.description!" "}
[/#list] [/@boilerplate] [/@file] [/#if] [#if resourceApis?size > 0] [@file name="resources.html"] [@boilerplate title=title + ": Resources" breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : "Resources" , "href" : "resources.html"}]]

Resources

[#list resourceApis as resourceApi] [#if downloads?size > 0]

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

[/#if] [#if resourceApi.wadlFile??]

There is a WADL document available that describes the resources API.

[/#if] [#if swaggerUI??]

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

[/#if] [#if resourceApi.includeResourceGroupName!false] [/#if] [#list resourceApi.resourceGroups as resourceGroup] [#if resourceApi.includeResourceGroupName!false] [/#if] [/#list]
namepath methods description
[@deprecation element=resourceGroup]${resourceGroup.label}[/@deprecation]
    [#list resourceGroup.paths as path]
  • [@deprecation element=resourceGroup][#if ((includeApplicationPath!false) && (resourceGroup.relativeContextPath?has_content))]/${resourceGroup.relativeContextPath}[/#if]${path.path}[/@deprecation]
    • [/#list]
    [#list resourceGroup.paths as path]
  • [@deprecation element=resourceGroup][#list path.methods as method]${method} [/#list][/@deprecation]
    • [/#list]
 [@deprecation element=resourceGroup]${resourceGroup.description!" "}[/@deprecation]
[/#list] [/@boilerplate] [/@file] [/#if] [#if serviceApis?size > 0] [@file name="services.html"] [@boilerplate title=title + ": Services" breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : "Services" , "href" : "services.html"}]]

Services

[#list serviceApis as serviceApi] [#list serviceApi.serviceGroups as serviceGroup] [#list serviceGroup.services as service] [/#list]
Namespace ${serviceGroup.namespace}[#if serviceGroup.wsdlFile??] (wsdl)[/#if]
name description
[@deprecation element=service]${service.label}[/@deprecation] [@deprecation element=service]${service.description!" "}[/@deprecation]
[/#list] [/#list] [#if downloads?size > 0]

The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.

[/#if] [/@boilerplate] [/@file] [/#if] [#macro processResourceGroup resourceGroup] [#assign pagenav=[]/] [#list resourceGroup.resources as resource] [#list resource.methods as method] [#assign path=resource.path/] [#if ((includeApplicationPath!false) && (resourceGroup.relativeContextPath?has_content))] [#assign path="/" + resourceGroup.relativeContextPath + resource.path/] [/#if] [#assign pagenav=pagenav + [{ "href" : "#" + method.slug, "title" : method.label + " " + path }]/] [/#list] [/#list] [#-- @ftlvariable name="resourceGroup" type="com.webcohesion.enunciate.api.resources.ResourceGroup" --] [@file name=resourceGroup.slug + ".html"] [@boilerplate title=title + ": " + resourceGroup.label breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : "Resources" , "href" : "resources.html"}, {"title" : resourceGroup.label , "href" : resourceGroup.slug + ".html"}] pagenav=pagenav]

${resourceGroup.label} Resource

[#if resourceGroup.description??]

${resourceGroup.description}

[/#if] [#list resourceGroup.resources as resource] [#if resource.since?? || resource.version?? || resource.seeAlso??]
[#if resource.since??]
Available Since
${resource.since}
[/#if] [#if resource.version??]
Version
${resource.version}
[/#if] [#if resource.seeAlso??] [#list resource.seeAlso as seeAlso]
See Also
${seeAlso}
[/#list] [/#if]
[/#if] [#list resource.methods as method]

${method.label} [#if ((includeApplicationPath!false) && (resourceGroup.relativeContextPath?has_content))]/${resourceGroup.relativeContextPath}[/#if]${resource.path}[#if !disableResourceLinks!false] [/#if]

[#if resourceGroup.deprecated?? || method.deprecated??]
This method has been deprecated. [#if method.deprecated??] ${method.deprecated!""}[#else] ${resource.deprecated!""}[/#if]
[/#if] [#if method.description??]

${method.description}

[/#if] [#-- would be nice to enable a "Try it out" link to Swagger. See https://github.com/swagger-api/swagger-spec/issues/239 [#if swaggerUI??]

Try it out!

[/#if] --] [#assign securityRoles=method.securityRoles![]/] [#if (method.since?? || method.version?? || method.seeAlso?? || securityRoles?size > 0)]
[#if method.since??]
Available Since
${method.since}
[/#if] [#if method.version??]
Version
${method.version}
[/#if] [#if securityRoles?size > 0]
Security Roles Allowed
[#list securityRoles as role]${role}[#if role_has_next], [/#if][/#list]
[/#if] [#if method.seeAlso??] [#list method.seeAlso as seeAlso]
See Also
${seeAlso}
[/#list] [/#if]
[/#if] [#if method.parameters?size > 0] [#assign includeDefault=method.includeDefaultParameterValues/] [#if includeDefault] [/#if] [#assign includeConstraints=method.hasParameterConstraints/] [#if includeConstraints] [/#if] [#assign includeMultiplicity=method.hasParameterMultiplicity/] [#if includeMultiplicity] [/#if] [#list method.parameters as parameter] [#if includeDefault] [/#if] [#if includeConstraints] [/#if] [#if includeMultiplicity] [/#if] [/#list]
Request Parameters
name type descriptiondefaultconstraintsmultivalued
${parameter.name} ${parameter.typeLabel} ${parameter.description!" "}${parameter.defaultValue!" "}${parameter.constraints!" "}${parameter.multivalued?string("yes", "no")}
[/#if] [#if method.requestEntity??] [#if method.requestEntity.description??] [/#if] [#list method.requestEntity.mediaTypes as io] [#if io_index = 0 && method.requestEntity.description??] 1] rowspan="${method.requestEntity.mediaTypes?size}" class="multi-row-description"[/#if]>${method.requestEntity.description} [/#if] [/#list]
Request Body
media type data typedescription
${io.mediaType} [@referenceDataType referenceType=io.dataType!{"label" : "(custom)"}/][#if io.syntax??] (${io.syntax})[/#if]
[/#if] [#if method.responseCodes?size > 0] [#assign hasExpectedTypes=false/] [#list method.responseCodes as responseCode] [#if responseCode.mediaTypes?size > 0] [#assign hasExpectedTypes=true/] [/#if] [/#list] [#if hasExpectedTypes] [/#if] [#list method.responseCodes as responseCode] [#if hasExpectedTypes] [/#if] [/#list]
Response Codes
code conditiontype
${responseCode.code} ${responseCode.condition!""}
    [#list responseCode.mediaTypes as io]
  • [@referenceDataType referenceType=io.dataType!{"label" : "(custom)"}/][#if io.syntax??] (${io.syntax})[/#if]
    • [/#list]
[/#if] [#if method.responseEntity??] [#if method.responseEntity.description??] [/#if] [#list method.responseEntity.mediaTypes as io] [#if io_index = 0 && method.responseEntity.description??] 1] rowspan="${method.responseEntity.mediaTypes?size}" class="multi-row-description"[/#if]>${method.responseEntity.description} [/#if] [/#list]
Response Body
media type data typedescription
${io.mediaType} [@referenceDataType referenceType=io.dataType!{"label" : "(custom)"}/][#if io.syntax??] (${io.syntax})[/#if]
[/#if] [#if method.warnings?size > 0] [#list method.warnings as responseCode] [/#list]
Response Warnings
code condition
${responseCode.code} ${responseCode.condition!""}
[/#if] [#if method.responseHeaders?size > 0] [#list method.responseHeaders as header] [/#list]
Response Headers
name description
${header.name} ${header.description!" "}
[/#if] [#if method.example??]

Example

Request
${method.example.requestHeaders?xhtml}
            [#if method.example.requestLang??]
                
${method.example.requestBody?xhtml}
                
            [/#if]
Response
${method.example.responseHeaders?xhtml}
            [#if method.example.responseLang??]
                
${method.example.responseBody?xhtml}
                
            [/#if]
[/#if]
[/#list] [/#list] [/@boilerplate] [/@file] [/#macro] [#macro processService service] [#assign pagenav=[]/] [#list service.operations as operation] [#assign pagenav=pagenav + [{ "href" : "#" + operation.slug, "title" : operation.name }]/] [/#list] [#-- @ftlvariable name="service" type="com.webcohesion.enunciate.api.services.Service" --] [@file name=service.slug + ".html"] [@boilerplate title=title + ": " + service.label breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : service.label , "href" : service.slug + ".html"}] pagenav=pagenav]

${service.label} Service

[#if service.deprecated??]
This service has been deprecated. ${service.deprecated}
[/#if] [#if service.description??]

${service.description}

[/#if]
[#if service.namespace?? && service.namespace?length > 0]
Namespace
${service.namespace}
[/#if] [#if service.group.wsdlFile??]
WSDL
${service.group.wsdlFile.href}
[/#if] [#if service.path??]
Path
${service.path}
[/#if] [#if service.since??]
Available Since
${service.since}
[/#if] [#if service.version??]
Version
${service.version}
[/#if] [#if service.seeAlso??] [#list service.seeAlso as seeAlso]
See Also
${seeAlso}
[/#list] [/#if]
[#list service.operations as operation]

${operation.name} Operation

[#if operation.deprecated??]
This method has been deprecated. ${operation.deprecated}
[/#if] [#if operation.description??]

${operation.description}

[/#if] [#if (operation.since?? || operation.version?? || operation.seeAlso??)]
[#if operation.since??]
Available Since
${operation.since}
[/#if] [#if operation.version??]
Version
${operation.version}
[/#if] [#if operation.seeAlso??] [#list operation.seeAlso as seeAlso]
See Also
${seeAlso}
[/#list] [/#if]
[/#if] [#if operation.inputParameters?size > 0] [#list operation.inputParameters as parameter] [/#list]
Input Parameters
name type description
${parameter.name} [@referenceDataType referenceType=parameter.dataType/] ${parameter.description!" "}
[/#if] [#if operation.httpRequestHeaders?size > 0] [#list operation.httpRequestHeaders as parameter] [/#list]
HTTP Request Headers
name type description
${parameter.name} [@referenceDataType referenceType=parameter.dataType/] ${parameter.description!" "}
[/#if] [#if operation.outputParameters?size > 0] [#list operation.outputParameters as parameter] [/#list]
Output Parameters
name type description
${parameter.name} [@referenceDataType referenceType=parameter.dataType/] ${parameter.description!" "}
[/#if] [#if operation.returnType??]
Return Value
type description
[@referenceDataType referenceType=operation.returnType/] ${operation.returnDescription!" "}
[/#if] [#if operation.faults?size > 0] [#list operation.faults as fault] [/#list]
Faults
name type conditions
${fault.name} [@referenceDataType referenceType=fault.dataType/] ${fault.conditions!" "}
[/#if] [/#list] [/@boilerplate] [/@file] [/#macro] [#macro processDataSyntax syntax] [#-- @ftlvariable name="syntax" type="com.webcohesion.enunciate.api.datatype.Syntax" --] [@file name=syntax.slug + ".html"] [@boilerplate title=title + ": " + syntax.label breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : syntax.label , "href" : syntax.slug + ".html"} ]]

${syntax.label}

[#list syntax.namespaces as ns] [#if ns.types?size > 0] [#if ns.uri??] [#if ns.uri?length > 0] [#else] [/#if] [/#if] [#list ns.types as type] [@processDataType type=type/] [/#list]
Namespace ${ns.uri}[#if ns.schemaFile??] (schema)[/#if]Default Namespace [#if ns.schemaFile??] (schema)[/#if]
type description
[@deprecation element=type]${type.label}[/@deprecation] [@deprecation element=type]${type.description}[/@deprecation]
[/#if] [/#list] [/@boilerplate] [/@file] [/#macro] [#macro processDataType type] [#-- @ftlvariable name="type" type="com.webcohesion.enunciate.api.datatype.DataType" --] [#assign pagenav=[]/] [#if type.values??] [#list type.values as value] [#assign pagenav=pagenav + [{ "href" : "#" + value.value, "title" : value.value }]/] [/#list] [/#if] [@file name=type.slug + ".html"] [@boilerplate title=title + ": " + type.label breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : type.syntax.label , "href" : type.syntax.slug + ".html"}, {"title" : type.label , "href" : type.slug + ".html"} ] pagenav=pagenav codeblocks=true]

${type.label} Data Type

[#if type.deprecated??]
This data type has been deprecated. ${type.deprecated}
[/#if] [#if type.description??]

${type.description}

[/#if]
[#if type.namespace.uri??]
Namespace
[#if type.namespace.uri?length > 0]
${type.namespace.uri}
[#else]
(Default)
[/#if] [/#if] [#if type.namespace.schemaFile??]
Schema
${type.namespace.schemaFile.href}
[/#if] [#if type.since??]
Available Since
${type.since}
[/#if] [#if type.version??]
Version
${type.version}
[/#if] [#if type.abstract]
Abstract Type
[/#if] [#if type.subtypes??]
Subtypes
[#list type.subtypes as subtype][#if subtype.slug??]${subtype.label}[#else]${subtype.label}[/#if][#if subtype_has_next], [/#if][/#list]
[/#if] [#if type.interfaces??]
Implemented Interfaces
[#list type.interfaces as iface]${iface.label}[#if iface_has_next], [/#if][/#list]
[/#if] [#if type.seeAlso??] [#list type.seeAlso as seeAlso]
See Also
${seeAlso}
[/#list] [/#if]
[#if type.values??] [#list type.values as value] [/#list]
Values
value description
${value.value} [#if value.since??]since ${value.since} [/#if]${value.description!" "}
[/#if] [#if type.properties??] [#list type.propertyMetadata?keys as meta] [/#list] [#list type.properties as property] [#list type.propertyMetadata?keys as meta] [/#list] [/#list] [#if type.supertypes??] [#list type.supertypes as supertype] [#if supertype.value?? && supertype.value.properties?? && supertype.value.properties?size > 0] [#list supertype.value.properties as superProperty] [#list type.propertyMetadata?keys as meta] [/#list] [/#list] [/#if] [/#list] [/#if]
Properties
name data type${type.propertyMetadata[meta]}description
[@deprecation element=property]${property.name}[/@deprecation] [@deprecation element=property][@referenceDataType referenceType=property.dataType/][/@deprecation][@deprecation element=property][@printPropertyMetadata property=property meta=meta/][/@deprecation][@deprecation element=property][#if property.since??]since ${property.since} [/#if]${property.description!" "}[/@deprecation]
Properties inherited from ${supertype.label}
${superProperty.name} [@referenceDataType referenceType=superProperty.dataType/][@printPropertyMetadata property=superProperty meta=meta/][#if superProperty.since??]since ${superProperty.since} [/#if]${superProperty.description!" "}
[/#if] [#if type.example??]

Example

[#if type.abstract && type.subtypes?? ]
This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
[/#if] 
${type.example.body?xhtml}
[/#if] [/@boilerplate] [/@file] [/#macro] [#macro referenceDataType referenceType] [#-- @ftlvariable name="type" type="com.webcohesion.enunciate.api.datatype.DataTypeReference" --] [#if referenceType.containers??][#list referenceType.containers as container]${container?string} of [/#list][/#if][#if referenceType.slug??][/#if]${referenceType.label!"(custom)"}[#if referenceType.slug??][/#if] [/#macro] [#macro printPropertyMetadata property meta] [#assign metaValue=property[meta]!({ "structure" : true })/] [#if metaValue?is_hash && metaValue.structure!false] [#if metaValue.href??][/#if][#if metaValue.title??][/#if]${metaValue.value!" "}[#if metaValue.title??][/#if][#if metaValue.href??][/#if] [#else] ${metaValue} [/#if] [/#macro]