POST api/v1/groups/nodes

Retrieves a list of nodes matching a set of filter criteria

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Group Service (GRP)	string	Required
filterCriteria	List of filter criteria to apply	Collection of GroupFilterCriteriaDTO	Required
ordering	List of criteria to order by	Collection of GroupProperty	None

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.GRP",
  "filterCriteria": [
    {
      "attribute": "Description",
      "value": "North"
    }
  ],
  "ordering": [
    "Description"
  ]
}

Response Information

Resource Description

Name	Description	Type	Additional information
groupNodes	List of group nodes	Collection of GroupHeaderDTO	None

Response Formats

application/json, text/json

Sample:

{
  "groupNodes": [
    {
      "id": 485,
      "type": "StandardGroup",
      "category": "SubGroup",
      "description": "North"
    }
  ]
}