Iot Breeze OCB (0.9.0)

Download OpenAPI specification:Download

Omni Channel Backend for managing your iot applications

Tenant

TenantController_readAvailableTenants

Authorizations:

bearersupabase

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_readAvailableTenants

Authorizations:

bearersupabase

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_readCurrentTenant

Authorizations:

bearersupabase

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_readCurrentTenant

Authorizations:

bearersupabase

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_updateCurrentTenant

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

customName	string customName
	object description
searchLabels	string searchLabels
	object smtpConfig
timezone	string timezone
defaultLanguage	string Default: "EN" Enum: "EN" "DE" "FR" language
	object theme

Responses

Request samples

Payload

Content type

application/json

{"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
}
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_updateCurrentTenant

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

customName	string customName
	object description
searchLabels	string searchLabels
	object smtpConfig
timezone	string timezone
defaultLanguage	string Default: "EN" Enum: "EN" "DE" "FR" language
	object theme

Responses

Request samples

Payload

Content type

application/json

{"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
}
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_rotateTenantKey

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

primary required	boolean primary
secondary required	boolean secondary

Responses

Request samples

Payload

Content type

application/json

{"primary": true,
"secondary": true
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_rotateTenantKey

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

primary required	boolean primary
secondary required	boolean secondary

Responses

Request samples

Payload

Content type

application/json

{"primary": true,
"secondary": true
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"publicKey": "string",
"dbName": "string",
"schema": "string",
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_readTenantPublic

Authorizations:

bearersupabase

query Parameters

name	string
id	string
domain	string
select	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

TenantController_readTenantPublic

Authorizations:

bearersupabase

query Parameters

name	string
id	string
domain	string
select	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"customName": "string",
"description": {"en": "string",
"de": "string",
"fr": "string"
},
"searchLabels": "string",
"type": "Organization",
"logo": { },
"icon": { },
"smtpConfig": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"from": "string",
"secure": true
},
"timezone": "string",
"defaultLanguage": "EN",
"theme": {"darkMode": false,
"palette": { },
"shadcnTheme": { }
},
"tenantKeys": {"primary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
},
"secondary": {"id": "string",
"key": "string",
"rotatedAt": "2019-08-24T14:15:22Z"
}
}
}

upload favicon

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

upload favicon

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

upload logo

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

upload logo

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

upload cover

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

upload cover

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

Thing Type

ThingTypeController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Thing Type

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Thing Type

name required	string name
displayName required	string displayName
tags	object tags
description	object description
extends	string extends
version	string version
	object schema
provider required	string Enum: "NIMBIT" "AZURE" "AWS" "GCP" "IBM" "MINIO" provider
searchLabels	string SearchLabels
groups	Array of strings groups

Responses

Request samples

Payload

Content type

application/json

{"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"extends": "tt_xxxxxxxxxxxxxxxxx",
"version": "1",
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
}

get all Thing Types

Filterable fields: id, name,displayName, hasDraft, groups, description, version, status, providerStatus, searchLabels, provider

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
language	string
include	string Valid includes: images,things,schema,groups,hasThings
noSchema	boolean Don,t include schema

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"select": "string",
"limit": 0,
"offset": 0,
"q": "string",
"orderBy": "string",
"language": "string",
"include": "string",
"noSchema": true
}
]

Create Thing Type

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Thing Type

Array

name required	string name
displayName required	string displayName
tags	object tags
description	object description
extends	string extends
version	string version
	object schema
provider required	string Enum: "NIMBIT" "AZURE" "AWS" "GCP" "IBM" "MINIO" provider
searchLabels	string SearchLabels
groups	Array of strings groups

Responses

Request samples

Payload

Content type

application/json

[{"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"extends": "tt_xxxxxxxxxxxxxxxxx",
"version": "1",
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": ["string"
]
}
]

Update thingType multiple schema direct without draft

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Thing Type update

Array

required	Array of objects (Interface) interfaces
id	string Id

Responses

Request samples

Payload

Content type

application/json

[{"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
],
"id": "tt_xxxxxxxxxxxxxxxxx"
}
]

Update thingType

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Thing Type update

displayName	string displayName
description	object description
extends	string extends
version	string version
	object schema
searchLabels	string SearchLabels

Responses

Request samples

Payload

Content type

application/json

{"displayName": "Thing Type 1",
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"extends": "tt_xxxxxxxxxxxxxxxxx",
"version": "1",
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"searchLabels": "label1 label2"
}

Response samples

200

Content type

application/json

{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
}

delete Thing Type

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

ThingTypeController_findThingTypeById

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
language	string
include	string Valid includes: things,groups

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
}

Get a list of all matching properties/commands/measures for one or more thing types

Authorizations:

bearersupabase

query Parameters

show_delta	boolean Default: false
show_ts_relevant_properties	boolean Default: false
context_key	string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Thing Type characteristics

ids	Array of strings thingType ids
tags	Array of strings tags

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
],
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"properties": {"customer": "string",
"anotherProperty": "string"
},
"commands": {"motor_on": "boolean",
"another_command": "boolean"
},
"measures": {"temperature": "numeric",
"pressure": "numeric"
},
"delta": { }
}

Update thingType schema direct without draft

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

required

Array of objects (Interface)

interfaces

Array

name required	string name
tags	object
required	Array of objects (CapProperty) Properties
required	Array of objects (CapCommand) Commands
required	Array of objects (CapMeasure) Measures

Responses

Request samples

Payload

Content type

application/json

{"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
}

Response samples

200

Content type

application/json

{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
}

apply Thing Type draft

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
}

reset Thing Type draft

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
}

Find profile image for thingtype

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"url": "string",
"path": "string",
"name": "string",
"originalName": "string",
"mimeType": "string",
"status": "SUCCESS",
"size": "string",
"searchLabels": "string",
"variants": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
}
}
]

upload file

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

Things

ThingController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create thing

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

name required	string Name
alternateId required	string Alternate id
customProperties	object customProperties
	object description
certType	string Enum: "x509" "sas" certType
parentId	string Parent Id
searchLabels	string SearchLabels
thingType required	string thingType
groups required	Array of strings groups
organization required	string organization

Responses

Request samples

Payload

Content type

application/json

{"name": "thing1",
"alternateId": "thingalternateid",
"customProperties": { },
"description": { },
"certType": "x509",
"parentId": "th_xxxxxxxxxxxxxxxxx",
"searchLabels": "label1 label 2",
"thingType": "string",
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"organization": "gr_xxxxxxxxxxxxxxxxx"
}

Response samples

200

Content type

application/json

{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing1",
"alternateId": "thingalternateid",
"characteristics": {"deviceTwin": {"commands": {"desired": { },
"reported": { }
},
"properties": { }
}
},
"customProperties": { },
"description": { },
"status": "Connected",
"owner": "string",
"certType": "x509",
"provider": "NIMBIT",
"searchLabels": "label1 label 2",
"connectionStatus": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastDisconnected": "2019-08-24T14:15:22Z",
"thingType": {"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingTypeName",
"description": {"en": "EN",
"de": "DE"
},
"displayName": "ThingTypeDisplayName"
},
"users": [{ }
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"hierarchy": ["string"
],
"accessType": ["string"
],
"parent": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing1",
"connectionStatus": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastDisconnected": "2019-08-24T14:15:22Z"
}
],
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "string",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
],
"organization": {"id": "string",
"name": "string"
}
}

Find things

Filterable fields: id, name, alternateId, status, groups, owner, certType, status, provider, searchLabels

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
language	string
include	string Valid includes: groups,thingType,parent,thingAccess,hierarchy,users,images

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"count": 0,
"_fullCount": 0,
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing1",
"alternateId": "thingalternateid",
"characteristics": {"deviceTwin": {"commands": {"desired": { },
"reported": { }
},
"properties": { }
}
},
"customProperties": { },
"description": { },
"status": "Connected",
"owner": "string",
"certType": "x509",
"provider": "NIMBIT",
"searchLabels": "label1 label 2",
"connectionStatus": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastDisconnected": "2019-08-24T14:15:22Z",
"thingType": {"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingTypeName",
"description": {"en": "EN",
"de": "DE"
},
"displayName": "ThingTypeDisplayName"
},
"users": [{ }
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"hierarchy": ["string"
],
"accessType": ["string"
],
"parent": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing1",
"connectionStatus": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastDisconnected": "2019-08-24T14:15:22Z"
}
],
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "string",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
],
"organization": {"id": "string",
"name": "string"
}
}
]
}

Create multiple things

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Update thing

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string Name
	object characteristics
customProperties	object customProperties
	object description
parentId	string Parent Id
searchLabels	string SearchLabels
organization	string organization
	Array of objects (OperationWithId) groups
	Array of objects (OperationWithIdAndPermissions) users

Responses

Request samples

Payload

Content type

application/json

{"name": "thing1",
"characteristics": {"deviceTwin": {"commands": {"desired": { },
"reported": { }
},
"properties": { }
}
},
"customProperties": { },
"description": { },
"parentId": "th_xxxxxxxxxxxxxxxxx",
"searchLabels": "label1 label 2",
"organization": "gr_xxxxxxxxxxxxxxxxx",
"groups": [{"operation": "ADD",
"id": "string"
}
],
"users": [{"operation": "ADD",
"id": "string",
"permissions": { }
}
]
}

