Gemma.WebApi

ProvisioningRequest

The following routes are available for this service:
GET	/provisioning/{Id}	Gets the provisioning details by ID

**ProvisioningRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	Guid	Yes	The unique identifier of the provisioning

**ProvisioningResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Provisioning	form	Provisioning	No	The provisioning details
ResponseStatus	form	ResponseStatus	No	The response status

**Provisioning** Parameters:
Name	Parameter	Data Type	Required	Description
Plants	form	List<ProvisioningPlant>	No

**IdentifiableEntityBase** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	Yes	Unique identifier for the entity
Name	form	string	Yes	The name of the entity
Description	form	string	No	A brief description of the entity
Location	form	string	No	The location associated with the entity
Code	form	string	No	A unique code for the entity
Serial	form	string	No	The serial number of the entity
Notes	form	string	No	Additional notes or comments about the entity
Tags	form	IEnumerable<string>	No	A collection of tags associated with the entity
IsDeleted	form	bool	No	Indicates whether the entity is marked as deleted
CreatedUtc	form	DateTime	Yes	The UTC timestamp when the entity was created
ModifiedUtc	form	DateTime	Yes	The UTC timestamp when the entity was last modified

**ProvisioningPlant** Parameters:
Name	Parameter	Data Type	Required	Description
ProvisioningId	form	Guid	No
Gateways	form	List<ProvisioningGateway>	No
FieldDevices	form	List<ProvisioningFieldDevice>	No
Modems	form	List<ProvisioningModem>	No
LanDefaultGateway	form	string	No	Default gateway for the LAN
LanSubnet	form	string	No	Subnet mask for the LAN
LanDns	form	array	No	DNS servers for the LAN
LanPublicAddressOrUrl	form	string	No	Public address or URL for the LAN

**ProvisioningGateway** Parameters:
Name	Parameter	Data Type	Required
PlantId	form	Guid	No
FieldDevices	form	List<ProvisioningFieldDevice>	No
RestConfigurations	form	List<ProvisioningGatewayRestConfiguration>	No
MqttConfigurations	form	List<ProvisioningGatewayMqttConfiguration>	No
ExtendedPanId	form	string	No
PanId	form	string	No
RadioChannel	form	string	No
RadioProtocol	form	string	No
MacAddress	form	string	No
ResetTime	form	string	No
ReliableMode	form	string	No
GatewaySoftware	form	string	No
CoordinatorFirmware	form	string	No
HsycoId	form	string	No
MicroSdImage	form	string	No
NetworkDhcpEnabled	form	bool	No
NetworkIpAddress	form	string	No
NetworkSubnetMask	form	string	No
NetworkDefaultGateway	form	string	No
NetworkDns1	form	string	No
NetworkDns2	form	string	No
NetworkTcpReceivePort	form	int	No
NetworkTcpListenPortForXm	form	int	No
NetworkTcpModbusPort	form	int	No
NetworkSshPort	form	int	No
NetworkHsycoPort	form	int	No
NetworkHttpsPort	form	int	No
NetworkTelnetPort	form	int	No
NetworkWifi	form	string	No
NetworkWifiSubnet	form	string	No
NetworkLogin	form	string	No
NetworkPassword	form	string	No

**ProvisioningFieldDevice** Parameters:
Name	Parameter	Data Type	Required
PlantId	form	Guid?	No
GatewayId	form	Guid?	No
LocationDetail	form	string	No
Floor	form	string	No
PlantReference	form	string	No
Group	form	string	No
Stage	form	string	No
PlantUserName	form	string	No
QKerberos	form	string	No
AutomaticDeviceType	form	string	No
ManagerProfileUsed	form	string	No
ModbusSlaveAddress	form	string	No
BaudRate	form	string	No
ModbusPublication	form	string	No
ReceptionTimeout	form	string	No
SamplingTimeMin	form	string	No
TaSize	form	string	No
FirmwareVersion	form	string	No
AutomaticPublication	form	string	No
Direct	form	string	No
Configuration	form	string	No
Offset	form	string	No
MeasurementValidation	form	string	No
ServerConfigProfileUsed	form	string	No
ServerConfigId	form	string	No
SlaveJson	form	string	No
JsonFieldDescription	form	string	No
JsonType2Description	form	string	No
Unnamed30	form	string	No
ThlScript	form	string	No
RelayScript	form	string	No

**ProvisioningGatewayRestConfiguration** Parameters:
Name	Parameter	Data Type	Required	Description
HostName	form	string	No	Host name for the REST configuration
ServerAddress	form	string	No	Server address for the REST configuration
Username	form	string	No	Username for authentication
Password	form	string	No	Password for authentication

**TransmissionConfiguration** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
GatewayId	form	int	No
ProtocolType	form	string	No	Type of the transmission protocol (e.g., REST, MQTT)

**ProvisioningGatewayMqttConfiguration** Parameters:
Name	Parameter	Data Type	Required	Description
MqttHostName	form	string	No	MQTT host name
HostBroker	form	string	No	Host broker for MQTT
BrokerPort	form	integer	No	Port of the MQTT broker
RouterIpAddress	form	string	No	Router IP address for MQTT
Topic	form	string	No	Topic for MQTT messages
Username	form	string	No	Username for authentication
Password	form	string	No	Password for authentication

**ProvisioningModem** Parameters:
Name	Parameter	Data Type	Required	Description
PlantId	form	Guid	No
Sims	form	List<ProvisioningSim>	No
HasExternalGsmAntenna	form	boolean	No	Indicates the presence of an external GSM antenna
IpAddress	form	string	No	IP address of the modem
Subnet	form	string	No	Subnet mask of the modem
Dns	form	array	No	DNS servers for the modem
ActiveRedirects	form	boolean	No	Indicates whether redirects are active

