Objects

Add a MobiusFlow object

post

The first available instance will be used

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

Body

application/json

The object to add to the service

configIsDirtybooleanOptional

Responses

201

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

post

/api/engine/v3/object/{hid}/{sid}/{pid}

HTTPcURLJavaScriptPython

POST /api/engine/v3/object/{hid}/{sid}/{pid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "configIsDirty": true,
  "rids": [
    {
      "rid": "40",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ],
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "from": "profile"
    }
  }
}

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Read a MobiusFlow object

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

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/engine/v3/object/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

GET /api/engine/v3/object/{hid}/{sid}/{pid}/{ins} HTTP/1.1
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"
      }
    }
  }
}

Add a MobiusFlow object

post

If the instance is already in use an error will be returned

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

Body

application/json

The object to add to the service

configIsDirtybooleanOptional

Responses

201

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

post

/api/engine/v3/object/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

POST /api/engine/v3/object/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "configIsDirty": true,
  "rids": [
    {
      "rid": "40",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ],
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "from": "profile"
    }
  }
}

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Delete a MobiusFlow object

delete

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

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

delete

/api/engine/v3/object/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

DELETE /api/engine/v3/object/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Clone a MobiusFlow object

post

Clone an object one or more times. The new object INSs will be sequential (skipping any existing object INSs) from the start INS or 0001 if not provided.

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

Body

application/json

copiesnumberRequired

The number of copies to make

startstring · min: 4 · max: 4Optional

The INS of the first clone

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

Responses

201

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

post

/api/engine/v3/object/clone/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

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

{
  "copies": 1,
  "start": "0001"
}

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Update a MobiusFlow object's INS

post

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

Body

application/json

The new INS

insstring · min: 4 · max: 4Required

Object Instance (INS)

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

Responses

200

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

post

/api/engine/v3/object/config/ins/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

POST /api/engine/v3/object/config/ins/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "ins": "0001"
}

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Get a MobiusFlow objects's configuration

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

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/engine/v3/object/config/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

GET /api/engine/v3/object/config/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "pid": "002F",
    "ins": "0001",
    "configIsDirty": true,
    "rids": [
      {
        "rid": "40",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      }
    ],
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "text",
        "from": "profile"
      }
    }
  }
}

Update a MobiusFlow object's configuration

patch

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

Body

application/json

The object to add to the service

configIsDirtybooleanOptional

Responses

200

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

patch

/api/engine/v3/object/config/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

PATCH /api/engine/v3/object/config/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "configIsDirty": true,
  "rids": [
    {
      "rid": "40",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ],
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "from": "profile"
    }
  }
}

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "pid": "002F",
    "ins": "0001",
    "configIsDirty": true,
    "rids": [
      {
        "rid": "40",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "profile"
          }
        }
      }
    ],
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "text",
        "from": "profile"
      }
    }
  }
}

Read a MobiusFlow object resource

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

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/engine/v3/object/resource/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

GET /api/engine/v3/object/resource/{hid}/{sid}/{pid}/{ins}/{rid} HTTP/1.1
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"
      }
    }
  }
}

Write a value to a MobiusFlow object resource

patch

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

Body

application/json

valueany ofRequired

The value to write to the resource

Example: 42

booleanOptional

or

numberOptional

or

stringOptional

or

string · enum · nullableOptionalPossible values:

priorityinteger · min: 1 · max: 15Optional

The priority to write to. Defaults to priority 15

Example: 12

Responses

200

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

patch

/api/engine/v3/object/resource/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

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

{
  "value": 42,
  "priority": 12
}

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

Write values to multiple MobiusFlow object resources at once

patch

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

Body

application/json

An array of objects containing the value and priority to write to each resource

Responses

200

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

patch

/api/engine/v3/object/resource/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

PATCH /api/engine/v3/object/resource/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "updates": [
    {
      "r": "40",
      "p": 15,
      "v": 42
    },
    {
      "r": "41",
      "p": 15,
      "v": 43
    }
  ]
}

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

Clear the value of a MobiusFlow object resource priority

patch

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

Body

application/json

priorityinteger · min: 1 · max: 15Required

The priority to clear

Example: 12

Responses

200

Default Response

application/json

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z

uristringRequired

URI of the response

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

408

Default Response

application/json

409

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

patch

/api/engine/v3/object/resource/clear/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

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

{
  "priority": 12
}

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