Remove thing

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read thing

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing1",
"alternateId": "thingalternateid",
"characteristics": {"deviceTwin": {"commands": {"desired": { },
"reported": { }
},
"properties": { }
}
},
"customProperties": { },
"description": { },
"status": "Connected",
"owner": "string",
"certType": "x509",
"provider": "NIMBIT",
"searchLabels": "label1 label 2",
"connectionStatus": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastDisconnected": "2019-08-24T14:15:22Z",
"thingType": {"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingTypeName",
"description": {"en": "EN",
"de": "DE"
},
"displayName": "ThingTypeDisplayName"
},
"users": [{ }
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"hierarchy": ["string"
],
"accessType": ["string"
],
"parent": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing1",
"connectionStatus": "string",
"lastConnected": "2019-08-24T14:15:22Z",
"lastDisconnected": "2019-08-24T14:15:22Z"
}
],
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "string",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
],
"organization": {"id": "string",
"name": "string"
}
}

Find profile image for thing

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"url": "string",
"path": "string",
"name": "string",
"originalName": "string",
"mimeType": "string",
"status": "SUCCESS",
"size": "string",
"searchLabels": "string",
"variants": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
}
}
]

upload file

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

User

Update user roles

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name required	string Default: "Gerd Mueller" name
required	object Authorization properties
	object Invitations
required	Array of objects (UserGroup) groups
password required	string password
tenantOwner	boolean
roles required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "Gerd Mueller",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"password": "string",
"tenantOwner": true,
"roles": ["string"
]
}

UserController_findUserById

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}

Remove user

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

UserController_findUser

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}

UserController_findUsers

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
]

UserController_count

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Reset user password

Authorizations:

bearersupabase

header Parameters

accept-language required	string
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

email required	string
redirectUrl required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"redirectUrl": "string"
}

Generate opt for user

Authorizations:

bearersupabase

header Parameters

accept-language required	string
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

email required	string
type required	string Default: "magiclink" Value: "magiclink" Type of the OTP link
redirectUrl required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"type": "magiclink",
"redirectUrl": "string"
}

Reset user password

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

File

FileController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

upload file

Authorizations:

bearersupabase

path Parameters

resource required	string Enum: "Thing" "ThingType" "Tenant" "Group" "User" "Organization" "File" "Widget" "ResourceHierarchy" "DashboardConfig" "Canvas"
id required	string id

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: multipart/form-data
required

file required	string <binary>
tags	string
customerManaged	boolean

Responses

FileController_findFile

Authorizations:

bearersupabase

path Parameters

id

required

any

query Parameters

disposition

required

string

Enum: "inline" "attachment"

header Parameters

x-ocb-tenant

any

Example: demo

Responses

FileController_deleteFile

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

List files for resource

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Remove profile picture assignment

Authorizations:

bearersupabase

path Parameters

id

required

string

file id

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Remove profile picture assignment

Authorizations:

bearersupabase

path Parameters

resourceId required	string Resource id
id required	string file id

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Groups

GroupController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Group

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name required	string Name
	object description
defaultPermissions required	object defaultPermissions
parentId	string Parent
searchLabels	string SearchLabels
type	string Default: "Default" Enum: "Default" "Organization" type
thingTypes	Array of strings thingTypes
things	Array of strings things
eventTypes	Array of strings eventTypes
	Array of objects (OperationWithIdAndPermissions) users

Responses

Request samples

Payload

Content type

application/json

{"name": "Group Name",
"description": { },
"defaultPermissions": { },
"parentId": "gr_xxxxxxxxxxxxxxxxx",
"searchLabels": "string",
"type": "Default",
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"eventTypes": ["et_xxxxxxxxxxxxxxxxx"
],
"users": [{"id": "us_xxxxxxxxxxxxxxxxx",
"permissions": {"r": true,
"u": true,
"x": true
}
}
]
}

Response samples

201

Content type

application/json

{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}

Find groups

Filterable fields: id, name, isRoot, description, things, thingTypes, eventTypes, searchLabels

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
language	string
include	string Valid includes: thingTypes,things,eventTypes,tenant,count,users

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
]

Update Group

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

	object description
defaultPermissions required	object defaultPermissions
parentId	string Parent
searchLabels	string SearchLabels
type	string Default: "Default" Enum: "Default" "Organization" type
name	string Name
	Array of objects (OperationWithIdAndPermissions) users
	Array of objects (OperationWithId) thingTypes
	Array of objects (OperationWithId) things
	Array of objects (OperationWithId) eventTypes

Responses

Request samples

Payload

Content type

application/json

{"description": { },
"defaultPermissions": { },
"parentId": "gr_xxxxxxxxxxxxxxxxx",
"searchLabels": "string",
"type": "Default",
"name": "Group Name",
"users": [{"operation": "ADD",
"id": "string",
"permissions": { }
}
],
"thingTypes": [{"operation": "ADD",
"id": "string"
}
],
"things": [{"operation": "ADD",
"id": "string"
}
],
"eventTypes": [{"operation": "ADD",
"id": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}

Find group by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
language	string
include	string Valid includes: thingTypes,things,eventTypes,tenant,children,parent,users,count

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}

Delete group

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Roles

RoleController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

RoleController_findRoles

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
]

Find role by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}

Invitation

InvitationController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Invitation

Authorizations:

bearersupabase

query Parameters

language

required

string

Enum: "en" "de"

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

required	Array of objects (Invites) list of users tht are being invited
expiresAt	string <date-time> expiresAt
roles required	Array of strings roles
required	Array of objects (UserPermissions) groups
required	Array of objects (UserPermissions) things
inviteKey required	boolean if false, create the user and directly send an email. if true or undefined, create a invite key that can be given to the user to complete their registration

Responses

Request samples

Payload

Content type

application/json

{"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"expiresAt": "2019-08-24T14:15:22Z",
"roles": ["string"
],
"groups": [{"id": "xx_xxxxxxxxxxxxxxxxx",
"permissions": {"r": true,
"u": true,
"x": true
}
}
],
"things": [{"id": "xx_xxxxxxxxxxxxxxxxx",
"permissions": {"r": true,
"u": true,
"x": true
}
}
],
"inviteKey": true
}

Response samples

201

Content type

application/json

{"id": "string",
"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"inviteKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"status": { },
"roles": [{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
],
"Groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"things": [{ }
]
}

Find invitations

Filterable fields: id, name, email, status

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"inviteKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"status": { },
"roles": [{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
],
"Groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"things": [{ }
]
}
]

Find invitation by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"inviteKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"status": { },
"roles": [{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
],
"Groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"things": [{ }
]
}

Delete Invitation

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Accept invitation

Authorizations:

bearersupabase

path Parameters

invitationKey

required

string

Invitation Key

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

firstName required	string firstName
lastName required	string lastName
password required	string Default: "Test1234@" Password should contain atleast 8 characters, a number and a special character like "!@#$%^&*()[]{};:<>?,./+-=\|~".
passwordConfirm required	string Default: "Test1234@" passwordConfirm. Has to match the password property

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"password": "Test1234@",
"passwordConfirm": "Test1234@"
}

Response samples

200

Content type

application/json

{"id": "string",
"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"inviteKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"status": { },
"roles": [{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
],
"Groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"things": [{ }
]
}

Reject invitation

Authorizations:

bearersupabase

path Parameters

invitationKey

required

string

Invitation Key

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"inviteKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"status": { },
"roles": [{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
],
"Groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"isRoot": false,
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"GroupToUser": [{"id": "us_xxxxxxxxxxxxxxxxx",
"name": "John Doe",
"permissions": {"read": true,
"write": true,
"execute": true
},
"email": "john@example.com"
}
],
"permissions": {"read": true,
"write": true,
"execute": true
},
"children": [{ }
],
"parents": [{ }
],
"parent": { },
"thingTypes": [{"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "thingtype_name",
"displayName": "Thing Type Name"
}
],
"things": [{"id": "th_xxxxxxxxxxxxxxxxx",
"name": "thing_name",
"alternateId": "altid"
}
],
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"things": [{ }
]
}

Find invitation by invitationKey

Authorizations:

bearersupabase

path Parameters

invitationKey

required

string

Invitation Key

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"invites": [{"email": "max.mustermann@nimbit.de",
"firstName": "Max",
"lastName": "Mustermann"
}
],
"inviteKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"status": { },
"roles": [{"id": "string",
"name": "string",
"description": { },
"permissions": {"ThingType": {"c": true,
"r": true,
"u": true,
"d": true
},
"Thing": {"c": true,
"r": true,
"u": true,
"d": true
}
},
"UserRoleAssignment": [{"id": "5e8f8f8f8f8f8f8j8f8f8f",
"user": "Mueller"
}
],
"searchLables": "string"
}
]
}

ApiClient

Create ApiClient

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string name
validTo required	string <date-time> valid To
roles required	Array of strings roles

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"validTo": "2019-08-24T14:15:22Z",
"roles": ["string"
]
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"clientId": "string",
"clientSecret": "string",
"deleted": true,
"validTo": "2019-08-24T14:15:22Z",
"roles": ["string"
]
}

ApiClientController_findApiClients

Authorizations:

bearersupabase

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"clientId": "string",
"deleted": true,
"validTo": "2019-08-24T14:15:22Z",
"roles": ["string"
]
}
]

Delete apiClient

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Destinations

