Discover

API Discover calls

The discover calls are used to learn about the present state of a given MobiusFlow instance

Discover MobiusFlow services on a given hub

GET/api/v1/mobius/discover/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

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

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*array of object

Response data

idstring

Service ID

spidstring

Service profile ID

registeredstring

Service registered

statusstring

Service status

lastConnectedstring

Service last connected time

Request

Response

Discover MobiusFlow objects profiles on a given service

GET/api/v1/mobius/discover/{hid}/{sid}

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}$

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"

data*array of string

Response data

itemsstring

MobiusFlow object profile ID

Request

Response

Discover MobiusFlow objects of a given type

GET/api/v1/mobius/discover/{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}$

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"

data*array of string

Response data

itemsstring

MobiusFlow object instance ID

Request

Response

Discover a MobiusFlow object

GET/api/v1/mobius/discover/{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*array of object

Response data

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

Discover a MobiusFlow resource

GET/api/v1/mobius/discover/{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*array of object

Response data

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

Discover a MobiusFlow resource

GET/api/v1/mobius/discover/{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*array of object

Response data

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

Discover a MobiusFlow object

GET/api/v1/mobius/discover/{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*array of object

Response data

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

{
  "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
    }
  ]
}