def getOrganizationDetails(self):
"""
Get details about an organization
It does not need any parameter to be passed
In case of failure it throws IoTFCReSTException
"""
if self.__options['org'] is None:
raise ibmiotf.ConfigurationException("Missing required property: org")
else:
url = ApiClient.organizationUrlv2 % (self.__options['org'])
r = requests.get(url, auth=self.credentials)
status = r.status_code
if status == 200:
self.logger.info("Organization retrieved")
return r.json()
elif status == 401:
raise ibmiotf.IoTFCReSTException(401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the api key used does not exist", None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "The organization does not exist", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getAllDevices(self, parameters = None):
"""
Retrieve bulk devices
It accepts accepts a list of devices (List of Dictionary of Devices)
In case of failure it throws IoTFCReSTException
"""
bulkRetrieve = ApiClient.bulkRetrievev2 % (self.__options['org'] )
r = requests.get(bulkRetrieve, auth = self.credentials, params = parameters)
status = r.status_code
print("Status = ", status)
if status == 200:
self.logger.info("Bulk retrieval successful")
print("Bulk retrieval successful")
return r.json()
elif status == 401:
raise ibmiotf.IoTFCReSTException(401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the API key used does not exist", None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "The organization or device type does not exist", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def deleteDiagnosticLog(self, deviceTypeId, deviceId, logId):
"""
Delete Device Diagnostic Logs.
It accepts deviceType (string), deviceId (string) and logId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceDiagnostics = ApiClient.deviceDiagLogsLogIdv2 % (
self.__options['org'], deviceTypeId, deviceId, logId)
r = requests.delete(deviceDiagnostics, auth=self.credentials)
status = r.status_code
if status == 204:
self.logger.info("Diagnostic log successfully cleared")
print("Diagnostic log successfully cleared")
return True
#403 and 404 error code needs to be added in Swagger documentation
elif status == 403:
raise ibmiotf.IoTFCReSTException(
403,
"The authentication method is invalid or the api key used does not exist",
None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Device not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def deleteAllErrorCodes(self, deviceTypeId, deviceId):
"""
Clears the list of error codes for the device. The list is replaced with a single error code of zero.
It accepts deviceType (string) and deviceId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceDiagnostics = ApiClient.deviceDiagErrorCodesv2 % (
self.__options['org'], deviceTypeId, deviceId)
r = requests.delete(deviceDiagnostics, auth=self.credentials)
status = r.status_code
print("Status = ", status)
if status == 204:
self.logger.info("Error codes successfully cleared")
print("Error code were successfully retrieved")
return True
#403 and 404 error code needs to be added in Swagger documentation
elif status == 403:
raise ibmiotf.IoTFCReSTException(
403,
"The authentication method is invalid or the api key used does not exist",
None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Error Code not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getDeviceConnectionLogs(self, deviceTypeId, deviceId):
"""
List connection log events for a device to aid in diagnosing connectivity problems.
The entries record successful connection, unsuccessful connection attempts, intentional disconnection and server-initiated disconnection.
It accepts deviceType (string) and deviceId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceLogs = ApiClient.deviceLogsv2 % (self.__options['org'],
deviceTypeId, deviceId)
r = requests.get(deviceLogs, auth=self.credentials)
status = r.status_code
if status == 200:
self.logger.info(
"Device Connection Logs were successfully obtained")
print("Device Connection Logs were successfully obtained")
return r.json()
elif status == 403:
raise ibmiotf.IoTFCReSTException(
403,
"The authentication method is invalid or the api key used does not exist",
None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Device not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getDeviceManagement(self, deviceTypeId, deviceId):
"""
Retrieve Device Location.
It accepts deviceType (string) and deviceId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceUrl = ApiClient.deviceUrlMgmtv2 % (self.__options['org'],
deviceTypeId, deviceId)
print("DeviceURL = ", deviceUrl)
r = requests.get(deviceUrl, auth=self.credentials)
status = r.status_code
print("Status = ", status)
if status == 200:
self.logger.info(
"Device Management Information was successfully obtained")
print("Device Management Information was successfully obtained")
return r.json()
#This also throws a 403, which has not been documented
elif status == 403:
raise ibmiotf.IoTFCReSTException(
403,
"The authentication method is invalid or the api key used does not exist",
None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Device not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def modifyDeviceLocation(self, deviceTypeId, deviceId, deviceLocation):
"""
Modify Device Location.
It accepts deviceType (string), deviceId (string) and deviceLocation (JSON) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceUrl = ApiClient.deviceUrlLocationv2 % (self.__options['org'],
deviceTypeId, deviceId)
r = requests.put(deviceUrl,
auth=self.credentials,
data=json.dumps(deviceLocation),
headers={'content-type': 'application/json'})
status = r.status_code
if status == 200:
self.logger.info("Device Location was successfully modified")
print("Device Location was successfully modified")
return r.json()
elif status == 404:
raise ibmiotf.IoTFCReSTException(
404, "Device location information not found", None)
elif status == 409:
raise ibmiotf.IoTFCReSTException(
404, "The update could not be completed due to a conflict",
r.json())
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def removeDevice(self, deviceTypeId, deviceId):
"""
Delete an existing device.
It accepts deviceType (string) and deviceId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceUrl = ApiClient.deviceUrlv2 % (self.__options['org'],
deviceTypeId, deviceId)
r = requests.delete(deviceUrl, auth=self.credentials)
status = r.status_code
if status == 204:
self.logger.info("Device was successfully removed")
print("Device was successfully removed")
return True
elif status == 401:
raise ibmiotf.IoTFCReSTException(
401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(
403,
"The authentication method is invalid or the api key used does not exist",
None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def addDiagnosticLog(self, deviceTypeId, deviceId, logs):
"""
Add Device Diagnostic Logs.
It accepts deviceType (string), deviceId (string) and logs (JSON) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceDiagnostics = ApiClient.deviceDiagLogsv2 % (self.__options['org'], deviceTypeId, deviceId)
print("URL = ", deviceDiagnostics, "\tLogs = ", logs)
r = requests.post(deviceDiagnostics, auth=self.credentials, data = json.dumps(logs), headers = {'content-type': 'application/json'} )
status = r.status_code
print("Status = ", status)
if status == 201:
self.logger.info("Diagnostic entry was successfully added")
print("Diagnostic entry was successfully added")
return True
#403 and 404 error code needs to be added in Swagger documentation
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the api key used does not exist", None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Device not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getDeviceType(self, deviceType):
"""
Retrieves an existing device type.
It accepts deviceType (string) as the parameter
In case of failure it throws IoTFCReSTException
"""
deviceTypeUrl = ApiClient.deviceTypeUrlv2 % (self.__options['org'],
deviceType)
r = requests.get(deviceTypeUrl, auth=self.credentials)
status = r.status_code
if status == 200:
self.logger.info("Device type was successfully retrieved")
print("Device type was successfully retrieved")
return r.json()
elif status == 401:
raise ibmiotf.IoTFCReSTException(
401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(
403,
"The authentication method is invalid or the api key used does not exist",
None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404,
"The device type does not exist",
None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def retrieveDevices(self, deviceTypeId, expand = None):
"""
Gets device details.
It accepts deviceType (string) and expand (JSON) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceUrl = ApiClient.devicesUrlv2 % (self.__options['org'], deviceTypeId)
r = requests.get(deviceUrl, auth=self.credentials, params = expand)
status = r.status_code
if status == 200:
self.logger.info("Devices were successfully retrieved")
print("Devices were successfully retrieved")
return r.json()
elif status == 401:
raise ibmiotf.IoTFCReSTException(401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the api key used does not exist", None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "The device does not exist", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getAllDiagnosticLogs(self, deviceTypeId, deviceId):
"""
Retrieves All Device Diagnostic Logs.
It accepts deviceType (string) and deviceId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceDiagnostics = ApiClient.deviceDiagLogsv2 % (self.__options['org'], deviceTypeId, deviceId)
r = requests.get(deviceDiagnostics, auth=self.credentials )
status = r.status_code
if status == 200:
self.logger.info("All Diagnostic logs successfully retrieved")
print("All Diagnostic logs successfully retrieved")
return r.json()
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Device not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getDeviceLocation(self, deviceTypeId, deviceId):
"""
Retrieve Device Location.
It accepts deviceType (string) and deviceId (string) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceUrl = ApiClient.deviceUrlLocationv2 % (self.__options['org'], deviceTypeId, deviceId)
r = requests.get(deviceUrl, auth=self.credentials)
status = r.status_code
if status == 200:
self.logger.info("Device Location was successfully obtained")
print("Device Location was successfully obtained")
return r.json()
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "Device location information not found", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def getAllDeviceTypes(self, queryParameters = None):
"""
Retrieves all existing device types.
It accepts accepts an optional query parameters (Dictionary)
In case of failure it throws IoTFCReSTException
"""
deviceTypeUrl = ApiClient.deviceTypesUrlv2 % (self.__options['org'])
r = requests.get(deviceTypeUrl, auth=self.credentials, params = queryParameters)
status = r.status_code
if status == 200:
self.logger.info("All Device types successfully retrieved")
print("All Device types successfully retrieved")
return r.json()
elif status == 401:
raise ibmiotf.IoTFCReSTException(401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the api key used does not exist", None)
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def addMultipleDevices(self, listOfDevices):
"""
Register multiple new devices, each request can contain a maximum of 512KB.
The response body will contain the generated authentication tokens for all devices.
You must make sure to record these tokens when processing the response.
We are not able to retrieve lost authentication tokens
It accepts accepts a list of devices (List of Dictionary of Devices)
In case of failure it throws IoTFCReSTException
"""
bulkAdd = ApiClient.bulkAddUrlv2 % (self.__options['org'] )
r = requests.post(bulkAdd, auth = self.credentials, data = json.dumps(listOfDevices), headers = {'content-type': 'application/json'})
status = r.status_code
print("Status = ", status)
print("List = ", listOfDevices)
if status == 201:
self.logger.info("Bulk registration successful")
print("Bulk registration successful")
return r.json()
elif status == 202:
raise ibmiotf.IoTFCReSTException(400, "Some devices registered successfully", r.json())
elif status == 400:
raise ibmiotf.IoTFCReSTException(400, "Invalid request (No body, invalid JSON, unexpected key, bad value)", r.json())
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "Maximum number of devices exceeded", r.json())
elif status == 413:
raise ibmiotf.IoTFCReSTException(413, "Request content exceeds 512KB", r.json())
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def updateDevice(self, deviceType, deviceId, metadata, deviceInfo = None, status = None):
"""
Updates a device.
It accepts deviceType (string), deviceId (string), metadata (JSON), deviceInfo (JSON) and status(JSON) as parameters
In case of failure it throws IoTFCReSTException
"""
deviceUrl = ApiClient.deviceUrlv2 % (self.__options['org'], deviceType, deviceId)
payload = {'status' : status, 'deviceInfo' : deviceInfo, 'metadata': metadata}
r = requests.put(deviceUrl, auth=self.credentials, data=json.dumps(payload), headers = {'content-type': 'application/json'})
status = r.status_code
if status == 200:
self.logger.info("Device was successfully modified")
print("Device was successfully modified")
return r.json()
elif status == 401:
raise ibmiotf.IoTFCReSTException(401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the api key used does not exist", None)
elif status == 404:
raise ibmiotf.IoTFCReSTException(404, "The organization, device type or device does not exist", None)
elif status == 409:
raise ibmiotf.IoTFCReSTException(409, "The update could not be completed due to a conflict", r.json())
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def registerDevice(self, deviceTypeId, deviceId, authToken = None, deviceInfo = None, location = None, metadata=None):
"""
Registers a new device.
It accepts deviceType (string), deviceId (string), authToken (string), location (JSON) and metadata (JSON) as parameters
In case of failure it throws IoTFCReSTException
"""
devicesUrl = ApiClient.devicesUrlv2 % (self.__options['org'], deviceTypeId)
payload = {'deviceId' : deviceId, 'authToken' : authToken, 'deviceInfo' : deviceInfo, 'location' : location, 'metadata': metadata}
r = requests.post(devicesUrl, auth=self.credentials, data=json.dumps(payload), headers = {'content-type': 'application/json'})
status = r.status_code
if status == 201:
self.logger.info("Device Instance Created")
print("Device Instance created")
return r.json()
elif status == 400:
raise ibmiotf.IoTFCReSTException(400, "Invalid request (No body, invalid JSON, unexpected key, bad value)", r.json())
elif status == 401:
raise ibmiotf.IoTFCReSTException(401, "The authentication token is empty or invalid", None)
elif status == 403:
raise ibmiotf.IoTFCReSTException(403, "The authentication method is invalid or the api key used does not exist", None)
elif status == 409:
raise ibmiotf.IoTFCReSTException(403, "The device already exists", r.json())
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
def deleteMultipleDevices(self, listOfDevices):
"""
Delete multiple devices, each request can contain a maximum of 512Kb
It accepts accepts a list of devices (List of Dictionary of Devices)
In case of failure it throws IoTFCReSTException
"""
bulkRemove = ApiClient.bulkRemoveUrlv2 % (self.__options['org'] )
r = requests.post(bulkRemove, auth = self.credentials, data = json.dumps(listOfDevices), headers = {'content-type': 'application/json'})
status = r.status_code
if status == 202:
self.logger.info("Some devices deleted successfully")
print("Some devices deleted successfully")
return r.json()
elif status == 400:
raise ibmiotf.IoTFCReSTException(400, "Invalid request (No body, invalid JSON, unexpected key, bad value)", r.json())
elif status == 413:
raise ibmiotf.IoTFCReSTException(413, "Request content exceeds 512KB", r.json())
elif status == 500:
raise ibmiotf.IoTFCReSTException(500, "Unexpected error", None)
else:
raise ibmiotf.IoTFCReSTException(None, "Unexpected error", None)
