Get Device Configurations

GET 
/api/v1/device/config/:deviceId

This service message returns an object of device configurations.

Request

Path Parameters

deviceId stringrequired

Query Parameters

group stringrequired

Responses

200

application/json

Schema

Schema

oneOf

AndroidConfigDto

group stringrequired

lastConfigUpdateDate date-time

minAvailableSpaceMB number

periodicInventoryIntervalMins number

periodicConfIntervalMins number

periodicMatomoIntervalMins number

lastCheckingMapUpdatesDate date-time

deliveryTimeoutMins number

MaxMapAreaSqKm number

maxMapSizeInMB number

maxParallelDownloads number

downloadRetryTime number

downloadTimeoutMins number

mapMinInclusionInPercentages number

matomoUrl string

matomoDimensionId string

matomoSiteId string

sdStoragePath string

flashStoragePath string

targetStoragePolicy string

Possible values: [SDOnly, FlashThenSD, SDThenFlash, FlashOnly]

Default value: SDOnly

sdInventoryMaxSizeMB number

flashInventoryMaxSizeMB number

ortophotoMapPath string

controlMapPath string

ortophotoMapPattern string

Substring to match in ortophoto map filename

controlMapPattern string

Substring to match in control map filename

WindowsConfigDto

group stringrequired

lastConfigUpdateDate date-time

minAvailableSpaceMB number

periodicInventoryIntervalMins number

periodicConfIntervalMins number

periodicMatomoIntervalMins number

lastCheckingMapUpdatesDate date-time

deliveryTimeoutMins number

MaxMapAreaSqKm number

maxMapSizeInMB number

maxParallelDownloads number

downloadRetryTime number

downloadTimeoutMins number

mapMinInclusionInPercentages number

matomoUrl string

matomoDimensionId string

matomoSiteId string

layers

object[]

Array [

layerName stringrequired

The name of the layer

tileLayerSource string

Possible values: [XYZ, WMTS]

The source of the tile layer

XYZtilesURL string

URL for XYZ tiles

capabilitiesUrl string

URL for capabilities

capabilitiesLayerName string

URL for capabilities

delete boolean

Flag to indicate if the layer should be deleted

]

getAppServerUrls string[]

mapsStoragePath string

queryStatusIntervalSec integer

How many seconds to wait between checking the import and prepare status

networkAvailabilityUrl string

periodicDiscoveryIntervalMins integer

networkStatusIntervalMins integer

Interval for background network status checks in minutes. Used when maps are in the import process.

maxInventoryMissedIntervalHours integer

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

mapInventoryMaxSizeMB integer

tcpStreamTimeoutSec integer

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.

matomoMaxRetentionHour integer

Maximum retention time for Matomo data in hours. Data older than this will be cleaned up.

matomoMaxBufferSizeMB integer

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

technicianPassword string

Possible values: >= 4 characters and <= 20 characters

The password that allows a technician to modify configurations directly on the device. Must be between 4 and 20 characters.

Example (from schema)

{}

Loading...