Infravista API (1.0.0)

Download OpenAPI specification:

Site

List all site names that have checklists

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json

["string"
]

Get the checklist for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
site required	string

Responses

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Create or update the checklist for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
site required	string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Delete the checklist for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
site required	string

Responses

List sites

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Create site

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects (SiteVersionResponse)

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get site by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Update site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Delete site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get action logs for site by numeric ID or site key

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"time": "string",
"entity": "string",
"action": "string",
"changes": { },
"actorId": "string",
"actorUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get alarms for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "string",
"clearedAt": "string",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"measurementChannel": {"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
},
"events": [{"id": 9007199254740991,
"alarmId": 9007199254740991,
"measurementId": 9007199254740991,
"time": "string",
"type": "triggered",
"severity": "minor",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"measurement": {"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}
}
]
}
]

Get devices for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get site energy aggregates

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

query Parameters

from required	string
to required	string
granularity	string (SiteEnergyGranularity) Default: "hourly" Enum: "hourly" "monthly"

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"from": "string",
"to": "string",
"granularity": "hourly",
"points": [{"time": "string",
"total": 0,
"main": 0,
"radio": 0,
"aircon": 0,
"ventilation": 0,
"solar": 0,
"coverage": 1
}
]
}

Get equipments for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Get latest full equipments for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"equipmentId": 9007199254740991,
"version": 9007199254740991,
"equipmentCategoryId": 9007199254740991,
"equipmentTypeId": 9007199254740991,
"equipmentManufacturerId": 9007199254740991,
"name": "string",
"description": "string",
"note": "string",
"quantity": -9007199254740991,
"position": "string",
"erpReferences": "string",
"voltage": 0,
"price": 0,
"currency": "string",
"status": "active",
"statusUpdatedAt": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"attributeValues": [{"id": 9007199254740991,
"equipmentVersionId": 9007199254740991,
"equipmentAttributeId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"valueTimestamp": "string"
}
]
}
}
]

Get energy forecast for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

query Parameters

range

string

Default: "30d"

Value: "30d"

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"range": "string",
"energyRadio": 0,
"energyAircon": 0,
"energyVentilation": 0
}

Get site (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"versions": [{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"thumbnailFile": {"id": 9007199254740991,
"bucket": "string",
"key": "string",
"status": "pending",
"fileName": "string",
"fileUpdatedAt": "string",
"sha256": "string",
"size": -9007199254740991,
"contentType": "string",
"metadata": { },
"expiresAt": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}

Get latest site (full)

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}

Get last-known relay status for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"relays": [{"portNr": "string",
"active": true
}
],
"updatedAt": "string"
}

Update relay status for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

required

Array of objects (Relay) = 2 items

Responses

Request samples

Payload

Content type

application/json

{"relays": [{"portNr": "string",
"active": true
},
{"portNr": "string",
"active": true
}
]
}

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"relays": [{"portNr": "string",
"active": true
}
],
"updatedAt": "string"
}

Get last-known ventilation settings for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"settings": [{"offTemp": 0,
"idleOnTemp": 0,
"idleEntryTemp": 0,
"midPoint1Temp": 0,
"setPointTemp": 0,
"midPoint2Temp": 0,
"highSpeedTemp": 0,
"extndHsEntryTemp": 0,
"extndHsExitTemp": 0,
"idleRpm": 0,
"midPointRpm": 0,
"highSpeedRpm": 0,
"idleDutyCycle": 0,
"midDutyCycle": 0,
"highSpeedDutyCycle": 0,
"extndHsDutyCycle": 0,
"boostDutyCycle": 0,
"tachoPulse": -9007199254740991,
"tachoControl": 1,
"ctrlType": 1,
"enable": 1
}
],
"updatedAt": "string"
}

Update ventilation settings for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

required

Array of objects (VentilationSettings) = 2 items

Responses

Request samples

Payload

Content type

application/json

{"settings": [{"offTemp": 0,
"idleOnTemp": 0,
"idleEntryTemp": 0,
"midPoint1Temp": 0,
"setPointTemp": 0,
"midPoint2Temp": 0,
"highSpeedTemp": 0,
"extndHsEntryTemp": 0,
"extndHsExitTemp": 0,
"idleRpm": 0,
"midPointRpm": 0,
"highSpeedRpm": 0,
"idleDutyCycle": 0,
"midDutyCycle": 0,
"highSpeedDutyCycle": 0,
"extndHsDutyCycle": 0,
"boostDutyCycle": 0,
"tachoPulse": 1,
"tachoControl": 1,
"ctrlType": 1,
"enable": 1
},
{"offTemp": 0,
"idleOnTemp": 0,
"idleEntryTemp": 0,
"midPoint1Temp": 0,
"setPointTemp": 0,
"midPoint2Temp": 0,
"highSpeedTemp": 0,
"extndHsEntryTemp": 0,
"extndHsExitTemp": 0,
"idleRpm": 0,
"midPointRpm": 0,
"highSpeedRpm": 0,
"idleDutyCycle": 0,
"midDutyCycle": 0,
"highSpeedDutyCycle": 0,
"extndHsDutyCycle": 0,
"boostDutyCycle": 0,
"tachoPulse": 1,
"tachoControl": 1,
"ctrlType": 1,
"enable": 1
}
]
}

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"settings": [{"offTemp": 0,
"idleOnTemp": 0,
"idleEntryTemp": 0,
"midPoint1Temp": 0,
"setPointTemp": 0,
"midPoint2Temp": 0,
"highSpeedTemp": 0,
"extndHsEntryTemp": 0,
"extndHsExitTemp": 0,
"idleRpm": 0,
"midPointRpm": 0,
"highSpeedRpm": 0,
"idleDutyCycle": 0,
"midDutyCycle": 0,
"highSpeedDutyCycle": 0,
"extndHsDutyCycle": 0,
"boostDutyCycle": 0,
"tachoPulse": -9007199254740991,
"tachoControl": 1,
"ctrlType": 1,
"enable": 1
}
],
"updatedAt": "string"
}

Get site infrabox information

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"siteKey": "string",
"boxNumber": "string",
"mountingLocation": "string",
"status": "online",
"updatedAt": "string",
"devices": [{"id": 9007199254740991,
"key": "string",
"location": "string",
"updatedAt": "string"
}
]
}

Get site measurement insights

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

query Parameters

from required	string
to required	string
resolution	string (SiteOverviewResolution) Default: "hourly" Enum: "hourly" "daily" "weekly"

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"from": "string",
"to": "string",
"metrics": [{"metric": "string",
"average": 0,
"minimum": 0,
"maximum": 0,
"p25": 0,
"p50": 0,
"p75": 0,
"count": 9007199254740991
}
],
"details": {"observedBuckets": 9007199254740991,
"expectedHourlyBuckets": 9007199254740991,
"coverage": 1,
"bucketMinutes": 9007199254740991,
"zeroValuePercentages": {"property1": 100,
"property2": 100
}
},
"temperatureHistogram": [{"metric": "string",
"start": 0,
"size": 0,
"frequency": 1
}
],
"powerHistogram": [{"metric": "string",
"start": 0,
"size": 0,
"frequency": 1
}
],
"histogramSource": "aggregate-buckets"
}

Get latest site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}

Get latest site measurements

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"updatedAt": "string",
"measurements": [{"measurementChannelId": 9007199254740991,
"metric": "string",
"definitionKey": "string",
"time": "string",
"value": 0
}
]
}

Get measurement channels for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get notes for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Get latest full notes for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"noteId": 9007199254740991,
"version": 9007199254740991,
"title": "string",
"description": "string",
"referenceTime": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"files": [{"id": 9007199254740991,
"noteVersionId": 9007199254740991,
"fileId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"createdAt": "string",
"file": {"id": 9007199254740991,
"bucket": "string",
"key": "string",
"status": "pending",
"fileName": "string",
"fileUpdatedAt": "string",
"sha256": "string",
"size": -9007199254740991,
"contentType": "string",
"metadata": { },
"expiresAt": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
}
]

Get site overcooling events

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"time": "string",
"totalPower": 0,
"airconPower": 0,
"ventilationPower": 0,
"indoorTemperature": 0
}
]

Get properties for site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get site telemetry aggregates

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

query Parameters

from required	string
to required	string
resolution	string (SiteOverviewResolution) Default: "hourly" Enum: "hourly" "daily" "weekly"

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"from": "string",
"to": "string",
"resolution": "hourly",
"series": [{"measurementChannelId": 9007199254740991,
"metric": "string",
"definitionKey": "string",
"points": [{"time": "string",
"average": 0,
"sum": 0,
"minimum": 0,
"maximum": 0,
"count": 9007199254740991
}
]
}
]
}

Get site versions

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Get current weather and 5-day forecast for site location

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"siteId": 9007199254740991,
"current": {"conditions": [{"id": -9007199254740991,
"main": "string",
"description": "string",
"icon": "string"
}
],
"main": {"temp": 0,
"feelsLike": 0,
"tempMin": 0,
"tempMax": 0,
"pressure": 0,
"humidity": 0
},
"wind": {"speed": 0,
"deg": 0
}
},
"forecast": [{"dt": -9007199254740991,
"conditions": [{"id": -9007199254740991,
"main": "string",
"description": "string",
"icon": "string"
}
],
"main": {"temp": 0,
"feelsLike": 0,
"tempMin": 0,
"tempMax": 0,
"pressure": 0,
"humidity": 0
},
"wind": {"speed": 0,
"deg": 0
}
}
]
}

List all external device records for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
],
"nextToken": "string"
}

List aggregated external device records for a site (not yet implemented)

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

[{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
]

List external device change records for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
],
"nextToken": "string"
}

List aggregated external device changes for a site (not yet implemented)

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
],
"nextToken": "string"
}

List external devices for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