DestinationController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Destination

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name required	string name
description required	string description
authenticationType required	string Enum: "NONE" "BASIC" "OAUTH" AuthenticationType
requestConfig required	object RequestConfig
authenticationConfig required	object AuthenticationConfig
searchLables required	string SearchLabels
secret required	object secret

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"authenticationType": "NONE",
"requestConfig": { },
"authenticationConfig": { },
"searchLables": "string",
"secret": { }
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"authenticationType": "NONE",
"requestConfig": { },
"authenticationConfig": { },
"searchLables": "string"
}

Find notifications

Filterable fields: id, name, description, authenticationType, searchLabels

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"authenticationType": "NONE",
"requestConfig": { },
"authenticationConfig": { },
"searchLables": "string"
}
]

Update Destination

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string name
description	string description
authenticationType	string Enum: "NONE" "BASIC" "OAUTH" AuthenticationType
requestConfig	object RequestConfig
authenticationConfig	object AuthenticationConfig
searchLables	string SearchLabels
secret required	object secret

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"authenticationType": "NONE",
"requestConfig": { },
"authenticationConfig": { },
"searchLables": "string",
"secret": { }
}

Remove Destination

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read Destination

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"authenticationType": "NONE",
"requestConfig": { },
"authenticationConfig": { },
"searchLables": "string"
}

Search

SearchController_search

Authorizations:

bearersupabase

query Parameters

q required	string
select required	string
search	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"searchLabels": "string",
"alternateId": "string",
"resource": "string",
"tenant": "string"
}
]

SearchController_customSearch

Authorizations:

bearersupabase

query Parameters

select	string
searchTerm	string
tags	string
resources	string
resourceLimit	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"searchLabels": "string",
"alternateId": "string",
"resource": "string",
"tenant": "string"
}
]

Labels

Create Label

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name required	string name
color required	string color

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

200

Content type

application/json

{"name": "string",
"color": "string"
}

Find notifications

Filterable fields: id, name, color

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"color": "string"
}
]

Remove Label via name

Authorizations:

bearersupabase

path Parameters

name

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read Label by name

Authorizations:

bearersupabase

path Parameters

name

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"name": "string",
"color": "string"
}

Update label color name

Authorizations:

bearersupabase

path Parameters

name

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

color

string

color

Responses

Request samples

Payload

Content type

application/json

{"color": "string"
}

Notification

find notifications types

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

["string"
]

Count notification by state

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

0

0

NotificationController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Find notifications

Filterable fields: id, sender, recipient, resourceType, resourceId, subject, message, readAt, notificationType, state, severity

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"sender": "string",
"i18nCode": "string",
"recipients": ["string"
],
"recipientGroups": ["string"
],
"notificationType": "Generic",
"resourceType": { },
"resourceId": "string",
"subject": "string",
"message": "string",
"severity": "INFO",
"tags": "string",
"readAt": "2019-08-24T14:15:22Z",
"eventId": "string",
"state": { }
}

Create notifications

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

i18nCode required	string i18nCode
recipients required	Array of strings recipients
recipientGroups required	Array of strings recipientGroups
notificationType required	object Default: "Generic" notificationType
resourceType required	object resourceType
resourceId required	string resourceId
subject required	string subject
message required	string message
severity required	object Default: "INFO" severity
tags required	string tags
eventId required	string ebent ID

Responses

Request samples

Payload

Content type

application/json

{"i18nCode": "string",
"recipients": ["string"
],
"recipientGroups": ["string"
],
"notificationType": "Generic",
"resourceType": { },
"resourceId": "string",
"subject": "string",
"message": "string",
"severity": "INFO",
"tags": "string",
"eventId": "string"
}

Response samples

201

Content type

application/json

"string"

Mark notifications as read

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

ids required	Array of strings ids
all	boolean Default: false all

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
],
"all": false
}

Mark notifications as read

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

ids

required

Array of strings

ids

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

DashboardConfigs

Create DashboardConfig

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

DashboardConfig

translations	object translations
thingId	string thingId
name required	string name
accessType required	string Enum: "User" "Tenant" accessType
dashboardType required	string Enum: "Thing" "ThingType" "General" "MultiAsset" "Report" dashboardType
default required	boolean default
locked required	boolean locked
	Array of DashboardLayout (objects) or ResponsiveLayouts (object) layouts - can be either an array (legacy, maps to xl) or an object with breakpoint keys (xs, sm, md, lg, xl)
	Array of objects (Widget) widgets
groups	Array of strings groups
dependent	string id of the thingtype or thing depending on if the dashboard type is Thing or ThingType
thingIds	Array of strings ids of the things when dashboard type is MultiAsset
	object gridSettings
	object timeSettings
ResourceHierarchy	Array of strings ResourceHierarchy

Responses

Request samples

Payload

Content type

application/json

{"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"groups": ["string"
],
"dependent": "string",
"thingIds": ["string"
],
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"ResourceHierarchy": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"owner": "string",
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"groups": ["string"
],
"dependent": "string",
"things": [{"id": "string",
"name": "string"
}
],
"ResourceHierarchy": [{"path": "string",
"pathName": "string",
"id": "string",
"name": "Hierarchy Name"
}
],
"valid": true,
"actionIds": ["string"
]
}

DashboardConfigController_findAllDashboardConfig

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"owner": "string",
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"groups": ["string"
],
"dependent": "string",
"things": [{"id": "string",
"name": "string"
}
],
"ResourceHierarchy": [{"path": "string",
"pathName": "string",
"id": "string",
"name": "Hierarchy Name"
}
],
"valid": true,
"actionIds": ["string"
]
}
]

Copy DashboardConfig

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
optional

Copy DashboardConfig

name	string name
resourceHierarchyId	string resourceHierarchyId

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"resourceHierarchyId": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"owner": "string",
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"groups": ["string"
],
"dependent": "string",
"things": [{"id": "string",
"name": "string"
}
],
"ResourceHierarchy": [{"path": "string",
"pathName": "string",
"id": "string",
"name": "Hierarchy Name"
}
],
"valid": true,
"actionIds": ["string"
]
}

Remove DashboardConfig via id

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read DashboardConfig by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"owner": "string",
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"groups": ["string"
],
"dependent": "string",
"things": [{"id": "string",
"name": "string"
}
],
"ResourceHierarchy": [{"path": "string",
"pathName": "string",
"id": "string",
"name": "Hierarchy Name"
}
],
"valid": true,
"actionIds": ["string"
]
}

Update dashboard config

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string name
translations	object translations
accessType	string Enum: "User" "Tenant" accessType
dashboardType	string Enum: "Thing" "ThingType" "General" "MultiAsset" "Report" dashboardType
default	boolean default
locked required	boolean locked
	Array of DashboardLayout (objects) or ResponsiveLayouts (object) layouts - can be either an array (legacy, maps to xl) or an object with breakpoint keys (xs, sm, md, lg, xl)
	object widgets
groups	Array of strings groups
dependent	string id of the thingtype or thing depending on if the dashboard type is Thing or ThingType
thingIds	Array of strings ids of the things when dashboard type is MultiAsset
	object gridSettings
	object timeSettings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"translations": { },
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": {"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
},
"groups": ["string"
],
"dependent": "string",
"thingIds": ["string"
],
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
}
}

Response samples

204

Content type

application/json

{"id": "string",
"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"owner": "string",
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"groups": ["string"
],
"dependent": "string",
"things": [{"id": "string",
"name": "string"
}
],
"ResourceHierarchy": [{"path": "string",
"pathName": "string",
"id": "string",
"name": "Hierarchy Name"
}
],
"valid": true,
"actionIds": ["string"
]
}

DashboardConfigController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

0

0

Find Dashboards for Hierarchy

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"translations": { },
"thingId": "string",
"name": "string",
"accessType": "User",
"dashboardType": "Thing",
"default": true,
"locked": true,
"layouts": [{"x": 0,
"y": 0,
"z": 0,
"w": 0,
"h": 0,
"i": "string",
"minW": 0,
"maxW": 0,
"minH": 0,
"maxH": 0,
"moved": true,
"static": true,
"isDraggable": true,
"isResizable": true,
"resizeHandles": "s",
"isBounded": true
}
],
"widgets": [{"fileId": "string",
"url": "string",
"fileType": "ocb",
"zoom": 0,
"type": "radar",
"zoomable": true,
"compactNumber": true,
"gapFill": "locf",
"translations": { },
"transparent": true,
"styles": {"borderColor": "string",
"bgColor": "string",
"zoomable": true,
"transparent": true,
"showMarkers": true
},
"mergeConsecutivePoints": true,
"variant": "page",
"id": "string",
"name": "NAME_OF_THE_WIDGET",
"uom": "string",
"mode": "mode",
"orientation": "orientation",
"displayAs": "string",
"offset": "offset",
"window": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"showMarkers": true,
"shape": "string",
"searchLabels": "label1, label 2",
"allowUpload": true,
"showTable": true,
"config": [{"id": "string",
"min": 0,
"max": 0
}
],
"descriptionsTrue": { },
"descriptionsFalse": { },
"colorTrue": "string",
"colorFalse": "string",
"thresholds": [{"id": "ab123412",
"name": "ThrsholdName",
"color": "#FFFFFF",
"variant": "line",
"operator": "between",
"left": 0,
"right": 0
}
],
"yMin": 0,
"yMax": 0,
"tableConfig": { },
"transformFunc": "string",
"dataSource": "string",
"valid": true
}
],
"owner": "string",
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
},
"timeSettings": {"active": true,
"timeframe": {"type": "period",
"period": "P30D",
"from": 6000,
"to": 0,
"bucket": "P1D",
"bucketDensity": 6000,
"override": false
},
"refreshRate": "string"
},
"groups": ["string"
],
"dependent": "string",
"things": [{"id": "string",
"name": "string"
}
],
"ResourceHierarchy": [{"path": "string",
"pathName": "string",
"id": "string",
"name": "Hierarchy Name"
}
],
"valid": true,
"actionIds": ["string"
]
}

