Get Application Status - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

Industrial Edge Platform Operation - APIs & References

Product
Industrial Edge
Edition
12/2024
Language
en-US (original)

Retrieves the connected camera list with status, streaming topic, application version, and implemented specification version.

Message Envelope For ZMQ Message

Frame Field Description Type
1 payload Method payload Binary String (UTF-8)

payload

Field Optional Type Description
TransactionID Yes String Transaction identification.
Action No String Method called. Fixed value GetStatus
{
    "TransactionID": "46543214635244",
    "Action": "GetStatus"
}

Response

Frame Field Description Type
1 payload Response object Binary String (UTF-8)

Response Object

Field Optional Type Description
TransactionID Yes String Transaction identification.
ReturnCode No Integer Message code following Message Codes.
Message Yes String Response message
ApplicationVersion No String Connector application version
SpecificationVersion No String Specification version of the connector
DeviceList No Array of Camera Object Array of camera objects

Camera Object

Field Optional Type Description
DeviceID No String Current camera identification
StreamingTopic No String Topic where the camera streams images
Status No String Camera status. Possible values: Connected, Streaming, Error
{
    "TransactionID": "46543214635244",
    "ReturnCode": 0,
    "Message": "Success.",
    "ApplicationVersion": "1.0.1",
    "SpecificationVersion": "1.0.0",
    "DeviceList":
    [
        {
            "DeviceID": "548451887",
            "StreamingTopic": "548451887/stream",
            "Status": "Streaming"
        }
    ]
}