Deprecated: GeoTSDB Smart Module data models

getAllGeospatialTimeSeriesCollections — 200 response

An array of geospatial time series collections are returned.

Metadata of a GeoTSDB collection.

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
idstringNoread-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$Geospatial Time Series Collection ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') can be used after the first alphanumeric character but must be followed by 1+ alphanumeric characters.
moduleIdstringNoread-only (server-generated)ID of Smart Module that created this collection.

getAllGeospatialTimeSeriesCollections — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getAllGeospatialTimeSeriesCollections — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getAllGeospatialTimeSeriesCollections — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getAllGeospatialTimeSeriesCollections — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteGeospatialTimeSeriesCollection — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteGeospatialTimeSeriesCollection — 404 response

The requested collection does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteGeospatialTimeSeriesCollection — 409 response

The collection cannot be deleted because it is being used by another part of the system.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteGeospatialTimeSeriesCollection — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteGeospatialTimeSeriesCollection — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteGeospatialTimeSeriesCollection — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeospatialTimeSeriesCollection — 200 response

Information of the requested geospatial time series collection is returned.

PropertyTypeRequiredConstraintsDescription
idstringNoread-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$Geospatial Time Series Collection ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') can be used after the first alphanumeric character but must be followed by 1+ alphanumeric characters.
moduleIdstringNoread-only (server-generated)ID of Smart Module that created this collection.

getGeospatialTimeSeriesCollection — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeospatialTimeSeriesCollection — 404 response

The requested geospatial time series collection is not found.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeospatialTimeSeriesCollection — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeospatialTimeSeriesCollection — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeospatialTimeSeriesCollection — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateCollection — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateCollection — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateCollection — 404 response

The requested collection does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateCollection — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateCollection — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateCollection — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createGeospatialTimeSeriesCollection — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createGeospatialTimeSeriesCollection — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createGeospatialTimeSeriesCollection — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteHistoricalCountedTimeSeriesData — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteHistoricalCountedTimeSeriesData — 404 response

The required historical counted data does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteHistoricalCountedTimeSeriesData — 409 response

The historical counted data cannot be deleted because it is being used by another part of the system.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteHistoricalCountedTimeSeriesData — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteHistoricalCountedTimeSeriesData — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getHistoricalCountedTimeSeriesData — 200 response

The requested historical counted data entries are returned.

PropertyTypeRequiredConstraintsDescription
collectionIdstringYesread-only (server-generated)Identifier of the GeoTSDB collection.
counterIdstringNoread-only (server-generated)Identifier of the object counter.
dataarray<object>Yesread-only (server-generated)The array of count data per area.
Properties of data
PropertyTypeRequiredConstraintsDescription
areaIdstringNoread-only (server-generated)The area ID of the count data.
countnumberNoread-only (server-generated)The the number of object in the area.
timestampstringNoread-only (server-generated)Time in RFC3339 format.
timestampstringYesread-only (server-generated)Time in RFC3339 format.

getHistoricalCountedTimeSeriesData — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getHistoricalCountedTimeSeriesData — 404 response

Any requested historical object counted data entries are not found.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getHistoricalCountedTimeSeriesData — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getHistoricalCountedTimeSeriesData — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCollectionData — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCollectionData — 404 response

The required data entry does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCollectionData — 409 response

The data entry cannot be deleted because it is being used by another part of the system.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCollectionData — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCollectionData — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeoJSONFormattedGeospatialData — 200 response

The requested geospatial data entries are returned.

PropertyTypeRequiredConstraintsDescription
beginstringNoread-only (server-generated)The begin time of data entries. The format follows RFC3339.
collectionIdstringNoread-only (server-generated)Identifier of the GeoTSDB collection.
dataarray<object>Noread-only (server-generated)Geospatial Time-series data. Each entry contains the timestamp of the value in RFC3339 format and GeoJSON formatted location data.
Properties of data
PropertyTypeRequiredConstraintsDescription
areasarray<object>No
Properties of areas
PropertyTypeRequiredConstraintsDescription
areaClassstringNo
areaIdstringYes
distancenumberYes
attributesobjectNoread-only (server-generated)The attributes that belong to the location, separated as key-value pairs.
createdAtstringNoCreated date time in RFC3339 format.
floorIdnumberYesread-only (server-generated)The floor ID of the location
geometryobjectYesread-only (server-generated)The GeoJSON object of the location.
searchKeystringYesread-only (server-generated)The string attached to the location.
timestampstringYesread-only (server-generated)Time in RFC3339 format.
endstringNoread-only (server-generated)The end time of data entries. The format follows RFC3339.

getGeoJSONFormattedGeospatialData — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeoJSONFormattedGeospatialData — 404 response

Any requested geospatial data entries are not found.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeoJSONFormattedGeospatialData — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeoJSONFormattedGeospatialData — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getGeoJSONFormattedGeospatialData — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createData — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createData — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createData — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createData — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createData — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 404 response

The required count does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 409 response

The count cannot be deleted because it is being used by another part of the system.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteCount — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getCurrentNumberObjectsAreas — 200 response