(Azure) Device Authentication

create/cycle primary authenication

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

201

Content type

application/json

{"key": "string",
"certificate": "string",
"type": "x509",
"expires": "string"
}

revoke x509 certificate

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

create/cycle secondary authentication

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

201

Content type

application/json

{"key": "string",
"certificate": "string",
"type": "x509",
"expires": "string"
}

revoke x509 certificate secondary

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

auth by id

Authorizations:

bearersupabase

path Parameters

id

required

any

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"type": "x509",
"x509Thumbprint": {"primaryThumbprint": {"value": "string",
"expires": "string"
},
"secondaryThumbprint": {"value": "string",
"expires": "string"
}
},
"symmetricKey": {"primaryKey": "string",
"secondaryKey": "string"
},
"connectivity": {"mqtt": {"url": "string",
"tlsVersion": "string",
"clientId": "string",
"username": "string",
"cloudBound": "string",
"deviceBound": "string",
"deviceTwin": {"subscribe": "string",
"get": "string"
}
},
"rest": {"cloudBound": "string",
"deviceBound": "string",
"abandon": "string",
"complete": "string",
"headers": { }
}
}
}

(Nimbit) Thing Authentication

create thing authentication key

Create a new thing authentication key for a single device. Thing authentication key can be used to sign JWT tokens for device authentication. Or basic auth passwords for device authentication.

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

thingId required	string Thing id or alternate id
keyType required	string Enum: "primary" "secondary" Key type (primary or secondary)
generateNonce required	boolean Should generate nonce
nonce required	string Nonce

Responses

Request samples

Payload

Content type

application/json

{"thingId": "string",
"keyType": "primary",
"generateNonce": true,
"nonce": "string"
}

Response samples

201

Content type

application/json

{"thingId": "string",
"key": "string",
"nonce": "string"
}

create device authentication token

Create a new authentication token for a single device.

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

expiresIn	number Default: 3600 Expires in (seconds)
deviceId required	string Device id
keyType	string Default: "primary" Enum: "primary" "secondary" Key type

Responses

Request samples

Payload

Content type

application/json

{"expiresIn": 3600,
"deviceId": "string",
"keyType": "primary"
}

Response samples

201

Content type

application/json

{"expiresIn": 3600,
"token": "string",
"username": "string",
"scope": "device"
}

create tenant authentication token

Create a new authentication token for a tenant. This token can be used to send request for any device in the tenant.

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

expiresIn	number Default: 3600 Expires in (seconds)
keyType	string Default: "primary" Enum: "primary" "secondary" Key type

Responses

Request samples

Payload

Content type

application/json

{"expiresIn": 3600,
"keyType": "primary"
}

Response samples

201

Content type

application/json

{"expiresIn": 3600,
"token": "string",
"username": "string",
"scope": "device"
}

create device basic auhtentication token

Create a new basic auth credentials for device.

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

deviceId required	string Device id
keyType	string Default: "primary" Enum: "primary" "secondary" Key type

Responses

Request samples

Payload

Content type

application/json

{"deviceId": "string",
"keyType": "primary"
}

Response samples

201

Content type

application/json

{"expiresIn": 3600,
"token": "string",
"username": "string",
"scope": "device"
}

create tenant basic auhtentication token

Create a new basic auth credentials for tenant.

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

keyType

string

Default: "primary"

Enum: "primary" "secondary"

Key type

Responses

Request samples

Payload

Content type

application/json

{"keyType": "primary"
}

Response samples

201

Content type

application/json

{"expiresIn": 3600,
"token": "string",
"username": "string",
"scope": "device"
}

QueryConfigs

QueryConfigController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create QueryConfig

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

QueryConfig

name required	string name
accessType required	string Default: "Tenant" Enum: "User" "Tenant" accessType
required	object widget
groups	Array of strings groups

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"accessType": "User",
"widget": {"window": {"start": "1659763600000",
"end": "1662449280000",
"bucketSize": "P1D"
},
"config": [{"id": "string",
"thingType": "string",
"thing": "string",
"measure": "string",
"aggregation": "avg",
"type": "line",
"lineType": "solid",
"color": "#000000"
}
]
},
"groups": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"accessType": "User",
"widget": {"window": {"start": "1659763600000",
"end": "1662449280000",
"bucketSize": "P1D"
},
"config": [{"id": "string",
"thingType": "string",
"thing": "string",
"measure": "string",
"aggregation": "avg",
"type": "line",
"lineType": "solid",
"color": "#000000"
}
]
},
"owner": "string",
"groups": ["string"
],
"shareCode": "string"
}

QueryConfigController_findAllQueryConfig

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"accessType": "User",
"widget": {"window": {"start": "1659763600000",
"end": "1662449280000",
"bucketSize": "P1D"
},
"config": [{"id": "string",
"thingType": "string",
"thing": "string",
"measure": "string",
"aggregation": "avg",
"type": "line",
"lineType": "solid",
"color": "#000000"
}
]
},
"owner": "string",
"groups": ["string"
],
"shareCode": "string"
}
]

Remove QueryConfig via id

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read QueryConfig by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"accessType": "User",
"widget": {"window": {"start": "1659763600000",
"end": "1662449280000",
"bucketSize": "P1D"
},
"config": [{"id": "string",
"thingType": "string",
"thing": "string",
"measure": "string",
"aggregation": "avg",
"type": "line",
"lineType": "solid",
"color": "#000000"
}
]
},
"owner": "string",
"groups": ["string"
],
"shareCode": "string"
}

Update query config

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string name
accessType	string Enum: "User" "Tenant" accessType
	object widget
owner	string owner
groups	Array of strings groups
shareCode	string shareCode

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"accessType": "User",
"widget": {"window": {"start": "1659763600000",
"end": "1662449280000",
"bucketSize": "P1D"
},
"config": [{"id": "string",
"thingType": "string",
"thing": "string",
"measure": "string",
"aggregation": "avg",
"type": "line",
"lineType": "solid",
"color": "#000000"
}
]
},
"owner": "string",
"groups": ["string"
],
"shareCode": "string"
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "string",
"accessType": "User",
"widget": {"window": {"start": "1659763600000",
"end": "1662449280000",
"bucketSize": "P1D"
},
"config": [{"id": "string",
"thingType": "string",
"thing": "string",
"measure": "string",
"aggregation": "avg",
"type": "line",
"lineType": "solid",
"color": "#000000"
}
]
},
"owner": "string",
"groups": ["string"
],
"shareCode": "string"
}

Events

EventController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string
groupBy	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Event

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Event

title required	string title
status	string status
severity required	string Enum: "INFO" "WARNING" "ERROR" "CRITICAL" severity
source required	string source
eventTimestamp required	string <date-time> eventTimestamp
externalId	string externalId
correlationId	string correlationId
eventTypeId required	string eventTypeId
payload	object any object/array that can be serialized to JSON
referenceId	string referenceId
resource required	string Enum: "ThingType" "Thing" "PropertySet" "User" "Organization" "Tenant" "Role" "Group" "File" "Invitation" "ObjectInstance" "ObjectType" "ApiClient" "Destination" "Job" "Rule" "Label" "Search" "Notification" "Timeseries" "DashboardConfig" "DeviceAuthentication" "QueryConfig" "Event" "EventType" "Theme" "MailTemplateBlock" "MailTemplate" "Report" "ResourceHierarchy" "Widget" "Subscription" "Account" "Action" "RuleVersion" "GeoFence" "AuditLog" "ActionLog" "Canvas" "Context" "Schedule" resource
i18nCode required	string i18nCode

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"status": "string",
"severity": "INFO",
"source": "string",
"eventTimestamp": "2019-08-24T14:15:22Z",
"externalId": "string",
"correlationId": "string",
"eventTypeId": "string",
"payload": { },
"referenceId": "string",
"resource": "ThingType",
"i18nCode": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"title": "string",
"severity": "INFO",
"source": "string",
"eventTimestamp": "2019-08-24T14:15:22Z",
"eventTypeId": "string",
"payload": { },
"resourceInformation": {"name": "string",
"description": { }
},
"i18nCode": "string",
"status": "string",
"externalId": "string",
"correlationId": "string",
"referenceId": "string",
"resource": "ThingType",
"type": {"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
]
}
}

EventController_findAllEvent

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"title": "string",
"severity": "INFO",
"source": "string",
"eventTimestamp": "2019-08-24T14:15:22Z",
"eventTypeId": "string",
"payload": { },
"resourceInformation": {"name": "string",
"description": { }
},
"i18nCode": "string",
"status": "string",
"externalId": "string",
"correlationId": "string",
"referenceId": "string",
"resource": "ThingType",
"type": {"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": null,
"name": null,
"description": { },
"isRoot": null,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
]
}
}
]

