v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
Secondary Services

Full metadata for a service

Lists all information about a secondary web service.

get/services/{service_id}

Response

Details of the created service

idstring required

A per-back-end unique identifier of the secondary web service, generated by the back-end during creation. MUST match the specified pattern.

titlestring nullable

A short description to easily distinguish entities.

descriptionstring commonmark nullable

Detailed multi-line description to explain the entity.

CommonMark 0.29 syntax MAY be used for rich text representation.

urlstring uri required

URL at which the secondary web service is accessible. Does not necessarily need to be located within the API.

typestring required

Definition of the service type to access result data. All available service types can be retrieved via GET /service_types. Service types MUST be accepted in a case insensitive manner.

enabledboolean required

Describes whether a secondary web service is responding to requests (true) or not (false). Disabled services do not produce any costs.

configurationServiceConfiguration

Map of configuration settings, i.e. the setting names supported by the secondary web service combined with actual values. See GET /service_types for supported configuration settings. For example, this could specify the required version of the service, visualization details or any other service dependent configuration.

attributesobject

Additional attributes of the secondary web service, e.g. available layers for a WMS instance based on the bands in the underlying GeoTiff.

createdstring date-time

Date and time of creation (for batch jobs: the status 'created' was set), formatted as a RFC 3339 date-time.

planstring

The billing plan to process and charge the job or service with.

Billing plans MUST be handled in a case insensitive manner.

The plans can be retrieved from GET /, but the value returned here may not be in the list of plans any longer.

costsnumber nullable

An amount of money or credits. The value MUST be specified in the currency the back-end is working with. The currency can be retrieved by calling GET /. If no currency is set, this field MUST be null.

budgetnumber nullable

Maximum amount of costs the request is allowed to produce. The value MUST be specified in the currency of the back-end. No limits apply, if the value is null or the back-end has no currency set in GET /.

log_level'error' | 'warning' | 'info' | 'debug'

The minimum severity level for log entries that the back-end stores for the processing request.

The order of the levels is as follows (from low to high severity): debug, info, warning, error. That means if warning is set, the back-end will only store log entries with the level warning and error.

The default minimum log level is info. Users need to specifically set this property to debug to capture all log entries. It is RECOMMENDED that users set the level at least to "warning" in production workflows.