PUT api/Networks/CustomCommand

Sends any number of Custom Commands through to the specified Networks, sending to every valid DataNode on them, depending on the input

Request Information

URI Parameters

None.

Body Parameters

Input containing all the information required for sending any number of commands to any number of Networks and their DataNodes

CustomCommandInput
NameDescriptionTypeAdditional information
Entries

Array of Custom Command entries for sending to specified recipients

Collection of CustomCommandEntry

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "Entries": [
    {
      "IDs": [
        1,
        2
      ],
      "PIN": "sample string 1",
      "Commands": [
        "sample string 1",
        "sample string 2"
      ],
      "RespectPolling": true
    },
    {
      "IDs": [
        1,
        2
      ],
      "PIN": "sample string 1",
      "Commands": [
        "sample string 1",
        "sample string 2"
      ],
      "RespectPolling": true
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomCommandInput'.

Response Information

Resource Description

object with information related to the commands sent and handled

GetCustomCommandResponse
NameDescriptionTypeAdditional information
Output

Array of Custom Command Responses

CustomCommandOutput

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:
{
  "Output": null,
  "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": "2026-01-09T23:44:37.3844663+10:00",
    "BuildDateUTC": "2026-01-09T23:44:37.3844663+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}