Remove Event via id

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read Event by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"title": "string",
"severity": "INFO",
"source": "string",
"eventTimestamp": "2019-08-24T14:15:22Z",
"eventTypeId": "string",
"payload": { },
"resourceInformation": {"name": "string",
"description": { }
},
"i18nCode": "string",
"status": "string",
"externalId": "string",
"correlationId": "string",
"referenceId": "string",
"resource": "ThingType",
"type": {"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
]
}
}

EventController_findAllEventForCorrelationId

Authorizations:

bearersupabase

path Parameters

correlationId

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"title": "string",
"severity": "INFO",
"source": "string",
"eventTimestamp": "2019-08-24T14:15:22Z",
"eventTypeId": "string",
"payload": { },
"resourceInformation": {"name": "string",
"description": { }
},
"i18nCode": "string",
"status": "string",
"externalId": "string",
"correlationId": "string",
"referenceId": "string",
"resource": "ThingType",
"type": {"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": null,
"name": null,
"description": { },
"isRoot": null,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
]
}
}
]

EventTypes

EventTypeController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create EventType

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

EventType

searchLabels	string SearchLabels
name required	string name
	object description
schema	object schema
displayType	object displayType

Responses

Request samples

Payload

Content type

application/json

{"searchLabels": "string",
"name": "string",
"description": { },
"schema": { },
"displayType": { }
}

Response samples

200

Content type

application/json

{"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"schema": { },
"displayType": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{ }
]
}

EventTypeController_findAllEventType

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"schema": { },
"displayType": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{ }
]
}
]

Remove EventType via id

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read EventType by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"schema": { },
"displayType": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{ }
]
}

Update eventType

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

searchLabels	string SearchLabels
name	string name
	object description
schema	object schema
displayType	object displayType

Responses

Request samples

Payload

Content type

application/json

{"searchLabels": "string",
"name": "string",
"description": { },
"schema": { },
"displayType": { }
}

Response samples

204

Content type

application/json

{"id": "string",
"searchLabels": "string",
"name": "string",
"description": { },
"schema": { },
"displayType": { },
"initiator": "SYSTEM",
"Subscription": [{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
],
"action": [{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
],
"groups": [{ }
]
}

Subscriptions

SubscriptionController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Subscription

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Subscription

external	string External Email
sendMail required	boolean Default: false Send Mail
sendNotification required	boolean Default: false Send Notification
	object Report
eventTypeId	string Event Type Id
reportId	string Report Id
userId	string User Id

Responses

Request samples

Payload

Content type

application/json

{"external": "string",
"sendMail": false,
"sendNotification": false,
"report": {"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}

SubscriptionController_findAllSubscription

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}
]

Remove Subscription via id

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read Subscription by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}

Update subscription

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

external	string External Email
sendMail	boolean Default: false Send Mail
sendNotification	boolean Default: false Send Notification
	object Report
eventTypeId	string Event Type Id
reportId	string Report Id
userId	string User Id

Responses

Request samples

Payload

Content type

application/json

{"external": "string",
"sendMail": false,
"sendNotification": false,
"report": {"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}

Response samples

204

Content type

application/json

{"id": "string",
"external": "string",
"sendMail": false,
"sendNotification": false,
"eventType": { },
"report": {"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
},
"user": {"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"auth": {"description": { },
"roles": ["admin",
"system_admin",
"manager",
"modeler",
"viewer"
],
"permissions": { }
},
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
},
"eventTypeId": "string",
"reportId": "string",
"userId": "string"
}

Unsubscribe

Authorizations:

bearersupabase

path Parameters

tenant required	string tenant of the subscription
id required	string id of the subscription

header Parameters

x-ocb-tenant

any

Example: demo

Responses

ResourceNames

Get ResourceNames

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

["string"
]

MailTemplateBlocks

MailTemplateBlockController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

MailTemplateBlockController_countByType

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create MailTemplateBlock

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

MailTemplateBlock

name required	string name
	object translations
html required	string html
type	string Enum: "Header" "Footer" "Body" "Layout" type
css required	string css
context	string context id

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"translations": { },
"html": "string",
"type": "Header",
"css": "string",
"context": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"html": "string",
"type": "Header",
"css": "string",
"context": "string",
"contextRel": {"id": "string",
"name": "Context A",
"type": "INVITATION",
"description": "This is a context",
"suggestions": { },
"contextData": { }
},
"tenantType": "Organization"
}

MailTemplateBlockController_findAllMailTemplateBlocks

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"html": "string",
"type": "Header",
"css": "string",
"context": "string",
"contextRel": {"id": "string",
"name": "Context A",
"type": "INVITATION",
"description": "This is a context",
"suggestions": { },
"contextData": { }
},
"tenantType": "Organization"
}
]

Remove MailTemplate Block via id

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read MailTemplate block by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"html": "string",
"type": "Header",
"css": "string",
"context": "string",
"contextRel": {"id": "string",
"name": "Context A",
"type": "INVITATION",
"description": "This is a context",
"suggestions": { },
"contextData": { }
},
"tenantType": "Organization"
}

Update mailTemplate

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string name
	object translations
html	string html
css	string css
context	string context id

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"translations": { },
"html": "string",
"css": "string",
"context": "string"
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "string",
"html": "string",
"type": "Header",
"css": "string",
"context": "string",
"contextRel": {"id": "string",
"name": "Context A",
"type": "INVITATION",
"description": "This is a context",
"suggestions": { },
"contextData": { }
},
"tenantType": "Organization"
}

MailTemplates

MailTemplateController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create mail template Body block and MailTemplate

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

MailTemplate

name required	string name
layout	object layout
body	object body
header	object header
footer	object footer
showHeader	boolean showHeader
showFooter	boolean showFooter
showBody	boolean showBody
availableFields	object availableFields
translations	object translations
html required	string html
css required	string css
context	string context id

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { },
"translations": { },
"html": "string",
"css": "string",
"context": "string"
}

Response samples

200

Content type

application/json

{"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { },
"translations": { },
"html": "string",
"css": "string",
"context": "string"
}

Create MailTemplate

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

MailTemplate

name required	string name
layout	object layout
body	object body
header	object header
footer	object footer
showHeader	boolean showHeader
showFooter	boolean showFooter
showBody	boolean showBody
availableFields	object availableFields

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { }
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { },
"tenantType": "Organization"
}

MailTemplateController_findAllMailTemplates

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { },
"tenantType": "Organization"
}
]

Remove MailTemplate and its body if not shared

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read MailTemplate by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { },
"tenantType": "Organization"
}

Update mailTemplate

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string name
layout	object layout
body	object body
header	object header
footer	object footer
showHeader	boolean showHeader
showFooter	boolean showFooter
showBody	boolean showBody
availableFields	object availableFields

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { }
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "string",
"layout": { },
"body": { },
"header": { },
"footer": { },
"showHeader": true,
"showFooter": true,
"showBody": true,
"availableFields": { },
"tenantType": "Organization"
}

MailTemplateAssignment

Get mail template assignment

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"templateMappings": {"INVITATION": "template-id-123",
"OTP": "template-id-456",
"EVENT": "template-id-789",
"REPORT": "template-id-abc",
"RESET_PASSWORD": "template-id-def",
"CUSTOM": "template-id-ghi"
}
}

Create or update mail template assignment

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Mail template assignment data

object

Mail template mappings for different scenarios

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"templateMappings": {"INVITATION": "template-id-123",
"OTP": "template-id-456",
"EVENT": "template-id-789",
"REPORT": "template-id-abc",
"RESET_PASSWORD": "template-id-def",
"CUSTOM": "template-id-ghi"
}
}

Response samples

201

Content type

application/json

{"templateMappings": {"INVITATION": "template-id-123",
"OTP": "template-id-456",
"EVENT": "template-id-789",
"REPORT": "template-id-abc",
"RESET_PASSWORD": "template-id-def",
"CUSTOM": "template-id-ghi"
}
}

Delete mail template assignment

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Get all available scenarios

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

["INVITATION",
"OTP",
"EVENT",
"REPORT",
"RESET_PASSWORD"
]

Get template ID for a specific scenario

Authorizations:

bearersupabase

path Parameters

scenario

required

string

Enum: "INVITATION" "OTP" "EVENT" "REPORT" "RESET_PASSWORD"

Mail template scenario

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"templateId": "string",
"scenario": "INVITATION"
}

Remove template mapping for a specific scenario

Authorizations:

bearersupabase

path Parameters

scenario

required

string

Enum: "INVITATION" "OTP" "EVENT" "REPORT" "RESET_PASSWORD"

Mail template scenario to remove

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"templateMappings": {"INVITATION": "template-id-123",
"OTP": "template-id-456",
"EVENT": "template-id-789",
"REPORT": "template-id-abc",
"RESET_PASSWORD": "template-id-def",
"CUSTOM": "template-id-ghi"
}
}

Update a single scenario template mapping

Authorizations:

bearersupabase

path Parameters

scenario

required

string

Enum: "INVITATION" "OTP" "EVENT" "REPORT" "RESET_PASSWORD"

Mail template scenario to update

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Single scenario update data

templateId

string

Template ID (leave empty or null to remove)

Responses

Request samples

Payload

Content type

application/json

{"templateId": "template-id-123"
}