[{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
]

Get a specific external device for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string
deviceId required	string

Responses

Response samples

200

Content type

application/json

[{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
]

List latest external device records for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

[{"time": "string",
"ID": "string",
"Site": "string",
"BoxNr": "string",
"measure_name": "string",
"Value_BOOLEAN": true,
"Value_VARCHAR": "string",
"Value_DOUBLE": 0,
"UpdatedOn": "string",
"Deleted": true
}
]

Get latest modbus device payload for a site/device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string
deviceName required	string
deviceId required	string

Responses

Response samples

200

Content type

application/json

{"measure_name": "string",
"DeviceID": "string",
"Site": "string",
"BoxNr": "string",
"time": "string",
"UpdatedOn": "string",
"InstalledOn": "string",
"property1": null,
"property2": null
}

Get averaged modbus device field history

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string
deviceName required	string
deviceId required	string

query Parameters

field required	string^[A-Za-z0-9_]+$
startDate required	string
endDate	string

Responses

Response samples

200

Content type

application/json

[{"time": "string",
"value": "string"
}
]

Get paginated modbus device field change history

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string
deviceName required	string
deviceId required	string

query Parameters

field required	string^[A-Za-z0-9_]+$
maxRows	integer ( 0 .. 9007199254740991 ]
token	string

Responses

Response samples

200

Content type

application/json

{"rows": [{"time": "string",
"value": "string"
}
],
"nextToken": "string"
}

Get a compact health snapshot for a site

Authorizations:

CognitoAuth

path Parameters

tenant required	string
siteId required	string

Responses

Response samples

200

Content type

application/json

{"Site": "string",
"BoxNr": "string",
"Status": "Online",
"time": "string",
"TempIndoor": "string",
"NrOfAlarms": -9007199254740991,
"ClimateProfile": "string"
}

Get aggregate energy across all sites

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

from	string
to	string
startDate	string
endDate	string

Responses

Response samples

200

Content type

application/json

{"EnergyTotal": 0,
"EnergyMain": 0,
"EnergyRadio": 0,
"EnergyAircon": 0,
"EnergyVentilation": 0,
"EnergySolar": 0,
"CostTotal": 0,
"CostMain": 0,
"CostRadio": 0,
"CostAircon": 0,
"CostVentilation": 0,
"CostSolar": 0
}

List sites (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"versions": [{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"thumbnailFile": {"id": 9007199254740991,
"bucket": "string",
"key": "string",
"status": "pending",
"fileName": "string",
"fileUpdatedAt": "string",
"sha256": "string",
"size": -9007199254740991,
"contentType": "string",
"metadata": { },
"expiresAt": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
]

List latest sites (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}
]

List latest site versions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"key": "string",
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

List site quick statuses

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

siteId[in]	string
siteId	integer [ 0 .. 9007199254740991 ]

Responses

Response samples

200

Content type

application/json

[{"siteId": 9007199254740991,
"siteKey": "string",
"infraboxStatus": "online",
"updatedAt": "string",
"channels": [{"measurementChannelId": 9007199254740991,
"status": "online",
"updatedAt": "string",
"metric": "string",
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991
}
]
}
]

Site Version

List site versions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
name	string non-empty name equals
name[eq]	string non-empty name equals
name[ne]	string non-empty name not equals
name[in]	string name in comma-separated list
name[notIn]	string name not in comma-separated list
name[isNull]	boolean name is null Value: true
name[isNotNull]	boolean name is not null Value: true
name[like]	string name matches pattern (case-sensitive)
name[ilike]	string name matches pattern (case-insensitive)
name[notLike]	string name does not match pattern (case-sensitive)
name[notIlike]	string name does not match pattern (case-insensitive)
thumbnailFileId	number thumbnailFileId equals
thumbnailFileId[eq]	number thumbnailFileId equals
thumbnailFileId[ne]	number thumbnailFileId not equals
thumbnailFileId[in]	string thumbnailFileId in comma-separated list
thumbnailFileId[notIn]	string thumbnailFileId not in comma-separated list
thumbnailFileId[isNull]	boolean thumbnailFileId is null Value: true
thumbnailFileId[isNotNull]	boolean thumbnailFileId is not null Value: true
thumbnailFileId[gt]	number thumbnailFileId greater than
thumbnailFileId[gte]	number thumbnailFileId greater than or equal to
thumbnailFileId[lt]	number thumbnailFileId less than
thumbnailFileId[lte]	number thumbnailFileId less than or equal to
climateProfile	string (ClimateProfile) Enum: "aircon" "ventilation_ac" "ventilation_dc" "combination_ac" climateProfile equals
climateProfile[eq]	string (ClimateProfile) Enum: "aircon" "ventilation_ac" "ventilation_dc" "combination_ac" climateProfile equals
climateProfile[ne]	string (ClimateProfile) Enum: "aircon" "ventilation_ac" "ventilation_dc" "combination_ac" climateProfile not equals
climateProfile[in]	string climateProfile in comma-separated list
climateProfile[notIn]	string climateProfile not in comma-separated list
climateProfile[isNull]	boolean climateProfile is null Value: true
climateProfile[isNotNull]	boolean climateProfile is not null Value: true
type	string type equals
type[eq]	string type equals
type[ne]	string type not equals
type[in]	string type in comma-separated list
type[notIn]	string type not in comma-separated list
type[isNull]	boolean type is null Value: true
type[isNotNull]	boolean type is not null Value: true
type[like]	string type matches pattern (case-sensitive)
type[ilike]	string type matches pattern (case-insensitive)
type[notLike]	string type does not match pattern (case-sensitive)
type[notIlike]	string type does not match pattern (case-insensitive)
street	string street equals
street[eq]	string street equals
street[ne]	string street not equals
street[in]	string street in comma-separated list
street[notIn]	string street not in comma-separated list
street[isNull]	boolean street is null Value: true
street[isNotNull]	boolean street is not null Value: true
street[like]	string street matches pattern (case-sensitive)
street[ilike]	string street matches pattern (case-insensitive)
street[notLike]	string street does not match pattern (case-sensitive)
street[notIlike]	string street does not match pattern (case-insensitive)
city	string city equals
city[eq]	string city equals
city[ne]	string city not equals
city[in]	string city in comma-separated list
city[notIn]	string city not in comma-separated list
city[isNull]	boolean city is null Value: true
city[isNotNull]	boolean city is not null Value: true
city[like]	string city matches pattern (case-sensitive)
city[ilike]	string city matches pattern (case-insensitive)
city[notLike]	string city does not match pattern (case-sensitive)
city[notIlike]	string city does not match pattern (case-insensitive)
zip	string zip equals
zip[eq]	string zip equals
zip[ne]	string zip not equals
zip[in]	string zip in comma-separated list
zip[notIn]	string zip not in comma-separated list
zip[isNull]	boolean zip is null Value: true
zip[isNotNull]	boolean zip is not null Value: true
zip[like]	string zip matches pattern (case-sensitive)
zip[ilike]	string zip matches pattern (case-insensitive)
zip[notLike]	string zip does not match pattern (case-sensitive)
zip[notIlike]	string zip does not match pattern (case-insensitive)
state	string state equals
state[eq]	string state equals
state[ne]	string state not equals
state[in]	string state in comma-separated list
state[notIn]	string state not in comma-separated list
state[isNull]	boolean state is null Value: true
state[isNotNull]	boolean state is not null Value: true
state[like]	string state matches pattern (case-sensitive)
state[ilike]	string state matches pattern (case-insensitive)
state[notLike]	string state does not match pattern (case-sensitive)
state[notIlike]	string state does not match pattern (case-insensitive)
region	string region equals
region[eq]	string region equals
region[ne]	string region not equals
region[in]	string region in comma-separated list
region[notIn]	string region not in comma-separated list
region[isNull]	boolean region is null Value: true
region[isNotNull]	boolean region is not null Value: true
region[like]	string region matches pattern (case-sensitive)
region[ilike]	string region matches pattern (case-insensitive)
region[notLike]	string region does not match pattern (case-sensitive)
region[notIlike]	string region does not match pattern (case-insensitive)
country	string country equals
country[eq]	string country equals
country[ne]	string country not equals
country[in]	string country in comma-separated list
country[notIn]	string country not in comma-separated list
country[isNull]	boolean country is null Value: true
country[isNotNull]	boolean country is not null Value: true
country[like]	string country matches pattern (case-sensitive)
country[ilike]	string country matches pattern (case-insensitive)
country[notLike]	string country does not match pattern (case-sensitive)
country[notIlike]	string country does not match pattern (case-insensitive)
measurementsValidFrom	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom equals
measurementsValidFrom[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom equals
measurementsValidFrom[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom not equals
measurementsValidFrom[in]	string measurementsValidFrom in comma-separated list
measurementsValidFrom[notIn]	string measurementsValidFrom not in comma-separated list
measurementsValidFrom[isNull]	boolean measurementsValidFrom is null Value: true
measurementsValidFrom[isNotNull]	boolean measurementsValidFrom is not null Value: true
measurementsValidFrom[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom greater than
measurementsValidFrom[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom greater than or equal to
measurementsValidFrom[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom less than
measurementsValidFrom[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom less than or equal to
currency	string currency equals
currency[eq]	string currency equals
currency[ne]	string currency not equals
currency[in]	string currency in comma-separated list
currency[notIn]	string currency not in comma-separated list
currency[isNull]	boolean currency is null Value: true
currency[isNotNull]	boolean currency is not null Value: true
currency[like]	string currency matches pattern (case-sensitive)
currency[ilike]	string currency matches pattern (case-insensitive)
currency[notLike]	string currency does not match pattern (case-sensitive)
currency[notIlike]	string currency does not match pattern (case-insensitive)
costPerKwh	number costPerKwh equals
costPerKwh[eq]	number costPerKwh equals
costPerKwh[ne]	number costPerKwh not equals
costPerKwh[in]	string costPerKwh in comma-separated list
costPerKwh[notIn]	string costPerKwh not in comma-separated list
costPerKwh[isNull]	boolean costPerKwh is null Value: true
costPerKwh[isNotNull]	boolean costPerKwh is not null Value: true
costPerKwh[gt]	number costPerKwh greater than
costPerKwh[gte]	number costPerKwh greater than or equal to
costPerKwh[lt]	number costPerKwh less than
costPerKwh[lte]	number costPerKwh less than or equal to
locationLatitude	number locationLatitude equals
locationLatitude[eq]	number locationLatitude equals
locationLatitude[ne]	number locationLatitude not equals
locationLatitude[in]	string locationLatitude in comma-separated list
locationLatitude[notIn]	string locationLatitude not in comma-separated list
locationLatitude[isNull]	boolean locationLatitude is null Value: true
locationLatitude[isNotNull]	boolean locationLatitude is not null Value: true
locationLatitude[gt]	number locationLatitude greater than
locationLatitude[gte]	number locationLatitude greater than or equal to
locationLatitude[lt]	number locationLatitude less than
locationLatitude[lte]	number locationLatitude less than or equal to
locationLongitude	number locationLongitude equals
locationLongitude[eq]	number locationLongitude equals
locationLongitude[ne]	number locationLongitude not equals
locationLongitude[in]	string locationLongitude in comma-separated list
locationLongitude[notIn]	string locationLongitude not in comma-separated list
locationLongitude[isNull]	boolean locationLongitude is null Value: true
locationLongitude[isNotNull]	boolean locationLongitude is not null Value: true
locationLongitude[gt]	number locationLongitude greater than
locationLongitude[gte]	number locationLongitude greater than or equal to
locationLongitude[lt]	number locationLongitude less than
locationLongitude[lte]	number locationLongitude less than or equal to
elevation	number elevation equals
elevation[eq]	number elevation equals
elevation[ne]	number elevation not equals
elevation[in]	string elevation in comma-separated list
elevation[notIn]	string elevation not in comma-separated list
elevation[isNull]	boolean elevation is null Value: true
elevation[isNotNull]	boolean elevation is not null Value: true
elevation[gt]	number elevation greater than
elevation[gte]	number elevation greater than or equal to
elevation[lt]	number elevation less than
elevation[lte]	number elevation less than or equal to
technicalRoomLocation	string technicalRoomLocation equals
technicalRoomLocation[eq]	string technicalRoomLocation equals
technicalRoomLocation[ne]	string technicalRoomLocation not equals
technicalRoomLocation[in]	string technicalRoomLocation in comma-separated list
technicalRoomLocation[notIn]	string technicalRoomLocation not in comma-separated list
technicalRoomLocation[isNull]	boolean technicalRoomLocation is null Value: true
technicalRoomLocation[isNotNull]	boolean technicalRoomLocation is not null Value: true
technicalRoomLocation[like]	string technicalRoomLocation matches pattern (case-sensitive)
technicalRoomLocation[ilike]	string technicalRoomLocation matches pattern (case-insensitive)
technicalRoomLocation[notLike]	string technicalRoomLocation does not match pattern (case-sensitive)
technicalRoomLocation[notIlike]	string technicalRoomLocation does not match pattern (case-insensitive)
systemLoad	string systemLoad equals
systemLoad[eq]	string systemLoad equals
systemLoad[ne]	string systemLoad not equals
systemLoad[in]	string systemLoad in comma-separated list
systemLoad[notIn]	string systemLoad not in comma-separated list
systemLoad[isNull]	boolean systemLoad is null Value: true
systemLoad[isNotNull]	boolean systemLoad is not null Value: true
systemLoad[like]	string systemLoad matches pattern (case-sensitive)
systemLoad[ilike]	string systemLoad matches pattern (case-insensitive)
systemLoad[notLike]	string systemLoad does not match pattern (case-sensitive)
systemLoad[notIlike]	string systemLoad does not match pattern (case-insensitive)
boxNumber	string boxNumber equals
boxNumber[eq]	string boxNumber equals
boxNumber[ne]	string boxNumber not equals
boxNumber[in]	string boxNumber in comma-separated list
boxNumber[notIn]	string boxNumber not in comma-separated list
boxNumber[isNull]	boolean boxNumber is null Value: true
boxNumber[isNotNull]	boolean boxNumber is not null Value: true
boxNumber[like]	string boxNumber matches pattern (case-sensitive)
boxNumber[ilike]	string boxNumber matches pattern (case-insensitive)
boxNumber[notLike]	string boxNumber does not match pattern (case-sensitive)
boxNumber[notIlike]	string boxNumber does not match pattern (case-insensitive)
economicEntity	string economicEntity equals
economicEntity[eq]	string economicEntity equals
economicEntity[ne]	string economicEntity not equals
economicEntity[in]	string economicEntity in comma-separated list
economicEntity[notIn]	string economicEntity not in comma-separated list
economicEntity[isNull]	boolean economicEntity is null Value: true
economicEntity[isNotNull]	boolean economicEntity is not null Value: true
economicEntity[like]	string economicEntity matches pattern (case-sensitive)
economicEntity[ilike]	string economicEntity matches pattern (case-insensitive)
economicEntity[notLike]	string economicEntity does not match pattern (case-sensitive)
economicEntity[notIlike]	string economicEntity does not match pattern (case-insensitive)
mountingLocation	string mountingLocation equals
mountingLocation[eq]	string mountingLocation equals
mountingLocation[ne]	string mountingLocation not equals
mountingLocation[in]	string mountingLocation in comma-separated list
mountingLocation[notIn]	string mountingLocation not in comma-separated list
mountingLocation[isNull]	boolean mountingLocation is null Value: true
mountingLocation[isNotNull]	boolean mountingLocation is not null Value: true
mountingLocation[like]	string mountingLocation matches pattern (case-sensitive)
mountingLocation[ilike]	string mountingLocation matches pattern (case-insensitive)
mountingLocation[notLike]	string mountingLocation does not match pattern (case-sensitive)
mountingLocation[notIlike]	string mountingLocation does not match pattern (case-insensitive)
visibility	boolean visibility equals
visibility[eq]	boolean visibility equals
visibility[ne]	boolean visibility not equals
visibility[in]	string visibility in comma-separated list
visibility[notIn]	string visibility not in comma-separated list
visibility[isNull]	boolean visibility is null Value: true
visibility[isNotNull]	boolean visibility is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Create site version

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
siteId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
name required	string non-empty
required	integer or null
required	ClimateProfile (string) or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	number or null
required	number or null
required	number or null
required	number or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	boolean or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get site version by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Update site version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
siteId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
name required	string non-empty
required	integer or null
required	ClimateProfile (string) or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	number or null
required	number or null
required	number or null
required	number or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	boolean or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "2019-08-24T14:15:22Z",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Delete site version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get site version (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"thumbnailFile": {"id": 9007199254740991,
"bucket": "string",
"key": "string",
"status": "pending",
"fileName": "string",
"fileUpdatedAt": "string",
"sha256": "string",
"size": -9007199254740991,
"contentType": "string",
"metadata": { },
"expiresAt": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}

List site versions (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
name	string non-empty name equals
name[eq]	string non-empty name equals
name[ne]	string non-empty name not equals
name[in]	string name in comma-separated list
name[notIn]	string name not in comma-separated list
name[isNull]	boolean name is null Value: true
name[isNotNull]	boolean name is not null Value: true
name[like]	string name matches pattern (case-sensitive)
name[ilike]	string name matches pattern (case-insensitive)
name[notLike]	string name does not match pattern (case-sensitive)
name[notIlike]	string name does not match pattern (case-insensitive)
thumbnailFileId	number thumbnailFileId equals
thumbnailFileId[eq]	number thumbnailFileId equals
thumbnailFileId[ne]	number thumbnailFileId not equals
thumbnailFileId[in]	string thumbnailFileId in comma-separated list
thumbnailFileId[notIn]	string thumbnailFileId not in comma-separated list
thumbnailFileId[isNull]	boolean thumbnailFileId is null Value: true
thumbnailFileId[isNotNull]	boolean thumbnailFileId is not null Value: true
thumbnailFileId[gt]	number thumbnailFileId greater than
thumbnailFileId[gte]	number thumbnailFileId greater than or equal to
thumbnailFileId[lt]	number thumbnailFileId less than
thumbnailFileId[lte]	number thumbnailFileId less than or equal to
climateProfile	string (ClimateProfile) Enum: "aircon" "ventilation_ac" "ventilation_dc" "combination_ac" climateProfile equals
climateProfile[eq]	string (ClimateProfile) Enum: "aircon" "ventilation_ac" "ventilation_dc" "combination_ac" climateProfile equals
climateProfile[ne]	string (ClimateProfile) Enum: "aircon" "ventilation_ac" "ventilation_dc" "combination_ac" climateProfile not equals
climateProfile[in]	string climateProfile in comma-separated list
climateProfile[notIn]	string climateProfile not in comma-separated list
climateProfile[isNull]	boolean climateProfile is null Value: true
climateProfile[isNotNull]	boolean climateProfile is not null Value: true
type	string type equals
type[eq]	string type equals
type[ne]	string type not equals
type[in]	string type in comma-separated list
type[notIn]	string type not in comma-separated list
type[isNull]	boolean type is null Value: true
type[isNotNull]	boolean type is not null Value: true
type[like]	string type matches pattern (case-sensitive)
type[ilike]	string type matches pattern (case-insensitive)
type[notLike]	string type does not match pattern (case-sensitive)
type[notIlike]	string type does not match pattern (case-insensitive)
street	string street equals
street[eq]	string street equals
street[ne]	string street not equals
street[in]	string street in comma-separated list
street[notIn]	string street not in comma-separated list
street[isNull]	boolean street is null Value: true
street[isNotNull]	boolean street is not null Value: true
street[like]	string street matches pattern (case-sensitive)
street[ilike]	string street matches pattern (case-insensitive)
street[notLike]	string street does not match pattern (case-sensitive)
street[notIlike]	string street does not match pattern (case-insensitive)
city	string city equals
city[eq]	string city equals
city[ne]	string city not equals
city[in]	string city in comma-separated list
city[notIn]	string city not in comma-separated list
city[isNull]	boolean city is null Value: true
city[isNotNull]	boolean city is not null Value: true
city[like]	string city matches pattern (case-sensitive)
city[ilike]	string city matches pattern (case-insensitive)
city[notLike]	string city does not match pattern (case-sensitive)
city[notIlike]	string city does not match pattern (case-insensitive)
zip	string zip equals
zip[eq]	string zip equals
zip[ne]	string zip not equals
zip[in]	string zip in comma-separated list
zip[notIn]	string zip not in comma-separated list
zip[isNull]	boolean zip is null Value: true
zip[isNotNull]	boolean zip is not null Value: true
zip[like]	string zip matches pattern (case-sensitive)
zip[ilike]	string zip matches pattern (case-insensitive)
zip[notLike]	string zip does not match pattern (case-sensitive)
zip[notIlike]	string zip does not match pattern (case-insensitive)
state	string state equals
state[eq]	string state equals
state[ne]	string state not equals
state[in]	string state in comma-separated list
state[notIn]	string state not in comma-separated list
state[isNull]	boolean state is null Value: true
state[isNotNull]	boolean state is not null Value: true
state[like]	string state matches pattern (case-sensitive)
state[ilike]	string state matches pattern (case-insensitive)
state[notLike]	string state does not match pattern (case-sensitive)
state[notIlike]	string state does not match pattern (case-insensitive)
region	string region equals
region[eq]	string region equals
region[ne]	string region not equals
region[in]	string region in comma-separated list
region[notIn]	string region not in comma-separated list
region[isNull]	boolean region is null Value: true
region[isNotNull]	boolean region is not null Value: true
region[like]	string region matches pattern (case-sensitive)
region[ilike]	string region matches pattern (case-insensitive)
region[notLike]	string region does not match pattern (case-sensitive)
region[notIlike]	string region does not match pattern (case-insensitive)
country	string country equals
country[eq]	string country equals
country[ne]	string country not equals
country[in]	string country in comma-separated list
country[notIn]	string country not in comma-separated list
country[isNull]	boolean country is null Value: true
country[isNotNull]	boolean country is not null Value: true
country[like]	string country matches pattern (case-sensitive)
country[ilike]	string country matches pattern (case-insensitive)
country[notLike]	string country does not match pattern (case-sensitive)
country[notIlike]	string country does not match pattern (case-insensitive)
measurementsValidFrom	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom equals
measurementsValidFrom[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom equals
measurementsValidFrom[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom not equals
measurementsValidFrom[in]	string measurementsValidFrom in comma-separated list
measurementsValidFrom[notIn]	string measurementsValidFrom not in comma-separated list
measurementsValidFrom[isNull]	boolean measurementsValidFrom is null Value: true
measurementsValidFrom[isNotNull]	boolean measurementsValidFrom is not null Value: true
measurementsValidFrom[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom greater than
measurementsValidFrom[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom greater than or equal to
measurementsValidFrom[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom less than
measurementsValidFrom[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... measurementsValidFrom less than or equal to
currency	string currency equals
currency[eq]	string currency equals
currency[ne]	string currency not equals
currency[in]	string currency in comma-separated list
currency[notIn]	string currency not in comma-separated list
currency[isNull]	boolean currency is null Value: true
currency[isNotNull]	boolean currency is not null Value: true
currency[like]	string currency matches pattern (case-sensitive)
currency[ilike]	string currency matches pattern (case-insensitive)
currency[notLike]	string currency does not match pattern (case-sensitive)
currency[notIlike]	string currency does not match pattern (case-insensitive)
costPerKwh	number costPerKwh equals
costPerKwh[eq]	number costPerKwh equals
costPerKwh[ne]	number costPerKwh not equals
costPerKwh[in]	string costPerKwh in comma-separated list
costPerKwh[notIn]	string costPerKwh not in comma-separated list
costPerKwh[isNull]	boolean costPerKwh is null Value: true
costPerKwh[isNotNull]	boolean costPerKwh is not null Value: true
costPerKwh[gt]	number costPerKwh greater than
costPerKwh[gte]	number costPerKwh greater than or equal to
costPerKwh[lt]	number costPerKwh less than
costPerKwh[lte]	number costPerKwh less than or equal to
locationLatitude	number locationLatitude equals
locationLatitude[eq]	number locationLatitude equals
locationLatitude[ne]	number locationLatitude not equals
locationLatitude[in]	string locationLatitude in comma-separated list
locationLatitude[notIn]	string locationLatitude not in comma-separated list
locationLatitude[isNull]	boolean locationLatitude is null Value: true
locationLatitude[isNotNull]	boolean locationLatitude is not null Value: true
locationLatitude[gt]	number locationLatitude greater than
locationLatitude[gte]	number locationLatitude greater than or equal to
locationLatitude[lt]	number locationLatitude less than
locationLatitude[lte]	number locationLatitude less than or equal to
locationLongitude	number locationLongitude equals
locationLongitude[eq]	number locationLongitude equals
locationLongitude[ne]	number locationLongitude not equals
locationLongitude[in]	string locationLongitude in comma-separated list
locationLongitude[notIn]	string locationLongitude not in comma-separated list
locationLongitude[isNull]	boolean locationLongitude is null Value: true
locationLongitude[isNotNull]	boolean locationLongitude is not null Value: true
locationLongitude[gt]	number locationLongitude greater than
locationLongitude[gte]	number locationLongitude greater than or equal to
locationLongitude[lt]	number locationLongitude less than
locationLongitude[lte]	number locationLongitude less than or equal to
elevation	number elevation equals
elevation[eq]	number elevation equals
elevation[ne]	number elevation not equals
elevation[in]	string elevation in comma-separated list
elevation[notIn]	string elevation not in comma-separated list
elevation[isNull]	boolean elevation is null Value: true
elevation[isNotNull]	boolean elevation is not null Value: true
elevation[gt]	number elevation greater than
elevation[gte]	number elevation greater than or equal to
elevation[lt]	number elevation less than
elevation[lte]	number elevation less than or equal to
technicalRoomLocation	string technicalRoomLocation equals
technicalRoomLocation[eq]	string technicalRoomLocation equals
technicalRoomLocation[ne]	string technicalRoomLocation not equals
technicalRoomLocation[in]	string technicalRoomLocation in comma-separated list
technicalRoomLocation[notIn]	string technicalRoomLocation not in comma-separated list
technicalRoomLocation[isNull]	boolean technicalRoomLocation is null Value: true
technicalRoomLocation[isNotNull]	boolean technicalRoomLocation is not null Value: true
technicalRoomLocation[like]	string technicalRoomLocation matches pattern (case-sensitive)
technicalRoomLocation[ilike]	string technicalRoomLocation matches pattern (case-insensitive)
technicalRoomLocation[notLike]	string technicalRoomLocation does not match pattern (case-sensitive)
technicalRoomLocation[notIlike]	string technicalRoomLocation does not match pattern (case-insensitive)
systemLoad	string systemLoad equals
systemLoad[eq]	string systemLoad equals
systemLoad[ne]	string systemLoad not equals
systemLoad[in]	string systemLoad in comma-separated list
systemLoad[notIn]	string systemLoad not in comma-separated list
systemLoad[isNull]	boolean systemLoad is null Value: true
systemLoad[isNotNull]	boolean systemLoad is not null Value: true
systemLoad[like]	string systemLoad matches pattern (case-sensitive)
systemLoad[ilike]	string systemLoad matches pattern (case-insensitive)
systemLoad[notLike]	string systemLoad does not match pattern (case-sensitive)
systemLoad[notIlike]	string systemLoad does not match pattern (case-insensitive)
boxNumber	string boxNumber equals
boxNumber[eq]	string boxNumber equals
boxNumber[ne]	string boxNumber not equals
boxNumber[in]	string boxNumber in comma-separated list
boxNumber[notIn]	string boxNumber not in comma-separated list
boxNumber[isNull]	boolean boxNumber is null Value: true
boxNumber[isNotNull]	boolean boxNumber is not null Value: true
boxNumber[like]	string boxNumber matches pattern (case-sensitive)
boxNumber[ilike]	string boxNumber matches pattern (case-insensitive)
boxNumber[notLike]	string boxNumber does not match pattern (case-sensitive)
boxNumber[notIlike]	string boxNumber does not match pattern (case-insensitive)
economicEntity	string economicEntity equals
economicEntity[eq]	string economicEntity equals
economicEntity[ne]	string economicEntity not equals
economicEntity[in]	string economicEntity in comma-separated list
economicEntity[notIn]	string economicEntity not in comma-separated list
economicEntity[isNull]	boolean economicEntity is null Value: true
economicEntity[isNotNull]	boolean economicEntity is not null Value: true
economicEntity[like]	string economicEntity matches pattern (case-sensitive)
economicEntity[ilike]	string economicEntity matches pattern (case-insensitive)
economicEntity[notLike]	string economicEntity does not match pattern (case-sensitive)
economicEntity[notIlike]	string economicEntity does not match pattern (case-insensitive)
mountingLocation	string mountingLocation equals
mountingLocation[eq]	string mountingLocation equals
mountingLocation[ne]	string mountingLocation not equals
mountingLocation[in]	string mountingLocation in comma-separated list
mountingLocation[notIn]	string mountingLocation not in comma-separated list
mountingLocation[isNull]	boolean mountingLocation is null Value: true
mountingLocation[isNotNull]	boolean mountingLocation is not null Value: true
mountingLocation[like]	string mountingLocation matches pattern (case-sensitive)
mountingLocation[ilike]	string mountingLocation matches pattern (case-insensitive)
mountingLocation[notLike]	string mountingLocation does not match pattern (case-sensitive)
mountingLocation[notIlike]	string mountingLocation does not match pattern (case-insensitive)
visibility	boolean visibility equals
visibility[eq]	boolean visibility equals
visibility[ne]	boolean visibility not equals
visibility[in]	string visibility in comma-separated list
visibility[notIn]	string visibility not in comma-separated list
visibility[isNull]	boolean visibility is null Value: true
visibility[isNotNull]	boolean visibility is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"thumbnailFileId": 9007199254740991,
"climateProfile": "aircon",
"type": "string",
"street": "string",
"city": "string",
"zip": "string",
"state": "string",
"region": "string",
"country": "string",
"measurementsValidFrom": "string",
"currency": "string",
"costPerKwh": 0,
"locationLatitude": 0,
"locationLongitude": 0,
"elevation": 0,
"technicalRoomLocation": "string",
"systemLoad": "string",
"boxNumber": "string",
"economicEntity": "string",
"mountingLocation": "string",
"visibility": true,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"thumbnailFile": {"id": 9007199254740991,
"bucket": "string",
"key": "string",
"status": "pending",
"fileName": "string",
"fileUpdatedAt": "string",
"sha256": "string",
"size": -9007199254740991,
"contentType": "string",
"metadata": { },
"expiresAt": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]

Device

A physical data gathering device registered to a site.

List devices

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
deviceTypeId	number deviceTypeId equals
deviceTypeId[eq]	number deviceTypeId equals
deviceTypeId[ne]	number deviceTypeId not equals
deviceTypeId[in]	string deviceTypeId in comma-separated list
deviceTypeId[notIn]	string deviceTypeId not in comma-separated list
deviceTypeId[isNull]	boolean deviceTypeId is null Value: true
deviceTypeId[isNotNull]	boolean deviceTypeId is not null Value: true
deviceTypeId[gt]	number deviceTypeId greater than
deviceTypeId[gte]	number deviceTypeId greater than or equal to
deviceTypeId[lt]	number deviceTypeId less than
deviceTypeId[lte]	number deviceTypeId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
location	string location equals
location[eq]	string location equals
location[ne]	string location not equals
location[in]	string location in comma-separated list
location[notIn]	string location not in comma-separated list
location[isNull]	boolean location is null Value: true
location[isNotNull]	boolean location is not null Value: true
location[like]	string location matches pattern (case-sensitive)
location[ilike]	string location matches pattern (case-insensitive)
location[notLike]	string location does not match pattern (case-sensitive)
location[notIlike]	string location does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create device

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
siteId required	integer [ 0 .. 9007199254740991 ]
deviceTypeId required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get device by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
siteId required	integer [ 0 .. 9007199254740991 ]
deviceTypeId required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get device (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"deviceType": {"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}

Get measurement channels for device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get sub-devices for device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

List devices (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
deviceTypeId	number deviceTypeId equals
deviceTypeId[eq]	number deviceTypeId equals
deviceTypeId[ne]	number deviceTypeId not equals
deviceTypeId[in]	string deviceTypeId in comma-separated list
deviceTypeId[notIn]	string deviceTypeId not in comma-separated list
deviceTypeId[isNull]	boolean deviceTypeId is null Value: true
deviceTypeId[isNotNull]	boolean deviceTypeId is not null Value: true
deviceTypeId[gt]	number deviceTypeId greater than
deviceTypeId[gte]	number deviceTypeId greater than or equal to
deviceTypeId[lt]	number deviceTypeId less than
deviceTypeId[lte]	number deviceTypeId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
location	string location equals
location[eq]	string location equals
location[ne]	string location not equals
location[in]	string location in comma-separated list
location[notIn]	string location not in comma-separated list
location[isNull]	boolean location is null Value: true
location[isNotNull]	boolean location is not null Value: true
location[like]	string location matches pattern (case-sensitive)
location[ilike]	string location matches pattern (case-insensitive)
location[notLike]	string location does not match pattern (case-sensitive)
location[notIlike]	string location does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"siteId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"location": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"deviceType": {"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]

Device Type

A specific type of a data gathering device.

List device types

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
description	string description equals
description[eq]	string description equals
description[ne]	string description not equals
description[in]	string description in comma-separated list
description[notIn]	string description not in comma-separated list
description[isNull]	boolean description is null Value: true
description[isNotNull]	boolean description is not null Value: true
description[like]	string description matches pattern (case-sensitive)
description[ilike]	string description matches pattern (case-insensitive)
description[notLike]	string description does not match pattern (case-sensitive)
description[notIlike]	string description does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create device type

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get device type by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get measurement definitions for device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get sub-device types for device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Sub Device

A physical device whose data is collected by a data gathering device.

List sub-devices

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
deviceId	number deviceId equals
deviceId[eq]	number deviceId equals
deviceId[ne]	number deviceId not equals
deviceId[in]	string deviceId in comma-separated list
deviceId[notIn]	string deviceId not in comma-separated list
deviceId[isNull]	boolean deviceId is null Value: true
deviceId[isNotNull]	boolean deviceId is not null Value: true
deviceId[gt]	number deviceId greater than
deviceId[gte]	number deviceId greater than or equal to
deviceId[lt]	number deviceId less than
deviceId[lte]	number deviceId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create sub-device

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
subDeviceTypeId required	integer [ 0 .. 9007199254740991 ]
deviceId required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get sub-device by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update sub-device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
subDeviceTypeId required	integer [ 0 .. 9007199254740991 ]
deviceId required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete sub-device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get sub-device (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Get measurement channels for sub-device

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

List sub-devices (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
deviceId	number deviceId equals
deviceId[eq]	number deviceId equals
deviceId[ne]	number deviceId not equals
deviceId[in]	string deviceId in comma-separated list
deviceId[notIn]	string deviceId not in comma-separated list
deviceId[isNull]	boolean deviceId is null Value: true
deviceId[isNotNull]	boolean deviceId is not null Value: true
deviceId[gt]	number deviceId greater than
deviceId[gte]	number deviceId greater than or equal to
deviceId[lt]	number deviceId less than
deviceId[lte]	number deviceId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"deviceId": 9007199254740991,
"key": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

List sub-devices (overview)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

site

string

Responses

Response samples

200

Content type

application/json

[{"device": "string",
"routeKey": "string",
"source": "Modbus",
"site": "string",
"status": true,
"updatedOn": "string",
"installationDate": "string"
}
]

Sub Device Type

A specific device type whose data is collected by a data gathering device.

List sub-device types

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
deviceTypeId	number deviceTypeId equals
deviceTypeId[eq]	number deviceTypeId equals
deviceTypeId[ne]	number deviceTypeId not equals
deviceTypeId[in]	string deviceTypeId in comma-separated list
deviceTypeId[notIn]	string deviceTypeId not in comma-separated list
deviceTypeId[isNull]	boolean deviceTypeId is null Value: true
deviceTypeId[isNotNull]	boolean deviceTypeId is not null Value: true
deviceTypeId[gt]	number deviceTypeId greater than
deviceTypeId[gte]	number deviceTypeId greater than or equal to
deviceTypeId[lt]	number deviceTypeId less than
deviceTypeId[lte]	number deviceTypeId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
description	string description equals
description[eq]	string description equals
description[ne]	string description not equals
description[in]	string description in comma-separated list
description[notIn]	string description not in comma-separated list
description[isNull]	boolean description is null Value: true
description[isNotNull]	boolean description is not null Value: true
description[like]	string description matches pattern (case-sensitive)
description[ilike]	string description matches pattern (case-insensitive)
description[notLike]	string description does not match pattern (case-sensitive)
description[notIlike]	string description does not match pattern (case-insensitive)
sourceType	string (SourceType) Enum: "modbus" "ext" sourceType equals
sourceType[eq]	string (SourceType) Enum: "modbus" "ext" sourceType equals
sourceType[ne]	string (SourceType) Enum: "modbus" "ext" sourceType not equals
sourceType[in]	string sourceType in comma-separated list
sourceType[notIn]	string sourceType not in comma-separated list
sourceType[isNull]	boolean sourceType is null Value: true
sourceType[isNotNull]	boolean sourceType is not null Value: true
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create sub-device type

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
deviceTypeId required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	SourceType (string) or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get sub-device type by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update sub-device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
deviceTypeId required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	SourceType (string) or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete sub-device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get sub-device type (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Get measurement definitions for sub-device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get modbus configs for sub-device type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

List sub-device types (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
deviceTypeId	number deviceTypeId equals
deviceTypeId[eq]	number deviceTypeId equals
deviceTypeId[ne]	number deviceTypeId not equals
deviceTypeId[in]	string deviceTypeId in comma-separated list
deviceTypeId[notIn]	string deviceTypeId not in comma-separated list
deviceTypeId[isNull]	boolean deviceTypeId is null Value: true
deviceTypeId[isNotNull]	boolean deviceTypeId is not null Value: true
deviceTypeId[gt]	number deviceTypeId greater than
deviceTypeId[gte]	number deviceTypeId greater than or equal to
deviceTypeId[lt]	number deviceTypeId less than
deviceTypeId[lte]	number deviceTypeId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
description	string description equals
description[eq]	string description equals
description[ne]	string description not equals
description[in]	string description in comma-separated list
description[notIn]	string description not in comma-separated list
description[isNull]	boolean description is null Value: true
description[isNotNull]	boolean description is not null Value: true
description[like]	string description matches pattern (case-sensitive)
description[ilike]	string description matches pattern (case-insensitive)
description[notLike]	string description does not match pattern (case-sensitive)
description[notIlike]	string description does not match pattern (case-insensitive)
sourceType	string (SourceType) Enum: "modbus" "ext" sourceType equals
sourceType[eq]	string (SourceType) Enum: "modbus" "ext" sourceType equals
sourceType[ne]	string (SourceType) Enum: "modbus" "ext" sourceType not equals
sourceType[in]	string sourceType in comma-separated list
sourceType[notIn]	string sourceType not in comma-separated list
sourceType[isNull]	boolean sourceType is null Value: true
sourceType[isNotNull]	boolean sourceType is not null Value: true
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"deviceTypeId": 9007199254740991,
"key": "string",
"description": "string",
"sourceType": "modbus",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Measurement

Timeseries data ingested from the devices.

List measurements

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
time	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time not equals
time[in]	string time in comma-separated list
time[notIn]	string time not in comma-separated list
time[isNull]	boolean time is null Value: true
time[isNotNull]	boolean time is not null Value: true
time[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than
time[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than or equal to
time[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than
time[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than or equal to
measurementChannelId	number measurementChannelId equals
measurementChannelId[eq]	number measurementChannelId equals
measurementChannelId[ne]	number measurementChannelId not equals
measurementChannelId[in]	string measurementChannelId in comma-separated list
measurementChannelId[notIn]	string measurementChannelId not in comma-separated list
measurementChannelId[isNull]	boolean measurementChannelId is null Value: true
measurementChannelId[isNotNull]	boolean measurementChannelId is not null Value: true
measurementChannelId[gt]	number measurementChannelId greater than
measurementChannelId[gte]	number measurementChannelId greater than or equal to
measurementChannelId[lt]	number measurementChannelId less than
measurementChannelId[lte]	number measurementChannelId less than or equal to
valueDouble	number valueDouble equals
valueDouble[eq]	number valueDouble equals
valueDouble[ne]	number valueDouble not equals
valueDouble[in]	string valueDouble in comma-separated list
valueDouble[notIn]	string valueDouble not in comma-separated list
valueDouble[isNull]	boolean valueDouble is null Value: true
valueDouble[isNotNull]	boolean valueDouble is not null Value: true
valueDouble[gt]	number valueDouble greater than
valueDouble[gte]	number valueDouble greater than or equal to
valueDouble[lt]	number valueDouble less than
valueDouble[lte]	number valueDouble less than or equal to
valueInt	number valueInt equals
valueInt[eq]	number valueInt equals
valueInt[ne]	number valueInt not equals
valueInt[in]	string valueInt in comma-separated list
valueInt[notIn]	string valueInt not in comma-separated list
valueInt[isNull]	boolean valueInt is null Value: true
valueInt[isNotNull]	boolean valueInt is not null Value: true
valueInt[gt]	number valueInt greater than
valueInt[gte]	number valueInt greater than or equal to
valueInt[lt]	number valueInt less than
valueInt[lte]	number valueInt less than or equal to
valueString	string valueString equals
valueString[eq]	string valueString equals
valueString[ne]	string valueString not equals
valueString[in]	string valueString in comma-separated list
valueString[notIn]	string valueString not in comma-separated list
valueString[isNull]	boolean valueString is null Value: true
valueString[isNotNull]	boolean valueString is not null Value: true
valueString[like]	string valueString matches pattern (case-sensitive)
valueString[ilike]	string valueString matches pattern (case-insensitive)
valueString[notLike]	string valueString does not match pattern (case-sensitive)
valueString[notIlike]	string valueString does not match pattern (case-insensitive)
valueBool	boolean valueBool equals
valueBool[eq]	boolean valueBool equals
valueBool[ne]	boolean valueBool not equals
valueBool[in]	string valueBool in comma-separated list
valueBool[notIn]	string valueBool not in comma-separated list
valueBool[isNull]	boolean valueBool is null Value: true
valueBool[isNotNull]	boolean valueBool is not null Value: true
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}
]

Create measurement

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
time required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
measurementChannelId required	integer [ 0 .. 9007199254740991 ]
required	number or null
required	integer or null
required	string or null
required	boolean or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get measurement by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}

Update measurement

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
time required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
measurementChannelId required	integer [ 0 .. 9007199254740991 ]
required	number or null
required	integer or null
required	string or null
required	boolean or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"time": "2019-08-24T14:15:22Z",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}

Delete measurement

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Measurement Aggregate

Pre-aggregated measurements for faster queries. All granularities share the same table, as they have the same structure and are distinguished by the granularity column.

List measurement aggregates

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
time	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time not equals
time[in]	string time in comma-separated list
time[notIn]	string time not in comma-separated list
time[isNull]	boolean time is null Value: true
time[isNotNull]	boolean time is not null Value: true
time[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than
time[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than or equal to
time[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than
time[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than or equal to
measurementChannelId	number measurementChannelId equals
measurementChannelId[eq]	number measurementChannelId equals
measurementChannelId[ne]	number measurementChannelId not equals
measurementChannelId[in]	string measurementChannelId in comma-separated list
measurementChannelId[notIn]	string measurementChannelId not in comma-separated list
measurementChannelId[isNull]	boolean measurementChannelId is null Value: true
measurementChannelId[isNotNull]	boolean measurementChannelId is not null Value: true
measurementChannelId[gt]	number measurementChannelId greater than
measurementChannelId[gte]	number measurementChannelId greater than or equal to
measurementChannelId[lt]	number measurementChannelId less than
measurementChannelId[lte]	number measurementChannelId less than or equal to
granularity	string (MeasurementAggregateGranularity) Enum: "hourly" "daily" "weekly" granularity equals
granularity[eq]	string (MeasurementAggregateGranularity) Enum: "hourly" "daily" "weekly" granularity equals
granularity[ne]	string (MeasurementAggregateGranularity) Enum: "hourly" "daily" "weekly" granularity not equals
granularity[in]	string granularity in comma-separated list
granularity[notIn]	string granularity not in comma-separated list
granularity[isNull]	boolean granularity is null Value: true
granularity[isNotNull]	boolean granularity is not null Value: true
avgValue	number avgValue equals
avgValue[eq]	number avgValue equals
avgValue[ne]	number avgValue not equals
avgValue[in]	string avgValue in comma-separated list
avgValue[notIn]	string avgValue not in comma-separated list
avgValue[isNull]	boolean avgValue is null Value: true
avgValue[isNotNull]	boolean avgValue is not null Value: true
avgValue[gt]	number avgValue greater than
avgValue[gte]	number avgValue greater than or equal to
avgValue[lt]	number avgValue less than
avgValue[lte]	number avgValue less than or equal to
sumValue	number sumValue equals
sumValue[eq]	number sumValue equals
sumValue[ne]	number sumValue not equals
sumValue[in]	string sumValue in comma-separated list
sumValue[notIn]	string sumValue not in comma-separated list
sumValue[isNull]	boolean sumValue is null Value: true
sumValue[isNotNull]	boolean sumValue is not null Value: true
sumValue[gt]	number sumValue greater than
sumValue[gte]	number sumValue greater than or equal to
sumValue[lt]	number sumValue less than
sumValue[lte]	number sumValue less than or equal to
minValue	number minValue equals
minValue[eq]	number minValue equals
minValue[ne]	number minValue not equals
minValue[in]	string minValue in comma-separated list
minValue[notIn]	string minValue not in comma-separated list
minValue[isNull]	boolean minValue is null Value: true
minValue[isNotNull]	boolean minValue is not null Value: true
minValue[gt]	number minValue greater than
minValue[gte]	number minValue greater than or equal to
minValue[lt]	number minValue less than
minValue[lte]	number minValue less than or equal to
maxValue	number maxValue equals
maxValue[eq]	number maxValue equals
maxValue[ne]	number maxValue not equals
maxValue[in]	string maxValue in comma-separated list
maxValue[notIn]	string maxValue not in comma-separated list
maxValue[isNull]	boolean maxValue is null Value: true
maxValue[isNotNull]	boolean maxValue is not null Value: true
maxValue[gt]	number maxValue greater than
maxValue[gte]	number maxValue greater than or equal to
maxValue[lt]	number maxValue less than
maxValue[lte]	number maxValue less than or equal to
p01Value	number p01Value equals
p01Value[eq]	number p01Value equals
p01Value[ne]	number p01Value not equals
p01Value[in]	string p01Value in comma-separated list
p01Value[notIn]	string p01Value not in comma-separated list
p01Value[isNull]	boolean p01Value is null Value: true
p01Value[isNotNull]	boolean p01Value is not null Value: true
p01Value[gt]	number p01Value greater than
p01Value[gte]	number p01Value greater than or equal to
p01Value[lt]	number p01Value less than
p01Value[lte]	number p01Value less than or equal to
p05Value	number p05Value equals
p05Value[eq]	number p05Value equals
p05Value[ne]	number p05Value not equals
p05Value[in]	string p05Value in comma-separated list
p05Value[notIn]	string p05Value not in comma-separated list
p05Value[isNull]	boolean p05Value is null Value: true
p05Value[isNotNull]	boolean p05Value is not null Value: true
p05Value[gt]	number p05Value greater than
p05Value[gte]	number p05Value greater than or equal to
p05Value[lt]	number p05Value less than
p05Value[lte]	number p05Value less than or equal to
p10Value	number p10Value equals
p10Value[eq]	number p10Value equals
p10Value[ne]	number p10Value not equals
p10Value[in]	string p10Value in comma-separated list
p10Value[notIn]	string p10Value not in comma-separated list
p10Value[isNull]	boolean p10Value is null Value: true
p10Value[isNotNull]	boolean p10Value is not null Value: true
p10Value[gt]	number p10Value greater than
p10Value[gte]	number p10Value greater than or equal to
p10Value[lt]	number p10Value less than
p10Value[lte]	number p10Value less than or equal to
p25Value	number p25Value equals
p25Value[eq]	number p25Value equals
p25Value[ne]	number p25Value not equals
p25Value[in]	string p25Value in comma-separated list
p25Value[notIn]	string p25Value not in comma-separated list
p25Value[isNull]	boolean p25Value is null Value: true
p25Value[isNotNull]	boolean p25Value is not null Value: true
p25Value[gt]	number p25Value greater than
p25Value[gte]	number p25Value greater than or equal to
p25Value[lt]	number p25Value less than
p25Value[lte]	number p25Value less than or equal to
p50Value	number p50Value equals
p50Value[eq]	number p50Value equals
p50Value[ne]	number p50Value not equals
p50Value[in]	string p50Value in comma-separated list
p50Value[notIn]	string p50Value not in comma-separated list
p50Value[isNull]	boolean p50Value is null Value: true
p50Value[isNotNull]	boolean p50Value is not null Value: true
p50Value[gt]	number p50Value greater than
p50Value[gte]	number p50Value greater than or equal to
p50Value[lt]	number p50Value less than
p50Value[lte]	number p50Value less than or equal to
p75Value	number p75Value equals
p75Value[eq]	number p75Value equals
p75Value[ne]	number p75Value not equals
p75Value[in]	string p75Value in comma-separated list
p75Value[notIn]	string p75Value not in comma-separated list
p75Value[isNull]	boolean p75Value is null Value: true
p75Value[isNotNull]	boolean p75Value is not null Value: true
p75Value[gt]	number p75Value greater than
p75Value[gte]	number p75Value greater than or equal to
p75Value[lt]	number p75Value less than
p75Value[lte]	number p75Value less than or equal to
p90Value	number p90Value equals
p90Value[eq]	number p90Value equals
p90Value[ne]	number p90Value not equals
p90Value[in]	string p90Value in comma-separated list
p90Value[notIn]	string p90Value not in comma-separated list
p90Value[isNull]	boolean p90Value is null Value: true
p90Value[isNotNull]	boolean p90Value is not null Value: true
p90Value[gt]	number p90Value greater than
p90Value[gte]	number p90Value greater than or equal to
p90Value[lt]	number p90Value less than
p90Value[lte]	number p90Value less than or equal to
p95Value	number p95Value equals
p95Value[eq]	number p95Value equals
p95Value[ne]	number p95Value not equals
p95Value[in]	string p95Value in comma-separated list
p95Value[notIn]	string p95Value not in comma-separated list
p95Value[isNull]	boolean p95Value is null Value: true
p95Value[isNotNull]	boolean p95Value is not null Value: true
p95Value[gt]	number p95Value greater than
p95Value[gte]	number p95Value greater than or equal to
p95Value[lt]	number p95Value less than
p95Value[lte]	number p95Value less than or equal to
p99Value	number p99Value equals
p99Value[eq]	number p99Value equals
p99Value[ne]	number p99Value not equals
p99Value[in]	string p99Value in comma-separated list
p99Value[notIn]	string p99Value not in comma-separated list
p99Value[isNull]	boolean p99Value is null Value: true
p99Value[isNotNull]	boolean p99Value is not null Value: true
p99Value[gt]	number p99Value greater than
p99Value[gte]	number p99Value greater than or equal to
p99Value[lt]	number p99Value less than
p99Value[lte]	number p99Value less than or equal to
count	number count equals
count[eq]	number count equals
count[ne]	number count not equals
count[in]	string count in comma-separated list
count[notIn]	string count not in comma-separated list
count[isNull]	boolean count is null Value: true
count[isNotNull]	boolean count is not null Value: true
count[gt]	number count greater than
count[gte]	number count greater than or equal to
count[lt]	number count less than
count[lte]	number count less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"granularity": "hourly",
"avgValue": 0,
"sumValue": 0,
"minValue": 0,
"maxValue": 0,
"p01Value": 0,
"p05Value": 0,
"p10Value": 0,
"p25Value": 0,
"p50Value": 0,
"p75Value": 0,
"p90Value": 0,
"p95Value": 0,
"p99Value": 0,
"count": 9007199254740991,
"createdAt": "string"
}
]

Create measurement aggregate

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
time required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
measurementChannelId required	integer [ 0 .. 9007199254740991 ]
granularity required	string (MeasurementAggregateGranularity) Enum: "hourly" "daily" "weekly"
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
count required	integer [ 0 .. 9007199254740991 ]
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get measurement aggregate by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"granularity": "hourly",
"avgValue": 0,
"sumValue": 0,
"minValue": 0,
"maxValue": 0,
"p01Value": 0,
"p05Value": 0,
"p10Value": 0,
"p25Value": 0,
"p50Value": 0,
"p75Value": 0,
"p90Value": 0,
"p95Value": 0,
"p99Value": 0,
"count": 9007199254740991,
"createdAt": "string"
}

Update measurement aggregate

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
time required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
measurementChannelId required	integer [ 0 .. 9007199254740991 ]
granularity required	string (MeasurementAggregateGranularity) Enum: "hourly" "daily" "weekly"
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
required	number or null
count required	integer [ 0 .. 9007199254740991 ]
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"time": "2019-08-24T14:15:22Z",
"measurementChannelId": 9007199254740991,
"granularity": "hourly",
"avgValue": 0,
"sumValue": 0,
"minValue": 0,
"maxValue": 0,
"p01Value": 0,
"p05Value": 0,
"p10Value": 0,
"p25Value": 0,
"p50Value": 0,
"p75Value": 0,
"p90Value": 0,
"p95Value": 0,
"p99Value": 0,
"count": 9007199254740991,
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"granularity": "hourly",
"avgValue": 0,
"sumValue": 0,
"minValue": 0,
"maxValue": 0,
"p01Value": 0,
"p05Value": 0,
"p10Value": 0,
"p25Value": 0,
"p50Value": 0,
"p75Value": 0,
"p90Value": 0,
"p95Value": 0,
"p99Value": 0,
"count": 9007199254740991,
"createdAt": "string"
}

Delete measurement aggregate

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Measurement Channel

Defines metadata to measurements.

List measurement channels

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
measurementDefinitionId	number measurementDefinitionId equals
measurementDefinitionId[eq]	number measurementDefinitionId equals
measurementDefinitionId[ne]	number measurementDefinitionId not equals
measurementDefinitionId[in]	string measurementDefinitionId in comma-separated list
measurementDefinitionId[notIn]	string measurementDefinitionId not in comma-separated list
measurementDefinitionId[isNull]	boolean measurementDefinitionId is null Value: true
measurementDefinitionId[isNotNull]	boolean measurementDefinitionId is not null Value: true
measurementDefinitionId[gt]	number measurementDefinitionId greater than
measurementDefinitionId[gte]	number measurementDefinitionId greater than or equal to
measurementDefinitionId[lt]	number measurementDefinitionId less than
measurementDefinitionId[lte]	number measurementDefinitionId less than or equal to
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
deviceId	number deviceId equals
deviceId[eq]	number deviceId equals
deviceId[ne]	number deviceId not equals
deviceId[in]	string deviceId in comma-separated list
deviceId[notIn]	string deviceId not in comma-separated list
deviceId[isNull]	boolean deviceId is null Value: true
deviceId[isNotNull]	boolean deviceId is not null Value: true
deviceId[gt]	number deviceId greater than
deviceId[gte]	number deviceId greater than or equal to
deviceId[lt]	number deviceId less than
deviceId[lte]	number deviceId less than or equal to
subDeviceId	number subDeviceId equals
subDeviceId[eq]	number subDeviceId equals
subDeviceId[ne]	number subDeviceId not equals
subDeviceId[in]	string subDeviceId in comma-separated list
subDeviceId[notIn]	string subDeviceId not in comma-separated list
subDeviceId[isNull]	boolean subDeviceId is null Value: true
subDeviceId[isNotNull]	boolean subDeviceId is not null Value: true
subDeviceId[gt]	number subDeviceId greater than
subDeviceId[gte]	number subDeviceId greater than or equal to
subDeviceId[lt]	number subDeviceId less than
subDeviceId[lte]	number subDeviceId less than or equal to
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create measurement channel

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
measurementDefinitionId required	integer [ 0 .. 9007199254740991 ]
siteId required	integer [ 0 .. 9007199254740991 ]
deviceId required	integer [ 0 .. 9007199254740991 ]
required	integer or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get measurement channel by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update measurement channel

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
measurementDefinitionId required	integer [ 0 .. 9007199254740991 ]
siteId required	integer [ 0 .. 9007199254740991 ]
deviceId required	integer [ 0 .. 9007199254740991 ]
required	integer or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete measurement channel

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get measurements for channel

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}
]

Measurement Definition

Defines measurable values.

List measurement definitions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
measurementMetricId	number measurementMetricId equals
measurementMetricId[eq]	number measurementMetricId equals
measurementMetricId[ne]	number measurementMetricId not equals
measurementMetricId[in]	string measurementMetricId in comma-separated list
measurementMetricId[notIn]	string measurementMetricId not in comma-separated list
measurementMetricId[isNull]	boolean measurementMetricId is null Value: true
measurementMetricId[isNotNull]	boolean measurementMetricId is not null Value: true
measurementMetricId[gt]	number measurementMetricId greater than
measurementMetricId[gte]	number measurementMetricId greater than or equal to
measurementMetricId[lt]	number measurementMetricId less than
measurementMetricId[lte]	number measurementMetricId less than or equal to
deviceTypeId	number deviceTypeId equals
deviceTypeId[eq]	number deviceTypeId equals
deviceTypeId[ne]	number deviceTypeId not equals
deviceTypeId[in]	string deviceTypeId in comma-separated list
deviceTypeId[notIn]	string deviceTypeId not in comma-separated list
deviceTypeId[isNull]	boolean deviceTypeId is null Value: true
deviceTypeId[isNotNull]	boolean deviceTypeId is not null Value: true
deviceTypeId[gt]	number deviceTypeId greater than
deviceTypeId[gte]	number deviceTypeId greater than or equal to
deviceTypeId[lt]	number deviceTypeId less than
deviceTypeId[lte]	number deviceTypeId less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
type	string (MeasurementType) Enum: "double" "int" "string" "bool" type equals
type[eq]	string (MeasurementType) Enum: "double" "int" "string" "bool" type equals
type[ne]	string (MeasurementType) Enum: "double" "int" "string" "bool" type not equals
type[in]	string type in comma-separated list
type[notIn]	string type not in comma-separated list
type[isNull]	boolean type is null Value: true
type[isNotNull]	boolean type is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create measurement definition

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
required	integer or null
deviceTypeId required	integer [ 0 .. 9007199254740991 ]
required	integer or null
key required	string non-empty
type required	string (MeasurementType) Enum: "double" "int" "string" "bool"
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get measurement definition by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update measurement definition

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
required	integer or null
deviceTypeId required	integer [ 0 .. 9007199254740991 ]
required	integer or null
key required	string non-empty
type required	string (MeasurementType) Enum: "double" "int" "string" "bool"
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete measurement definition

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get channels for measurement definition

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Measurement Metric

Defines known metrics, which can be used as lookup in the frontend.

List measurement metrics

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
key	string non-empty key equals
key[eq]	string non-empty key equals
key[ne]	string non-empty key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
description	string description equals
description[eq]	string description equals
description[ne]	string description not equals
description[in]	string description in comma-separated list
description[notIn]	string description not in comma-separated list
description[isNull]	boolean description is null Value: true
description[isNotNull]	boolean description is not null Value: true
description[like]	string description matches pattern (case-sensitive)
description[ilike]	string description matches pattern (case-insensitive)
description[notLike]	string description does not match pattern (case-sensitive)
description[notIlike]	string description does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create measurement metric

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get measurement metric by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update measurement metric

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"key": "string",
"description": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete measurement metric

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get definitions for measurement metric

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Alarm

List alarms

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
measurementChannelId	number measurementChannelId equals
measurementChannelId[eq]	number measurementChannelId equals
measurementChannelId[ne]	number measurementChannelId not equals
measurementChannelId[in]	string measurementChannelId in comma-separated list
measurementChannelId[notIn]	string measurementChannelId not in comma-separated list
measurementChannelId[isNull]	boolean measurementChannelId is null Value: true
measurementChannelId[isNotNull]	boolean measurementChannelId is not null Value: true
measurementChannelId[gt]	number measurementChannelId greater than
measurementChannelId[gte]	number measurementChannelId greater than or equal to
measurementChannelId[lt]	number measurementChannelId less than
measurementChannelId[lte]	number measurementChannelId less than or equal to
type	string (AlarmType) Enum: "offline" "port" "temperature" type equals
type[eq]	string (AlarmType) Enum: "offline" "port" "temperature" type equals
type[ne]	string (AlarmType) Enum: "offline" "port" "temperature" type not equals
type[in]	string type in comma-separated list
type[notIn]	string type not in comma-separated list
type[isNull]	boolean type is null Value: true
type[isNotNull]	boolean type is not null Value: true
severity	string (AlarmSeverity) Enum: "minor" "major" "critical" severity equals
severity[eq]	string (AlarmSeverity) Enum: "minor" "major" "critical" severity equals
severity[ne]	string (AlarmSeverity) Enum: "minor" "major" "critical" severity not equals
severity[in]	string severity in comma-separated list
severity[notIn]	string severity not in comma-separated list
severity[isNull]	boolean severity is null Value: true
severity[isNotNull]	boolean severity is not null Value: true
status	string (AlarmStatus) Enum: "active" "cleared" status equals
status[eq]	string (AlarmStatus) Enum: "active" "cleared" status equals
status[ne]	string (AlarmStatus) Enum: "active" "cleared" status not equals
status[in]	string status in comma-separated list
status[notIn]	string status not in comma-separated list
status[isNull]	boolean status is null Value: true
status[isNotNull]	boolean status is not null Value: true
activeAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt equals
activeAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt equals
activeAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt not equals
activeAt[in]	string activeAt in comma-separated list
activeAt[notIn]	string activeAt not in comma-separated list
activeAt[isNull]	boolean activeAt is null Value: true
activeAt[isNotNull]	boolean activeAt is not null Value: true
activeAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt greater than
activeAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt greater than or equal to
activeAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt less than
activeAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt less than or equal to
clearedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt equals
clearedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt equals
clearedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt not equals
clearedAt[in]	string clearedAt in comma-separated list
clearedAt[notIn]	string clearedAt not in comma-separated list
clearedAt[isNull]	boolean clearedAt is null Value: true
clearedAt[isNotNull]	boolean clearedAt is not null Value: true
clearedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt greater than
clearedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt greater than or equal to
clearedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt less than
clearedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt less than or equal to
details	any details equals
details[eq]	any details equals
details[ne]	any details not equals
details[in]	string details in comma-separated list
details[notIn]	string details not in comma-separated list
details[isNull]	boolean details is null Value: true
details[isNotNull]	boolean details is not null Value: true
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "string",
"clearedAt": "string",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create alarm

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
measurementChannelId required	integer [ 0 .. 9007199254740991 ]
type required	string (AlarmType) Enum: "offline" "port" "temperature"
severity required	string (AlarmSeverity) Enum: "minor" "major" "critical"
status required	string (AlarmStatus) Enum: "active" "cleared"
activeAt required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
required	string or null
required	any or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get alarm by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "string",
"clearedAt": "string",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update alarm

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
measurementChannelId required	integer [ 0 .. 9007199254740991 ]
type required	string (AlarmType) Enum: "offline" "port" "temperature"
severity required	string (AlarmSeverity) Enum: "minor" "major" "critical"
status required	string (AlarmStatus) Enum: "active" "cleared"
activeAt required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
required	string or null
required	any or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "2019-08-24T14:15:22Z",
"clearedAt": "2019-08-24T14:15:22Z",
"details": { },
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "string",
"clearedAt": "string",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete alarm

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get events for alarm

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"alarmId": 9007199254740991,
"measurementId": 9007199254740991,
"time": "string",
"type": "triggered",
"severity": "minor",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Get alarm (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "string",
"clearedAt": "string",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"measurementChannel": {"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
},
"events": [{"id": 9007199254740991,
"alarmId": 9007199254740991,
"measurementId": 9007199254740991,
"time": "string",
"type": "triggered",
"severity": "minor",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"measurement": {"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}
}
]
}

List alarms (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
measurementChannelId	number measurementChannelId equals
measurementChannelId[eq]	number measurementChannelId equals
measurementChannelId[ne]	number measurementChannelId not equals
measurementChannelId[in]	string measurementChannelId in comma-separated list
measurementChannelId[notIn]	string measurementChannelId not in comma-separated list
measurementChannelId[isNull]	boolean measurementChannelId is null Value: true
measurementChannelId[isNotNull]	boolean measurementChannelId is not null Value: true
measurementChannelId[gt]	number measurementChannelId greater than
measurementChannelId[gte]	number measurementChannelId greater than or equal to
measurementChannelId[lt]	number measurementChannelId less than
measurementChannelId[lte]	number measurementChannelId less than or equal to
type	string (AlarmType) Enum: "offline" "port" "temperature" type equals
type[eq]	string (AlarmType) Enum: "offline" "port" "temperature" type equals
type[ne]	string (AlarmType) Enum: "offline" "port" "temperature" type not equals
type[in]	string type in comma-separated list
type[notIn]	string type not in comma-separated list
type[isNull]	boolean type is null Value: true
type[isNotNull]	boolean type is not null Value: true
severity	string (AlarmSeverity) Enum: "minor" "major" "critical" severity equals
severity[eq]	string (AlarmSeverity) Enum: "minor" "major" "critical" severity equals
severity[ne]	string (AlarmSeverity) Enum: "minor" "major" "critical" severity not equals
severity[in]	string severity in comma-separated list
severity[notIn]	string severity not in comma-separated list
severity[isNull]	boolean severity is null Value: true
severity[isNotNull]	boolean severity is not null Value: true
status	string (AlarmStatus) Enum: "active" "cleared" status equals
status[eq]	string (AlarmStatus) Enum: "active" "cleared" status equals
status[ne]	string (AlarmStatus) Enum: "active" "cleared" status not equals
status[in]	string status in comma-separated list
status[notIn]	string status not in comma-separated list
status[isNull]	boolean status is null Value: true
status[isNotNull]	boolean status is not null Value: true
activeAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt equals
activeAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt equals
activeAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt not equals
activeAt[in]	string activeAt in comma-separated list
activeAt[notIn]	string activeAt not in comma-separated list
activeAt[isNull]	boolean activeAt is null Value: true
activeAt[isNotNull]	boolean activeAt is not null Value: true
activeAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt greater than
activeAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt greater than or equal to
activeAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt less than
activeAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... activeAt less than or equal to
clearedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt equals
clearedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt equals
clearedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt not equals
clearedAt[in]	string clearedAt in comma-separated list
clearedAt[notIn]	string clearedAt not in comma-separated list
clearedAt[isNull]	boolean clearedAt is null Value: true
clearedAt[isNotNull]	boolean clearedAt is not null Value: true
clearedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt greater than
clearedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt greater than or equal to
clearedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt less than
clearedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... clearedAt less than or equal to
details	any details equals
details[eq]	any details equals
details[ne]	any details not equals
details[in]	string details in comma-separated list
details[notIn]	string details not in comma-separated list
details[isNull]	boolean details is null Value: true
details[isNotNull]	boolean details is not null Value: true
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"measurementChannelId": 9007199254740991,
"type": "offline",
"severity": "minor",
"status": "active",
"activeAt": "string",
"clearedAt": "string",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"measurementChannel": {"id": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"siteId": 9007199254740991,
"deviceId": 9007199254740991,
"subDeviceId": 9007199254740991,
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
},
"events": [{"id": 9007199254740991,
"alarmId": 9007199254740991,
"measurementId": 9007199254740991,
"time": "string",
"type": "triggered",
"severity": "minor",
"details": { },
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"measurement": {"id": 9007199254740991,
"time": "string",
"measurementChannelId": 9007199254740991,
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"createdAt": "string"
}
}
]
}
]

Modbus Config

Defines modbus configurations for a sub device, with which the IoT Event can be read and stored as measurements.

List modbus configs

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Create modbus config

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
subDeviceTypeId required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get modbus config by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Update modbus config

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
subDeviceTypeId required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Delete modbus config

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get modbus config (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"versions": [{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"registerVersions": [{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"register": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
},
"measurementDefinition": {"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
]
}

Get latest modbus config (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"registerVersions": [{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"register": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
},
"measurementDefinition": {"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
}

Get latest modbus config version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}

Get versions for modbus config

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Get modbus device config

Authorizations:

CognitoAuth

path Parameters

tenant required	string
device required	string

Responses

Response samples

200

Content type

application/json

[{"Name": "string",
"RegAddress": 0,
"NumRegisters": 0,
"SystemType": "UINT",
"SystemName": "string",
"Transform": "string",
"IngestionTransform": "string",
"Unit": "string",
"Group": "string"
}
]

Write modbus device config

Authorizations:

CognitoAuth

path Parameters

tenant required	string
device required	string

Request Body schema: application/json

Array

Name required	string
RegAddress required	number
NumRegisters required	number
SystemType required	string Enum: "UINT" "INT" "UINT_BE" "INT_BE" "STRING" "BOOL" "FLOAT"
SystemName required	string
Transform	string
IngestionTransform	string
Unit	string
Group	string

Responses

Request samples

Payload

Content type

application/json

[{"Name": "string",
"RegAddress": 0,
"NumRegisters": 0,
"SystemType": "UINT",
"SystemName": "string",
"Transform": "string",
"IngestionTransform": "string",
"Unit": "string",
"Group": "string"
}
]

List modbus configs (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"versions": [{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"registerVersions": [{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"register": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
},
"measurementDefinition": {"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
]
}
]

List latest modbus configs (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"registerVersions": [{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"register": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
},
"measurementDefinition": {"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
}
]

List latest modbus configs

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
subDeviceTypeId	number subDeviceTypeId equals
subDeviceTypeId[eq]	number subDeviceTypeId equals
subDeviceTypeId[ne]	number subDeviceTypeId not equals
subDeviceTypeId[in]	string subDeviceTypeId in comma-separated list
subDeviceTypeId[notIn]	string subDeviceTypeId not in comma-separated list
subDeviceTypeId[isNull]	boolean subDeviceTypeId is null Value: true
subDeviceTypeId[isNotNull]	boolean subDeviceTypeId is not null Value: true
subDeviceTypeId[gt]	number subDeviceTypeId greater than
subDeviceTypeId[gte]	number subDeviceTypeId greater than or equal to
subDeviceTypeId[lt]	number subDeviceTypeId less than
subDeviceTypeId[lte]	number subDeviceTypeId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}
]

List modbus configs Overview

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json

[{"device": "string",
"lastModified": "string",
"sites": "string",
"activeCount": 9007199254740991,
"deletedCount": 9007199254740991
}
]

Modbus Config Version

Defines a modbus configiuration versions.

List modbus config versions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
modbusConfigId	number modbusConfigId equals
modbusConfigId[eq]	number modbusConfigId equals
modbusConfigId[ne]	number modbusConfigId not equals
modbusConfigId[in]	string modbusConfigId in comma-separated list
modbusConfigId[notIn]	string modbusConfigId not in comma-separated list
modbusConfigId[isNull]	boolean modbusConfigId is null Value: true
modbusConfigId[isNotNull]	boolean modbusConfigId is not null Value: true
modbusConfigId[gt]	number modbusConfigId greater than
modbusConfigId[gte]	number modbusConfigId greater than or equal to
modbusConfigId[lt]	number modbusConfigId less than
modbusConfigId[lte]	number modbusConfigId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Create modbus config version

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
modbusConfigId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get modbus config version by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Update modbus config version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
modbusConfigId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Delete modbus config version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get modbus config version (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"registerVersions": [{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"register": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
},
"measurementDefinition": {"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}

Get register versions for modbus config version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

List modbus config versions (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
modbusConfigId	number modbusConfigId equals
modbusConfigId[eq]	number modbusConfigId equals
modbusConfigId[ne]	number modbusConfigId not equals
modbusConfigId[in]	string modbusConfigId in comma-separated list
modbusConfigId[notIn]	string modbusConfigId not in comma-separated list
modbusConfigId[isNull]	boolean modbusConfigId is null Value: true
modbusConfigId[isNotNull]	boolean modbusConfigId is not null Value: true
modbusConfigId[gt]	number modbusConfigId greater than
modbusConfigId[gte]	number modbusConfigId greater than or equal to
modbusConfigId[lt]	number modbusConfigId less than
modbusConfigId[lte]	number modbusConfigId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"version": 9007199254740991,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"registerVersions": [{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"register": {"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
},
"measurementDefinition": {"id": 9007199254740991,
"measurementMetricId": 9007199254740991,
"deviceTypeId": 9007199254740991,
"subDeviceTypeId": 9007199254740991,
"key": "string",
"type": "double",
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
}
]
}
]

Modbus Config Register

Defines modbus configuration register identities. These are used as stable identity and as reference point for other entities.

List modbus config registers

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
modbusConfigId	number modbusConfigId equals
modbusConfigId[eq]	number modbusConfigId equals
modbusConfigId[ne]	number modbusConfigId not equals
modbusConfigId[in]	string modbusConfigId in comma-separated list
modbusConfigId[notIn]	string modbusConfigId not in comma-separated list
modbusConfigId[isNull]	boolean modbusConfigId is null Value: true
modbusConfigId[isNotNull]	boolean modbusConfigId is not null Value: true
modbusConfigId[gt]	number modbusConfigId greater than
modbusConfigId[gte]	number modbusConfigId greater than or equal to
modbusConfigId[lt]	number modbusConfigId less than
modbusConfigId[lte]	number modbusConfigId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Create modbus config register

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
modbusConfigId required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get modbus config register by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Update modbus config register

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
modbusConfigId required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Delete modbus config register

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get versions for modbus config register

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Modbus Config Register Version

Defines modbus configurations register versions. Each modbus register is read based on an address, count and type.

List modbus config register versions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
modbusConfigVersionId	number modbusConfigVersionId equals
modbusConfigVersionId[eq]	number modbusConfigVersionId equals
modbusConfigVersionId[ne]	number modbusConfigVersionId not equals
modbusConfigVersionId[in]	string modbusConfigVersionId in comma-separated list
modbusConfigVersionId[notIn]	string modbusConfigVersionId not in comma-separated list
modbusConfigVersionId[isNull]	boolean modbusConfigVersionId is null Value: true
modbusConfigVersionId[isNotNull]	boolean modbusConfigVersionId is not null Value: true
modbusConfigVersionId[gt]	number modbusConfigVersionId greater than
modbusConfigVersionId[gte]	number modbusConfigVersionId greater than or equal to
modbusConfigVersionId[lt]	number modbusConfigVersionId less than
modbusConfigVersionId[lte]	number modbusConfigVersionId less than or equal to
modbusConfigRegisterId	number modbusConfigRegisterId equals
modbusConfigRegisterId[eq]	number modbusConfigRegisterId equals
modbusConfigRegisterId[ne]	number modbusConfigRegisterId not equals
modbusConfigRegisterId[in]	string modbusConfigRegisterId in comma-separated list
modbusConfigRegisterId[notIn]	string modbusConfigRegisterId not in comma-separated list
modbusConfigRegisterId[isNull]	boolean modbusConfigRegisterId is null Value: true
modbusConfigRegisterId[isNotNull]	boolean modbusConfigRegisterId is not null Value: true
modbusConfigRegisterId[gt]	number modbusConfigRegisterId greater than
modbusConfigRegisterId[gte]	number modbusConfigRegisterId greater than or equal to
modbusConfigRegisterId[lt]	number modbusConfigRegisterId less than
modbusConfigRegisterId[lte]	number modbusConfigRegisterId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
measurementDefinitionId	number measurementDefinitionId equals
measurementDefinitionId[eq]	number measurementDefinitionId equals
measurementDefinitionId[ne]	number measurementDefinitionId not equals
measurementDefinitionId[in]	string measurementDefinitionId in comma-separated list
measurementDefinitionId[notIn]	string measurementDefinitionId not in comma-separated list
measurementDefinitionId[isNull]	boolean measurementDefinitionId is null Value: true
measurementDefinitionId[isNotNull]	boolean measurementDefinitionId is not null Value: true
measurementDefinitionId[gt]	number measurementDefinitionId greater than
measurementDefinitionId[gte]	number measurementDefinitionId greater than or equal to
measurementDefinitionId[lt]	number measurementDefinitionId less than
measurementDefinitionId[lte]	number measurementDefinitionId less than or equal to
registerAddress	number registerAddress equals
registerAddress[eq]	number registerAddress equals
registerAddress[ne]	number registerAddress not equals
registerAddress[in]	string registerAddress in comma-separated list
registerAddress[notIn]	string registerAddress not in comma-separated list
registerAddress[isNull]	boolean registerAddress is null Value: true
registerAddress[isNotNull]	boolean registerAddress is not null Value: true
registerAddress[gt]	number registerAddress greater than
registerAddress[gte]	number registerAddress greater than or equal to
registerAddress[lt]	number registerAddress less than
registerAddress[lte]	number registerAddress less than or equal to
registerCount	number registerCount equals
registerCount[eq]	number registerCount equals
registerCount[ne]	number registerCount not equals
registerCount[in]	string registerCount in comma-separated list
registerCount[notIn]	string registerCount not in comma-separated list
registerCount[isNull]	boolean registerCount is null Value: true
registerCount[isNotNull]	boolean registerCount is not null Value: true
registerCount[gt]	number registerCount greater than
registerCount[gte]	number registerCount greater than or equal to
registerCount[lt]	number registerCount less than
registerCount[lte]	number registerCount less than or equal to
registerType	string (ModbusConfigRegisterType) Enum: "uint" "int" "uint_be" "int_be" "string" "bool" "float" registerType equals
registerType[eq]	string (ModbusConfigRegisterType) Enum: "uint" "int" "uint_be" "int_be" "string" "bool" "float" registerType equals
registerType[ne]	string (ModbusConfigRegisterType) Enum: "uint" "int" "uint_be" "int_be" "string" "bool" "float" registerType not equals
registerType[in]	string registerType in comma-separated list
registerType[notIn]	string registerType not in comma-separated list
registerType[isNull]	boolean registerType is null Value: true
registerType[isNotNull]	boolean registerType is not null Value: true
registerTransform	string registerTransform equals
registerTransform[eq]	string registerTransform equals
registerTransform[ne]	string registerTransform not equals
registerTransform[in]	string registerTransform in comma-separated list
registerTransform[notIn]	string registerTransform not in comma-separated list
registerTransform[isNull]	boolean registerTransform is null Value: true
registerTransform[isNotNull]	boolean registerTransform is not null Value: true
registerTransform[like]	string registerTransform matches pattern (case-sensitive)
registerTransform[ilike]	string registerTransform matches pattern (case-insensitive)
registerTransform[notLike]	string registerTransform does not match pattern (case-sensitive)
registerTransform[notIlike]	string registerTransform does not match pattern (case-insensitive)
label	string label equals
label[eq]	string label equals
label[ne]	string label not equals
label[in]	string label in comma-separated list
label[notIn]	string label not in comma-separated list
label[isNull]	boolean label is null Value: true
label[isNotNull]	boolean label is not null Value: true
label[like]	string label matches pattern (case-sensitive)
label[ilike]	string label matches pattern (case-insensitive)
label[notLike]	string label does not match pattern (case-sensitive)
label[notIlike]	string label does not match pattern (case-insensitive)
unit	string unit equals
unit[eq]	string unit equals
unit[ne]	string unit not equals
unit[in]	string unit in comma-separated list
unit[notIn]	string unit not in comma-separated list
unit[isNull]	boolean unit is null Value: true
unit[isNotNull]	boolean unit is not null Value: true
unit[like]	string unit matches pattern (case-sensitive)
unit[ilike]	string unit matches pattern (case-insensitive)
unit[notLike]	string unit does not match pattern (case-sensitive)
unit[notIlike]	string unit does not match pattern (case-insensitive)
group	string group equals
group[eq]	string group equals
group[ne]	string group not equals
group[in]	string group in comma-separated list
group[notIn]	string group not in comma-separated list
group[isNull]	boolean group is null Value: true
group[isNotNull]	boolean group is not null Value: true
group[like]	string group matches pattern (case-sensitive)
group[ilike]	string group matches pattern (case-insensitive)
group[notLike]	string group does not match pattern (case-sensitive)
group[notIlike]	string group does not match pattern (case-insensitive)
transform	string transform equals
transform[eq]	string transform equals
transform[ne]	string transform not equals
transform[in]	string transform in comma-separated list
transform[notIn]	string transform not in comma-separated list
transform[isNull]	boolean transform is null Value: true
transform[isNotNull]	boolean transform is not null Value: true
transform[like]	string transform matches pattern (case-sensitive)
transform[ilike]	string transform matches pattern (case-insensitive)
transform[notLike]	string transform does not match pattern (case-sensitive)
transform[notIlike]	string transform does not match pattern (case-insensitive)
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Create modbus config register version

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
modbusConfigVersionId required	integer [ 0 .. 9007199254740991 ]
modbusConfigRegisterId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
measurementDefinitionId required	integer [ 0 .. 9007199254740991 ]
registerAddress required	integer [ 0 .. 9007199254740991 ]
registerCount required	integer [ 0 .. 9007199254740991 ]
registerType required	string (ModbusConfigRegisterType) Enum: "uint" "int" "uint_be" "int_be" "string" "bool" "float"
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
required	object (ModbusConfigRegisterRequest)
required	object (MeasurementDefinitionCreateRequest)

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get modbus config register version by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Update modbus config register version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
modbusConfigVersionId required	integer [ 0 .. 9007199254740991 ]
modbusConfigRegisterId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
measurementDefinitionId required	integer [ 0 .. 9007199254740991 ]
registerAddress required	integer [ 0 .. 9007199254740991 ]
registerCount required	integer [ 0 .. 9007199254740991 ]
registerType required	string (ModbusConfigRegisterType) Enum: "uint" "int" "uint_be" "int_be" "string" "bool" "float"
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"modbusConfigVersionId": 9007199254740991,
"modbusConfigRegisterId": 9007199254740991,
"version": 9007199254740991,
"measurementDefinitionId": 9007199254740991,
"registerAddress": 9007199254740991,
"registerCount": 9007199254740991,
"registerType": "uint",
"registerTransform": "string",
"label": "string",
"unit": "string",
"group": "string",
"transform": "string",
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Delete modbus config register version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Property

List properties

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
site	string non-empty site equals
site[eq]	string non-empty site equals
site[ne]	string non-empty site not equals
site[in]	string site in comma-separated list
site[notIn]	string site not in comma-separated list
site[isNull]	boolean site is null Value: true
site[isNotNull]	boolean site is not null Value: true
site[like]	string site matches pattern (case-sensitive)
site[ilike]	string site matches pattern (case-insensitive)
site[notLike]	string site does not match pattern (case-sensitive)
site[notIlike]	string site does not match pattern (case-insensitive)
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
propertyTypeId	number propertyTypeId equals
propertyTypeId[eq]	number propertyTypeId equals
propertyTypeId[ne]	number propertyTypeId not equals
propertyTypeId[in]	string propertyTypeId in comma-separated list
propertyTypeId[notIn]	string propertyTypeId not in comma-separated list
propertyTypeId[isNull]	boolean propertyTypeId is null Value: true
propertyTypeId[isNotNull]	boolean propertyTypeId is not null Value: true
propertyTypeId[gt]	number propertyTypeId greater than
propertyTypeId[gte]	number propertyTypeId greater than or equal to
propertyTypeId[lt]	number propertyTypeId less than
propertyTypeId[lte]	number propertyTypeId less than or equal to
propertyTypeVersionId	number propertyTypeVersionId equals
propertyTypeVersionId[eq]	number propertyTypeVersionId equals
propertyTypeVersionId[ne]	number propertyTypeVersionId not equals
propertyTypeVersionId[in]	string propertyTypeVersionId in comma-separated list
propertyTypeVersionId[notIn]	string propertyTypeVersionId not in comma-separated list
propertyTypeVersionId[isNull]	boolean propertyTypeVersionId is null Value: true
propertyTypeVersionId[isNotNull]	boolean propertyTypeVersionId is not null Value: true
propertyTypeVersionId[gt]	number propertyTypeVersionId greater than
propertyTypeVersionId[gte]	number propertyTypeVersionId greater than or equal to
propertyTypeVersionId[lt]	number propertyTypeVersionId less than
propertyTypeVersionId[lte]	number propertyTypeVersionId less than or equal to
time	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time not equals
time[in]	string time in comma-separated list
time[notIn]	string time not in comma-separated list
time[isNull]	boolean time is null Value: true
time[isNotNull]	boolean time is not null Value: true
time[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than
time[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than or equal to
time[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than
time[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than or equal to
valueDouble	number valueDouble equals
valueDouble[eq]	number valueDouble equals
valueDouble[ne]	number valueDouble not equals
valueDouble[in]	string valueDouble in comma-separated list
valueDouble[notIn]	string valueDouble not in comma-separated list
valueDouble[isNull]	boolean valueDouble is null Value: true
valueDouble[isNotNull]	boolean valueDouble is not null Value: true
valueDouble[gt]	number valueDouble greater than
valueDouble[gte]	number valueDouble greater than or equal to
valueDouble[lt]	number valueDouble less than
valueDouble[lte]	number valueDouble less than or equal to
valueInt	number valueInt equals
valueInt[eq]	number valueInt equals
valueInt[ne]	number valueInt not equals
valueInt[in]	string valueInt in comma-separated list
valueInt[notIn]	string valueInt not in comma-separated list
valueInt[isNull]	boolean valueInt is null Value: true
valueInt[isNotNull]	boolean valueInt is not null Value: true
valueInt[gt]	number valueInt greater than
valueInt[gte]	number valueInt greater than or equal to
valueInt[lt]	number valueInt less than
valueInt[lte]	number valueInt less than or equal to
valueString	string valueString equals
valueString[eq]	string valueString equals
valueString[ne]	string valueString not equals
valueString[in]	string valueString in comma-separated list
valueString[notIn]	string valueString not in comma-separated list
valueString[isNull]	boolean valueString is null Value: true
valueString[isNotNull]	boolean valueString is not null Value: true
valueString[like]	string valueString matches pattern (case-sensitive)
valueString[ilike]	string valueString matches pattern (case-insensitive)
valueString[notLike]	string valueString does not match pattern (case-sensitive)
valueString[notIlike]	string valueString does not match pattern (case-insensitive)
valueBool	boolean valueBool equals
valueBool[eq]	boolean valueBool equals
valueBool[ne]	boolean valueBool not equals
valueBool[in]	string valueBool in comma-separated list
valueBool[notIn]	string valueBool not in comma-separated list
valueBool[isNull]	boolean valueBool is null Value: true
valueBool[isNotNull]	boolean valueBool is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Create property

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
site required	string non-empty
siteId required	integer [ 0 .. 9007199254740991 ]
propertyTypeId required	integer [ 0 .. 9007199254740991 ]
propertyTypeVersionId required	integer [ 0 .. 9007199254740991 ]
time required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
required	number or null
required	integer or null
required	string or null
required	boolean or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects (PropertyFileRequest)

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get property by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Update property

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
site required	string non-empty
siteId required	integer [ 0 .. 9007199254740991 ]
propertyTypeId required	integer [ 0 .. 9007199254740991 ]
propertyTypeVersionId required	integer [ 0 .. 9007199254740991 ]
time required	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
required	number or null
required	integer or null
required	string or null
required	boolean or null
required	string or null
required	string or null
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "2019-08-24T14:15:22Z",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

Delete property

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get files for property

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"propertyId": 9007199254740991,
"fileId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Get property (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"files": [{"id": 9007199254740991,
"propertyId": 9007199254740991,
"fileId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]
}

Get latest property

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}

List properties (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
site	string non-empty site equals
site[eq]	string non-empty site equals
site[ne]	string non-empty site not equals
site[in]	string site in comma-separated list
site[notIn]	string site not in comma-separated list
site[isNull]	boolean site is null Value: true
site[isNotNull]	boolean site is not null Value: true
site[like]	string site matches pattern (case-sensitive)
site[ilike]	string site matches pattern (case-insensitive)
site[notLike]	string site does not match pattern (case-sensitive)
site[notIlike]	string site does not match pattern (case-insensitive)
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
propertyTypeId	number propertyTypeId equals
propertyTypeId[eq]	number propertyTypeId equals
propertyTypeId[ne]	number propertyTypeId not equals
propertyTypeId[in]	string propertyTypeId in comma-separated list
propertyTypeId[notIn]	string propertyTypeId not in comma-separated list
propertyTypeId[isNull]	boolean propertyTypeId is null Value: true
propertyTypeId[isNotNull]	boolean propertyTypeId is not null Value: true
propertyTypeId[gt]	number propertyTypeId greater than
propertyTypeId[gte]	number propertyTypeId greater than or equal to
propertyTypeId[lt]	number propertyTypeId less than
propertyTypeId[lte]	number propertyTypeId less than or equal to
propertyTypeVersionId	number propertyTypeVersionId equals
propertyTypeVersionId[eq]	number propertyTypeVersionId equals
propertyTypeVersionId[ne]	number propertyTypeVersionId not equals
propertyTypeVersionId[in]	string propertyTypeVersionId in comma-separated list
propertyTypeVersionId[notIn]	string propertyTypeVersionId not in comma-separated list
propertyTypeVersionId[isNull]	boolean propertyTypeVersionId is null Value: true
propertyTypeVersionId[isNotNull]	boolean propertyTypeVersionId is not null Value: true
propertyTypeVersionId[gt]	number propertyTypeVersionId greater than
propertyTypeVersionId[gte]	number propertyTypeVersionId greater than or equal to
propertyTypeVersionId[lt]	number propertyTypeVersionId less than
propertyTypeVersionId[lte]	number propertyTypeVersionId less than or equal to
time	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time not equals
time[in]	string time in comma-separated list
time[notIn]	string time not in comma-separated list
time[isNull]	boolean time is null Value: true
time[isNotNull]	boolean time is not null Value: true
time[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than
time[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than or equal to
time[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than
time[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than or equal to
valueDouble	number valueDouble equals
valueDouble[eq]	number valueDouble equals
valueDouble[ne]	number valueDouble not equals
valueDouble[in]	string valueDouble in comma-separated list
valueDouble[notIn]	string valueDouble not in comma-separated list
valueDouble[isNull]	boolean valueDouble is null Value: true
valueDouble[isNotNull]	boolean valueDouble is not null Value: true
valueDouble[gt]	number valueDouble greater than
valueDouble[gte]	number valueDouble greater than or equal to
valueDouble[lt]	number valueDouble less than
valueDouble[lte]	number valueDouble less than or equal to
valueInt	number valueInt equals
valueInt[eq]	number valueInt equals
valueInt[ne]	number valueInt not equals
valueInt[in]	string valueInt in comma-separated list
valueInt[notIn]	string valueInt not in comma-separated list
valueInt[isNull]	boolean valueInt is null Value: true
valueInt[isNotNull]	boolean valueInt is not null Value: true
valueInt[gt]	number valueInt greater than
valueInt[gte]	number valueInt greater than or equal to
valueInt[lt]	number valueInt less than
valueInt[lte]	number valueInt less than or equal to
valueString	string valueString equals
valueString[eq]	string valueString equals
valueString[ne]	string valueString not equals
valueString[in]	string valueString in comma-separated list
valueString[notIn]	string valueString not in comma-separated list
valueString[isNull]	boolean valueString is null Value: true
valueString[isNotNull]	boolean valueString is not null Value: true
valueString[like]	string valueString matches pattern (case-sensitive)
valueString[ilike]	string valueString matches pattern (case-insensitive)
valueString[notLike]	string valueString does not match pattern (case-sensitive)
valueString[notIlike]	string valueString does not match pattern (case-insensitive)
valueBool	boolean valueBool equals
valueBool[eq]	boolean valueBool equals
valueBool[ne]	boolean valueBool not equals
valueBool[in]	string valueBool in comma-separated list
valueBool[notIn]	string valueBool not in comma-separated list
valueBool[isNull]	boolean valueBool is null Value: true
valueBool[isNotNull]	boolean valueBool is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"files": [{"id": 9007199254740991,
"propertyId": 9007199254740991,
"fileId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]
}
]

List latest properties

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
site	string non-empty site equals
site[eq]	string non-empty site equals
site[ne]	string non-empty site not equals
site[in]	string site in comma-separated list
site[notIn]	string site not in comma-separated list
site[isNull]	boolean site is null Value: true
site[isNotNull]	boolean site is not null Value: true
site[like]	string site matches pattern (case-sensitive)
site[ilike]	string site matches pattern (case-insensitive)
site[notLike]	string site does not match pattern (case-sensitive)
site[notIlike]	string site does not match pattern (case-insensitive)
siteId	number siteId equals
siteId[eq]	number siteId equals
siteId[ne]	number siteId not equals
siteId[in]	string siteId in comma-separated list
siteId[notIn]	string siteId not in comma-separated list
siteId[isNull]	boolean siteId is null Value: true
siteId[isNotNull]	boolean siteId is not null Value: true
siteId[gt]	number siteId greater than
siteId[gte]	number siteId greater than or equal to
siteId[lt]	number siteId less than
siteId[lte]	number siteId less than or equal to
propertyTypeId	number propertyTypeId equals
propertyTypeId[eq]	number propertyTypeId equals
propertyTypeId[ne]	number propertyTypeId not equals
propertyTypeId[in]	string propertyTypeId in comma-separated list
propertyTypeId[notIn]	string propertyTypeId not in comma-separated list
propertyTypeId[isNull]	boolean propertyTypeId is null Value: true
propertyTypeId[isNotNull]	boolean propertyTypeId is not null Value: true
propertyTypeId[gt]	number propertyTypeId greater than
propertyTypeId[gte]	number propertyTypeId greater than or equal to
propertyTypeId[lt]	number propertyTypeId less than
propertyTypeId[lte]	number propertyTypeId less than or equal to
propertyTypeVersionId	number propertyTypeVersionId equals
propertyTypeVersionId[eq]	number propertyTypeVersionId equals
propertyTypeVersionId[ne]	number propertyTypeVersionId not equals
propertyTypeVersionId[in]	string propertyTypeVersionId in comma-separated list
propertyTypeVersionId[notIn]	string propertyTypeVersionId not in comma-separated list
propertyTypeVersionId[isNull]	boolean propertyTypeVersionId is null Value: true
propertyTypeVersionId[isNotNull]	boolean propertyTypeVersionId is not null Value: true
propertyTypeVersionId[gt]	number propertyTypeVersionId greater than
propertyTypeVersionId[gte]	number propertyTypeVersionId greater than or equal to
propertyTypeVersionId[lt]	number propertyTypeVersionId less than
propertyTypeVersionId[lte]	number propertyTypeVersionId less than or equal to
time	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time equals
time[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time not equals
time[in]	string time in comma-separated list
time[notIn]	string time not in comma-separated list
time[isNull]	boolean time is null Value: true
time[isNotNull]	boolean time is not null Value: true
time[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than
time[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time greater than or equal to
time[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than
time[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... time less than or equal to
valueDouble	number valueDouble equals
valueDouble[eq]	number valueDouble equals
valueDouble[ne]	number valueDouble not equals
valueDouble[in]	string valueDouble in comma-separated list
valueDouble[notIn]	string valueDouble not in comma-separated list
valueDouble[isNull]	boolean valueDouble is null Value: true
valueDouble[isNotNull]	boolean valueDouble is not null Value: true
valueDouble[gt]	number valueDouble greater than
valueDouble[gte]	number valueDouble greater than or equal to
valueDouble[lt]	number valueDouble less than
valueDouble[lte]	number valueDouble less than or equal to
valueInt	number valueInt equals
valueInt[eq]	number valueInt equals
valueInt[ne]	number valueInt not equals
valueInt[in]	string valueInt in comma-separated list
valueInt[notIn]	string valueInt not in comma-separated list
valueInt[isNull]	boolean valueInt is null Value: true
valueInt[isNotNull]	boolean valueInt is not null Value: true
valueInt[gt]	number valueInt greater than
valueInt[gte]	number valueInt greater than or equal to
valueInt[lt]	number valueInt less than
valueInt[lte]	number valueInt less than or equal to
valueString	string valueString equals
valueString[eq]	string valueString equals
valueString[ne]	string valueString not equals
valueString[in]	string valueString in comma-separated list
valueString[notIn]	string valueString not in comma-separated list
valueString[isNull]	boolean valueString is null Value: true
valueString[isNotNull]	boolean valueString is not null Value: true
valueString[like]	string valueString matches pattern (case-sensitive)
valueString[ilike]	string valueString matches pattern (case-insensitive)
valueString[notLike]	string valueString does not match pattern (case-sensitive)
valueString[notIlike]	string valueString does not match pattern (case-insensitive)
valueBool	boolean valueBool equals
valueBool[eq]	boolean valueBool equals
valueBool[ne]	boolean valueBool not equals
valueBool[in]	string valueBool in comma-separated list
valueBool[notIn]	string valueBool not in comma-separated list
valueBool[isNull]	boolean valueBool is null Value: true
valueBool[isNotNull]	boolean valueBool is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"site": "string",
"siteId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"propertyTypeVersionId": 9007199254740991,
"time": "string",
"valueDouble": 0,
"valueInt": -9007199254740991,
"valueString": "string",
"valueBool": true,
"updatedById": "string",
"updatedByUsername": "string",
"createdById": "string",
"createdByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"createdAt": "string"
}
]

Property Type

List property types

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
formId	number formId equals
formId[eq]	number formId equals
formId[ne]	number formId not equals
formId[in]	string formId in comma-separated list
formId[notIn]	string formId not in comma-separated list
formId[isNull]	boolean formId is null Value: true
formId[isNotNull]	boolean formId is not null Value: true
formId[gt]	number formId greater than
formId[gte]	number formId greater than or equal to
formId[lt]	number formId less than
formId[lte]	number formId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Create property type

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
formId required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get property type by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Update property type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
formId required	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Delete property type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get property type (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Get latest property type version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Get versions for property type

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

List property types (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
formId	number formId equals
formId[eq]	number formId equals
formId[ne]	number formId not equals
formId[in]	string formId in comma-separated list
formId[notIn]	string formId not in comma-separated list
formId[isNull]	boolean formId is null Value: true
formId[isNotNull]	boolean formId is not null Value: true
formId[gt]	number formId greater than
formId[gte]	number formId greater than or equal to
formId[lt]	number formId less than
formId[lte]	number formId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

List latest property types

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
formId	number formId equals
formId[eq]	number formId equals
formId[ne]	number formId not equals
formId[in]	string formId in comma-separated list
formId[notIn]	string formId not in comma-separated list
formId[isNull]	boolean formId is null Value: true
formId[isNotNull]	boolean formId is not null Value: true
formId[gt]	number formId greater than
formId[gte]	number formId greater than or equal to
formId[lt]	number formId less than
formId[lte]	number formId less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Property Type Version

List property type versions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
formVersionId	number formVersionId equals
formVersionId[eq]	number formVersionId equals
formVersionId[ne]	number formVersionId not equals
formVersionId[in]	string formVersionId in comma-separated list
formVersionId[notIn]	string formVersionId not in comma-separated list
formVersionId[isNull]	boolean formVersionId is null Value: true
formVersionId[isNotNull]	boolean formVersionId is not null Value: true
formVersionId[gt]	number formVersionId greater than
formVersionId[gte]	number formVersionId greater than or equal to
formVersionId[lt]	number formVersionId less than
formVersionId[lte]	number formVersionId less than or equal to
propertyTypeId	number propertyTypeId equals
propertyTypeId[eq]	number propertyTypeId equals
propertyTypeId[ne]	number propertyTypeId not equals
propertyTypeId[in]	string propertyTypeId in comma-separated list
propertyTypeId[notIn]	string propertyTypeId not in comma-separated list
propertyTypeId[isNull]	boolean propertyTypeId is null Value: true
propertyTypeId[isNotNull]	boolean propertyTypeId is not null Value: true
propertyTypeId[gt]	number propertyTypeId greater than
propertyTypeId[gte]	number propertyTypeId greater than or equal to
propertyTypeId[lt]	number propertyTypeId less than
propertyTypeId[lte]	number propertyTypeId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
key	string key equals
key[eq]	string key equals
key[ne]	string key not equals
key[in]	string key in comma-separated list
key[notIn]	string key not in comma-separated list
key[isNull]	boolean key is null Value: true
key[isNotNull]	boolean key is not null Value: true
key[like]	string key matches pattern (case-sensitive)
key[ilike]	string key matches pattern (case-insensitive)
key[notLike]	string key does not match pattern (case-sensitive)
key[notIlike]	string key does not match pattern (case-insensitive)
schema	any schema equals
schema[eq]	any schema equals
schema[ne]	any schema not equals
schema[in]	string schema in comma-separated list
schema[notIn]	string schema not in comma-separated list
schema[isNull]	boolean schema is null Value: true
schema[isNotNull]	boolean schema is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Create property type version

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
formVersionId required	integer [ 0 .. 9007199254740991 ]
propertyTypeId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
schema required	any
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	object (PropertyTypeRequest)

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get property type version by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Update property type version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
formVersionId required	integer [ 0 .. 9007199254740991 ]
propertyTypeId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
key required	string non-empty
schema required	any
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Delete property type version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Form

List forms

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Create form

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get form by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Update form

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
required	string or null
required	string or null
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}

Delete form

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get form (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"versions": [{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyTypeVersions": [{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyType": {"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
}
]
}
]
}

Get latest form (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyTypeVersions": [{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyType": {"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
}
]
}
}

Get latest form

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}

Get property types for form

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
]

Get latest property types for form

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}
]

Get versions for form

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

List forms (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"versions": [{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyTypeVersions": [{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyType": {"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
}
]
}
]
}
]

List latest forms (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyTypeVersions": [{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyType": {"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
}
]
}
}
]

List latest forms

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
createdById	string createdById equals
createdById[eq]	string createdById equals
createdById[ne]	string createdById not equals
createdById[in]	string createdById in comma-separated list
createdById[notIn]	string createdById not in comma-separated list
createdById[isNull]	boolean createdById is null Value: true
createdById[isNotNull]	boolean createdById is not null Value: true
createdById[like]	string createdById matches pattern (case-sensitive)
createdById[ilike]	string createdById matches pattern (case-insensitive)
createdById[notLike]	string createdById does not match pattern (case-sensitive)
createdById[notIlike]	string createdById does not match pattern (case-insensitive)
createdByUsername	string createdByUsername equals
createdByUsername[eq]	string createdByUsername equals
createdByUsername[ne]	string createdByUsername not equals
createdByUsername[in]	string createdByUsername in comma-separated list
createdByUsername[notIn]	string createdByUsername not in comma-separated list
createdByUsername[isNull]	boolean createdByUsername is null Value: true
createdByUsername[isNotNull]	boolean createdByUsername is not null Value: true
createdByUsername[like]	string createdByUsername matches pattern (case-sensitive)
createdByUsername[ilike]	string createdByUsername matches pattern (case-insensitive)
createdByUsername[notLike]	string createdByUsername does not match pattern (case-sensitive)
createdByUsername[notIlike]	string createdByUsername does not match pattern (case-insensitive)
createdAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt equals
createdAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt not equals
createdAt[in]	string createdAt in comma-separated list
createdAt[notIn]	string createdAt not in comma-separated list
createdAt[isNull]	boolean createdAt is null Value: true
createdAt[isNotNull]	boolean createdAt is not null Value: true
createdAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than
createdAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt greater than or equal to
createdAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than
createdAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... createdAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string",
"latestVersion": {"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
}
]

Form Version

List form versions

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
formId	number formId equals
formId[eq]	number formId equals
formId[ne]	number formId not equals
formId[in]	string formId in comma-separated list
formId[notIn]	string formId not in comma-separated list
formId[isNull]	boolean formId is null Value: true
formId[isNotNull]	boolean formId is not null Value: true
formId[gt]	number formId greater than
formId[gte]	number formId greater than or equal to
formId[lt]	number formId less than
formId[lte]	number formId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
name	string non-empty name equals
name[eq]	string non-empty name equals
name[ne]	string non-empty name not equals
name[in]	string name in comma-separated list
name[notIn]	string name not in comma-separated list
name[isNull]	boolean name is null Value: true
name[isNotNull]	boolean name is not null Value: true
name[like]	string name matches pattern (case-sensitive)
name[ilike]	string name matches pattern (case-insensitive)
name[notLike]	string name does not match pattern (case-sensitive)
name[notIlike]	string name does not match pattern (case-insensitive)
description	string description equals
description[eq]	string description equals
description[ne]	string description not equals
description[in]	string description in comma-separated list
description[notIn]	string description not in comma-separated list
description[isNull]	boolean description is null Value: true
description[isNotNull]	boolean description is not null Value: true
description[like]	string description matches pattern (case-sensitive)
description[ilike]	string description matches pattern (case-insensitive)
description[notLike]	string description does not match pattern (case-sensitive)
description[notIlike]	string description does not match pattern (case-insensitive)
uiSchema	any uiSchema equals
uiSchema[eq]	any uiSchema equals
uiSchema[ne]	any uiSchema not equals
uiSchema[in]	string uiSchema in comma-separated list
uiSchema[notIn]	string uiSchema not in comma-separated list
uiSchema[isNull]	boolean uiSchema is null Value: true
uiSchema[isNotNull]	boolean uiSchema is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

Create form version

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

Request Body schema: application/json

Any of

id	integer [ 0 .. 9007199254740991 ]
formId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
name required	string non-empty
required	string or null
uiSchema required	any
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...
	Array of objects

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

201

Content type

application/json

[ ]

Get form version by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Update form version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Request Body schema: application/json

id	integer [ 0 .. 9007199254740991 ]
formId required	integer [ 0 .. 9007199254740991 ]
version required	integer [ 0 .. 9007199254740991 ]
name required	string non-empty
required	string or null
uiSchema required	any
required	string or null
required	string or null
required	string or null
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[...

Responses

Request samples

Payload

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}

Delete form version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Get form version (full) by ID

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyTypeVersions": [{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyType": {"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
}
]
}

Get property type versions for form version

Authorizations:

CognitoAuth

path Parameters

tenant required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string"
}
]

List form versions (full)

Authorizations:

CognitoAuth

path Parameters

tenant

required

string

query Parameters

limit	integer >= 1 Maximum number of results to return
offset	integer >= 0 Number of results to skip
orderBy	string Comma-separated fields, prefix with + for asc or - for desc. E.g. +id,-createdAt
id	number id equals
id[eq]	number id equals
id[ne]	number id not equals
id[in]	string id in comma-separated list
id[notIn]	string id not in comma-separated list
id[isNull]	boolean id is null Value: true
id[isNotNull]	boolean id is not null Value: true
id[gt]	number id greater than
id[gte]	number id greater than or equal to
id[lt]	number id less than
id[lte]	number id less than or equal to
formId	number formId equals
formId[eq]	number formId equals
formId[ne]	number formId not equals
formId[in]	string formId in comma-separated list
formId[notIn]	string formId not in comma-separated list
formId[isNull]	boolean formId is null Value: true
formId[isNotNull]	boolean formId is not null Value: true
formId[gt]	number formId greater than
formId[gte]	number formId greater than or equal to
formId[lt]	number formId less than
formId[lte]	number formId less than or equal to
version	number version equals
version[eq]	number version equals
version[ne]	number version not equals
version[in]	string version in comma-separated list
version[notIn]	string version not in comma-separated list
version[isNull]	boolean version is null Value: true
version[isNotNull]	boolean version is not null Value: true
version[gt]	number version greater than
version[gte]	number version greater than or equal to
version[lt]	number version less than
version[lte]	number version less than or equal to
name	string non-empty name equals
name[eq]	string non-empty name equals
name[ne]	string non-empty name not equals
name[in]	string name in comma-separated list
name[notIn]	string name not in comma-separated list
name[isNull]	boolean name is null Value: true
name[isNotNull]	boolean name is not null Value: true
name[like]	string name matches pattern (case-sensitive)
name[ilike]	string name matches pattern (case-insensitive)
name[notLike]	string name does not match pattern (case-sensitive)
name[notIlike]	string name does not match pattern (case-insensitive)
description	string description equals
description[eq]	string description equals
description[ne]	string description not equals
description[in]	string description in comma-separated list
description[notIn]	string description not in comma-separated list
description[isNull]	boolean description is null Value: true
description[isNotNull]	boolean description is not null Value: true
description[like]	string description matches pattern (case-sensitive)
description[ilike]	string description matches pattern (case-insensitive)
description[notLike]	string description does not match pattern (case-sensitive)
description[notIlike]	string description does not match pattern (case-insensitive)
uiSchema	any uiSchema equals
uiSchema[eq]	any uiSchema equals
uiSchema[ne]	any uiSchema not equals
uiSchema[in]	string uiSchema in comma-separated list
uiSchema[notIn]	string uiSchema not in comma-separated list
uiSchema[isNull]	boolean uiSchema is null Value: true
uiSchema[isNotNull]	boolean uiSchema is not null Value: true
updatedById	string updatedById equals
updatedById[eq]	string updatedById equals
updatedById[ne]	string updatedById not equals
updatedById[in]	string updatedById in comma-separated list
updatedById[notIn]	string updatedById not in comma-separated list
updatedById[isNull]	boolean updatedById is null Value: true
updatedById[isNotNull]	boolean updatedById is not null Value: true
updatedById[like]	string updatedById matches pattern (case-sensitive)
updatedById[ilike]	string updatedById matches pattern (case-insensitive)
updatedById[notLike]	string updatedById does not match pattern (case-sensitive)
updatedById[notIlike]	string updatedById does not match pattern (case-insensitive)
updatedByUsername	string updatedByUsername equals
updatedByUsername[eq]	string updatedByUsername equals
updatedByUsername[ne]	string updatedByUsername not equals
updatedByUsername[in]	string updatedByUsername in comma-separated list
updatedByUsername[notIn]	string updatedByUsername not in comma-separated list
updatedByUsername[isNull]	boolean updatedByUsername is null Value: true
updatedByUsername[isNotNull]	boolean updatedByUsername is not null Value: true
updatedByUsername[like]	string updatedByUsername matches pattern (case-sensitive)
updatedByUsername[ilike]	string updatedByUsername matches pattern (case-insensitive)
updatedByUsername[notLike]	string updatedByUsername does not match pattern (case-sensitive)
updatedByUsername[notIlike]	string updatedByUsername does not match pattern (case-insensitive)
deletedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt equals
deletedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt not equals
deletedAt[in]	string deletedAt in comma-separated list
deletedAt[notIn]	string deletedAt not in comma-separated list
deletedAt[isNull]	boolean deletedAt is null Value: true
deletedAt[isNotNull]	boolean deletedAt is not null Value: true
deletedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than
deletedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt greater than or equal to
deletedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than
deletedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... deletedAt less than or equal to
updatedAt	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[eq]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt equals
updatedAt[ne]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt not equals
updatedAt[in]	string updatedAt in comma-separated list
updatedAt[notIn]	string updatedAt not in comma-separated list
updatedAt[isNull]	boolean updatedAt is null Value: true
updatedAt[isNotNull]	boolean updatedAt is not null Value: true
updatedAt[gt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than
updatedAt[gte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt greater than or equal to
updatedAt[lt]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than
updatedAt[lte]	string <date-time> ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[... updatedAt less than or equal to

Responses

Response samples

200

Content type

application/json

[{"id": 9007199254740991,
"formId": 9007199254740991,
"version": 9007199254740991,
"name": "string",
"description": "string",
"uiSchema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyTypeVersions": [{"id": 9007199254740991,
"formVersionId": 9007199254740991,
"propertyTypeId": 9007199254740991,
"version": 9007199254740991,
"key": "string",
"schema": null,
"updatedById": "string",
"updatedByUsername": "string",
"deletedAt": "string",
"updatedAt": "string",
"propertyType": {"id": 9007199254740991,
"formId": 9007199254740991,
"createdById": "string",
"createdByUsername": "string",
"createdAt": "string"
}
}
]
}
]