GET api/v1/groups/metadata?siteService={siteService}

Retrieves group service metadata

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

Body Parameters

None

Response Information

Resource Description

List of attribute definitions for the specified Group service

Name	Description	Type	Additional information
yesNoAttributeDefinitions	List of Yes or No Attribute Definitions	Collection of GroupAttributeDefinitionDTO	None
attributeDefinitions	List of general group Attribute Definitions	Collection of GroupAttributeDefinitionDTO	None
applicationAttributeDefinitions	List of Application Attribute Definitions	Collection of GroupAttributeDefinitionDTO	None

Response Formats

application/json, text/json

Sample:

{
  "yesNoAttributeDefinitions": [],
  "attributeDefinitions": [
    {
      "description": "Facility ID",
      "inUse": true,
      "ordinal": 0,
      "maxLength": 20,
      "isBoolean": false,
      "definition": "%facility_id%"
    },
    {
      "description": "Facility Type",
      "inUse": true,
      "ordinal": 1,
      "maxLength": 20,
      "isBoolean": false,
      "definition": "%facility_type%"
    },
    {
      "description": "Facility Description",
      "inUse": true,
      "ordinal": 3,
      "maxLength": 40,
      "isBoolean": false,
      "definition": "%facility_desc%"
    },
    {
      "description": "Facility Attr0",
      "inUse": true,
      "ordinal": 4,
      "maxLength": 40,
      "isBoolean": false,
      "definition": "%facility_attr0%"
    },
    {
      "description": "Facility Attr1",
      "inUse": true,
      "ordinal": 5,
      "maxLength": 40,
      "isBoolean": false,
      "definition": "%facility_attr1%"
    },
    {
      "description": "Facility Info0",
      "inUse": true,
      "ordinal": 6,
      "maxLength": 60,
      "isBoolean": false,
      "definition": "%facility_info0%"
    },
    {
      "description": "Facility Info1",
      "inUse": true,
      "ordinal": 7,
      "maxLength": 60,
      "isBoolean": false,
      "definition": "%facility_info1%"
    }
  ],
  "applicationAttributeDefinitions": [
    {
      "description": "Application 0",
      "inUse": true,
      "ordinal": 0,
      "maxLength": 20,
      "isBoolean": false,
      "definition": ""
    },
    {
      "description": "Application 1",
      "inUse": true,
      "ordinal": 1,
      "maxLength": 20,
      "isBoolean": false,
      "definition": ""
    },
    {
      "description": "Application 2",
      "inUse": true,
      "ordinal": 2,
      "maxLength": 20,
      "isBoolean": false,
      "definition": ""
    },
    {
      "description": "Application 3",
      "inUse": true,
      "ordinal": 3,
      "maxLength": 200,
      "isBoolean": false,
      "definition": ""
    },
    {
      "description": "Application 4",
      "inUse": true,
      "ordinal": 4,
      "maxLength": 200,
      "isBoolean": false,
      "definition": ""
    },
    {
      "description": "Application 5",
      "inUse": true,
      "ordinal": 5,
      "maxLength": 200,
      "isBoolean": false,
      "definition": ""
    }
  ]
}