Response samples

200

Content type

application/json

{"templateMappings": {"INVITATION": "template-id-123",
"OTP": "template-id-456",
"EVENT": "template-id-789",
"REPORT": "template-id-abc",
"RESET_PASSWORD": "template-id-def",
"CUSTOM": "template-id-ghi"
}
}

Mail

send mail with data

Authorizations:

bearersupabase

query Parameters

language

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

id required	string id
subject required	string subject
from required	string from
to required	string to
values	object values

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"subject": "string",
"from": "string",
"to": "string",
"values": { }
}

send test mail template

Authorizations:

bearersupabase

path Parameters

mail

required

string

query Parameters

language	string
templateId	string
contextId	string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

id required	string id
subject required	string subject
from required	string from
to required	string to
values	object values

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"subject": "string",
"from": "string",
"to": "string",
"values": { }
}

ResourceHierarchies

ResourceHierarchyController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create ResourceHierarchy

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

ResourceHierarchy

name required	string Name of the hierarchy
description	object Description of the hierarchy
hierarchy required	string Hierarchy path
parentId	string Parent ID of the hierarchy
nextId	string
groups required	Array of strings
users required	Array of strings
dashboards required	Array of strings
thingTypes required	Array of strings
things required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"parent": [{ }
],
"children": [{ }
],
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"path": "string",
"pathName": "string"
}

ResourceHierarchyController_findAllResourceHierarchy

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"parent": [{ }
],
"children": [{ }
],
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"path": "string",
"pathName": "string"
}
]

Remove ResourceHierarchy via id, with optional dashboard deletion

Authorizations:

bearersupabase

path Parameters

id

required

any

ID of the ResourceHierarchy to delete

query Parameters

deleteDashboards

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
optional

Request body to delete ResourceHierarchy with or without dashboards

isDashboardDeletable

boolean

Flag to indicate whether dashboards should be deleted with the resource hierarchy

Responses

Request samples

Payload

Content type

application/json

{"isDashboardDeletable": true
}

Read ResourceHierarchy by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"parent": [{ }
],
"children": [{ }
],
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"path": "string",
"pathName": "string"
}

Update resourceHierarchy

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string Name of the hierarchy
description	object Description of the hierarchy
hierarchy	string Hierarchy path
parentId	string Parent ID of the hierarchy
nextId	string
groups	Array of strings
users	Array of strings
dashboards	Array of strings
thingTypes	Array of strings
things	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
]
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"parent": [{ }
],
"children": [{ }
],
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"path": "string",
"pathName": "string"
}

Move and reassign dashboards from source to target hierarchy

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

name	string Name of the hierarchy
description	object Description of the hierarchy
hierarchy	string Hierarchy path
parentId	string Parent ID of the hierarchy
nextId	string
groups	Array of strings
users	Array of strings
dashboards required	Array of strings Array of dash IDs to move
thingTypes	Array of strings
things	Array of strings
source ID required	string
target ID required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["string"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"source ID": "string",
"target ID": "string"
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"parent": [{ }
],
"children": [{ }
],
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"path": "string",
"pathName": "string"
}

Reorder ResourceHierarchy

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

ResourceHierarchy

Hierarchy ID required	string
Parent ID required	string
Next ID required	string
previousId required	string previousId

Responses

Request samples

Payload

Content type

application/json

{"Hierarchy ID": "string",
"Parent ID": "string",
"Next ID": "string",
"previousId": "string"
}

ResourceHierarchyController_findAllResourceHierarchiesByHierarchyString

Authorizations:

bearersupabase

path Parameters

hierarchy

required

string

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "Hierarchy Name",
"description": "{}",
"hierarchy": "__dashboards",
"parentId": "rh122",
"nextId": "string",
"parent": [{ }
],
"children": [{ }
],
"groups": ["gr_xxxxxxxxxxxxxxxxx"
],
"things": ["th_xxxxxxxxxxxxxxxxx"
],
"thingTypes": ["tt_xxxxxxxxxxxxxxxxx"
],
"dashboards": ["db_xxxxxxxxxxxxxxxxx"
],
"users": ["us_xxxxxxxxxxxxxxxxx"
],
"path": "string",
"pathName": "string"
}
]

Report Config

ReportController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

0

0

ReportController_findAll

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
}
]

Create report

Authorizations:

bearersupabase

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Report

name required	string Name
translations	object translations
fileName required	string FileName
fileNameLexical required	string fileNameLexical
explorerPath required	string explorerPath
	object description
searchLabels	string SearchLabels
pageCount required	number
	object timeFrame
published	boolean published
publishedAt	string <date-time> publishedAt
required	Array of objects (ReportPageSettings) pageSettings
things required	Array of strings things
users	Array of strings users
groups	Array of strings groups
	object gridSettings

Responses

Request samples

Payload

Content type

application/json

{"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
],
"things": ["string"
],
"users": ["string"
],
"groups": ["string"
],
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
}
}

Response samples

200

Content type

application/json

{"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
}

Read Report by id

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
}

Update report

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Report to update

name required	string Name
translations	object translations
fileName required	string FileName
fileNameLexical required	string fileNameLexical
explorerPath required	string explorerPath
	object description
searchLabels	string SearchLabels
pageCount required	number
	object timeFrame
published	boolean published
publishedAt	string <date-time> publishedAt
required	Array of objects (ReportPageSettings) pageSettings
things required	Array of strings things
users	Array of strings users
groups	Array of strings groups
	object gridSettings

Responses

Request samples

Payload

Content type

application/json

{"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
],
"things": ["string"
],
"users": ["string"
],
"groups": ["string"
],
"gridSettings": {"layoutFactorX": 0,
"layoutFactorY": 0,
"cols": {"property1": 0,
"property2": 0
},
"rowHeight": 0,
"columnSize": 0,
"margin": [0,
0
],
"containerPadding": [0,
0
],
"resizeHandles": ["s"
],
"compactType": "vertical",
"isBounded": true,
"autoSize": true,
"allowOverlap": true,
"preventCollision": true
}
}

Response samples

200

Content type

application/json

{"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
}

Delete report

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Duplicate Report

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
optional

Copy Report

name	string name

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"id": "rp_xxxxxxxxxxxxxxxxx",
"name": "Weekly report",
"translations": { },
"fileName": "Weekly report",
"fileNameLexical": "Weekly report",
"explorerPath": "/test/folder/",
"description": {"en": "Description",
"de": "Beschreibung"
},
"searchLabels": "label1 label 2",
"pageCount": 0,
"timeFrame": {"reportPeriod": "P1D",
"startDate": "2021-01-01T00:00:00.000Z",
"interval": "P1D"
},
"published": true,
"publishedAt": "2021-01-01T00:00:00.000Z",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "Group Name",
"description": { },
"defaultPermissions": { },
"searchLabels": "string",
"type": "Default",
"_count": {"children": 0,
"dashboards": 0,
"invitations": 0,
"users": 0,
"organizationThings": 0,
"things": 0,
"thingTypes": 0
},
"eventTypes": [{"id": "et_xxxxxxxxxxxxxxxxx",
"name": "eventtype_name",
"displayName": "Event Type Name"
}
]
}
],
"users": [{"id": "bHYC0ZqbiZhxvciptZdS",
"name": "Gerd Mueller",
"email": "gerd.mueller@nimbit.de",
"userType": "USER",
"invitations": {"id": "string",
"created": "string",
"status": "PENDING"
},
"groups": [{"id": "string",
"name": "string",
"description": { },
"isRoot": true,
"permissions": { }
}
],
"searchLables": "string",
"password": "string",
"tenantOwner": true
}
],
"dashboard": {"id": "string",
"name": "string"
},
"things": [{"id": "string",
"name": "string"
}
],
"pageSettings": [{"containerMargins": [10,
20
],
"containerPadding": [10,
20
],
"frameHeight": 0,
"frameWidth": 0,
"pageSize": "a4-portrait"
}
]
}

Generate Test PDF for Report

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

RuleVersion

RuleVersionController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create RuleVersion

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

RuleVersion

ruleId required	string
draft	object flowContent
tags required	string
thingType required	string
things required	Array of strings
operator required	string Enum: "ANY" "ALL"
comment required	string

Responses

Request samples

Payload

Content type

application/json

{"ruleId": "string",
"draft": { },
"tags": "string",
"thingType": "string",
"things": ["string"
],
"operator": "ANY",
"comment": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"ruleId": "string",
"version": 0,
"flowContent": { },
"draft": { },
"active": true,
"tags": "string",
"thingType": "string",
"things": ["string"
],
"operator": "ANY",
"comment": "string",
"triggers": [{"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
}
],
"rule": [{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}
]
}

RuleVersionController_findAllRuleVersions

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" Show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"ruleId": "string",
"version": 0,
"flowContent": { },
"draft": { },
"active": true,
"tags": "string",
"thingType": "string",
"things": ["string"
],
"operator": "ANY",
"comment": "string",
"triggers": [{"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
}
],
"rule": [{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}
]
}
]

Remove RuleVersion by ID

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read RuleVersion by ID

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"ruleId": "string",
"version": 0,
"flowContent": { },
"draft": { },
"active": true,
"tags": "string",
"thingType": "string",
"things": ["string"
],
"operator": "ANY",
"comment": "string",
"triggers": [{"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
}
],
"rule": [{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}
]
}