The requested counted data entries are returned.

PropertyTypeRequiredConstraintsDescription
collectionIdstringYesread-only (server-generated)Identifier of the GeoTSDB collection.
dataarray<object>Yesread-only (server-generated)The array of count data per area.
Properties of data
PropertyTypeRequiredConstraintsDescription
areaIdstringNoread-only (server-generated)The area ID of the count data.
countnumberNoread-only (server-generated)The the number of object in the area.
timestampstringYesread-only (server-generated)Time in RFC3339 format.

getCurrentNumberObjectsAreas — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getCurrentNumberObjectsAreas — 404 response

Any requested object counted data entries are not found.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getCurrentNumberObjectsAreas — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getCurrentNumberObjectsAreas — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getCurrentNumberObjectsAreas — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfigs — 200 response

A list of object counter configs are returned.

Configuration of an object counter.

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
areaSearchKeyPrefixstringYesThe target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributesobjectNoThe attribute names and values to search the objects.
Properties of attributes
PropertyTypeRequiredConstraintsDescription
namestringYesThe name of the attribute.
valuesarray<string>NoThe attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
collectionIdstringYesThe collection ID to count the number of objects. It allows you to specify wildcard character (*) to count objects in the all of collections in the module.
counterIdstringYespattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$Object counter ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') can be used after the first alphanumeric character but must be followed by 1+ alphanumeric characters.
frequencystringYesone of: 5s, 30s, 60sThe frequency to count objects in the areas.
namestringNoThe name of the object counter config.
objectSearchKeyPrefixesarray<string>NoThe searchKey prefixes to filter the counted objects. The object counter counts objects searched with the keywords specified here

getObjectCounterConfigs — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfigs — 404 response

Any requested object counter config data entries are not found.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfigs — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfigs — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfigs — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteObjectCounterConfig — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteObjectCounterConfig — 404 response

The required object counter config does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteObjectCounterConfig — 409 response

The object counter config cannot be deleted because it is being used by another part of the system.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteObjectCounterConfig — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteObjectCounterConfig — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

deleteObjectCounterConfig — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfig — 200 response

The object counter config is returned.

PropertyTypeRequiredConstraintsDescription
areaSearchKeyPrefixstringYesThe target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributesobjectNoThe attribute names and values to search the objects.
Properties of attributes
PropertyTypeRequiredConstraintsDescription
namestringYesThe name of the attribute.
valuesarray<string>NoThe attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
collectionIdstringYesThe collection ID to count the number of objects. It allows you to specify wildcard character (*) to count objects in the all of collections in the module.
counterIdstringYespattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$Object counter ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') can be used after the first alphanumeric character but must be followed by 1+ alphanumeric characters.
frequencystringYesone of: 5s, 30s, 60sThe frequency to count objects in the areas.
namestringNoThe name of the object counter config.
objectSearchKeyPrefixesarray<string>NoThe searchKey prefixes to filter the counted objects. The object counter counts objects searched with the keywords specified here

getObjectCounterConfig — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfig — 404 response

The requested object counter config does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfig — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfig — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getObjectCounterConfig — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateObjectCounterConfig — request

Request body for Update object counter config.

PropertyTypeRequiredConstraintsDescription
areaSearchKeyPrefixstringNoThe target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributesobjectNoThe attribute names and values to search the objects.
Properties of attributes
PropertyTypeRequiredConstraintsDescription
namestringYesThe name of the attribute.
valuesarray<string>NoThe attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
frequencystringNoone of: 5s, 30s, 60sThe frequency to count objects in the areas.
namestringNoThe name of the object counter config.
objectSearchKeyPrefixesarray<string>NoThe searchKey prefixes to filter the counted objects. The object counter counts for objects searched for the keyword specified here

updateObjectCounterConfig — 400 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateObjectCounterConfig — 403 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateObjectCounterConfig — 404 response

The requested counter does not exist or is not accessible.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateObjectCounterConfig — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateObjectCounterConfig — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

updateObjectCounterConfig — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createObjectCounterConfig — request

Request body for Create object counter config.

PropertyTypeRequiredConstraintsDescription
areaSearchKeyPrefixstringYesThe target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributesobjectNoThe attribute names and values to search the objects.
Properties of attributes
PropertyTypeRequiredConstraintsDescription
namestringYesThe name of the attribute.
valuesarray<string>NoThe attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
collectionIdstringYesThe collection ID to count the number of objects. It allows you to specify wildcard character (*) to count objects in the all of collections in the module.
counterIdstringYespattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$Object counter ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') can be used after the first alphanumeric character but must be followed by 1+ alphanumeric characters.
frequencystringYesone of: 5s, 30s, 60sThe frequency to count objects in the areas.
namestringNoThe name of the object counter config.
objectSearchKeyPrefixesarray<string>NoThe searchKey prefixes to filter the counted objects. The object counter counts objects searched with the keywords specified here

createObjectCounterConfig — 400 response

Request failed because of invalid data or denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createObjectCounterConfig — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

createObjectCounterConfig — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.