GET api/ControlSystems/{id}

Get a specific Control System by ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the Control System

integer

Required

Body Parameters

None.

Response Information

Resource Description

Single Control System object

GetControlSystemResponse
NameDescriptionTypeAdditional information
ControlSystems

Array of Control Systems

Collection of ControlSystemStruct

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:
{
  "ControlSystems": [
    {
      "ID": 1,
      "ClientName": "sample string 2",
      "LastHandledDt": "2026-10-18T10:27:10.3512041+10:00",
      "ConditionGroups": [
        {
          "Conditions": [
            {
              "Name": "sample string 1",
              "ID": 2
            },
            {
              "Name": "sample string 1",
              "ID": 2
            }
          ],
          "WhenTrue": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "WhenFalse": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "Index": 1,
          "ID": 1
        },
        {
          "Conditions": [
            {
              "Name": "sample string 1",
              "ID": 2
            },
            {
              "Name": "sample string 1",
              "ID": 2
            }
          ],
          "WhenTrue": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "WhenFalse": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "Index": 1,
          "ID": 1
        }
      ],
      "EmergencyStop": {
        "Actions": [
          {
            "TypeName": "SetDevice",
            "TargetTypeName": "Device",
            "Type": 0,
            "TargetID": 1,
            "TargetType": 10,
            "Value": 1.0
          },
          {
            "TypeName": "SetDevice",
            "TargetTypeName": "Device",
            "Type": 0,
            "TargetID": 1,
            "TargetType": 10,
            "Value": 1.0
          }
        ],
        "ID": 1
      },
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Enabled": true,
      "ClientID": 1
    },
    {
      "ID": 1,
      "ClientName": "sample string 2",
      "LastHandledDt": "2026-10-18T10:27:10.3512041+10:00",
      "ConditionGroups": [
        {
          "Conditions": [
            {
              "Name": "sample string 1",
              "ID": 2
            },
            {
              "Name": "sample string 1",
              "ID": 2
            }
          ],
          "WhenTrue": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "WhenFalse": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "Index": 1,
          "ID": 1
        },
        {
          "Conditions": [
            {
              "Name": "sample string 1",
              "ID": 2
            },
            {
              "Name": "sample string 1",
              "ID": 2
            }
          ],
          "WhenTrue": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "WhenFalse": {
            "ParentID": 1,
            "ParentType": null,
            "ID": 1
          },
          "Index": 1,
          "ID": 1
        }
      ],
      "EmergencyStop": {
        "Actions": [
          {
            "TypeName": "SetDevice",
            "TargetTypeName": "Device",
            "Type": 0,
            "TargetID": 1,
            "TargetType": 10,
            "Value": 1.0
          },
          {
            "TypeName": "SetDevice",
            "TargetTypeName": "Device",
            "Type": 0,
            "TargetID": 1,
            "TargetType": 10,
            "Value": 1.0
          }
        ],
        "ID": 1
      },
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Enabled": true,
      "ClientID": 1
    }
  ],
  "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-10-18T10:27:10.3512041+10:00",
    "BuildDateUTC": "2026-10-18T10:27:10.3512041+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}