Update RuleVersion

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

draft	object flowContent
tags	string
thingType	string
things	Array of strings
operator	string Enum: "ANY" "ALL"
comment	string

Responses

Request samples

Payload

Content type

application/json

{"draft": { },
"tags": "string",
"thingType": "string",
"things": ["string"
],
"operator": "ANY",
"comment": "string"
}

Response samples

204

Content type

application/json

{"id": "string",
"ruleId": "string",
"version": 0,
"flowContent": { },
"draft": { },
"active": true,
"tags": "string",
"thingType": "string",
"things": ["string"
],
"operator": "ANY",
"comment": "string",
"triggers": [{"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
}
],
"rule": [{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}
]
}

Set RuleVersion Active/Inactive

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

active required	boolean
ruleId required	string
id required	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"ruleId": "string",
"id": "string"
}

Remove RuleVersion Trigger by ID

Authorizations:

bearersupabase

path Parameters

ruleVersionId required	any
id required	any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Rule

RuleController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Rule

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Rule

name required	string
type required	string Enum: "VALIDATION" "TRANSFORMATION"
severity	string Enum: "INFO" "WARNING" "ERROR" "CRITICAL"
description required	string
searchLabels	string SearchLabels
thingType	string thingType only used for transformation rules
active required	boolean
initialContent	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"thingType": "string",
"active": true,
"initialContent": "initialContent"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}

RuleController_findAllRules

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" Show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}
]

Remove Rule by ID

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read Rule by ID

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}

Update Rule

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

name	string
type	string Enum: "VALIDATION" "TRANSFORMATION"
severity	string Enum: "INFO" "WARNING" "ERROR" "CRITICAL"
description	string
searchLabels	string SearchLabels
active	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"active": true
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "string",
"type": "VALIDATION",
"severity": "INFO",
"description": "string",
"searchLabels": "label1 label 2",
"versions": [{ }
],
"thingType": "string",
"active": true
}

Validate transformation Rule

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

Tansformation

rule required	object
payload required	object

Responses

Request samples

Payload

Content type

application/json

{"rule": { },
"payload": { }
}

Response samples

200

Content type

application/json

{"performance": "string",
"result": { },
"trace": { }
}

Action

ActionController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Action

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Action

name required	string name
type required	string Enum: "EMAIL" "NOTIFICATION" "WHATSAPP" "WEBHOOK" "EVENT" "SMS" "LAMDA" "AZURE_CLOUD2DEVICE" "UPDATE_MEASURES" "MQTT_MESSAGE" Action type
active required	boolean Default: false active
description	string description
config	object Configuration
eventTypeId	string Event Type ID
triggerId	string triggerId
translations	object translations
allowInDashboard required	boolean allow usage as dashboard widget
thingId	string thingId
thingTypeId	string thingTypeId

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"thingId": "string",
"thingTypeId": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}

ActionController_findAllActions

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" Show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}
]

Remove Action by ID

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Read Action by ID

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}

Update Action

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

name	string name
type	string Enum: "EMAIL" "NOTIFICATION" "WHATSAPP" "WEBHOOK" "EVENT" "SMS" "LAMDA" "AZURE_CLOUD2DEVICE" "UPDATE_MEASURES" "MQTT_MESSAGE" Action type
active	boolean Default: false active
description	string description
config	object Configuration
eventTypeId	string Event Type ID
triggerId	string triggerId
translations	object translations
allowInDashboard	boolean allow usage as dashboard widget
thingId	string thingId
thingTypeId	string thingTypeId

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"thingId": "string",
"thingTypeId": "string"
}

Response samples

204

Content type

application/json

{"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
}

Trigger Action

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

actionId required	string Action ID
actionType required	string Enum: "EMAIL" "NOTIFICATION" "WHATSAPP" "WEBHOOK" "EVENT" "SMS" "LAMDA" "AZURE_CLOUD2DEVICE" "UPDATE_MEASURES" "MQTT_MESSAGE" Action Type
templateName	string Template Name
thingId	string thingId
payload	object Payload
eventId required	string event ID
resource required	string resource type

Responses

Request samples

Payload

Content type

application/json

{"actionId": "string",
"actionType": "EMAIL",
"templateName": "string",
"thingId": "string",
"payload": { },
"eventId": "string",
"resource": "string"
}

Action Log

Count Action Logs

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

42

Get Action Log by ID

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true"
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"actionId": "string",
"messageId": "string",
"status": "SENT",
"requestPayload": "string",
"responseMessage": "string",
"errorMessage": "string",
"action": {"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
},
"thingId": "string",
"thing": {"id": "string",
"name": "string"
},
"thingTypeId": "string",
"thingType": {"id": "string",
"name": "string"
},
"type": "string",
"name": "string",
"description": "string"
}

Remove Action log by ID

Authorizations:

bearersupabase

path Parameters

id

required

any

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Get all Action Logs

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true"
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"actionId": "string",
"messageId": "string",
"status": "SENT",
"requestPayload": "string",
"responseMessage": "string",
"errorMessage": "string",
"action": {"id": "string",
"name": "string",
"type": "EMAIL",
"active": false,
"description": "string",
"config": { },
"eventTypeId": "string",
"triggerId": "string",
"translations": { },
"allowInDashboard": true,
"Trigger": {"id": "string",
"triggerType": "SLEEP",
"sleepPeriod": "string",
"scheduleEvent": true,
"duration": "string",
"firstMatchOnly": true,
"fulfillmentTarget": 0,
"direction": "IN",
"eventTypes": [{ }
],
"actions": [{ }
]
},
"thingId": "string",
"thingTypeId": "string"
},
"thingId": "string",
"thing": {"id": "string",
"name": "string"
},
"thingTypeId": "string",
"thingType": {"id": "string",
"name": "string"
},
"type": "string",
"name": "string",
"description": "string"
}
]

health

HealthController_check

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200
503

Content type

application/json

{"status": "ok",
"info": {"database": {"status": "up"
}
},
"error": { },
"details": {"database": {"status": "up"
}
}
}

Schedule

Get all schedule configurations for the tenant

Retrieves all configured schedules for the current tenant, including both default and custom schedules

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"resourceId": "ALL_EVENTS",
"resource": "ThingType",
"functionName": "cleanUpEvents",
"config": {"value": 30,
"unit": "days"
},
"startDate": "2024-01-01T00:00:00Z",
"interval": "0 2 * * *",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"enabled": true
}
]

Create a new schedule configuration

Creates a new schedule configuration for the tenant. Each tenant can only have one schedule of each type. The system automatically populates resource, resourceId, functionName, interval, and startDate based on the scheduleType.

Authorizations:

bearersupabase

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

config required	object Configuration object for the scheduled function
scheduleType required	string Enum: "CLEAN_UP_EVENTS" "CLEAN_UP_ACTION_LOGS" "CLEAN_UP_AUDIT_LOG" Schedule type to create

Responses

Request samples

Payload

Content type

application/json

{"config": {"value": 30,
"unit": "days"
},
"scheduleType": "CLEAN_UP_EVENTS"
}

Response samples

201

Content type

application/json

{"id": "string",
"resourceId": "ALL_EVENTS",
"resource": "ThingType",
"functionName": "cleanUpEvents",
"config": {"value": 30,
"unit": "days"
},
"startDate": "2024-01-01T00:00:00Z",
"interval": "0 2 * * *",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"enabled": true
}

Get a specific schedule configuration by ID

Retrieves the schedule configuration for a specific schedule ID

Authorizations:

bearersupabase

path Parameters

id

required

any

Example: sch_3e8a0d9b84bc0a595b

The schedule ID

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"resourceId": "ALL_EVENTS",
"resource": "ThingType",
"functionName": "cleanUpEvents",
"config": {"value": 30,
"unit": "days"
},
"startDate": "2024-01-01T00:00:00Z",
"interval": "0 2 * * *",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"enabled": true
}

Update a schedule configuration

Updates an existing schedule configuration. Only config, interval, startDate, and enabled fields can be updated.

Authorizations:

bearersupabase

path Parameters

id

required

any

Example: sch_3e8a0d9b84bc0a595b

The schedule ID

header Parameters

x-ocb-tenant

any

Example: demo

Request Body schema: application/json
required

config

required

object

Configuration object for the scheduled function

Responses

Request samples

Payload

Content type

application/json

{"config": {"value": 30,
"unit": "days"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"resourceId": "ALL_EVENTS",
"resource": "ThingType",
"functionName": "cleanUpEvents",
"config": {"value": 30,
"unit": "days"
},
"startDate": "2024-01-01T00:00:00Z",
"interval": "0 2 * * *",
"nextRun": "2019-08-24T14:15:22Z",
"lastRun": "2019-08-24T14:15:22Z",
"enabled": true
}

Geofence

GeofenceController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Geofence

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Geofence Mutation

name required	string Geofence Name
description	string description
type required	string Enum: "circle" "polygon" Geofence type
context required	string Enum: "TAGS" "THINGTYPE" ContextType
radius	number Radius in meters (only required for circles)
	object Polygon
	object Polygon
isActive	boolean Whether the geofence is active
tags	Array of strings Tags are used to define which things the geofence should be applied on
thingType	string Thing type id
things	Array of strings Thing ids

Responses

Request samples

Payload

Content type

application/json

{"name": "Warehouse Zone A",
"description": "This is a geofence for warehouse zone A",
"type": "polygon",
"context": "TAGS",
"radius": 100,
"center": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"isActive": true,
"tags": ["tag1",
"tag2"
],
"thingType": "string",
"things": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "gf_xxxxxxxxxxxxxxxxx",
"name": "Warehouse Zone A",
"description": "This is a geofence for warehouse zone A",
"type": "polygon",
"context": "TAGS",
"radius": 100,
"center": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"isActive": true,
"tags": ["tag1",
"tag2"
],
"thingType": "string",
"things": ["string"
]
}

get all geofences

Filterable fields: id, name, description,searchLabels

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "gf_xxxxxxxxxxxxxxxxx",
"name": "Warehouse Zone A",
"description": "This is a geofence for warehouse zone A",
"type": "polygon",
"context": "TAGS",
"radius": 100,
"center": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"isActive": true,
"tags": ["tag1",
"tag2"
],
"thingType": "string",
"things": ["string"
]
}
]

