GET api/Networks/{id}/Queue?loadQueuedItems={loadQueuedItems}

Gets the Queue Information for the specified Network

Request Information

URI Parameters

Name	Description	Type	Additional information
id	ID of the Network to retrieve the Queue Information for	integer	Required
loadQueuedItems	Whether or not to load in the information for all queued items	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Network Queue information

GetNetworkQueueResponse

Name	Description	Type	Additional information
Queue	Queue for the Network	Queue	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Queue": {
    "GatewayID": 1,
    "Count": 2,
    "CurrentItem": {
      "Position": 1,
      "CommandID": "7b265d7e-dbe0-447c-a16c-78fe64baf5d3",
      "CommandIntID": 3,
      "DataNodeID": 4,
      "DataNodeName": "sample string 5",
      "Custom": true,
      "CustomString": "sample string 7",
      "Command": "sample string 8",
      "PostCommandString": "sample string 9",
      "DateAdded": "2025-11-09T21:30:19.7312643+10:00",
      "Age": "00:00:00.1234567",
      "Standalone": true,
      "Priority": true,
      "Owner": {
        "ID": 1,
        "Type": 10,
        "TypeName": "Device",
        "Valid": true
      },
      "Target": {
        "ID": 1,
        "Type": 10,
        "TypeName": "Device",
        "Valid": true
      },
      "User": {
        "ID": 1,
        "UserName": "sample string 2",
        "Role": 0,
        "RoleName": "Monitor"
      },
      "Attempts": 14
    },
    "QueuedItems": [
      {
        "Position": 1,
        "CommandID": "7b265d7e-dbe0-447c-a16c-78fe64baf5d3",
        "CommandIntID": 3,
        "DataNodeID": 4,
        "DataNodeName": "sample string 5",
        "Custom": true,
        "CustomString": "sample string 7",
        "Command": "sample string 8",
        "PostCommandString": "sample string 9",
        "DateAdded": "2025-11-09T21:30:19.7312643+10:00",
        "Age": "00:00:00.1234567",
        "Standalone": true,
        "Priority": true,
        "Owner": {
          "ID": 1,
          "Type": 10,
          "TypeName": "Device",
          "Valid": true
        },
        "Target": {
          "ID": 1,
          "Type": 10,
          "TypeName": "Device",
          "Valid": true
        },
        "User": {
          "ID": 1,
          "UserName": "sample string 2",
          "Role": 0,
          "RoleName": "Monitor"
        },
        "Attempts": 14
      },
      {
        "Position": 1,
        "CommandID": "7b265d7e-dbe0-447c-a16c-78fe64baf5d3",
        "CommandIntID": 3,
        "DataNodeID": 4,
        "DataNodeName": "sample string 5",
        "Custom": true,
        "CustomString": "sample string 7",
        "Command": "sample string 8",
        "PostCommandString": "sample string 9",
        "DateAdded": "2025-11-09T21:30:19.7312643+10:00",
        "Age": "00:00:00.1234567",
        "Standalone": true,
        "Priority": true,
        "Owner": {
          "ID": 1,
          "Type": 10,
          "TypeName": "Device",
          "Valid": true
        },
        "Target": {
          "ID": 1,
          "Type": 10,
          "TypeName": "Device",
          "Valid": true
        },
        "User": {
          "ID": 1,
          "UserName": "sample string 2",
          "Role": 0,
          "RoleName": "Monitor"
        },
        "Attempts": 14
      }
    ]
  },
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:30:19.7312643+10:00",
    "BuildDateUTC": "2025-11-09T21:30:19.7312643+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}