POST api/v1/measurement/fmsCommandWithTimeFormat?siteService={siteService}

Sends a command to the FMS service, and specifies the date/time format.

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the FMS Service	string	Required

Body Parameters

The request to send command to FMS service.

Name	Description	Type	Additional information
nodeName	The name of the group or device to which to send the command.	string	Required
command	The command to execute.	Command	Required
commandPriority	The processing priority of the command.	CommandPriority	Required
loggingLevel	The logging level of the command.	LoggingLevel	Required
parameters	[optional] A semicolon-delimited string of key/value-pair parameters for the command.	string	None
timeFormat	The format of datetime parameters specified in Parameters.	TimeFormat	Required

Request Formats

application/json, text/json

Sample:

{
  "nodeName": "NewDevice",
  "command": "RequestCurrentConfiguration",
  "commandPriority": "Low",
  "loggingLevel": "Low",
  "parameters": null,
  "timeFormat": "DeviceTime"
}

Response Information

Resource Description

Transaction Id

Name	Description	Type	Additional information
transactionId	A numeric token which can be used in conjunction with IsTransactionComplete to determine if the command has completed. A return value of zero indicates that the command failed.	integer	None

Response Formats

application/json, text/json

Sample:

{
  "transactionId": 123456
}