Module snipeit.Maintenances
Source code
import ssl
try:
_create_unverified_https_context = ssl._create_unverified_context
except AttributeError:
# Legacy Python that doesn't verify HTTPS certificates by default
pass
else:
# Handle target environment that doesn't support HTTPS verification
ssl._create_default_https_context = _create_unverified_https_context
import requests
try:
requests.packages.urllib3.disable_warnings()
except AttributeError:
pass
else:
requests.packages.urllib3.disable_warnings()
try:
from .packages.urllib3.exceptions import ResponseError
except:
pass
import json
class Maintenances(object):
def __init__(self):
"""Class to access maintenances API.
"""
pass
def get(self, server, token, limit=None, order='asc', offset=None):
"""Get list of maintenances
Arguments:
server {string} -- Server URI
token {string} -- Token value to be used for accessing the API
Keyword Arguments:
limit {string} -- Limit the number of data returned by the server (default: {50})
Returns:
string -- List of maintenances in JSON format.
"""
if limit is not None:
self.uri = '/api/v1/maintenances?limit={0}'.format(str(limit))
if offset is not None:
self.uri = self.uri + '&offset={0}'.format(str(offset))
else:
self.uri = '/api/v1/maintenances'
if offset is not None:
self.uri = self.uri + '?offset={0}'.format(str(offset))
self.server = server + self.uri
headers = {'Authorization': 'Bearer {0}'.format(token)}
results = requests.get(self.server, headers=headers)
return results.content
#return json.dumps(results.json(),indent=4, separators=(',', ':'))
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
"""Get list of maintenances based on search keyword
Arguments:
server {string} -- Server URI
token {string} -- Token value to be used for accessing the API
order {string} -- Display order of data (asc / desc default:{asc})
Keyword Arguments:
limit {string} -- Limit the number of data returned by the server (default: {50})
Returns:
string -- List of maintenances in JSON format.
"""
if keyword is None:
keyword = ""
if limit is not None:
self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit),order)
else:
self.uri = '/api/v1/maintenances?order={0}'.format(order)
if offset is not None:
self.uri = self.uri + '&offset={0}'.format(str(offset))
self.server = server + self.uri + '&search={0}'.format(keyword)
headers = {'Authorization': 'Bearer {0}'.format(token)}
results = requests.get(self.server, headers=headers)
return results.content
def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None):
"""Get maintenances information by asset ID
Arguments:
server {string} -- Server URI
token {string} -- Token value to be used for accessing the API
order {string} -- Display order of data (asc / desc default:{asc})
assetID {string} -- Asset ID to be find
Keyword Arguments:
limit {string} -- Limit the number of data returned by the server (default: {50})
Returns:
string -- List of maintenances in JSON format.
"""
if limit is not None:
self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit), order)
else:
self.uri = '/api/v1/maintenances?order={0}'.format(order)
if offset is not None:
self.uri = self.uri + '&offset={0}'.format(str(offset))
self.server = server + self.uri + '&asset_id={0}'.format(assetID)
headers = {'Authorization': 'Bearer {0}'.format(token)}
results = requests.get(self.server, headers=headers)
return results.content
#return json.dumps(results.json(),indent=4, separators=(',', ':'))
def create(self, server, token, payload):
"""Create new maintenances data.
Arguments:
server {string} -- Server URI
token {string} -- Token value to be used for accessing the API
payload {string} -- Input parameters
Returns:
string -- server response in JSON format
"""
self.uri = '/api/v1/maintenances'
self.server = server + self.uri
headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
results = requests.post(self.server, headers=headers, data=payload)
return json.dumps(results.json(),indent=4, separators=(',', ':'))
Classes
class Maintenances
-
Class to access maintenances API.
Source code
class Maintenances(object): def __init__(self): """Class to access maintenances API. """ pass def get(self, server, token, limit=None, order='asc', offset=None): """Get list of maintenances Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) Returns: string -- List of maintenances in JSON format. """ if limit is not None: self.uri = '/api/v1/maintenances?limit={0}'.format(str(limit)) if offset is not None: self.uri = self.uri + '&offset={0}'.format(str(offset)) else: self.uri = '/api/v1/maintenances' if offset is not None: self.uri = self.uri + '?offset={0}'.format(str(offset)) self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content #return json.dumps(results.json(),indent=4, separators=(',', ':')) def search(self, server, token, limit=None, order='asc', keyword=None, offset=None): """Get list of maintenances based on search keyword Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API order {string} -- Display order of data (asc / desc default:{asc}) Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) Returns: string -- List of maintenances in JSON format. """ if keyword is None: keyword = "" if limit is not None: self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit),order) else: self.uri = '/api/v1/maintenances?order={0}'.format(order) if offset is not None: self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&search={0}'.format(keyword) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None): """Get maintenances information by asset ID Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API order {string} -- Display order of data (asc / desc default:{asc}) assetID {string} -- Asset ID to be find Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) Returns: string -- List of maintenances in JSON format. """ if limit is not None: self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit), order) else: self.uri = '/api/v1/maintenances?order={0}'.format(order) if offset is not None: self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&asset_id={0}'.format(assetID) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content #return json.dumps(results.json(),indent=4, separators=(',', ':')) def create(self, server, token, payload): """Create new maintenances data. Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API payload {string} -- Input parameters Returns: string -- server response in JSON format """ self.uri = '/api/v1/maintenances' self.server = server + self.uri headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} results = requests.post(self.server, headers=headers, data=payload) return json.dumps(results.json(),indent=4, separators=(',', ':'))
Methods
def create(self, server, token, payload)
-
Create new maintenances data.
Arguments
server {string} – Server URI token {string} – Token value to be used for accessing the API payload {string} – Input parameters
Returns
string
–server
response
in
JSON
format
Source code
def create(self, server, token, payload): """Create new maintenances data. Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API payload {string} -- Input parameters Returns: string -- server response in JSON format """ self.uri = '/api/v1/maintenances' self.server = server + self.uri headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} results = requests.post(self.server, headers=headers, data=payload) return json.dumps(results.json(),indent=4, separators=(',', ':'))
def get(self, server, token, limit=None, order='asc', offset=None)
-
Get list of maintenances
Arguments
server {string} – Server URI token {string} – Token value to be used for accessing the API Keyword Arguments: limit {string} – Limit the number of data returned by the server (default: {50})
Returns
string – List of maintenances in JSON format.
Source code
def get(self, server, token, limit=None, order='asc', offset=None): """Get list of maintenances Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) Returns: string -- List of maintenances in JSON format. """ if limit is not None: self.uri = '/api/v1/maintenances?limit={0}'.format(str(limit)) if offset is not None: self.uri = self.uri + '&offset={0}'.format(str(offset)) else: self.uri = '/api/v1/maintenances' if offset is not None: self.uri = self.uri + '?offset={0}'.format(str(offset)) self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content
def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None)
-
Get maintenances information by asset ID
Arguments
server {string} – Server URI token {string} – Token value to be used for accessing the API order {string} – Display order of data (asc / desc default:{asc}) assetID {string} – Asset ID to be find Keyword Arguments: limit {string} – Limit the number of data returned by the server (default: {50})
Returns
string – List of maintenances in JSON format.
Source code
def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None): """Get maintenances information by asset ID Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API order {string} -- Display order of data (asc / desc default:{asc}) assetID {string} -- Asset ID to be find Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) Returns: string -- List of maintenances in JSON format. """ if limit is not None: self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit), order) else: self.uri = '/api/v1/maintenances?order={0}'.format(order) if offset is not None: self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&asset_id={0}'.format(assetID) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None)
-
Get list of maintenances based on search keyword
Arguments
server {string} – Server URI token {string} – Token value to be used for accessing the API order {string} – Display order of data (asc / desc default:{asc}) Keyword Arguments: limit {string} – Limit the number of data returned by the server (default: {50})
Returns
string – List of maintenances in JSON format.
Source code
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None): """Get list of maintenances based on search keyword Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API order {string} -- Display order of data (asc / desc default:{asc}) Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) Returns: string -- List of maintenances in JSON format. """ if keyword is None: keyword = "" if limit is not None: self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit),order) else: self.uri = '/api/v1/maintenances?order={0}'.format(order) if offset is not None: self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&search={0}'.format(keyword) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content