GET api/v1/groups/nodepathlist?siteService={siteService}&ancestorNodeId={ancestorNodeId}&descendantNodeId={descendantNodeId}

Retrieves a list of nodes between ancestor and descendant

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Group Service (GRP)	string	Required
ancestorNodeId	Ancestor's node ID for node path	string	Required
descendantNodeId	Descendant's node ID for node path	string	Required

Body Parameters

None

Response Information

Resource Description

Name	Description	Type	Additional information
nodePaths	List of node paths	Collection of NodePathDTO	None

Response Formats

application/json, text/json

Sample:

{
  "nodePaths": [
    {
      "nodePath": [
        {
          "id": 1,
          "type": "Nav",
          "category": "RootGroup",
          "description": "Navigation Hierarchy"
        },
        {
          "id": 5,
          "type": "StandardGroup",
          "category": "SubGroup",
          "description": "San Antonio"
        },
        {
          "id": 59,
          "type": "Facility",
          "category": "Leaf",
          "description": "Calvin Tank Battery"
        }
      ]
    },
    {
      "nodePath": [
        {
          "id": 1,
          "type": "Nav",
          "category": "RootGroup",
          "description": "Navigation Hierarchy"
        },
        {
          "id": 15,
          "type": "StandardGroup",
          "category": "RootGroup",
          "description": "Operator View"
        },
        {
          "id": 433,
          "type": "StandardGroup",
          "category": "SubGroup",
          "description": "LA Production"
        },
        {
          "id": 59,
          "type": "Facility",
          "category": "Leaf",
          "description": "Calvin Tank Battery"
        }
      ]
    }
  ]
}