Service

API Service Calls

The service calls are used to read, add, remove and manipulate MobiusFlow services.

Get service configuration

GET/api/v1/mobius/service/config/{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

200400401404408500

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

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/config/{hid}/{sid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404408500

{
  "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": "000D",
            "ins": "000A",
            "rids": [
              {
                "rid": "01",
                "settings": {
                  "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                }
              },
              {
                "rid": "0B",
                "settings": {
                  "pv": "11223344"
                }
              }
            ]
          }
        ]
      },
      {
        "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"
                }
              }
            ]
          }
        ]
      },
      {
        "pid": "0201",
        "objects": [
          {
            "pid": "0201",
            "ins": "0001",
            "rids": []
          }
        ]
      }
    ]
  }
}

Start service

POST/api/v1/mobius/service/start/{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

200400401404408500

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

Start service result information

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/start/{hid}/{sid}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "result": "OK"
  }
}

Stop service

POST/api/v1/mobius/service/stop/{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

200400401404408500

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

Stop service result information

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/stop/{hid}/{sid}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "result": "OK"
  }
}

Reload service

POST/api/v1/mobius/service/reload/{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

200400401404408500

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

Reload service result information

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/reload/{hid}/{sid}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020",
  "data": {
    "result": "OK"
  }
}

Add service

POST/api/v1/mobius/service/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

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

Body

application/json

sidstring

Service ID

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

spid*string

Service profile ID

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

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

Response

200400401404408500

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

Mobius Node Configuration (array of services information)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/{hid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spid": "000E",
      "name": "New example nr-connector service",
      "enabled": false,
      "runAtStart": true
    }),
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": [
    {
      "id": "0004/002",
      "name": "mobius-engine-api",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0012/012",
      "name": "mobius-ui-restapi",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0021/020",
      "name": "enocean devices",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "000E/021",
      "name": "Test",
      "enabled": false,
      "runAtStart": true
    },
    {
      "id": "000E/022",
      "name": "New example nr-connector service",
      "enabled": false,
      "runAtStart": true
    }
  ]
}

Clone service

POST/api/v1/mobius/service/clone/{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}$

Body

application/json

copies*number

Number of copies

start*string

Starting service ID for 1st copy, subsequent copies will be incremented

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

Response

200400401404408500

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

Mobius Node Configuration (array of services information)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/clone/{hid}/{sid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "copies": 1,
      "start": "030"
    }),
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": [
    {
      "id": "0004/002",
      "name": "mobius-engine-api",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0012/012",
      "name": "mobius-ui-restapi",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0021/020",
      "name": "enocean devices",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "000E/021",
      "name": "Test",
      "enabled": false,
      "runAtStart": true
    },
    {
      "id": "0021/030",
      "name": "Clone of 020 0",
      "enabled": true,
      "runAtStart": true
    }
  ]
}

Update service ID of a service

PATCH/api/v1/mobius/service/config/sid/{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}$

Body

application/json

newSID*string

New service ID

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

Response

200400401404408500

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

Mobius Node Configuration (array of services information)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/config/sid/{hid}/{sid}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "newSID": "02A"
    }),
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": [
    {
      "id": "0004/002",
      "name": "mobius-engine-api",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0012/012",
      "name": "mobius-ui-restapi",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0021/020",
      "name": "enocean devices",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "000E/02A",
      "name": "nr-connector",
      "enabled": true,
      "runAtStart": true
    }
  ]
}

Update service configuration

PATCH/api/v1/mobius/service/config/{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}$

Body

application/json

namestring

Service name

enabledboolean

Service enabled flag

runAtStartboolean

Service run at start flag

customobject

Custom service settings configuration

Response

200400401404408500

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

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/config/{hid}/{sid}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "nr-connector",
      "runAtStart": true,
      "enabled": true
    }),
});
const data = await response.json();

Response

200400401404408500

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": {
    "sid": "021",
    "spid": "000E",
    "name": "nr-connector",
    "enabled": true,
    "runAtStart": true,
    "settings": {
      "mqtt": {
        "host": "mqtt://localhost",
        "port": 2016
      },
      "timeouts": {
        "local": 500,
        "remote": 5000
      }
    },
    "custom": {
      "host": "localhost",
      "port": 1890,
      "psk": "node-red"
    },
    "objects": []
  }
}

Replace all objects within a service

PUT/api/v1/mobius/service/config/replaceAllObjects/{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}$

Body

application/json

pidstring

Object PID

objectsarray of object

Array of objects

Response

200400401404408500

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

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/config/replaceAllObjects/{hid}/{sid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "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"
                }
              }
            ]
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

200400401404408500

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

Delete service

DELETE/api/v1/mobius/service/{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

200400401404408500

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

Mobius Node Configuration (array of services information)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/mobius/service/{hid}/{sid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400401404408500

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