Gemma.WebApi

<back to all web services

ProvisioningRequest

The following routes are available for this service:
GET/provisioning/{Id}Gets the provisioning details by ID
ProvisioningRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe unique identifier of the provisioning
ProvisioningResponse Parameters:
NameParameterData TypeRequiredDescription
ProvisioningformProvisioningNoThe provisioning details
ResponseStatusformResponseStatusNoThe response status
Provisioning Parameters:
NameParameterData TypeRequiredDescription
PlantsformList<ProvisioningPlant>No
IdentifiableEntityBase Parameters:
NameParameterData TypeRequiredDescription
IdformGuidYesUnique identifier for the entity
NameformstringYesThe name of the entity
DescriptionformstringNoA brief description of the entity
LocationformstringNoThe location associated with the entity
CodeformstringNoA unique code for the entity
SerialformstringNoThe serial number of the entity
NotesformstringNoAdditional notes or comments about the entity
TagsformIEnumerable<string>NoA collection of tags associated with the entity
IsDeletedformboolNoIndicates whether the entity is marked as deleted
CreatedUtcformDateTimeYesThe UTC timestamp when the entity was created
ModifiedUtcformDateTimeYesThe UTC timestamp when the entity was last modified
ProvisioningPlant Parameters:
NameParameterData TypeRequiredDescription
ProvisioningIdformGuidNo
GatewaysformList<ProvisioningGateway>No
FieldDevicesformList<ProvisioningFieldDevice>No
ModemsformList<ProvisioningModem>No
LanDefaultGatewayformstringNoDefault gateway for the LAN
LanSubnetformstringNoSubnet mask for the LAN
LanDnsformarrayNoDNS servers for the LAN
LanPublicAddressOrUrlformstringNoPublic address or URL for the LAN
ProvisioningGateway Parameters:
NameParameterData TypeRequiredDescription
PlantIdformGuidNo
FieldDevicesformList<ProvisioningFieldDevice>No
RestConfigurationsformList<ProvisioningGatewayRestConfiguration>No
MqttConfigurationsformList<ProvisioningGatewayMqttConfiguration>No
ExtendedPanIdformstringNo
PanIdformstringNo
RadioChannelformstringNo
RadioProtocolformstringNo
MacAddressformstringNo
ResetTimeformstringNo
ReliableModeformstringNo
GatewaySoftwareformstringNo
CoordinatorFirmwareformstringNo
HsycoIdformstringNo
MicroSdImageformstringNo
NetworkDhcpEnabledformboolNo
NetworkIpAddressformstringNo
NetworkSubnetMaskformstringNo
NetworkDefaultGatewayformstringNo
NetworkDns1formstringNo
NetworkDns2formstringNo
NetworkTcpReceivePortformintNo
NetworkTcpListenPortForXmformintNo
NetworkTcpModbusPortformintNo
NetworkSshPortformintNo
NetworkHsycoPortformintNo
NetworkHttpsPortformintNo
NetworkTelnetPortformintNo
NetworkWififormstringNo
NetworkWifiSubnetformstringNo
NetworkLoginformstringNo
NetworkPasswordformstringNo
ProvisioningFieldDevice Parameters:
NameParameterData TypeRequiredDescription
PlantIdformGuid?No
GatewayIdformGuid?No
LocationDetailformstringNo
FloorformstringNo
PlantReferenceformstringNo
GroupformstringNo
StageformstringNo
PlantUserNameformstringNo
QKerberosformstringNo
AutomaticDeviceTypeformstringNo
ManagerProfileUsedformstringNo
ModbusSlaveAddressformstringNo
BaudRateformstringNo
ModbusPublicationformstringNo
ReceptionTimeoutformstringNo
SamplingTimeMinformstringNo
TaSizeformstringNo
FirmwareVersionformstringNo
AutomaticPublicationformstringNo
DirectformstringNo
ConfigurationformstringNo
OffsetformstringNo
MeasurementValidationformstringNo
ServerConfigProfileUsedformstringNo
ServerConfigIdformstringNo
SlaveJsonformstringNo
JsonFieldDescriptionformstringNo
JsonType2DescriptionformstringNo
Unnamed30formstringNo
ThlScriptformstringNo
RelayScriptformstringNo
ProvisioningGatewayRestConfiguration Parameters:
NameParameterData TypeRequiredDescription
HostNameformstringNoHost name for the REST configuration
ServerAddressformstringNoServer address for the REST configuration
UsernameformstringNoUsername for authentication
PasswordformstringNoPassword for authentication
TransmissionConfiguration Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GatewayIdformintNo
ProtocolTypeformstringNoType of the transmission protocol (e.g., REST, MQTT)
ProvisioningGatewayMqttConfiguration Parameters:
NameParameterData TypeRequiredDescription
MqttHostNameformstringNoMQTT host name
HostBrokerformstringNoHost broker for MQTT
BrokerPortformintegerNoPort of the MQTT broker
RouterIpAddressformstringNoRouter IP address for MQTT
TopicformstringNoTopic for MQTT messages
UsernameformstringNoUsername for authentication
PasswordformstringNoPassword for authentication
ProvisioningModem Parameters:
NameParameterData TypeRequiredDescription
PlantIdformGuidNo
SimsformList<ProvisioningSim>No
HasExternalGsmAntennaformbooleanNoIndicates the presence of an external GSM antenna
IpAddressformstringNoIP address of the modem
SubnetformstringNoSubnet mask of the modem
DnsformarrayNoDNS servers for the modem
ActiveRedirectsformbooleanNoIndicates whether redirects are active
ProvisioningSim Parameters:
NameParameterData TypeRequiredDescription
ModemIdformGuidNo
ApnTypeformstringNoType of APN used by the SIM
IccidformstringNoIntegrated Circuit Card Identifier (ICCID) of the SIM
IsPinActiveformbooleanNoIndicates whether the SIM PIN is active
StaticIpformstringNoStatic IP address assigned to the SIM, if present
VpnTypeformstringNoType of VPN used by the SIM

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}