Skip to content


"type": "wps-result"


Trait Type Default Description
wpsParameters WPSParameterTraits[]

Parameter names & values for this result item

wpsResponse any

The WPS response object

geojsonFeatures any

Geojson feature collection of input features.

wpsResponseUrl string

WPS response URL

attribution string

The attribution to display with the data.

refreshInterval number 1

How often the job will poll for results, in seconds. (This overrides AutoRefreshingTraits)

refreshEnabled boolean

Toggle for enabling auto refresh. (This overrides Trait in AutoRefreshingTraits)

logs string[]

Job logs.

jobStatus string inactive

Job status.

downloadedResults boolean

Downloaded results.

parameters any

Function parameters (only contains key-value pairs).

name string

The name of the catalog item.

description string

The description of the catalog item. Markdown and HTML may be used.

nameInCatalog string

The name of the item to be displayed in the catalog, if it is different from the one to display in the workbench.

info InfoSectionTraits[]

Human-readable information about this dataset.

infoSectionOrder string[]

An array of section titles definining the display order of info sections. If this property is not defined, {@link DataPreviewSections}'s DEFAULT_SECTION_ORDER is used

isOpenInWorkbench boolean true

Whether the item in the workbench open or collapsed.

shortReport string Job is inactive

A short report to show on the now viewing tab.

shortReportSections ShortReportTraits[]

A list of collapsible sections of the short report

isExperiencingIssues boolean

Whether the catalog item is experiencing issues which may cause its data to be unavailable

hideSource boolean

