MobiusFlow Website

Discover

Discover MobiusFlow services on a hub

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/discover/{hid}
GET /api/engine/v3/discover/{hid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "hid": "000001",
      "sid": "020",
      "spid": "F021",
      "name": "Floor 1 Sensors",
      "enabled": true,
      "runAtStart": true,
      "lastConnected": "2025-03-13T09:09:01.631Z",
      "lastDisconnected": "1970-01-01T00:00:00.000Z",
      "lastSeen": "2025-03-13T09:09:06.707Z",
      "status": "running",
      "serviceStatus": "OK",
      "serviceStatusText": "Service is running"
    }
  ]
}

Discover object profiles used by a MobiusFlow service

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/discover/{hid}/{sid}
GET /api/engine/v3/discover/{hid}/{sid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    "002B",
    "004A"
  ]
}

Discover object instances for an object profile

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/discover/{hid}/{sid}/{pid}
GET /api/engine/v3/discover/{hid}/{sid}/{pid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    "002B",
    "004A"
  ]
}

Discover an object used by a MobiusFlow service

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b
insstring · min: 4 · max: 4Required

Object Instance (INS)

Example: 0001Pattern: \b[0-9A-F]{4}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/discover/{hid}/{sid}/{pid}/{ins}
GET /api/engine/v3/discover/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "pid": "002F",
      "ins": "0001",
      "profileName": "text",
      "description": "text",
      "resources": [
        {
          "rid": "40",
          "type": "bool",
          "pv": true,
          "prar": [
            true
          ],
          "name": "text",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ],
      "isFromConfig": true,
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ]
}

Discover a resource belonging to an object used by a MobiusFlow service

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
pidstring · min: 4 · max: 4Required

Object Profile ID (PID)

Example: 002FPattern: \b[0-9A-F]{4}$\b
insstring · min: 4 · max: 4Required

Object Instance (INS)

Example: 0001Pattern: \b[0-9A-F]{4}$\b
ridstringRequired

Resource ID (RID)

Example: 40Pattern: \b(?:[0-9A-F]{4}|[0-9A-F]{2})\b
Responses
200

Default Response

application/json
get
/api/engine/v3/discover/{hid}/{sid}/{pid}/{ins}/{rid}
GET /api/engine/v3/discover/{hid}/{sid}/{pid}/{ins}/{rid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "rid": "40",
      "type": "bool",
      "pv": true,
      "prar": [
        true
      ],
      "name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ]
}

Discover objects in a MobiusFlow service

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
get
/api/engine/v3/discover/{hid}/{sid}/allobjects
GET /api/engine/v3/discover/{hid}/{sid}/allobjects HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "pid": "002F",
      "ins": "0001",
      "profileName": "text",
      "description": "text",
      "resources": [
        {
          "rid": "40",
          "type": "bool",
          "pv": true,
          "prar": [
            true
          ],
          "name": "text",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ],
      "isFromConfig": true,
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ]
}
PreviousProfilesNextServices

Last updated

Was this helpful?