Object

API Object & Resource Calls

The object calls are used to read, add, remove and manipulate MobiusFlow objects and resources.

Get live object

GET/api/v1/mobius/object/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001"

data*object

Mobius live object information

pidstring

Profile ID associated to the object

insstring

Instance ID of the object

profileNamestring

Profile name associated to the object

descriptionstring

Object description

resourcesarray of object

Array of resources

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

familiesarray of string

Array of families

itemsstring

Family name

isFromConfignumber

Object is from config, 0 for created but not configured, 1 for created from config

Request

Response

Get live resource

GET/api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}/{rid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

rid*string

MobiusFlow Resource ID

Example: "40"

Pattern: ^[0-9A-Fa-f]{2}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001/40"

data*object

Mobius live resource information

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

Request

Response

Get object configuration

GET/api/v1/mobius/object/config/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Add object

POST/api/v1/mobius/object/{hid}/{sid}/{pid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

Body

ridstring

settingsobject

Other propertiesany

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Add object with specified instance ID

POST/api/v1/mobius/object/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

ridstring

settingsobject

Other propertiesany

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Clone object

POST/api/v1/mobius/object/clone/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

copies*number

Number of copies to be created

startstring

Starting instance ID of the 1st copy, subsequent copies will be incremented

Pattern: ^[0-9A-F]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Patch live resource

PATCH/api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}/{rid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

rid*string

MobiusFlow Resource ID

Example: "40"

Pattern: ^[0-9A-Fa-f]{2}$

Body

prioritynumber

Priority of the resource value

value*any of

Value of the resource

string

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001/40"

data*object

Mobius live resource information

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

Request

Response

Patch multiple live resources

PATCH/api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

r*string

Resource ID

p*number

Priority of the resource value

v*any of

Value of the resource

string

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001"

data*object

Mobius live object information

pidstring

Profile ID associated to the object

insstring

Instance ID of the object

profileNamestring

Profile name associated to the object

descriptionstring

Object description

resourcesarray of object

Array of resources

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

familiesarray of string

Array of families

itemsstring

Family name

isFromConfignumber

Object is from config, 0 for created but not configured, 1 for created from config

Request

Response

Clear live resource

PATCH/api/v1/mobius/object/resource/clear/{hid}/{sid}/{pid}/{ins}/{rid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

rid*string

MobiusFlow Resource ID

Example: "40"

Pattern: ^[0-9A-Fa-f]{2}$

Body

priority*number

Priority of the resource value

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001/40"

data*object

Mobius live resource information

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

Request

Response

Update object in service

PATCH/api/v1/mobius/object/config/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

ins*string

Replacement object instance ID

rids*array of object

Array of resource IDs and settings

rid*string

Resource ID

settings*object

Resource settings

Other propertiesany

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Delete object

DELETE/api/v1/mobius/object/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Get object configuration

GET/api/v1/mobius/object/config/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Get live resource

GET/api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}/{rid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

rid*string

MobiusFlow Resource ID

Example: "40"

Pattern: ^[0-9A-Fa-f]{2}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001/40"

data*object

Mobius live resource information

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

Request

Response

Clear live resource

PATCH/api/v1/mobius/object/resource/clear/{hid}/{sid}/{pid}/{ins}/{rid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

rid*string

MobiusFlow Resource ID

Example: "40"

Pattern: ^[0-9A-Fa-f]{2}$

Body

priority*number

Priority of the resource value

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001/40"

data*object

Mobius live resource information

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

Request

Response

Update object in service

PATCH/api/v1/mobius/object/config/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

ins*string

Replacement object instance ID

rids*array of object

Array of resource IDs and settings

rid*string

Resource ID

settings*object

Resource settings

Other propertiesany

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Patch live resource

PATCH/api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}/{rid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

rid*string

MobiusFlow Resource ID

Example: "40"

Pattern: ^[0-9A-Fa-f]{2}$

Body

prioritynumber

Priority of the resource value

value*any of

Value of the resource

string

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001/40"

data*object

Mobius live resource information

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

Request

Response

Get live object

GET/api/v1/mobius/object/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001"

data*object

Mobius live object information

pidstring

Profile ID associated to the object

insstring

Instance ID of the object

profileNamestring

Profile name associated to the object

descriptionstring

Object description

resourcesarray of object

Array of resources

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

familiesarray of string

Array of families

itemsstring

Family name

isFromConfignumber

Object is from config, 0 for created but not configured, 1 for created from config

Request

Response

Delete object

DELETE/api/v1/mobius/object/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Patch multiple live resources

PATCH/api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

r*string

Resource ID

p*number

Priority of the resource value

v*any of

Value of the resource

string

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001/020/000D/0001"

data*object

Mobius live object information

pidstring

Profile ID associated to the object

insstring

Instance ID of the object

profileNamestring

Profile name associated to the object

descriptionstring

Object description

resourcesarray of object

Array of resources

ridstring

Resource ID

typestring

Resource type

namestring

Resource name

pvany of

Resource value

string

prararray of any of

Resource priority array

itemsany of

Resource value for given priority

string

settingsobject

Resource settings

Other propertiesany

familiesarray of string

Array of families

itemsstring

Family name

isFromConfignumber

Object is from config, 0 for created but not configured, 1 for created from config

Request

Response

Add object with specified instance ID

POST/api/v1/mobius/object/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

ridstring

settingsobject

Other propertiesany

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Add object

POST/api/v1/mobius/object/{hid}/{sid}/{pid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

Body

ridstring

settingsobject

Other propertiesany

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Clone object

POST/api/v1/mobius/object/clone/{hid}/{sid}/{pid}/{ins}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

sid*string

MobiusFlow Service ID

Example: "020"

Pattern: ^[0-9A-Fa-f]{3}$

pid*string

MobiusFlow Object Profile ID

Example: "014A"

Pattern: ^[0-9A-Fa-f]{4}$

ins*string

MobiusFlow Object Instance ID

Example: "0001"

Pattern: ^[0-9A-Fa-f]{4}$

Body

copies*number

Number of copies to be created

startstring

Starting instance ID of the 1st copy, subsequent copies will be incremented

Pattern: ^[0-9A-F]{4}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Mobius service configuration

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001",
  "data": {
    "pid": "000D",
    "ins": "0001",
    "profileName": "enocean_A5-08-01",
    "description": "<p>EnOcean light, temperature and occupancy sensor</p>",
    "resources": [
      {
        "rid": "00",
        "type": "string",
        "name": "parentObject",
        "pv": "",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "",
          ""
        ],
        "settings": {
          "access": "rw",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "01",
        "type": "string",
        "name": "name",
        "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "02",
        "type": "datetime",
        "name": "objectLastUpdated",
        "pv": "1970-01-01T00:00:00.000Z",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "1970-01-01T00:00:00.000Z",
          "1970-01-01T00:00:00.000Z"
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "03",
        "type": "string",
        "name": "description",
        "pv": "",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "04",
        "type": "string",
        "name": "location",
        "pv": "",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "0A",
        "type": "string",
        "name": "eep",
        "pv": "A5-08-01",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "A5-08-01",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "0B",
        "type": "string",
        "name": "uid",
        "pv": "12345678",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "12345678",
          ""
        ],
        "settings": {
          "access": "r",
          "maxlen": 8,
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "0C",
        "type": "number",
        "name": "status",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "0D",
        "type": "number",
        "name": "dBm",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "units": "dBm"
        }
      },
      {
        "rid": "0E",
        "type": "bool",
        "name": "lrn",
        "pv": false,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          false,
          false
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "40",
        "type": "number",
        "name": "tmp",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "min": 0,
          "max": 51,
          "precision": 1,
          "units": "C"
        }
      },
      {
        "rid": "41",
        "type": "number",
        "name": "lux",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "min": 0,
          "max": 510,
          "precision": 1,
          "units": "lx"
        }
      },
      {
        "rid": "42",
        "type": "bool",
        "name": "pirs",
        "pv": false,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          false,
          false
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "43",
        "type": "bool",
        "name": "occupany",
        "pv": false,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          false,
          false
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "44",
        "type": "number",
        "name": "supplyVoltage",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "min": 0,
          "max": 5.1,
          "precision": 1,
          "units": "V"
        }
      }
    ],
    "families": [
      "EnOcean",
      "TemperatureSensor",
      "OccupancySensor",
      "LightSensor"
    ],
    "isFromConfig": 1,
    "__$markdownParsed": true
  }
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "sid": "020",
    "spid": "0021",
    "name": "enocean devices",
    "enabled": true,
    "runAtStart": true,
    "settings": {
      "mqtt": {
        "host": "mqtt://localhost",
        "port": 2016
      },
      "timeouts": {
        "local": 500,
        "remote": 5000
      }
    },
    "custom": {},
    "objects": [
      {
        "pid": "000D",
        "objects": [
          {
            "pid": "000D",
            "ins": "0002",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "11223344"
                }
              }
            ]
          },
          {
            "pid": "000D",
            "ins": "0006",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 30
                }
              }
            ]
          },
          {
            "pid": "000D",
            "ins": "0001",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 30
                }
              }
            ]
          }
        ]
      },
      {
        "pid": "0010",
        "objects": [
          {
            "pid": "0010",
            "ins": "0001",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-02-02 Temperature Sensor (-30C to 10C)"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "12121212"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001",
  "data": {
    "pid": "000D",
    "ins": "0001",
    "profileName": "enocean_A5-08-01",
    "description": "<p>EnOcean light, temperature and occupancy sensor</p>",
    "resources": [
      {
        "rid": "00",
        "type": "string",
        "name": "parentObject",
        "pv": "Hello",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "Hello",
          ""
        ],
        "settings": {
          "access": "rw",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "01",
        "type": "string",
        "name": "name",
        "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "02",
        "type": "datetime",
        "name": "objectLastUpdated",
        "pv": "2022-12-21T12:12:40.566Z",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "2022-12-21T12:12:40.566Z",
          "1970-01-01T00:00:00.000Z"
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "03",
        "type": "string",
        "name": "description",
        "pv": "",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "04",
        "type": "string",
        "name": "location",
        "pv": "",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "0A",
        "type": "string",
        "name": "eep",
        "pv": "A5-08-01",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "A5-08-01",
          ""
        ],
        "settings": {
          "access": "r",
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "0B",
        "type": "string",
        "name": "uid",
        "pv": "12345678",
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          "12345678",
          ""
        ],
        "settings": {
          "access": "r",
          "maxlen": 8,
          "tags": {
            "attribute": "true"
          }
        }
      },
      {
        "rid": "0C",
        "type": "number",
        "name": "status",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "0D",
        "type": "number",
        "name": "dBm",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "units": "dBm"
        }
      },
      {
        "rid": "0E",
        "type": "bool",
        "name": "lrn",
        "pv": false,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          false,
          false
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "40",
        "type": "number",
        "name": "tmp",
        "pv": 43.9,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          43.9,
          0
        ],
        "settings": {
          "access": "r",
          "min": 0,
          "max": 51,
          "precision": 1,
          "units": "C"
        }
      },
      {
        "rid": "41",
        "type": "number",
        "name": "lux",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "min": 0,
          "max": 510,
          "precision": 1,
          "units": "lx"
        }
      },
      {
        "rid": "42",
        "type": "bool",
        "name": "pirs",
        "pv": false,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          false,
          false
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "43",
        "type": "bool",
        "name": "occupany",
        "pv": false,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          false,
          false
        ],
        "settings": {
          "access": "r"
        }
      },
      {
        "rid": "44",
        "type": "number",
        "name": "supplyVoltage",
        "pv": 0,
        "prar": [
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          null,
          0,
          0
        ],
        "settings": {
          "access": "r",
          "min": 0,
          "max": 5.1,
          "precision": 1,
          "units": "V"
        }
      }
    ],
    "families": [
      "EnOcean",
      "TemperatureSensor",
      "OccupancySensor",
      "LightSensor"
    ],
    "isFromConfig": 1,
    "__$markdownParsed": true
  }
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "sid": "020",
    "spid": "0021",
    "name": "enocean devices",
    "enabled": true,
    "runAtStart": true,
    "settings": {
      "mqtt": {
        "host": "mqtt://localhost",
        "port": 2016
      },
      "timeouts": {
        "local": 500,
        "remote": 5000
      }
    },
    "custom": {},
    "objects": [
      {
        "pid": "000D",
        "objects": [
          {
            "pid": "000D",
            "ins": "0005",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 22
                }
              }
            ]
          },
          {
            "pid": "000D",
            "ins": "0002",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "11223344"
                }
              }
            ]
          },
          {
            "pid": "000D",
            "ins": "0006",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 30
                }
              }
            ]
          }
        ]
      },
      {
        "pid": "0010",
        "objects": [
          {
            "pid": "0010",
            "ins": "0001",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-02-02 Temperature Sensor (-30C to 10C)"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "12121212"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "sid": "020",
    "spid": "0021",
    "name": "enocean devices",
    "enabled": true,
    "runAtStart": true,
    "settings": {
      "mqtt": {
        "host": "mqtt://localhost",
        "port": 2016
      },
      "timeouts": {
        "local": 500,
        "remote": 5000
      }
    },
    "custom": {},
    "objects": [
      {
        "pid": "000D",
        "objects": [
          {
            "pid": "000D",
            "ins": "0005",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 22
                }
              }
            ]
          },
          {
            "pid": "000D",
            "ins": "0002",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "11223344"
                }
              }
            ]
          },
          {
            "pid": "000D",
            "ins": "0006",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 30
                }
              }
            ]
          }
        ]
      },
      {
        "pid": "0010",
        "objects": [
          {
            "pid": "0010",
            "ins": "0001",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-02-02 Temperature Sensor (-30C to 10C)"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "12121212"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "sid": "020",
    "spid": "0021",
    "name": "enocean devices",
    "enabled": true,
    "runAtStart": true,
    "settings": {
      "mqtt": {
        "host": "mqtt://localhost",
        "port": 2016
      },
      "timeouts": {
        "local": 500,
        "remote": 5000
      }
    },
    "objects": [
      {
        "pid": "000D",
        "objects": [
          {
            "ins": "0002",
            "pid": "000D",
            "uiname": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "11223344"
                }
              }
            ],
            "timestamp": 1671618304292
          },
          {
            "ins": "0006",
            "pid": "000D",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 30
                }
              }
            ]
          },
          {
            "ins": "0001",
            "pid": "000D",
            "rids": [
              {
                "rid": "40",
                "settings": {
                  "min": 30
                }
              }
            ]
          },
          {
            "ins": "000A",
            "pid": "000D",
            "uiname": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "11223344"
                }
              }
            ],
            "timestamp": 1671618304292
          }
        ]
      },
      {
        "pid": "0010",
        "objects": [
          {
            "ins": "0001",
            "pid": "0010",
            "uiname": "EnOcean EEP A5-02-02 Temperature Sensor (-30C to 10C)",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-02-02 Temperature Sensor (-30C to 10C)"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "12121212"
                }
              }
            ],
            "timestamp": 1671618299023
          }
        ]
      }
    ],
    "custom": {}
  }
}