Name of the Log Collection to be created. Must be unique per Project.
listProjectCustomLogData — 200 response
Successfully retrieved Log Entries.
Property
Type
Required
Constraints
Description
begin
string
No
format: date-time
The beginning of the time range for the records.
end
string
No
format: date-time
The end of the time range for the records.
limit
integer
No
min: 1
The maximum number of Log Entries returned.
records
array<object>
No
The Log Entries.
Properties of records
Property
Type
Required
Constraints
Description
createdAt
string
No
format: date-time
The creation timestamp of the Log Entry.
eventKey
string
No
The event key of the Log Entry.
fields
object
No
The fields of the Log Entry. The keys are the field names and the values are the field values.
searchKeys
array<string>
No
The search keys of the Log Entry.
timestamp
string
No
format: date-time
The timestamp of the Log Entry.
updatedAt
string
No
format: date-time
The update timestamp of the Log Entry.
skip
integer
No
min: 0
The number of Log Entries skipped.
total
integer
No
min: 0
The total number of Log Entries available.
createLogEntries — request
Request body for Create Log Entries.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
entryId
string
No
read-only (server-generated)
The unique identifier of the Log Entry.
eventKey
string
No
read-only (server-generated)
The event key of the Log Entry.
fields
object
No
The fields of the Log Entry. The keys are the field names and the values are the field values.
searchKeys
array<string>
No
The search keys of the Log Entry.
timestamp
string
No
read-only (server-generated); format: date-time
The timestamp of the Log Entry.
deleteLogEntry — 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.
deleteLogEntry — 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.
deleteLogEntry — 404 response
The required data 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.
deleteLogEntry — 409 response
The data 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.
deleteLogEntry — 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.
deleteLogEntry — 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.
deleteLogEntry — 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.
getLogEntry — 200 response
Successfully retrieved a Log Entry.
Property
Type
Required
Constraints
Description
createdAt
string
No
format: date-time
The creation timestamp of the Log Entry.
eventKey
string
No
The event key of the Log Entry.
fields
object
No
The fields of the Log Entry. The keys are the field names and the values are the field values.
searchKeys
array<string>
No
The search keys of the Log Entry.
timestamp
string
No
format: date-time
The timestamp of the Log Entry.
updatedAt
string
No
format: date-time
The update timestamp of the Log Entry.
getLogEntry — 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.
getLogEntry — 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.
getLogEntry — 404 response
The requested data 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.
getLogEntry — 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.
getLogEntry — 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.
getLogEntry — 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.
updateLogEntry — request
Request body for Update Log Entry.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
fields
object
No
The fields of the Log Entry. The keys are the field names and the values are the field values.
updateLogEntry — 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.
updateLogEntry — 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.
updateLogEntry — 404 response
The requested data 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.
updateLogEntry — 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.
updateLogEntry — 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.
updateLogEntry — 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.
getCustomLogDistinctValues — 200 response
Successfully retrieved distinct values.
Property
Type
Required
Constraints
Description
count
integer
Yes
The total number of unique values returned.
values
array<object>
Yes
An array containing the unique values found for the field. Values can be strings, numbers, or booleans.
getListDataFilters — 200 response
Successful retrieval of data filters.
Represents a data filter instance created in a project.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
areaDeterminationRules
object
No
The configuration of area determination type of data filter.
Properties of areaDeterminationRules
Property
Type
Required
Constraints
Description
forceOverwrite
boolean
No
Force overwrite the areas field in location data when it already has any areas.
searchKeyPrefixes
array<string>
No
The search key prefixes to search areas in GeoTSDB.
catalogId
string
Yes
Data Source Catalog ID of data filter.
conversionRules
object
No
The configuration of conversion type of data filter.
Properties of conversionRules
Property
Type
Required
Constraints
Description
differencing
array<object>
No
The rules for calculating the difference between a numeric value and its subsequent value.
Properties of differencing
Property
Type
Required
Constraints
Description
reset
object
No
Properties of reset
Property
Type
Required
Constraints
Description
initialValue
number
No
If the source or target value is null or the previous timestamp is over the reset interval, use the initial value instead.
resetInterval
string
No
The interval at which data is considered lost. The previous value will be replaced with the initial value if the previous timestamp is over this interval. The format is Golang's duration format, such as '1h', '30m', '5s'.
resetValue
number
No
The maximum value of the counters. If the counter reset happens, the difference is calculated from this value.
source
string
Yes
The source measurement value name. This name must be in a metric definition.
target
string
Yes
The target measurement value name. This name must be in a metric definition.
entityClass
string
No
The entity class to be used for conversion. If the destination entity's entityClass doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any entityClass.
excludes
array<string>
No
The metrics that should be omitted.
metricsDefinitionId
string
No
The metrics definition ID to be used for conversion. If the destination entity's metricsDefinitionID doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any metricsDefinitionId.
tags
array<object>
No
The rules for converting tag names from measurement to metric.
Properties of tags
Property
Type
Required
Constraints
Description
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
Yes
The name of metrics.
name
string
Yes
The name of measurement values.
replacement
array<object>
No
The rules for replace tag values from old to new.
Properties of replacement
Property
Type
Required
Constraints
Description
metricName
string
No
The to value of the replacement rule.
name
string
No
The from value of the replacement rule.
values
array<object>
No
The rules for converting numeric names from measurement to metric.
Properties of values
Property
Type
Required
Constraints
Description
copyToTag
string
No
A tag name to copy a value from the metric. If the same tag name exists in the record, this field is ignored.
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
No
The name of metrics.
name
string
Yes
The name of measurement values.
dataType
string
Yes
read-only (server-generated)
Data type of the data filter. It must be one of the supported data types: metrics and locations.
filterId
string
Yes
read-only (server-generated)
Unique Data Filter ID.
filterType
string
Yes
one of: conversion, area_determination, ellipsoid_to_orthometric_conversion
Filter type of the data filter.
name
string
No
Display name of data filter.
projectId
integer
Yes
read-only (server-generated)
Project that this data filter belongs to.
getListDataFilters — 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.
getListDataFilters — 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.
getListDataFilters — 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.
getListDataFilters — 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.
getListDataFilters — 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.
createDataFilters — request
Request body for Create data filters.
Property
Type
Required
Constraints
Description
areaDeterminationRules
object
No
The configuration of area determination type of data filter.
Properties of areaDeterminationRules
Property
Type
Required
Constraints
Description
forceOverwrite
boolean
No
Force overwrite the areas field in location data when it already has any areas.
searchKeyPrefixes
array<string>
No
The search key prefixes to search areas in GeoTSDB.
catalogId
string
Yes
Data Source Catalog ID of data filter.
conversionRules
object
No
The configuration of conversion type of data filter.
Properties of conversionRules
Property
Type
Required
Constraints
Description
differencing
array<object>
No
The rules for calculating the difference between a numeric value and its subsequent value.
Properties of differencing
Property
Type
Required
Constraints
Description
reset
object
No
Properties of reset
Property
Type
Required
Constraints
Description
initialValue
number
No
If the source or target value is null or the previous timestamp is over the reset interval, use the initial value instead.
resetInterval
string
No
The interval at which data is considered lost. The previous value will be replaced with the initial value if the previous timestamp is over this interval. The format is Golang's duration format, such as '1h', '30m', '5s'.
resetValue
number
No
The maximum value of the counters. If the counter reset happens, the difference is calculated from this value.
source
string
Yes
The source measurement value name. This name must be in a metric definition.
target
string
Yes
The target measurement value name. This name must be in a metric definition.
entityClass
string
No
The entity class to be used for conversion. If the destination entity's entityClass doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any entityClass.
excludes
array<string>
No
The metrics that should be omitted.
metricsDefinitionId
string
No
The metrics definition ID to be used for conversion. If the destination entity's metricsDefinitionID doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any metricsDefinitionId.
tags
array<object>
No
The rules for converting tag names from measurement to metric.
Properties of tags
Property
Type
Required
Constraints
Description
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
Yes
The name of metrics.
name
string
Yes
The name of measurement values.
replacement
array<object>
No
The rules for replace tag values from old to new.
Properties of replacement
Property
Type
Required
Constraints
Description
metricName
string
No
The to value of the replacement rule.
name
string
No
The from value of the replacement rule.
values
array<object>
No
The rules for converting numeric names from measurement to metric.
Properties of values
Property
Type
Required
Constraints
Description
copyToTag
string
No
A tag name to copy a value from the metric. If the same tag name exists in the record, this field is ignored.
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
No
The name of metrics.
name
string
Yes
The name of measurement values.
dataType
string
Yes
read-only (server-generated)
Data type of the data filter. It must be one of the supported data types: metrics and locations.
filterId
string
Yes
read-only (server-generated)
Unique Data Filter ID.
filterType
string
Yes
one of: conversion, area_determination, ellipsoid_to_orthometric_conversion
Filter type of the data filter.
name
string
No
Display name of data filter.
projectId
integer
Yes
read-only (server-generated)
Project that this data filter belongs to.
createDataFilters — 201 response
Successful creation of data filter.
Property
Type
Required
Constraints
Description
areaDeterminationRules
object
No
The configuration of area determination type of data filter.
Properties of areaDeterminationRules
Property
Type
Required
Constraints
Description
forceOverwrite
boolean
No
Force overwrite the areas field in location data when it already has any areas.
searchKeyPrefixes
array<string>
No
The search key prefixes to search areas in GeoTSDB.
catalogId
string
Yes
Data Source Catalog ID of data filter.
conversionRules
object
No
The configuration of conversion type of data filter.
Properties of conversionRules
Property
Type
Required
Constraints
Description
differencing
array<object>
No
The rules for calculating the difference between a numeric value and its subsequent value.
Properties of differencing
Property
Type
Required
Constraints
Description
reset
object
No
Properties of reset
Property
Type
Required
Constraints
Description
initialValue
number
No
If the source or target value is null or the previous timestamp is over the reset interval, use the initial value instead.
resetInterval
string
No
The interval at which data is considered lost. The previous value will be replaced with the initial value if the previous timestamp is over this interval. The format is Golang's duration format, such as '1h', '30m', '5s'.
resetValue
number
No
The maximum value of the counters. If the counter reset happens, the difference is calculated from this value.
source
string
Yes
The source measurement value name. This name must be in a metric definition.
target
string
Yes
The target measurement value name. This name must be in a metric definition.
entityClass
string
No
The entity class to be used for conversion. If the destination entity's entityClass doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any entityClass.
excludes
array<string>
No
The metrics that should be omitted.
metricsDefinitionId
string
No
The metrics definition ID to be used for conversion. If the destination entity's metricsDefinitionID doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any metricsDefinitionId.
tags
array<object>
No
The rules for converting tag names from measurement to metric.
Properties of tags
Property
Type
Required
Constraints
Description
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
Yes
The name of metrics.
name
string
Yes
The name of measurement values.
replacement
array<object>
No
The rules for replace tag values from old to new.
Properties of replacement
Property
Type
Required
Constraints
Description
metricName
string
No
The to value of the replacement rule.
name
string
No
The from value of the replacement rule.
values
array<object>
No
The rules for converting numeric names from measurement to metric.
Properties of values
Property
Type
Required
Constraints
Description
copyToTag
string
No
A tag name to copy a value from the metric. If the same tag name exists in the record, this field is ignored.
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
No
The name of metrics.
name
string
Yes
The name of measurement values.
dataType
string
Yes
read-only (server-generated)
Data type of the data filter. It must be one of the supported data types: metrics and locations.
filterId
string
Yes
read-only (server-generated)
Unique Data Filter ID.
filterType
string
Yes
one of: conversion, area_determination, ellipsoid_to_orthometric_conversion
Filter type of the data filter.
name
string
No
Display name of data filter.
projectId
integer
Yes
read-only (server-generated)
Project that this data filter belongs to.
createDataFilters — 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.
createDataFilters — 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.
createDataFilters — 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.
createDataFilters — 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.
createDataFilters — 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.
deleteDataFilter — 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.
deleteDataFilter — 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.
deleteDataFilter — 404 response
The required dataFilter 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.
deleteDataFilter — 409 response
The dataFilter 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.
deleteDataFilter — 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.
deleteDataFilter — 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.
deleteDataFilter — 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.
getDataFilter — 200 response
Successful retrieval of the data filter
Property
Type
Required
Constraints
Description
areaDeterminationRules
object
No
The configuration of area determination type of data filter.
Properties of areaDeterminationRules
Property
Type
Required
Constraints
Description
forceOverwrite
boolean
No
Force overwrite the areas field in location data when it already has any areas.
searchKeyPrefixes
array<string>
No
The search key prefixes to search areas in GeoTSDB.
catalogId
string
Yes
Data Source Catalog ID of data filter.
conversionRules
object
No
The configuration of conversion type of data filter.
Properties of conversionRules
Property
Type
Required
Constraints
Description
differencing
array<object>
No
The rules for calculating the difference between a numeric value and its subsequent value.
Properties of differencing
Property
Type
Required
Constraints
Description
reset
object
No
Properties of reset
Property
Type
Required
Constraints
Description
initialValue
number
No
If the source or target value is null or the previous timestamp is over the reset interval, use the initial value instead.
resetInterval
string
No
The interval at which data is considered lost. The previous value will be replaced with the initial value if the previous timestamp is over this interval. The format is Golang's duration format, such as '1h', '30m', '5s'.
resetValue
number
No
The maximum value of the counters. If the counter reset happens, the difference is calculated from this value.
source
string
Yes
The source measurement value name. This name must be in a metric definition.
target
string
Yes
The target measurement value name. This name must be in a metric definition.
entityClass
string
No
The entity class to be used for conversion. If the destination entity's entityClass doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any entityClass.
excludes
array<string>
No
The metrics that should be omitted.
metricsDefinitionId
string
No
The metrics definition ID to be used for conversion. If the destination entity's metricsDefinitionID doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any metricsDefinitionId.
tags
array<object>
No
The rules for converting tag names from measurement to metric.
Properties of tags
Property
Type
Required
Constraints
Description
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
Yes
The name of metrics.
name
string
Yes
The name of measurement values.
replacement
array<object>
No
The rules for replace tag values from old to new.
Properties of replacement
Property
Type
Required
Constraints
Description
metricName
string
No
The to value of the replacement rule.
name
string
No
The from value of the replacement rule.
values
array<object>
No
The rules for converting numeric names from measurement to metric.
Properties of values
Property
Type
Required
Constraints
Description
copyToTag
string
No
A tag name to copy a value from the metric. If the same tag name exists in the record, this field is ignored.
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
No
The name of metrics.
name
string
Yes
The name of measurement values.
dataType
string
Yes
read-only (server-generated)
Data type of the data filter. It must be one of the supported data types: metrics and locations.
filterId
string
Yes
read-only (server-generated)
Unique Data Filter ID.
filterType
string
Yes
one of: conversion, area_determination, ellipsoid_to_orthometric_conversion
Filter type of the data filter.
name
string
No
Display name of data filter.
projectId
integer
Yes
read-only (server-generated)
Project that this data filter belongs to.
getDataFilter — 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.
getDataFilter — 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.
getDataFilter — 404 response
The requested dataFilter 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.
getDataFilter — 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.
getDataFilter — 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.
getDataFilter — 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.
updateDataFilter — request
Request body for Update data filter.
Property
Type
Required
Constraints
Description
areaDeterminationRules
object
No
The configuration of area determination type of data filter.
Properties of areaDeterminationRules
Property
Type
Required
Constraints
Description
forceOverwrite
boolean
No
Force overwrite the areas field in location data when it already has any areas.
searchKeyPrefixes
array<string>
No
The search key prefixes to search areas in GeoTSDB.
catalogId
string
Yes
Data Source Catalog ID of data filter.
conversionRules
object
No
The configuration of conversion type of data filter.
Properties of conversionRules
Property
Type
Required
Constraints
Description
differencing
array<object>
No
The rules for calculating the difference between a numeric value and its subsequent value.
Properties of differencing
Property
Type
Required
Constraints
Description
reset
object
No
Properties of reset
Property
Type
Required
Constraints
Description
initialValue
number
No
If the source or target value is null or the previous timestamp is over the reset interval, use the initial value instead.
resetInterval
string
No
The interval at which data is considered lost. The previous value will be replaced with the initial value if the previous timestamp is over this interval. The format is Golang's duration format, such as '1h', '30m', '5s'.
resetValue
number
No
The maximum value of the counters. If the counter reset happens, the difference is calculated from this value.
source
string
Yes
The source measurement value name. This name must be in a metric definition.
target
string
Yes
The target measurement value name. This name must be in a metric definition.
entityClass
string
No
The entity class to be used for conversion. If the destination entity's entityClass doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any entityClass.
excludes
array<string>
No
The metrics that should be omitted.
metricsDefinitionId
string
No
The metrics definition ID to be used for conversion. If the destination entity's metricsDefinitionID doesn't match, the conversion is ignored. When this field is blank, it applies to data that has any metricsDefinitionId.
tags
array<object>
No
The rules for converting tag names from measurement to metric.
Properties of tags
Property
Type
Required
Constraints
Description
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
Yes
The name of metrics.
name
string
Yes
The name of measurement values.
replacement
array<object>
No
The rules for replace tag values from old to new.
Properties of replacement
Property
Type
Required
Constraints
Description
metricName
string
No
The to value of the replacement rule.
name
string
No
The from value of the replacement rule.
values
array<object>
No
The rules for converting numeric names from measurement to metric.
Properties of values
Property
Type
Required
Constraints
Description
copyToTag
string
No
A tag name to copy a value from the metric. If the same tag name exists in the record, this field is ignored.
formula
string
No
The formula to convert measurement values to metric values. The formula must be a valid expression that can be evaluated in the context of the measurement values.
metricName
string
No
The name of metrics.
name
string
Yes
The name of measurement values.
dataType
string
Yes
read-only (server-generated)
Data type of the data filter. It must be one of the supported data types: metrics and locations.
filterId
string
Yes
read-only (server-generated)
Unique Data Filter ID.
filterType
string
Yes
one of: conversion, area_determination, ellipsoid_to_orthometric_conversion
Filter type of the data filter.
name
string
No
Display name of data filter.
projectId
integer
Yes
read-only (server-generated)
Project that this data filter belongs to.
updateDataFilter — 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.
updateDataFilter — 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.
updateDataFilter — 404 response
The requested dataFilter 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.
updateDataFilter — 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.
updateDataFilter — 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.
updateDataFilter — 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.
getDataSourceCatalogItems — 200 response
List of available data source catalog items are returned.
Definition of a data source catalog item available for a project.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
catalogItemId
string
Yes
read-only (server-generated)
The ID of a data source catalog item. Must be unique.
catalogItemType
string
Yes
one of: gatewayPeripheralModule, virtualDataObject
The type of a data source catalog item.
configurationType
string
Yes
one of: gw-discovery, gw-discovery-with-driver-setup, manual
The configuration type of a data source catalog item.
description
string
Yes
The description for a data source catalog item.
imageData
object
No
The image data for a data source catalog item.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
read-only (server-generated)
The filename of a image.
url
string
No
read-only (server-generated)
The URL to get the image file.
name
string
Yes
The name for a data source catalog item.
vendor
string
Yes
The vendor name for a data source catalog item.
getDataSourceCatalogItems — 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.
getDataSourceCatalogItems — 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.
getDataSourceCatalogItems — 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.
getDataSourceCatalogItems — 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.
getDataSourceCatalogItems — 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.
getDataSourceCatalogItem — 200 response
Data source catalog item is returned.
Property
Type
Required
Constraints
Description
catalogItemId
string
Yes
read-only (server-generated)
The ID of a data source catalog item. Must be unique.
catalogItemType
string
Yes
one of: gatewayPeripheralModule, virtualDataObject
The type of a data source catalog item.
configurationType
string
Yes
one of: gw-discovery, gw-discovery-with-driver-setup, manual
The configuration type of a data source catalog item.
description
string
Yes
The description for a data source catalog item.
imageData
object
No
The image data for a data source catalog item.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
read-only (server-generated)
The filename of a image.
url
string
No
read-only (server-generated)
The URL to get the image file.
name
string
Yes
The name for a data source catalog item.
vendor
string
Yes
The vendor name for a data source catalog item.
getDataSourceCatalogItem — 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.
getDataSourceCatalogItem — 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.
getDataSourceCatalogItem — 404 response
The requested dataSourceCatalogItem 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.
getDataSourceCatalogItem — 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.
getDataSourceCatalogItem — 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.
getDataSourceCatalogItem — 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.
getListDeviceClasses — 200 response
List of device classes are returned.
Definition of a class of devices made by a project.
Device Class ID. Must be unique within the project. Must be 3 or more lowercase alphanumeric characters; dashes ('-') and underscores ('_') may be used after the first character but must be followed by 1+ lowercase alphanumeric characters.
getListDeviceClasses — 401 response
Authorization is required to access this resource.
Device Class ID. Must be unique within the project. Must be 3 or more lowercase alphanumeric characters; dashes ('-') and underscores ('_') may be used after the first character but must be followed by 1+ lowercase alphanumeric characters.
getDeviceClass — 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.
getDeviceClass — 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.
getDeviceClass — 404 response
The requested deviceClass 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.
getDeviceClass — 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.
getDeviceClass — 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.
getDeviceClass — 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.
getListEntityInstances — 200 response
Successful retrieval of list of entity instances.
Represents an entity instance created by a project.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
attributes
object
No
The attributes that belong to the entity instance, separated as key-value pairs.
createdAt
string
No
read-only (server-generated); format: date-time
Timestamp of entity creation.
displaySettings
object
No
Various user interface settings used for display of the entity instance.
Properties of displaySettings
Property
Type
Required
Constraints
Description
description
string
No
An intuitive description for the entity instance for display.
iconData
object
No
Metadata used for the uploaded icon of the entity instance.
Properties of iconData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
imageData
object
No
Metadata used for the uploaded image of the entity instance.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
name
string
No
The display name for the entity instance.
entityClass
string
Yes
read-only (server-generated)
The entity class that the entity was instantiated from.
entityId
string
Yes
read-only (server-generated)
Unique entity ID.
homeId
integer
Yes
read-only (server-generated)
Home that this entity belongs to.
metrics
array<object>
No
read-only (server-generated)
Meta data of the metrics associated with this entity instance.
Properties of metrics
Property
Type
Required
Constraints
Description
metricsDefinitionId
string
No
Corresponding metrics definition ID in entity class.
parentId
string
No
The ID of the entity instance that is a parent of the instance.
projectId
integer
Yes
read-only (server-generated)
Project that this entity belongs to.
suspendAlertRuleEvaluationConditions
array<object>
No
An array of condition for suspending alerts, which are evaluated as if they are concatenated with OR
Properties of suspendAlertRuleEvaluationConditions
Property
Type
Required
Constraints
Description
alertConditionTypes
array<string>
No
An array of alert condition types. This allows suspending alerts based on the alert types. All rules of the specified condition type will be suspended.
from
string
No
format: date-time
Timestamp of the begin of the interval. Null applies this rule without this time constrains
includeDescendants
boolean
No
Boolean value that shows whether alert rules are suspended for only this entity or this entity and descendants
rules
array<number>
No
An array of alertRuleId. Empty array means all rules
to
string
No
format: date-time
Timestamp of the end of the interval. Null applies this rule without this time constrains
timeZone
string
Yes
read-only (server-generated)
The time zone that the entity exists in. This should be a time zone name defined in the IANA TZ Database.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings. These will override the entity class uiSettings.
updatedAt
string
No
read-only (server-generated); format: date-time
Timestamp of the last update on the entity.
getListEntityInstances — 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.
getListEntityInstances — 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.
getListEntityInstances — 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.
getListEntityInstances — 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.
getListEntityInstances — 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.
createEntityInstance — request
Request body for Create entity instance.
Property
Type
Required
Constraints
Description
attributes
object
No
The attributes that belong to the entity instance, separated as key-value pairs.
displaySettings
object
Yes
Various user interface settings used for display of the entity class. This object must contain at least the name field.
entityClass
string
Yes
The entity class that the entity will be instantiated from.
entityId
string
Yes
Unique entity ID.
homeId
number
Yes
Home that this entity belongs to.
parentId
string
No
The ID of the entity instance that is a parent of the instance.
timeZone
string
Yes
The time zone that the entity exists in. This should be a time zone name defined in the IANA TZ Database.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings. These will override the entity class uiSettings.
createEntityInstance — 201 response
Successful creation of entity instance.
Property
Type
Required
Constraints
Description
attributes
object
No
The attributes that belong to the entity instance, separated as key-value pairs.
createdAt
string
No
read-only (server-generated); format: date-time
Timestamp of entity creation.
displaySettings
object
No
Various user interface settings used for display of the entity instance.
Properties of displaySettings
Property
Type
Required
Constraints
Description
description
string
No
An intuitive description for the entity instance for display.
iconData
object
No
Metadata used for the uploaded icon of the entity instance.
Properties of iconData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
imageData
object
No
Metadata used for the uploaded image of the entity instance.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
name
string
No
The display name for the entity instance.
entityClass
string
Yes
read-only (server-generated)
The entity class that the entity was instantiated from.
entityId
string
Yes
read-only (server-generated)
Unique entity ID.
homeId
integer
Yes
read-only (server-generated)
Home that this entity belongs to.
metrics
array<object>
No
read-only (server-generated)
Meta data of the metrics associated with this entity instance.
Properties of metrics
Property
Type
Required
Constraints
Description
metricsDefinitionId
string
No
Corresponding metrics definition ID in entity class.
parentId
string
No
The ID of the entity instance that is a parent of the instance.
projectId
integer
Yes
read-only (server-generated)
Project that this entity belongs to.
suspendAlertRuleEvaluationConditions
array<object>
No
An array of condition for suspending alerts, which are evaluated as if they are concatenated with OR
Properties of suspendAlertRuleEvaluationConditions
Property
Type
Required
Constraints
Description
alertConditionTypes
array<string>
No
An array of alert condition types. This allows suspending alerts based on the alert types. All rules of the specified condition type will be suspended.
from
string
No
format: date-time
Timestamp of the begin of the interval. Null applies this rule without this time constrains
includeDescendants
boolean
No
Boolean value that shows whether alert rules are suspended for only this entity or this entity and descendants
rules
array<number>
No
An array of alertRuleId. Empty array means all rules
to
string
No
format: date-time
Timestamp of the end of the interval. Null applies this rule without this time constrains
timeZone
string
Yes
read-only (server-generated)
The time zone that the entity exists in. This should be a time zone name defined in the IANA TZ Database.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings. These will override the entity class uiSettings.
updatedAt
string
No
read-only (server-generated); format: date-time
Timestamp of the last update on the entity.
createEntityInstance — 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.
createEntityInstance — 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.
createEntityInstance — 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.
createEntityInstance — 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.
createEntityInstance — 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.
getListEntityClasses — 200 response
Successful retrieval of entity classes.
Defines a class of entities of a project.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
attributeSchema
array
No
A schema used for validating the attributes of an entity instance.
createdAt
string
No
read-only (server-generated); format: date-time
Timestamp of entity class creation.
displaySettings
object
No
Various user interface settings used for display of the entity class.
Properties of displaySettings
Property
Type
Required
Constraints
Description
description
string
No
An intuitive description for the entity class for display.
iconData
object
No
Metadata used for the uploaded icon of the entity class.
Properties of iconData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
imageData
object
No
Metadata used for the uploaded image of the entity class.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
name
string
No
The display name for the entity class.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings.
entityClass
string
Yes
read-only (server-generated)
ID of the entity class. Must be unique within a project.
metricsDefinitions
array
No
An array of metrics definitions that are applicable to this class of entities.
projectId
integer
Yes
read-only (server-generated)
Project that this entity class belongs to.
updatedAt
string
No
read-only (server-generated); format: date-time
Timestamp of the last update on the entity class.
getListEntityClasses — 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.
getListEntityClasses — 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.
getListEntityClasses — 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.
getListEntityClasses — 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.
getListEntityClasses — 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.
createEntityClass — request
Request body for Create entity class.
Property
Type
Required
Constraints
Description
attributeSchema
array
No
A schema used for validating the attributes of an entity instance.
createdAt
string
No
read-only (server-generated); format: date-time
Timestamp of entity class creation.
displaySettings
object
No
Various user interface settings used for display of the entity class.
Properties of displaySettings
Property
Type
Required
Constraints
Description
description
string
No
An intuitive description for the entity class for display.
iconData
object
No
Metadata used for the uploaded icon of the entity class.
Properties of iconData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
imageData
object
No
Metadata used for the uploaded image of the entity class.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
name
string
No
The display name for the entity class.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings.
entityClass
string
Yes
read-only (server-generated)
ID of the entity class. Must be unique within a project.
metricsDefinitions
array
No
An array of metrics definitions that are applicable to this class of entities.
projectId
integer
Yes
read-only (server-generated)
Project that this entity class belongs to.
updatedAt
string
No
read-only (server-generated); format: date-time
Timestamp of the last update on the entity class.
createEntityClass — 201 response
Successful creation of entity class.
Property
Type
Required
Constraints
Description
attributeSchema
array
No
A schema used for validating the attributes of an entity instance.
createdAt
string
No
read-only (server-generated); format: date-time
Timestamp of entity class creation.
displaySettings
object
No
Various user interface settings used for display of the entity class.
Properties of displaySettings
Property
Type
Required
Constraints
Description
description
string
No
An intuitive description for the entity class for display.
iconData
object
No
Metadata used for the uploaded icon of the entity class.
Properties of iconData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
imageData
object
No
Metadata used for the uploaded image of the entity class.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
name
string
No
The display name for the entity class.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings.
entityClass
string
Yes
read-only (server-generated)
ID of the entity class. Must be unique within a project.
metricsDefinitions
array
No
An array of metrics definitions that are applicable to this class of entities.
projectId
integer
Yes
read-only (server-generated)
Project that this entity class belongs to.
updatedAt
string
No
read-only (server-generated); format: date-time
Timestamp of the last update on the entity class.
createEntityClass — 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.
createEntityClass — 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.
createEntityClass — 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.
createEntityClass — 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.
createEntityClass — 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.
deleteEntityClass — 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.
deleteEntityClass — 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.
deleteEntityClass — 404 response
The required entityClass 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.
deleteEntityClass — 409 response
The entityClass 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.
deleteEntityClass — 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.
deleteEntityClass — 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.
deleteEntityClass — 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.
getEntityClass — 200 response
Successful retrieval of the entity class
Property
Type
Required
Constraints
Description
attributeSchema
array
No
A schema used for validating the attributes of an entity instance.
createdAt
string
No
read-only (server-generated); format: date-time
Timestamp of entity class creation.
displaySettings
object
No
Various user interface settings used for display of the entity class.
Properties of displaySettings
Property
Type
Required
Constraints
Description
description
string
No
An intuitive description for the entity class for display.
iconData
object
No
Metadata used for the uploaded icon of the entity class.
Properties of iconData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
imageData
object
No
Metadata used for the uploaded image of the entity class.
Properties of imageData
Property
Type
Required
Constraints
Description
fileName
string
No
FileName represents the name of the file uploaded.
url
string
No
A temporary signed URL for file download.
name
string
No
The display name for the entity class.
uiSettings
object
No
An opaque object used by UI applications to store any additional settings.
entityClass
string
Yes
read-only (server-generated)
ID of the entity class. Must be unique within a project.
metricsDefinitions
array
No
An array of metrics definitions that are applicable to this class of entities.
projectId
integer
Yes
read-only (server-generated)
Project that this entity class belongs to.
updatedAt
string
No
read-only (server-generated); format: date-time
Timestamp of the last update on the entity class.
getEntityClass — 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.
getEntityClass — 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.
getEntityClass — 404 response
The requested entityClass 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.
getEntityClass — 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.
getEntityClass — 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.
getEntityClass — 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.
updateEntityClass — 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.
updateEntityClass — 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.
updateEntityClass — 404 response
The requested entityClass 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.
updateEntityClass — 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.
updateEntityClass — 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.
updateEntityClass — 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.
getMetricsDataEntityClass — 200 response
The requested metrics data entries are returned.
Property
Type
Required
Constraints
Description
aggregation
string
No
read-only (server-generated); one of: avg, min, max, sum, count
Aggregation method used.
begin
string
No
read-only (server-generated)
The begin time of data entries. The format follows RFC3339.
end
string
No
read-only (server-generated)
The end time of data entries. The format follows RFC3339.
entitiesData
array<object>
No
read-only (server-generated)
Properties of entitiesData
Property
Type
Required
Constraints
Description
data
array
No
read-only (server-generated)
Collection data. Each entry is an array as tuple and the first item is timestamp of the value in RFC3339 format, followed by the selected values and tags. e.g. [["2016-01-01T00:00:00Z", 1.0, 333, "foo"], ["2016-01-02T00:00:00Z", 2.0, 299, "bar"]]
entityId
string
No
read-only (server-generated)
ID of the entity that owns the data
limit
integer
No
read-only (server-generated)
The maximum number of data entries to be fetched.
resolution
string
No
read-only (server-generated); one of: 1min, 10min, 1hour, 1day, 1week, 1month
Aggregation bucket resolution. Its value depends on the time span of the query.
ts
string
No
read-only (server-generated)
The point in time (in RFC3339) from which data entries were fetched.
getMetricsDataEntityClass — 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.
getMetricsDataEntityClass — 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.
getMetricsDataEntityClass — 404 response
The requested data 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.
getMetricsDataEntityClass — 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.
getMetricsDataEntityClass — 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.
getMetricsDataEntityClass — 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.
getProjectFiles — 200 response
Successful query for project files.
An arbitrary file associated with an entity.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
attributes
object
No
Attributes associated with the entity file, separated as key-value pairs.
contentType
string
No
MIME type of the entity file.
entityId
string
Yes
read-only (server-generated)
Entity that this entity file belongs to.
expirationDate
string
No
format: date-time
Timestamp indicating when the entity file should expire.
fileId
string
No
read-only (server-generated)
ID of the entity file.
fileName
string
No
read-only (server-generated)
Name of the entity file.
projectId
integer
Yes
read-only (server-generated)
Project that this entity file belongs to.
tags
array
No
A collection of unique string identifiers associated with the entity file.
timestamp
string
No
read-only (server-generated); format: date-time
Timestamp of the entity file.
url
string
No
A pre-signed URL for file download.
getProjectFiles — 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.
getProjectFiles — 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.
getProjectFiles — 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.
getProjectFiles — 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.
getProjectFiles — 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.
deleteProjectFile — 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.
deleteProjectFile — 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.
deleteProjectFile — 404 response
The required file 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.
deleteProjectFile — 409 response
The file 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.
deleteProjectFile — 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.
deleteProjectFile — 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.
deleteProjectFile — 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.
getProjectFileMetadata — 200 response
Successful retrieval of project file metadata.
Property
Type
Required
Constraints
Description
attributes
object
No
Attributes associated with the entity file, separated as key-value pairs.
contentType
string
No
MIME type of the entity file.
entityId
string
Yes
read-only (server-generated)
Entity that this entity file belongs to.
expirationDate
string
No
format: date-time
Timestamp indicating when the entity file should expire.
fileId
string
No
read-only (server-generated)
ID of the entity file.
fileName
string
No
read-only (server-generated)
Name of the entity file.
projectId
integer
Yes
read-only (server-generated)
Project that this entity file belongs to.
tags
array
No
A collection of unique string identifiers associated with the entity file.
timestamp
string
No
read-only (server-generated); format: date-time
Timestamp of the entity file.
url
string
No
A pre-signed URL for file download.
getProjectFileMetadata — 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.
getProjectFileMetadata — 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.
getProjectFileMetadata — 404 response
The requested file 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.
getProjectFileMetadata — 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.
getProjectFileMetadata — 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.
getProjectFileMetadata — 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.
updateProjectFileMetadata — request
Request body for Update project file metadata.
Property
Type
Required
Constraints
Description
attributes
object
No
Attributes associated with the entity file, separated as key-value pairs.
expirationDate
string
No
format: date-time
Timestamp indicating when the entity file should expire.
tags
array
No
A collection of unique string identifiers associated with the entity file.
updateProjectFileMetadata — 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.
updateProjectFileMetadata — 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.
updateProjectFileMetadata — 404 response
The requested file 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.
updateProjectFileMetadata — 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.
updateProjectFileMetadata — 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.
updateProjectFileMetadata — 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.
getProjectLogEntries — 200 response
200 response for Get Project Log Entries.
Entry in a general-purpose log.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
caller
object
No
Information about the caller (id, type, display name, sudoer).
level
integer
No
read-only (server-generated)
Log level of entry.
source
string
No
Source from where the message was generated.
text
string
No
read-only (server-generated)
Text of log message.
timestamp
string
No
read-only (server-generated); format: date-time
Timestamp of entry creation.
getProjectLogEntries — 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.
getProjectLogEntries — 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.
getProjectLogEntries — 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.
getProjectLogEntries — 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.
getProjectLogEntries — 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.
createTenant — request
Request body for Create Tenant.
Property
Type
Required
Constraints
Description
name
string
Yes
Display name of the tenant. This will be used as the name for the tenant's home.
tenant
object
Yes
Tenant-specific configuration.
Properties of tenant
Property
Type
Required
Constraints
Description
agencyAdminAccessControlGroupId
integer
Yes
min: 1
ID of the existing access control group that will serve as the agency admin for this tenant. This group will have permissions to manage the tenant's resources.
identifier
string
Yes
pattern: ^[a-z0-9-]+$
Unique identifier for the tenant within the project. Must be URL-safe and contain only lowercase letters, numbers, and hyphens. Cannot contain spaces.
timeZone
string
Yes
Time zone for the tenant's root entity. This should be a time zone name defined in the IANA TZ Database.
createTenant — 201 response
Successful creation of tenant. Returns the created home with tenant information.
Property
Type
Required
Constraints
Description
creationTime
string
No
read-only (server-generated); format: date-time
Timestamp of home creation.
deactivated
boolean
No
True if home has been deactivated by project admin.
id
integer
Yes
read-only (server-generated)
Unique ID assigned at time of creation.
name
string
Yes
Display name of home.
projectId
integer
Yes
read-only (server-generated)
Project that this home belongs to.
tenant
object
No
Tenant information associated with a home.
Properties of tenant
Property
Type
Required
Constraints
Description
agencyAdminAccessControlGroupId
integer
Yes
read-only (server-generated)
ID of the access control group that serves as the agency admin for this tenant.
identifier
string
Yes
read-only (server-generated)
Unique identifier for the tenant within the project.
tenantAdminAccessControlGroupId
integer
Yes
read-only (server-generated)
ID of the access control group that serves as the tenant admin for this tenant.
createTenant — 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.
createTenant — 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.
createTenant — 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.
createTenant — 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.
deleteTenant — 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.
deleteTenant — 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.
deleteTenant — 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.
deleteTenant — 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.
updateTenantInformation — request
Request body for Update the Tenant information.
Property
Type
Required
Constraints
Description
identifier
string
No
pattern: ^[a-z0-9-]+$
Unique identifier for the tenant within the project. Must be URL-safe and contain only lowercase letters, numbers, and hyphens. Cannot contain spaces.
updateTenantInformation — 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.
updateTenantInformation — 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.
updateTenantInformation — 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.
updateTenantInformation — 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.
listTSDBv2Schemas — 200 response
Successfully retrieved list of schemas.
Response body from creating or retrieving a schema.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
metrics
array<object>
No
Properties of metrics
Property
Type
Required
Constraints
Description
name
string
Yes
read-only (server-generated)
Name of the metric.
tags
array<object>
No
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
name
string
No
read-only (server-generated)
Name of the schema.
totalMetrics
integer
No
read-only (server-generated)
Total number of metrics in schema.
listTSDBv2Schemas — 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.
listTSDBv2Schemas — 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.
listTSDBv2Schemas — 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.
listTSDBv2Schemas — 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.
listTSDBv2Schemas — 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.
createTSDBv2Schema — request
Request body for Create TSDBv2 Schema.
Property
Type
Required
Constraints
Description
metrics
array<object>
Yes
One or more metrics to be included in the schema.
Properties of metrics
Property
Type
Required
Constraints
Description
name
string
Yes
Name of the metric to be created.
tags
array<object>
No
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
name
string
Yes
Name of the schema to be created.
createTSDBv2Schema — 201 response
Successfully created the schema.
Property
Type
Required
Constraints
Description
metrics
array<object>
No
Properties of metrics
Property
Type
Required
Constraints
Description
name
string
Yes
read-only (server-generated)
Name of the metric.
tags
array<object>
No
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
name
string
No
read-only (server-generated)
Name of the schema.
totalMetrics
integer
No
read-only (server-generated)
Total number of metrics in schema.
createTSDBv2Schema — 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.
createTSDBv2Schema — 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.
createTSDBv2Schema — 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.
createTSDBv2Schema — 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.
createTSDBv2Schema — 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.
deleteTSDBv2Schema — 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.
deleteTSDBv2Schema — 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.
deleteTSDBv2Schema — 404 response
The required schema 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.
deleteTSDBv2Schema — 409 response
The schema 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.
deleteTSDBv2Schema — 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.
deleteTSDBv2Schema — 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.
deleteTSDBv2Schema — 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.
getTSDBv2Schema — 200 response
Successfully retrieved the schema.
Property
Type
Required
Constraints
Description
metrics
array<object>
No
Properties of metrics
Property
Type
Required
Constraints
Description
name
string
Yes
read-only (server-generated)
Name of the metric.
tags
array<object>
No
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
name
string
No
read-only (server-generated)
Name of the schema.
totalMetrics
integer
No
read-only (server-generated)
Total number of metrics in schema.
getTSDBv2Schema — 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.
getTSDBv2Schema — 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.
getTSDBv2Schema — 404 response
The requested schema 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.
getTSDBv2Schema — 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.
getTSDBv2Schema — 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.
getTSDBv2Schema — 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.
getTSDBv2Metrics — 200 response
Successfully retrieved the metrics.
Property
Type
Required
Constraints
Description
entries
array<object>
No
Metrics in the schema.
Properties of entries
Property
Type
Required
Constraints
Description
name
string
Yes
read-only (server-generated)
Name of the metric.
tags
array<object>
No
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
nextToken
string
No
Token for additional metrics. A non-empty token indicates additional metrics are available and can be used to retrieve the next set of metrics by reissuing the request with this token. An empty token means there are no more metrics to retrieve.
getTSDBv2Metrics — 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.
getTSDBv2Metrics — 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.
getTSDBv2Metrics — 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.
getTSDBv2Metrics — 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.
getTSDBv2Metrics — 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.
createTSDBv2Metric — request
Request body for Create TSDBv2 Metric.
Property
Type
Required
Constraints
Description
name
string
Yes
Name of the metric.
tags
array<object>
No
Key and optional value pairs that can be used to filter metrics.
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
type
string
No
one of: float, string
Data type of this metric. The default is float.
createTSDBv2Metric — 201 response
Successfully created the metric.
Property
Type
Required
Constraints
Description
name
string
Yes
Name of the metric.
tags
array<object>
No
Key and optional value pairs that can be used to filter metrics.
Properties of tags
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
type
string
No
one of: float, string
Data type of this metric. The default is float.
createTSDBv2Metric — 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.
createTSDBv2Metric — 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.
createTSDBv2Metric — 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.
createTSDBv2Metric — 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.
createTSDBv2Metric — 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.
updateTSDBv2MetricTags — request
Request body for Update TSDBv2 Metric Tags.
A key and optional value pair that can be used to filter metrics.
An array of objects with the following shape:
Property
Type
Required
Constraints
Description
key
string
Yes
Name of the metric tag.
value
string
No
Value of the metric tag.
createProjectUploadFile — request
Request body for Upload a file.
Property
Type
Required
Constraints
Description
action
string
Yes
one of: open-upload, close-upload
Action to be taken.
metadata
object
No
Metadata for the file. Required for the open-upload action.
Properties of metadata
Property
Type
Required
Constraints
Description
attributes
string
No
Type of the file.
contentType
string
No
Type of the entity instance.
expirationDate
string
No
Name of the file.
fileName
integer
No
Size of the file.
tags
string
No
ID of the file.
timestamp
string
No
ID of the entity instance.
numberOfParts
integer
No
Optional number of parts to split the upload into. Defaults to 1.
uploadId
string
No
Upload ID returned from the open-upload action. Required for the close-upload action.
createProjectUploadFile — 200 response
For the open-upload action, this represents a successful start of the upload for a file. The response
body is a JSON object that contains an array of pre-signed upload URLs. The
client should divide up the file in the same number of parts as the number of URLs,
and upload each part to its corresponding URL with a PUT request.
Property
Type
Required
Constraints
Description
uploadId
string
No
Upload ID returned from the open-upload action.
urls
array<string>
No
URL to upload the entity file, or, URLs to upload each part of the entity file.
createProjectUploadFile — 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.
createProjectUploadFile — 403 response
Request failed because of invalid data or denied permission.