**ProvisioningSim** Parameters:
Name	Parameter	Data Type	Required	Description
ModemId	form	Guid	No
ApnType	form	string	No	Type of APN used by the SIM
Iccid	form	string	No	Integrated Circuit Card Identifier (ICCID) of the SIM
IsPinActive	form	boolean	No	Indicates whether the SIM PIN is active
StaticIp	form	string	No	Static IP address assigned to the SIM, if present
VpnType	form	string	No	Type of VPN used by the SIM

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /provisioning/{Id} HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	provisioning: 
	{
		plants: 
		[
			{
				provisioningId: 00000000000000000000000000000000,
				gateways: 
				[
					{
						plantId: 00000000000000000000000000000000,
						fieldDevices: 
						[
							{
								plantId: 00000000000000000000000000000000,
								gatewayId: 00000000000000000000000000000000,
								locationDetail: String,
								floor: String,
								plantReference: String,
								group: String,
								stage: String,
								plantUserName: String,
								qKerberos: String,
								automaticDeviceType: String,
								managerProfileUsed: String,
								modbusSlaveAddress: String,
								baudRate: String,
								modbusPublication: String,
								receptionTimeout: String,
								samplingTimeMin: String,
								taSize: String,
								firmwareVersion: String,
								automaticPublication: String,
								direct: String,
								configuration: String,
								offset: String,
								measurementValidation: String,
								serverConfigProfileUsed: String,
								serverConfigId: String,
								slaveJson: String,
								jsonFieldDescription: String,
								jsonType2Description: String,
								unnamed30: String,
								thlScript: String,
								relayScript: String,
								id: 00000000000000000000000000000000,
								name: String,
								description: String,
								location: String,
								code: String,
								serial: String,
								notes: String,
								isDeleted: False
							}
						],
						restConfigurations: 
						[
							{
								hostName: String,
								serverAddress: String,
								username: String,
								password: String,
								id: 0,
								gatewayId: 0,
								protocolType: String
							}
						],
						mqttConfigurations: 
						[
							{
								mqttHostName: String,
								hostBroker: String,
								brokerPort: 0,
								routerIpAddress: String,
								topic: String,
								username: String,
								password: String,
								id: 0,
								gatewayId: 0,
								protocolType: String
							}
						],
						extendedPanId: String,
						panId: String,
						radioChannel: String,
						radioProtocol: String,
						macAddress: String,
						resetTime: String,
						reliableMode: String,
						gatewaySoftware: String,
						coordinatorFirmware: String,
						hsycoId: String,
						microSdImage: String,
						networkDhcpEnabled: False,
						networkIpAddress: String,
						networkSubnetMask: String,
						networkDefaultGateway: String,
						networkDns1: String,
						networkDns2: String,
						networkTcpReceivePort: 0,
						networkTcpListenPortForXm: 0,
						networkTcpModbusPort: 0,
						networkSshPort: 0,
						networkHsycoPort: 0,
						networkHttpsPort: 0,
						networkTelnetPort: 0,
						networkWifi: String,
						networkWifiSubnet: String,
						networkLogin: String,
						networkPassword: String,
						id: 00000000000000000000000000000000,
						name: String,
						description: String,
						location: String,
						code: String,
						serial: String,
						notes: String,
						isDeleted: False
					}
				],
				fieldDevices: 
				[
					{
						plantId: 00000000000000000000000000000000,
						gatewayId: 00000000000000000000000000000000,
						locationDetail: String,
						floor: String,
						plantReference: String,
						group: String,
						stage: String,
						plantUserName: String,
						qKerberos: String,
						automaticDeviceType: String,
						managerProfileUsed: String,
						modbusSlaveAddress: String,
						baudRate: String,
						modbusPublication: String,
						receptionTimeout: String,
						samplingTimeMin: String,
						taSize: String,
						firmwareVersion: String,
						automaticPublication: String,
						direct: String,
						configuration: String,
						offset: String,
						measurementValidation: String,
						serverConfigProfileUsed: String,
						serverConfigId: String,
						slaveJson: String,
						jsonFieldDescription: String,
						jsonType2Description: String,
						unnamed30: String,
						thlScript: String,
						relayScript: String,
						id: 00000000000000000000000000000000,
						name: String,
						description: String,
						location: String,
						code: String,
						serial: String,
						notes: String,
						isDeleted: False
					}
				],
				modems: 
				[
					{
						plantId: 00000000000000000000000000000000,
						sims: 
						[
							{
								modemId: 00000000000000000000000000000000,
								apnType: String,
								iccid: String,
								isPinActive: False,
								staticIp: String,
								vpnType: String,
								id: 00000000000000000000000000000000,
								name: String,
								description: String,
								location: String,
								code: String,
								serial: String,
								notes: String,
								isDeleted: False
							}
						],
						hasExternalGsmAntenna: False,
						ipAddress: String,
						subnet: String,
						dns: 
						[
							String
						],
						activeRedirects: False,
						id: 00000000000000000000000000000000,
						name: String,
						description: String,
						location: String,
						code: String,
						serial: String,
						notes: String,
						isDeleted: False
					}
				],
				lanDefaultGateway: String,
				lanSubnet: String,
				lanDns: 
				[
					String
				],
				lanPublicAddressOrUrl: String,
				id: 00000000000000000000000000000000,
				name: String,
				description: String,
				location: String,
				code: String,
				serial: String,
				notes: String,
				isDeleted: False
			}
		],
		id: 00000000000000000000000000000000,
		name: String,
		description: String,
		location: String,
		code: String,
		serial: String,
		notes: String,
		isDeleted: False
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}