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.
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.
moduleId
string
No
read-only (server-generated)
ID of Smart Module that created this collection.
getGeospatialTimeSeriesCollection — 403 response
Request failed because of denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeospatialTimeSeriesCollection — 404 response
The requested geospatial time series collection is not found.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeospatialTimeSeriesCollection — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeospatialTimeSeriesCollection — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeospatialTimeSeriesCollection — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateCollection — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateCollection — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateCollection — 404 response
The requested collection does not exist or is not accessible.
The requested historical counted data entries are returned.
Property
Type
Required
Constraints
Description
collectionId
string
Yes
read-only (server-generated)
Identifier of the GeoTSDB collection.
counterId
string
No
read-only (server-generated)
Identifier of the object counter.
data
array<object>
Yes
read-only (server-generated)
The array of count data per area.
Properties of data
Property
Type
Required
Constraints
Description
areaId
string
No
read-only (server-generated)
The area ID of the count data.
count
number
No
read-only (server-generated)
The the number of object in the area.
timestamp
string
No
read-only (server-generated)
Time in RFC3339 format.
timestamp
string
Yes
read-only (server-generated)
Time in RFC3339 format.
getHistoricalCountedTimeSeriesData — 403 response
Request failed because of denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getHistoricalCountedTimeSeriesData — 404 response
Any requested historical object counted data entries are not found.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getHistoricalCountedTimeSeriesData — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getHistoricalCountedTimeSeriesData — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCollectionData — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCollectionData — 404 response
The required data entry does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-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.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCollectionData — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCollectionData — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeoJSONFormattedGeospatialData — 200 response
The requested geospatial data entries are returned.
Property
Type
Required
Constraints
Description
begin
string
No
read-only (server-generated)
The begin time of data entries. The format follows RFC3339.
collectionId
string
No
read-only (server-generated)
Identifier of the GeoTSDB collection.
data
array<object>
No
read-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
Property
Type
Required
Constraints
Description
areas
array<object>
No
Properties of areas
Property
Type
Required
Constraints
Description
areaClass
string
No
areaId
string
Yes
distance
number
Yes
attributes
object
No
read-only (server-generated)
The attributes that belong to the location, separated as key-value pairs.
createdAt
string
No
Created date time in RFC3339 format.
floorId
number
Yes
read-only (server-generated)
The floor ID of the location
geometry
object
Yes
read-only (server-generated)
The GeoJSON object of the location.
searchKey
string
Yes
read-only (server-generated)
The string attached to the location.
timestamp
string
Yes
read-only (server-generated)
Time in RFC3339 format.
end
string
No
read-only (server-generated)
The end time of data entries. The format follows RFC3339.
getGeoJSONFormattedGeospatialData — 403 response
Request failed because of denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeoJSONFormattedGeospatialData — 404 response
Any requested geospatial data entries are not found.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeoJSONFormattedGeospatialData — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeoJSONFormattedGeospatialData — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getGeoJSONFormattedGeospatialData — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createData — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createData — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createData — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createData — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createData — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCount — 401 response
Authorization is required to access this resource.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCount — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCount — 404 response
The required count does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-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.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCount — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCount — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteCount — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getCurrentNumberObjectsAreas — 200 response
The requested counted data entries are returned.
Property
Type
Required
Constraints
Description
collectionId
string
Yes
read-only (server-generated)
Identifier of the GeoTSDB collection.
data
array<object>
Yes
read-only (server-generated)
The array of count data per area.
Properties of data
Property
Type
Required
Constraints
Description
areaId
string
No
read-only (server-generated)
The area ID of the count data.
count
number
No
read-only (server-generated)
The the number of object in the area.
timestamp
string
Yes
read-only (server-generated)
Time in RFC3339 format.
getCurrentNumberObjectsAreas — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getCurrentNumberObjectsAreas — 404 response
Any requested object counted data entries are not found.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getCurrentNumberObjectsAreas — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getCurrentNumberObjectsAreas — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getCurrentNumberObjectsAreas — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-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:
Property
Type
Required
Constraints
Description
areaSearchKeyPrefix
string
Yes
The target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributes
object
No
The attribute names and values to search the objects.
Properties of attributes
Property
Type
Required
Constraints
Description
name
string
Yes
The name of the attribute.
values
array<string>
No
The attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
collectionId
string
Yes
The 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.
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.
frequency
string
Yes
one of: 5s, 30s, 60s
The frequency to count objects in the areas.
name
string
No
The name of the object counter config.
objectSearchKeyPrefixes
array<string>
No
The 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.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfigs — 404 response
Any requested object counter config data entries are not found.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfigs — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfigs — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfigs — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteObjectCounterConfig — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteObjectCounterConfig — 404 response
The required object counter config does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-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.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteObjectCounterConfig — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteObjectCounterConfig — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
deleteObjectCounterConfig — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfig — 200 response
The object counter config is returned.
Property
Type
Required
Constraints
Description
areaSearchKeyPrefix
string
Yes
The target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributes
object
No
The attribute names and values to search the objects.
Properties of attributes
Property
Type
Required
Constraints
Description
name
string
Yes
The name of the attribute.
values
array<string>
No
The attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
collectionId
string
Yes
The 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.
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.
frequency
string
Yes
one of: 5s, 30s, 60s
The frequency to count objects in the areas.
name
string
No
The name of the object counter config.
objectSearchKeyPrefixes
array<string>
No
The 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.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfig — 404 response
The requested object counter config does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfig — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfig — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
getObjectCounterConfig — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateObjectCounterConfig — request
Request body for Update object counter config.
Property
Type
Required
Constraints
Description
areaSearchKeyPrefix
string
No
The target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributes
object
No
The attribute names and values to search the objects.
Properties of attributes
Property
Type
Required
Constraints
Description
name
string
Yes
The name of the attribute.
values
array<string>
No
The attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
frequency
string
No
one of: 5s, 30s, 60s
The frequency to count objects in the areas.
name
string
No
The name of the object counter config.
objectSearchKeyPrefixes
array<string>
No
The 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.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateObjectCounterConfig — 403 response
Request failed because of invalid data or denied permission.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateObjectCounterConfig — 404 response
The requested counter does not exist or is not accessible.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateObjectCounterConfig — 429 response
Request failed because of rate limit.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateObjectCounterConfig — 500 response
An unexpected error has occurred.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
updateObjectCounterConfig — 503 response
The service is temporarily unavailable.
Property
Type
Required
Constraints
Description
data
object
No
read-only (server-generated)
Any relevant data related to error.
reason
string
Yes
read-only (server-generated)
Reason of error.
createObjectCounterConfig — request
Request body for Create object counter config.
Property
Type
Required
Constraints
Description
areaSearchKeyPrefix
string
Yes
The target area ID prefix. The object counter counts objects in the found area and stores the results per area.
attributes
object
No
The attribute names and values to search the objects.
Properties of attributes
Property
Type
Required
Constraints
Description
name
string
Yes
The name of the attribute.
values
array<string>
No
The attribute values to search objects. When this values are not specified, use the search string in the area's attribute value.
collectionId
string
Yes
The 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.
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.
frequency
string
Yes
one of: 5s, 30s, 60s
The frequency to count objects in the areas.
name
string
No
The name of the object counter config.
objectSearchKeyPrefixes
array<string>
No
The 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.