GET api/v1/groups/{nodeId}/hierarchy?siteService={siteService}

Retrieves the group node hierarchy for a specified group node

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
nodeId	Group node ID	string	Required
siteService	CygNet site and service (Site.Service) of the Group Service (GRP)	string	Required

Body Parameters

None

Response Information

Resource Description

Hierarchy of group tree nodes for the specified node ID

Name	Description	Type	Additional information
node	Group tree node containing the requested hierarchy	GroupTreeNodeDTO	None

Response Formats

application/json, text/json

Sample:

{
  "node": {
    "id": 44,
    "type": "StandardGroup",
    "category": "SubGroup",
    "description": "Area View",
    "children": [
      {
        "id": 45,
        "type": "StandardGroup",
        "category": "SubGroup",
        "description": "LA Production",
        "children": [
          {
            "id": 46,
            "type": "StandardGroup",
            "category": "SubGroup",
            "description": "LA",
            "children": [
              {
                "id": 47,
                "type": "StandardGroup",
                "category": "SubGroup",
                "description": "Alexandria",
                "children": [
                  {
                    "id": 48,
                    "type": "StandardGroup",
                    "category": "Leaf",
                    "description": "Calvin Central Delivery Point",
                    "children": []
                  },
                  {
                    "id": 49,
                    "type": "StandardGroup",
                    "category": "Leaf",
                    "description": "Calvin Compressor Unit 01",
                    "children": []
                  },
                  {
                    "id": 50,
                    "type": "StandardGroup",
                    "category": "SubGroup",
                    "description": "Calvin Oil Tank 1",
                    "children": []
                  }
                ]
              }
            ]
          },
          {
            "id": 51,
            "type": "StandardGroup",
            "category": "SubGroup",
            "description": "TX",
            "children": [
              {
                "id": 52,
                "type": "StandardGroup",
                "category": "SubGroup",
                "description": "Austin",
                "children": [
                  {
                    "id": 53,
                    "type": "StandardGroup",
                    "category": "Leaf",
                    "description": "Brady Gas Meter",
                    "children": []
                  },
                  {
                    "id": 54,
                    "type": "StandardGroup",
                    "category": "Leaf",
                    "description": "Gentry Gas Meter",
                    "children": []
                  },
                  {
                    "id": 55,
                    "type": "StandardGroup",
                    "category": "Leaf",
                    "description": "Gentry oil Meter",
                    "children": []
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}