Object

API Object & Resource Calls

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

Get live object

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/mobius/object/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001",
  "data": {
    "pid": "000D",
    "ins": "0001",
    "profileName": "enocean_A5-08-01",
    "description": "EnOcean light, temperature and occupancy sensor",
    "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
  }
}

Get live resource

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

ridstringRequired

MobiusFlow Resource ID

Example: {"value":"40"}Pattern: ^[0-9A-Fa-f]{2}$

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}/{rid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001/40",
  "data": {
    "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"
    }
  }
}

Get object configuration

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/mobius/object/config/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "pid": "000D",
    "ins": "0001",
    "rids": [
      {
        "rid": "01",
        "settings": {
          "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
        }
      },
      {
        "rid": "0B",
        "settings": {
          "pv": "12345678"
        }
      }
    ]
  }
}

Add object

post

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

Body

Array of resources

ridstringOptional

Responses

201

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/mobius/object/{hid}/{sid}/{pid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 36

[
  {
    "rid": "40",
    "settings": {
      "min": 30
    }
  }
]

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

Add object with specified instance ID

post

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Body

Array of resources

ridstringOptional

Responses

201

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/mobius/object/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 36

[
  {
    "rid": "40",
    "settings": {
      "min": 30
    }
  }
]

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

Clone object

post

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Body

Object cloning information

copiesnumberRequired

Number of copies to be created

startstringOptional

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

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

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/mobius/object/clone/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "copies": 1,
  "start": "000A"
}

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

Patch live resource

patch

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

ridstringRequired

MobiusFlow Resource ID

Example: {"value":"40"}Pattern: ^[0-9A-Fa-f]{2}$

Body

Resource information

prioritynumberOptional

Priority of the resource value

valueany ofRequired

Value of the resource

stringOptional

or

numberOptional

or

booleanOptional

or

nullOptional

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins}/{rid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "priority": 15,
  "value": 10
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001/40",
  "data": {
    "rid": "40",
    "type": "number",
    "name": "tmp",
    "pv": 10,
    "prar": [
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      10,
      0
    ],
    "settings": {
      "access": "r",
      "min": 0,
      "max": 51,
      "precision": 1,
      "units": "C"
    }
  }
}

Patch multiple live resources

patch

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Body

Array of patched live resources

rstringRequired

Resource ID

pnumberRequired

Priority of the resource value

vany ofRequired

Value of the resource

stringOptional

or

numberOptional

or

booleanOptional

or

nullOptional

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/mobius/object/resource/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "r": "00",
    "p": 15,
    "v": "Hello"
  },
  {
    "r": "40",
    "p": 15,
    "v": 43.9
  }
]

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001",
  "data": {
    "pid": "000D",
    "ins": "0001",
    "profileName": "enocean_A5-08-01",
    "description": "EnOcean light, temperature and occupancy sensor",
    "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
  }
}

Clear live resource

patch

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

ridstringRequired

MobiusFlow Resource ID

Example: {"value":"40"}Pattern: ^[0-9A-Fa-f]{2}$

Body

Resource information

prioritynumberRequired

Priority of the resource value

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/mobius/object/resource/clear/{hid}/{sid}/{pid}/{ins}/{rid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "priority": 15
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001/40",
  "data": {
    "rid": "40",
    "type": "number",
    "name": "tmp",
    "pv": 0,
    "prar": [
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      0
    ],
    "settings": {
      "access": "r",
      "min": 0,
      "max": 51,
      "precision": 1,
      "units": "C"
    }
  }
}

Update object in service

patch

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Body

Object information

insstringRequired

Replacement object instance ID

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/mobius/object/config/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "ins": "0005",
  "rids": [
    {
      "rid": "40",
      "settings": {
        "min": 22
      }
    }
  ]
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "pid": "000D",
    "ins": "0005",
    "rids": [
      {
        "rid": "40",
        "settings": {
          "min": 22
        }
      }
    ]
  }
}

Delete object

delete

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Responses

200

Ok response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/mobius/object/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Accept: */*

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