IDS NXT

October 2021 11
IDS NXT: Vision apps – Object Detector
4 Interface description vision app "Object Detector"
The description of the REST interface is limited to the parameters/values that are specific for the vision app. A
more detailed description of the IDS NXT REST interface can be found in the manual "IDS NXT - REST
interface".
REST queries are only possible for activated vision apps, as these are generated dynamically at runtime.
Depending on the action and parameters, the used HTTP methods are color-coded and assigned to the
permission of IDS NXT user profiles (see manual "IDS NXT - Operation with the IDS NXT cockpit").
4.1 /vapps/objectdetector
/vapps/objectdetector
· GET
· OPTIONS
Provides information about the "Object Detector" vision app.
Response format
The content of the HTTP response is transferred in JSON format (application/json).
Return values
· Activated (Boolean): Activation status of the vision app
· Brief (String): Short description of the vision app
· Description (String): Long description of the vision app
· Manufacturer (String): Manufacturer of the vision app
· Name (String): Name of the vision app
· Status (String): Runtime status of the vision app "NotRunning", "Starting", "Running", "Crashed",
"FailedToStart", "TimedOut", "ReadError", "WriteError", "UnknownError", "Incompatible",
"DeepOceanCoreInUse", "Debugging"
· Title (String): Vision app title
· Type (String): Vision app type