PUT api/v1/measurement/updateGeneralGroup/{groupName}?siteService={siteService}

Updates an existing general group in the connected FMS service.

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
groupName	The name of the general group to update	string	Required
siteService	CygNet site and service (Site.Service) of the FMS Service	string	Required

Body Parameters

The request containing the properties of the general group to update.

Name	Description	Type	Additional information
beginActiveDate	(Optional) Begin Active Date	date	None
endActiveDate	(Optional) End Active Date	date	None
name	(Optional) Name of group	string	None
description	Group Description	string	None
siteService	Group site service	string	None
facilityId	Associated Facility ID of the group	string	None
sortPriority	(Optional) Sort priority of the group	integer	None
securityApp	(Optional) Security application of the group	string	None
categoryName	(Optional) Category name for the group.	string	None
generalUniqueType	(Optional) Indicates the group’s unique type	GeneralUniqueType	None

Request Formats

application/json, text/json

Sample:

{
  "beginActiveDate": "2000-01-01T00:00:00",
  "endActiveDate": "3000-12-31T00:00:00",
  "name": "GeneralGroupNode",
  "description": "Test Group",
  "siteService": "CYGNET.UIS",
  "facilityId": "ANTIER_GM",
  "sortPriority": 0,
  "securityApp": "",
  "categoryName": "Job",
  "generalUniqueType": "None"
}

Response Information

Resource Description

Name	Description	Type	Additional information
nodeId	Node ID of the group	integer	None
fmsGeneralGroup	Fms general group details	FmsGeneralGroupDTO	None

Response Formats

application/json, text/json

Sample:

{
  "nodeId": 2,
  "fmsGeneralGroup": {
    "beginActiveDate": "2000-01-01T00:00:00",
    "endActiveDate": "3000-12-31T00:00:00",
    "name": "GeneralGroup",
    "description": "New General Group",
    "siteService": "",
    "facilityId": "",
    "sortPriority": 0,
    "securityApp": "",
    "categoryName": "Job",
    "generalUniqueType": "None"
  }
}