GET api/Conditions/Branches/{id}?subLevels={subLevels}

Get a specific ConditionBranch by ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the ConditionBranch to get

integer

Required

subLevels

Number of sublevels to load. Default is all (-1)

integer

Default value is -1

Body Parameters

None.

Response Information

Resource Description

object with ConditionBranch matching the ID, if found

GetConditionBranchResponse
NameDescriptionTypeAdditional information
Branches

Array of ConditionBranches

Collection of ConditionBranchStruct

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:
{
  "Branches": [
    {
      "ID": 2,
      "Name": "sample string 3",
      "DisplayIndex": 4,
      "LogicOperator": 0,
      "SubBranches": [],
      "Leaves": [
        {
          "ID": 2,
          "Name": "sample string 3",
          "DisplayIndex": 1,
          "LinkID": 1,
          "LinkObjectType": 10,
          "LinkObjectTypeName": "Device",
          "LinkObjectName": "sample string 4",
          "LinkValue": 1.0,
          "LinkCondition": 0
        },
        {
          "ID": 2,
          "Name": "sample string 3",
          "DisplayIndex": 1,
          "LinkID": 1,
          "LinkObjectType": 10,
          "LinkObjectTypeName": "Device",
          "LinkObjectName": "sample string 4",
          "LinkValue": 1.0,
          "LinkCondition": 0
        }
      ]
    },
    {
      "ID": 2,
      "Name": "sample string 3",
      "DisplayIndex": 4,
      "LogicOperator": 0,
      "SubBranches": [],
      "Leaves": [
        {
          "ID": 2,
          "Name": "sample string 3",
          "DisplayIndex": 1,
          "LinkID": 1,
          "LinkObjectType": 10,
          "LinkObjectTypeName": "Device",
          "LinkObjectName": "sample string 4",
          "LinkValue": 1.0,
          "LinkCondition": 0
        },
        {
          "ID": 2,
          "Name": "sample string 3",
          "DisplayIndex": 1,
          "LinkID": 1,
          "LinkObjectType": 10,
          "LinkObjectTypeName": "Device",
          "LinkObjectName": "sample string 4",
          "LinkValue": 1.0,
          "LinkCondition": 0
        }
      ]
    }
  ],
  "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:34:45.7869585+10:00",
    "BuildDateUTC": "2025-11-09T21:34:45.7869585+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}