PUT api/DataNodes/CustomCommand

Sends any number of Custom Commands through to specified DataNodes, 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 DataNodes

Name	Description	Type	Additional information
Entries	Array of Custom Command entries for sending to DataNodes	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"
      ]
    },
    {
      "IDs": [
        1,
        2
      ],
      "PIN": "sample string 1",
      "Commands": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<APIStructs.CustomCommandInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <Entries>
    <APIStructs.CustomCommandEntry>
      <Commands xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Commands>
      <IDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </IDs>
      <PIN>sample string 1</PIN>
    </APIStructs.CustomCommandEntry>
    <APIStructs.CustomCommandEntry>
      <Commands xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Commands>
      <IDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </IDs>
      <PIN>sample string 1</PIN>
    </APIStructs.CustomCommandEntry>
  </Entries>
</APIStructs.CustomCommandInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

object with information related to the commands sent and handled

GetCustomCommandResponse

Name	Description	Type	Additional information
Output	Array of DataNode 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": "2025-11-09T21:24:42.3855395+10:00",
    "BuildDateUTC": "2025-11-09T21:24:42.3855395+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.