Skip to main content

Map Configuration

PATCH 

/config/map

This endpoint allows to update the configuration related to map management.

Request

Body

required

    applyServerConfig booleannullable

    If true, the server configuration will be applied.

    availableGetAppServerUrls string[]nullable

    The exist urls for 'get app' server

    deliveryTimeoutMins int32nullable

    Timeout for delivery operations in minutes.

    downloadRetryCount int32nullable

    Retry count for failed download/delivery.

    layersConfigFromServer

    object[]

    nullable

    Configuration for layers from get app server, including URLs, source type, etc.

  • Array [

  • XYZtilesURL stringnullable

    URL for XYZ tiles

    capabilitiesLayerName stringnullable

    Layer name in the capabilities

    capabilitiesUrl stringnullable

    URL for capabilities

    layerName stringrequired

    The name of the layer

    tileLayerSource object
  • ]

  • mapInventoryMaxSizeMb int32nullable

    The maximum size of the map inventory in megabytes.

    mapMinInclusionInPercentages floatnullable

    Minimum percentage of map inclusion required.

    mapsStoragePath stringnullable

    The path into which the maps are downloaded.

    matomoDimensionId stringnullable

    Dimension ID for Matomo analytics.

    matomoMaxBufferSizeMb int32nullable

    Maximum buffer size in megabytes. If the buffer limit is reached, the oldest entries will be discarded to free up space.

    matomoMaxRetentionHours int32nullable

    Maximum retention time in hours for Matomo analytics data. Entries older than this will be discarded.

    matomoSiteId stringnullable

    Site ID for Matomo analytics.

    matomoUrl stringnullable

    URL for Matomo analytics.

    maxInventoryMissedIntervalHours int32nullable

    Maximum allowed interval (in hours) for inventory updates before triggering an error. #[serde(skip_serializing_if = "Option::is_none")]

    maxMapAreaSqKm floatnullable

    The maximum map area in square kilometers.

    maxMapSizeInMb floatnullable

    The maximum map size in megabytes.

    maxParallelDownloads int32nullable

    Maximum number of parallel downloads allowed.

    minAvailableSpaceMb int32nullable

    Minimum available space in megabytes required.

    networkAvailabilityUrl stringnullable

    The URL for network availability check.

    networkStatusIntervalMins int32nullable

    Interval for background network status check in minutes (in case there is maps in import process).

    periodicConfIntervalMins floatnullable

    Interval for periodic configuration updates in minutes.

    periodicDiscoveryIntervalMins int32nullable

    Interval for periodic discovery in minutes.

    periodicInventoryIntervalHours floatnullable

    Interval for periodic inventory updates in minutes.

    periodicMatomoIntervalMins floatnullable

    Interval for periodic Matomo analytics updates in minutes.

    queryStatusIntervalSec int32nullable

    Number of seconds to wait between checking the import and prepare status

    tcpStreamTimeoutSec int32nullable

    Maximum time (in seconds) to wait for a response when checking if a TCP connection is valid. If no response is received within this time, an error is returned.

    tileLayerProps stringnullable

    The properties for the available layer, like URLs, source type, etc.

Responses

Schema

    activeServerUrl stringrequired

    The active 'get app' server url

    applyServerConfig booleanrequired

    If true, the server configuration will be applied.

    availableGetAppServerUrls string[]required

    The exists urls for 'get app' server

    deliveryTimeoutMins int32required

    Timeout for delivery operations in minutes.

    downloadRetryCount int32required

    Retry count for failed download/delivery.

    effectiveAvailableSpaceMb int32nullable

    The calculated effective available space (considering quota limits) in MB.

    lastAnalyticsDispatch date-timenullable

    Date of the last Matomo analytics event dispatch.

    lastConfigCheck date-timenullable

    Date of the last configuration check.

    lastMapDiscovery date-timenullable

    Date of the last map discovery process for receiving map products.

    lastMapUpdateCheck date-timenullable

    Date of the last map update check.

    lastServerConfigUpdate date-timenullable

    Date of the last 'server' configuration update.

    lastServerMapUpdateCheck date-timenullable

    Date of the last 'server' map update check.

    layersConfigFromServer

    object[]

    nullable

    Configuration for layers from get app server, including URLs, source type, etc.

  • Array [

  • XYZtilesURL stringnullable

    URL for XYZ tiles

    capabilitiesLayerName stringnullable

    Layer name in the capabilities

    capabilitiesUrl stringnullable

    URL for capabilities

    layerName stringrequired

    The name of the layer

    tileLayerSource object
  • ]

  • mapInventoryMaxSizeMb int32nullable

    The maximum size of the map inventory in megabytes.

    mapMinInclusionInPercentages floatrequired

    Minimum percentage of map inclusion required.

    mapsStoragePath stringrequired

    The path into which the maps are downloaded.

    matomoDimensionId stringnullable

    Dimension ID for Matomo analytics.

    matomoMaxBufferSizeMb int32required

    Maximum buffer size in megabytes. If the buffer limit is reached, the oldest entries will be discarded to free up space.

    matomoMaxRetentionHours int32required

    Maximum retention time in hours for Matomo analytics data. Entries older than this will be discarded.

    matomoSiteId stringnullable

    Site ID for Matomo analytics.

    matomoUrl stringnullable

    URL for Matomo analytics.

    maxInventoryMissedIntervalHours int32required

    Maximum allowed interval (in hours) for inventory updates before triggering an error.

    maxMapAreaSqKm floatrequired

    The maximum map area in square kilometers.

    maxMapSizeInMb floatrequired

    The maximum map size in megabytes.

    maxParallelDownloads int32required

    Maximum number of parallel downloads allowed.

    minAvailableSpaceMb int32required

    Minimum available space in megabytes required.

    networkAvailabilityUrl stringnullable

    The URL for network availability check.

    networkStatusIntervalMins int32required

    Interval for background network status check in minutes (in case there is maps in import process).

    periodicConfIntervalMins floatrequired

    Interval for periodic configuration updates in minutes.

    periodicDiscoveryIntervalMins int32required

    Interval for periodic discovery in minutes.

    periodicInventoryIntervalHours floatrequired

    Interval for periodic inventory updates in minutes.

    periodicMatomoIntervalMins floatrequired

    Interval for periodic Matomo analytics updates in minutes.

    queryStatusIntervalSec int32required

    Number of seconds to wait between checking the import and prepare status

    tcpStreamTimeoutSec int64required

    Maximum time (in seconds) to wait for a response when checking if a TCP connection is valid. If no response is received within this time, an error is returned.

    technicalPassword stringnullable

    An hash of the password

    tileLayerProps stringnullable

    The properties for the available layer, like URLs, source type, etc.

Loading...