Indicates that the source of this data should be hidden from the UI (obviously this isn't super-secure as you can just look at the network requests).

metadataUrls MetadataUrlTraits[]

Metadata URLs to show in data catalog.

dataUrls DataUrlTraits[]

Data URLs to show in data catalog.

dataCustodian string

Gets or sets a description of the custodian of this data item.

modelDimensions DimensionTraits[]

This provides ability to set model JSON through SelectableDimensions (a dropdown).

disableAboutData boolean

Disables the 'About Data' button in the workbench.

featureInfoTemplate FeatureInfoTemplateTraits

A template object for formatting content in feature info panel

featureInfoUrlTemplate string

A template URL string for fetching feature info. Template values of the form {x} will be replaced with corresponding property values from the picked feature.

showStringIfPropertyValueIsNull string

If the value of a property is null or undefined, show the specified string as the value of the property. Otherwise, the property name will not be listed at all.

excludeMembers string[]

An array of strings of excluded group and item names. A group or item name that appears in this list will not be shown to the user. This is case-insensitive and will also apply to all child/nested groups

isOpen boolean

True if this group is open and its contents are visible; otherwise, false.

sortMembersBy string

Sort members by the given property/trait. For example name, will sort all members by alphabetically

members ModelReference

The members of this group.

legends LegendTraits[]

The legends to display on the workbench.

hideLegendInWorkbench boolean

Whether the legend is hidden in the workbench for this catalog member.

rectangle RectangleTraits

The bounding box rectangle that contains all the data in this catalog item.

disablePreview boolean

Disables the preview on the Add Data panel. This is useful when the preview will be very slow to load.

disableZoomTo boolean

Disables the zoom to (aka 'Ideal Zoom') button in the workbench.

zoomOnAddToWorkbench boolean

Zoom to dataset when added to workbench. Doesn't work if disableZoomTo is true.

show boolean true

Show or hide a workbench item. When show is false, a mappable item is removed from the map and a chartable item is removed from the chart panel.

initialMessage InitialMessageTraits

A message to show when the user adds the catalog item to the workbench. Useful for showing disclaimers.

url string

The base URL of the file or service.

forceProxy boolean

Force the default proxy to be used for all network requests.

cacheDuration string

The cache duration to use for proxied URLs for this catalog member. If undefined, proxied URLs are effectively cachable forever. The duration is expressed as a Varnish-like duration string, such as '1d' (one day) or '10000s' (ten thousand seconds).

executeWithHttpGet boolean

If true, sends a GET request to the Execute endpoint instead of the default POST request.

storeSupported boolean

Indicates if the output can be stored by the WPS server and be accessed via a URL.

statusSupported boolean

Indicates if Execute operation can return just the status information and perform the actual operation asynchronously.

identifier string

The identifier for the process

forceConvertResultsToV8 boolean

If true, then all results will be converted from v7 to v8. If false, then the result.version string will be checked to see if conversion is necessary.


Trait Type Default Description
inputIdentifier string

WPS input parameter identifier

inputValue string

WPS input parameter value

inputType string

WPS input parameter type


Trait Type Default Description
name string

The name of the section.

content string

The content of the section, in Markdown and HTML format. Set this property to null to remove this section entirely.

contentAsObject any

The content of the section which is a JSON object. Set this property to null to remove this section entirely.

show boolean true

Indicates if this info section showing (not collapsed).


Trait Type Default Description
name string

The name of the section.

content string

The content of the section.

show boolean true

Indicates if this short report section showing.


Trait Type Default Description
url string

The metadata URL of the file or service.

title string

Title used for metadata URL button.


Trait Type Default Description
type string

Type of data URL. This value will be used to provide context or instruction on how to use the data URL. For example wcs will provide a link to WCS docs. Current supported values are: - wfs = A Web Feature Service (WFS) base URL - wcs = A Web Coverage Service (WCS) base URL - wfs-complete = A complete, ready-to-use link to download features from a WCS server - wcs-complete = A complete, ready-to-use link to download features from a WFS server - direct = Direct URL to dataset (this is the default if no type is specified) - none = Hide data URL

url string

The metadata URL of the file or service.

title string

Title used for metadata URL button.


Trait Type Default Description
id string

Dimension ID

name string

Dimension name (human-readable)

options DimensionOptionTraits[]

Dimension options

selectedId string

Selected Option's ID

allowUndefined boolean

Allow dimension to be undefined

disable boolean

Hides dimension


Trait Type Default Description
id string

Option ID

name string

Option name (human-readable)

value any

Value (if this is undefined, id will be used)


Trait Type Default Description
name string

A mustache template string for formatting name

template string

A Mustache template string for formatting description

partials any

An object, mapping partial names to a template string. Defines the partials used in Template.

formats any

An object, mapping field names to formatting options.


Trait Type Default Description
title string

A title to be displayed above the legend.

url string

The URL of the legend image.

imageScaling number 1

Scaling of the legend. For example, a high DPI legend may have scaling = 0.5, so it will be scaled doown 50%

urlMimeType string

The MIME type of the URL legend image.

items LegendItemTraits[]


Trait Type Default Description
title string

The title to display next to this legend item.

multipleTitles string

Multiple titles to display next to this legend item.

maxMultipleTitlesShowed string 10

Maximum number of multiple titles to display next to this legend item. (Default is 10)

titleAbove string

The title to display above this legend item, i.e. marking the top of a box on the legend.

titleBelow string

The title to display below this legend item, i.e. marking the bottom of a box on the legend.

color string

The CSS color to display for this item. This property is ignored if Legend URL is specified.

outlineColor string

The CSS color with which to outline this item.

multipleColors string[]

Multiple colors to show with this item in a grid arrangement.

imageUrl string

The URL of an image to display with this item.

addSpacingAbove boolean

True to add a bit of extra spacing above this item in order to separate it visually from the rest of the legend.

imageHeight number 20

The height of the legend image.

imageWidth number 20

The width of the legend image.


Trait Type Default Description
west number

The westernmost longitude in degrees.

south number

The southernmost longitude in degrees.

east number

The easternmost longitude in degrees.

north number

The northernmost longitude in degrees.


Trait Type Default Description
title string

The title of the message.

content string

The content of the message.

key string

Identifier. If multiple messages with the same key are triggered, only the first will be displayed.

confirmation boolean

Whether the message requires confirmation.

confirmText string

If confirmation is true, the text to put on the confirmation button.

width number

Width of the message.

height number

Height of the message.