Service

API Service Calls

PreviousNode NextObject

Last updated 1 year ago

Get service configuration

get

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/mobius/service/config/{hid}/{sid}'

200

400

401

404

408

500

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

Ok response

Start service

post

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/mobius/service/start/{hid}/{sid}'

200

400

401

404

408

500

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

Ok response

Stop service

post

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/mobius/service/stop/{hid}/{sid}'

200

400

401

404

408

500

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

Ok response

Reload service

post

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/mobius/service/reload/{hid}/{sid}'

200

400

401

404

408

500

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

Ok response

Delete service

delete

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/mobius/service/{hid}/{sid}'

200

400

401

404

408

500

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

Ok response

Add service

post

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

Body

sidstringoptional

Service ID

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

spidstringrequired

Service profile ID

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

namestringrequired

Service name

enabledbooleanrequired

Service enabled flag

runAtStartbooleanrequired

Service run at start flag

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/mobius/service/{hid}' \
  --header 'Content-Type: application/json' \
  --data '{
    "spid": "000E",
    "name": "New example nr-connector service",
    "enabled": false,
    "runAtStart": true
  }'

200

400

401

404

408

500

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

Ok response

Clone service

post

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Body

copiesnumberrequired

Number of copies

startstringrequired

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/mobius/service/clone/{hid}/{sid}' \
  --header 'Content-Type: application/json' \
  --data '{
    "copies": 1,
    "start": "030"
  }'

200

400

401

404

408

500

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

Ok response

Update service ID of a service

patch

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Body

newSIDstringrequired

New service ID

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/v1/mobius/service/config/sid/{hid}/{sid}' \
  --header 'Content-Type: application/json' \
  --data '{
    "newSID": "02A"
  }'

200

400

401

404

408

500

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

Ok response

Update service configuration

patch

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Body

namestringoptional

Service name

enabledbooleanoptional

Service enabled flag

runAtStartbooleanoptional

Service run at start flag

customobjectoptional

Custom service settings configuration

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/v1/mobius/service/config/{hid}/{sid}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "nr-connector",
    "runAtStart": true,
    "enabled": true
  }'

200

400

401

404

408

500

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

Ok response

Replace all objects within a service

put

Path parameters

hidanyrequired

MobiusFlow Hub ID

Example: {"value":"000001"}

sidanyrequired

MobiusFlow Service ID

Example: {"value":"020"}

Body

pidstringoptional

Object PID

objectsobject[]optional

Array of objects

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/mobius/service/config/replaceAllObjects/{hid}/{sid}' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "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"
              }
            }
          ]
        }
      ]
    }
  ]'

200

400

401

404

408

500

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

Ok response

Get service configuration

Start service

Stop service

Reload service

Delete service

Add service

Clone service

Update service ID of a service

Update service configuration

Show child attributes

Replace all objects within a service

Show child attributes