Update geofence

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Geofence update

name required	string Geofence Name
description	string description
type required	string Enum: "circle" "polygon" Geofence type
context required	string Enum: "TAGS" "THINGTYPE" ContextType
radius	number Radius in meters (only required for circles)
	object Polygon
	object Polygon
isActive	boolean Whether the geofence is active
tags	Array of strings Tags are used to define which things the geofence should be applied on
thingType	string Thing type id
things	Array of strings Thing ids

Responses

Request samples

Payload

Content type

application/json

{"name": "Warehouse Zone A",
"description": "This is a geofence for warehouse zone A",
"type": "polygon",
"context": "TAGS",
"radius": 100,
"center": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"isActive": true,
"tags": ["tag1",
"tag2"
],
"thingType": "string",
"things": ["string"
]
}

Response samples

200

Content type

application/json

{"name": "Warehouse Zone A",
"description": "This is a geofence for warehouse zone A",
"type": "polygon",
"context": "TAGS",
"radius": 100,
"center": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"isActive": true,
"tags": ["tag1",
"tag2"
],
"thingType": "string",
"things": ["string"
]
}

delete Geofence

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

GeofenceController_findGeofenceById

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "gf_xxxxxxxxxxxxxxxxx",
"name": "Warehouse Zone A",
"description": "This is a geofence for warehouse zone A",
"type": "polygon",
"context": "TAGS",
"radius": 100,
"center": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0
]
]
]
},
"isActive": true,
"tags": ["tag1",
"tag2"
],
"thingType": "string",
"things": ["string"
]
}

Canvas

CanvasController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

Create Canvas

Authorizations:

bearersupabase

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Canvas Mutation

name required	string Canvas Name
description	string description
type required	string type
searchLabels	string SearchLabels
config	object config
Things	Array of strings Things
ThingType required	string ThingType

Responses

Request samples

Payload

Content type

application/json

{"name": "Canvas A",
"description": "This is a canvas",
"type": "string",
"searchLabels": "label1 label2",
"config": { },
"Things": ["string"
],
"ThingType": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "Canvas A",
"description": "This is a canvas",
"type": "string",
"searchLabels": "label1 label2",
"thingType": {"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
},
"things": [{"id": "string",
"name": "string",
"alternateId": "string",
"thingTypeRel": {"id": "string",
"name": "string",
"displayName": "string"
},
"characteristics": { }
}
],
"config": { }
}

get all canvas

Filterable fields: id, name, description,searchLabels

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "Canvas A",
"description": "This is a canvas",
"type": "string",
"searchLabels": "label1 label2",
"thingType": {"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": null,
"max": null,
"name": null,
"color": null,
"severity": null
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
},
"things": [{"id": "string",
"name": "string",
"alternateId": "string",
"thingTypeRel": {"id": "string",
"name": "string",
"displayName": "string"
},
"characteristics": { }
}
],
"config": { }
}
]

Update canvas

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Request Body schema: application/json
required

Canvas update

name	string Canvas Name
description	string description
type	string type
searchLabels	string SearchLabels
config	object config
Things	Array of strings Things
ThingType	string ThingType

Responses

Request samples

Payload

Content type

application/json

{"name": "Canvas A",
"description": "This is a canvas",
"type": "string",
"searchLabels": "label1 label2",
"config": { },
"Things": ["string"
],
"ThingType": "string"
}

Response samples

200

Content type

application/json

{"name": "Canvas A",
"description": "This is a canvas",
"type": "string",
"searchLabels": "label1 label2",
"config": { },
"Things": ["string"
],
"ThingType": "string"
}

delete Canvas

Authorizations:

bearersupabase

path Parameters

id

required

string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

CanvasController_findCanvasById

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "Canvas A",
"description": "This is a canvas",
"type": "string",
"searchLabels": "label1 label2",
"thingType": {"id": "tt_xxxxxxxxxxxxxxxxx",
"name": "Thing_Type_1",
"displayName": "Thing Type 1",
"tags": { },
"description": {"en": "Warehouse Zone A",
"de": "Lagerzone A"
},
"version": "1",
"provider": "NIMBIT",
"searchLabels": "label1 label2",
"groups": [{"id": "gr_xxxxxxxxxxxxxxxxx",
"name": "group1"
}
],
"extends": ["string"
],
"schema": {"interfaces": [{"name": "Interface1",
"tags": { },
"properties": [{"id": "string",
"name": "imei",
"displayName": "IMEI",
"mapping": "imei_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"timeseriesRelevant": false,
"hasPrecedence": false,
"isPrivate": false,
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
},
"translations": { }
}
],
"commands": [{"id": "string",
"displayName": "Ignition State",
"name": "machine_ignition",
"mapping": "machine_ignition_alt_name_on_machine",
"initialValue": "string",
"description": { },
"dataType": "string",
"uom": "string",
"tags": { }
}
],
"measures": [{"id": "string",
"name": "humidity",
"mapping": "humidity_alt_name_on_machine",
"description": { },
"dataType": "string",
"uom": "%",
"tags": { },
"displayName": "Humidity",
"translations": { },
"minValue": "0",
"maxValue": "100",
"aggregationState": "aggregated",
"decimalPlaces": "2",
"factor": "2",
"offset": "2",
"ignoreOutliers": false,
"thresholds": [{"min": 0,
"max": 0,
"name": "string",
"color": "string",
"severity": "Low"
}
],
"displayNameTranslations": {"fallbackName": "temp",
"translations": [{"locale": "de",
"translation": "td"
},
{"locale": "en",
"translation": "te"
}
]
}
}
]
}
]
},
"deprecated": true,
"deprecationDate": "2019-08-24T14:15:22Z",
"images": {"50": "string",
"100": "string",
"250": "string",
"400": "string",
"700": "string",
"1200": "string",
"default": "string"
},
"avatarColor": "#000000",
"DashboardConfig": [{"id": "string",
"default": true,
"locked": true,
"accessType": "User"
}
]
},
"things": [{"id": "string",
"name": "string",
"alternateId": "string",
"thingTypeRel": {"id": "string",
"name": "string",
"displayName": "string"
},
"characteristics": { }
}
],
"config": { }
}

Context

ContextController_count

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

1

get all context

Filterable fields: id, name, description,searchLabels

Authorizations:

bearersupabase

query Parameters

select	string
limit	number
offset	number <int32> (Page) >= 0 Default: 0
q	string
orderBy	string
include	string
language	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "Context A",
"type": "INVITATION",
"description": "This is a context",
"suggestions": { },
"contextData": { }
}
]

ContextController_findContextById

Authorizations:

bearersupabase

path Parameters

id

required

string

query Parameters

select	string
include	string

header Parameters

ocb-metadata	string Value: "true" show optional metadata in response
x-ocb-tenant	any Example: demo

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "Context A",
"type": "INVITATION",
"description": "This is a context",
"suggestions": { },
"contextData": { }
}

Azure

Handle Azure IoT Hub device connectivity events

Webhook endpoint for Azure Event Grid to send device connection state changes and subscription validation

Authorizations:

bearersupabase

query Parameters

api_key

required

string

API key for webhook authentication

header Parameters

x-ocb-tenant

any

Example: demo

Responses

Response samples

200

Content type

application/json

{"validationResponse": "string",
"success": true
}

Iot Breeze OCB (0.9.0)

Tenant

TenantController_readAvailableTenants

Authorizations:

query Parameters

header Parameters

Responses

Response samples

TenantController_readAvailableTenants

Authorizations:

query Parameters

header Parameters

Responses

Response samples

TenantController_readCurrentTenant

Authorizations:

query Parameters

header Parameters

Responses

Response samples

TenantController_readCurrentTenant

Authorizations:

query Parameters

header Parameters

Responses

Response samples

TenantController_updateCurrentTenant

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

TenantController_updateCurrentTenant

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

TenantController_rotateTenantKey

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

TenantController_rotateTenantKey

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

TenantController_readTenantPublic

Authorizations:

query Parameters

header Parameters

Responses

Response samples

TenantController_readTenantPublic

Authorizations:

query Parameters

header Parameters

Responses

Response samples

upload favicon

Authorizations:

header Parameters

Request Body schema: multipart/form-datarequired

Responses

upload favicon

Authorizations:

header Parameters

Request Body schema: multipart/form-datarequired

Responses

upload logo

Authorizations:

header Parameters

Request Body schema: multipart/form-datarequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required