MobiusFlow Website

Profiles

Get service profiles

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

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Query parameters
spidstring · min: 4 · max: 4Optional

Service Profile ID (SPID)

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

Default Response

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

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "spid": "000A",
      "name": "text",
      "cwd": "text",
      "script": "text",
      "isConfigurable": true,
      "isControllable": true,
      "description": "text",
      "icon": "text",
      "allowedObjectFamalies": [
        "text"
      ],
      "uiLayout": {
        "fields": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      }
    }
  ]
}

Get object profile templates

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

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Query parameters
pidstring · min: 4 · max: 4Optional

Object Profile ID (PID)

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

Default Response

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

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "header": {
        "pid": "002F",
        "profileName": "text",
        "description": "text",
        "uiname": "text",
        "group": "text",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      },
      "resources": [
        {
          "rid": "40",
          "name": "text",
          "type": "bool",
          "uiname": "text",
          "attribute": true,
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ],
      "preprocessor": {
        "language": "ts",
        "func": "text"
      },
      "codec": {
        "language": "ts",
        "func": "text"
      },
      "uiLayout": "text"
    }
  ]
}

Get object profiles

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/profile/object/{hid}
GET /api/engine/v3/profile/object/{hid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "header": {
        "pid": "002F",
        "profileName": "text",
        "description": "text",
        "uiname": "text",
        "group": "text",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      },
      "resources": [
        {
          "rid": "40",
          "name": "text",
          "type": "bool",
          "uiname": "text",
          "attribute": true,
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ],
      "preprocessor": {
        "language": "ts",
        "func": "text"
      },
      "codec": {
        "language": "ts",
        "func": "text"
      },
      "uiLayout": "text"
    }
  ]
}

Create an object profile

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

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Body
uiLayoutstringOptional
Responses
post
/api/engine/v3/profile/object/{hid}
POST /api/engine/v3/profile/object/{hid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 479

{
  "header": {
    "pid": "002F",
    "profileName": "text",
    "description": "text",
    "uiname": "text",
    "group": "text",
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "text",
        "from": "profile"
      }
    }
  },
  "resources": [
    {
      "rid": "40",
      "name": "text",
      "type": "bool",
      "uiname": "text",
      "attribute": true,
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ],
  "preprocessor": {
    "language": "ts",
    "func": "text"
  },
  "codec": {
    "language": "ts",
    "func": "text"
  },
  "uiLayout": "text"
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "header": {
      "pid": "002F",
      "profileName": "text",
      "description": "text",
      "uiname": "text",
      "group": "text",
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    },
    "resources": [
      {
        "rid": "40",
        "name": "text",
        "type": "bool",
        "uiname": "text",
        "attribute": true,
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      }
    ],
    "preprocessor": {
      "language": "ts",
      "func": "text"
    },
    "codec": {
      "language": "ts",
      "func": "text"
    },
    "uiLayout": "text"
  }
}

Update an object profile

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

Hub ID (HID)

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

Default Response

application/json
patch
/api/engine/v3/profile/object/{hid}
PATCH /api/engine/v3/profile/object/{hid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 479

{
  "header": {
    "pid": "002F",
    "profileName": "text",
    "description": "text",
    "uiname": "text",
    "group": "text",
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "text",
        "from": "profile"
      }
    }
  },
  "resources": [
    {
      "rid": "40",
      "name": "text",
      "type": "bool",
      "uiname": "text",
      "attribute": true,
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ],
  "preprocessor": {
    "language": "ts",
    "func": "text"
  },
  "codec": {
    "language": "ts",
    "func": "text"
  },
  "uiLayout": "text"
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "header": {
      "pid": "002F",
      "profileName": "text",
      "description": "text",
      "uiname": "text",
      "group": "text",
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    },
    "resources": [
      {
        "rid": "40",
        "name": "text",
        "type": "bool",
        "uiname": "text",
        "attribute": true,
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      }
    ],
    "preprocessor": {
      "language": "ts",
      "func": "text"
    },
    "codec": {
      "language": "ts",
      "func": "text"
    },
    "uiLayout": "text"
  }
}

Get object profile

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

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\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/profile/object/{hid}/{pid}
GET /api/engine/v3/profile/object/{hid}/{pid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "header": {
      "pid": "002F",
      "profileName": "text",
      "description": "text",
      "uiname": "text",
      "group": "text",
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    },
    "resources": [
      {
        "rid": "40",
        "name": "text",
        "type": "bool",
        "uiname": "text",
        "attribute": true,
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      }
    ],
    "preprocessor": {
      "language": "ts",
      "func": "text"
    },
    "codec": {
      "language": "ts",
      "func": "text"
    },
    "uiLayout": "text"
  }
}

Delete an object profile

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

Hub ID (HID)

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

Object Profile ID (PID)

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

Default Response

application/json
delete
/api/engine/v3/profile/object/{hid}/{pid}
DELETE /api/engine/v3/profile/object/{hid}/{pid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}

Get used object profiles

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/profile/object/used/{hid}
GET /api/engine/v3/profile/object/used/{hid} HTTP/1.1
Host: 
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    "text"
  ]
}
PreviousNodeNextDiscover

Last updated

Was this helpful?