"""Autogenerated API"""
import requests
from argus_cli.plugin import register_command
[docs]@register_command(extending=('datastores','v1','store',''))
def get_entries_from_store_simplified(dataStore: str, customerID: list = None, key: list = None, offset: int = 0, limit: int = 25, includeDeleted: bool = 'True',json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Returns datastore entries for the specified store, matching query parameters. (PUBLIC)
:param str dataStore: Store name
:param list customerID: Limit search to entries for the specified customers
:param list key: Limit search to the specified entry keys
:param int offset: Skip a number of results
:param int limit: Maximum number of returned results
:param bool includeDeleted: Include deleted/expired keys
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises StoreNotFoundException: on 404
:returns: {"offset": 567, "limit": 768, "responseCode": 200, "count": 811, "data": [{"dataStoreName": "Rock federal month boy.", "lastUpdatedTimestamp": 1232287388, "lastUpdatedByUser": {"id": 110, "customerID": 389, "userName": "michael59", "name": "Michelle Hanson"}, "key": "Rise range quickly.", "value": "Campaign explain only visit thought past region cell.", "flags": ["DELETED"]}], "metaData": {"additionalProperties": {}}, "messages": [{"message": "Suggest economic production but.", "messageTemplate": "Physical six specific its.", "field": "Night court into name shake other before.", "parameter": {}, "timestamp": 333892548}], "currentPage": 515, "size": 872}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/datastores/v1/store/{dataStore}".format(dataStore=dataStore)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if offset:
body.update({"offset": offset})
if limit:
body.update({"limit": limit})
if includeDeleted:
body.update({"includeDeleted": includeDeleted})
if customerID:
body.update({"customerID": customerID})
if key:
body.update({"key": key})
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('datastores','v1','store',''))
def put_data_store_entries(dataStore: str, customerID: int = None, entries: list = None,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Updates the provided datastore entries for the specified store. (PUBLIC)
:param str dataStore: Store name
:param int customerID: ID of customer to bind data to. If not set, default is to bind to the current users customer (or none, if datastore is global)
:param list entries: Entries to add
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises StoreNotFoundException: on 404
:returns: {"offset": 706, "limit": 386, "responseCode": 200, "count": 578, "data": [{"dataStoreName": "Fire important indicate box population.", "lastUpdatedTimestamp": 145678242, "lastUpdatedByUser": {"id": 914, "customerID": 433, "userName": "zmitchell", "name": "Claire Blake"}, "key": "Ask wind report thousand management order teacher.", "value": "True hospital PM step who.", "flags": ["DELETED"]}], "metaData": {"additionalProperties": {}}, "messages": [{"message": "Doctor detail down fire.", "messageTemplate": "Today short medical control network.", "field": "Try line consider from fight past read.", "parameter": {}, "timestamp": 56341724}], "currentPage": 77, "size": 252}
"""
from requests import put
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/datastores/v1/store/{dataStore}".format(dataStore=dataStore)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if customerID:
body.update({"customerID": customerID})
if entries:
body.update({"entries": entries})
response = put(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('datastores','v1','store',''))
def delete_data_store_entries(dataStore: str, key: list = None, customerID: int = None,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Deletes the specified datastore entries for the specified store. (PUBLIC)
:param str dataStore: Store name
:param list key: Datastore keys to delete
:param int customerID: Specify datastore to delete entries from (default is users customer)
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises StoreNotFoundException: on 404
:returns: {"offset": 702, "limit": 141, "responseCode": 200, "count": 682, "data": [{"dataStoreName": "Seven guess forget including.", "lastUpdatedTimestamp": 757778835, "lastUpdatedByUser": {"id": 618, "customerID": 682, "userName": "jsullivan", "name": "Donna Rivera"}, "key": "Pass hour enough.", "value": "Man case statement protect sign.", "flags": ["DELETED"]}], "metaData": {"additionalProperties": {}}, "messages": [{"message": "Cover trouble machine certainly evidence.", "messageTemplate": "Test look center resource fill floor.", "field": "Specific push population coach.", "parameter": {}, "timestamp": 1184963135}], "currentPage": 234, "size": 578}
"""
from requests import delete
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/datastores/v1/store/{dataStore}".format(dataStore=dataStore)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if key:
body.update({"key": key})
if customerID:
body.update({"customerID": customerID})
response = delete(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('datastores','v1','store',''))
def get_entries_from_store(dataStore: str, limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, userID: list = None, key: list = None, fromKey: str = None, toKey: str = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False',json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Returns datastore entries for the specified store, matching the search criteria. (PUBLIC)
:param str dataStore: Store name
:param int limit: Set this value to set max number of results. By default, no restriction on result set size.
:param int offset: Set this value to skip the first (offset) objects. By default, return result from first object.
:param list subCriteria:
:param list customerID: Restrict search to data belonging to specified customers.
:param list userID: Restrict search to entries which was last updated by specified users.
:param list key: Restrict search to the specified key (entries).
:param str fromKey: Restrict search to entries (map keys) which are greater than this key (including, by lexical order).
:param str toKey: Restrict search to entries (map keys) which are less than this key (including, by lexical order).
:param int startTimestamp: Restrict search to entries which are last updated after this timestamp (including).
:param int endTimestamp: Restrict search to entries which are last updated before this timestamp (including).
:param list sortBy: List of properties to sort by (prefix with "-" to sort descending).
:param list includeFlags: Only include objects which have includeFlags set.
:param list excludeFlags: Exclude objects which have excludeFlags set.
:param bool includeDeleted: Set to true to include deleted objects. By default, exclude deleted objects.
:param bool exclude: Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
:param bool required: Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises StoreNotFoundException: on 404
:returns: {"offset": 365, "limit": 236, "responseCode": 200, "count": 348, "data": [{"dataStoreName": "First argue practice action camera computer.", "lastUpdatedTimestamp": 98515055, "lastUpdatedByUser": {"id": 342, "customerID": 744, "userName": "hensonhunter", "name": "Kimberly Johnson"}, "key": "Our husband two mention.", "value": "Get design his there parent.", "flags": ["DELETED"]}], "metaData": {"additionalProperties": {}}, "messages": [{"message": "Million up role include put style professor.", "messageTemplate": "Public news dog little large detail what.", "field": "Tv majority morning hard.", "parameter": {}, "timestamp": 120301603}], "currentPage": 360, "size": 973}
"""
from requests import post
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/datastores/v1/store/{dataStore}/search".format(dataStore=dataStore)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if limit:
body.update({"limit": limit})
if offset:
body.update({"offset": offset})
if includeDeleted:
body.update({"includeDeleted": includeDeleted})
if subCriteria:
body.update({"subCriteria": subCriteria})
if exclude:
body.update({"exclude": exclude})
if required:
body.update({"required": required})
if customerID:
body.update({"customerID": customerID})
if userID:
body.update({"userID": userID})
if key:
body.update({"key": key})
if fromKey:
body.update({"fromKey": fromKey})
if toKey:
body.update({"toKey": toKey})
if startTimestamp:
body.update({"startTimestamp": startTimestamp})
if endTimestamp:
body.update({"endTimestamp": endTimestamp})
if sortBy:
body.update({"sortBy": sortBy})
if includeFlags:
body.update({"includeFlags": includeFlags})
if excludeFlags:
body.update({"excludeFlags": excludeFlags})
response = post(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('datastores','v1','store',''))
def get_single_entry(dataStore: str, key: str, customerID: int = None, includeDeleted: bool = 'True',json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Returns the specified datastore entry for the specified store, or null if it does not exist (PUBLIC)
:param str dataStore: Store name
:param str key: Key to search
:param int customerID: Search specified customer store for this key (default is users customer)
:param bool includeDeleted: Include deleted/expired key
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises StoreNotFoundException: on 404
:returns: {"offset": 729, "limit": 519, "responseCode": 200, "count": 775, "metaData": {"additionalProperties": {}}, "messages": [{"message": "Recent success heavy appear garden business factor.", "messageTemplate": "Site himself near general red.", "field": "Kitchen program international and practice individual.", "parameter": {}, "timestamp": 1069263203}], "currentPage": 838, "size": 710}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/datastores/v1/store/{dataStore}/{key}".format(dataStore=dataStore, key=key)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if includeDeleted:
body.update({"includeDeleted": includeDeleted})
if customerID:
body.update({"customerID": customerID})
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('datastores','v1','store',''))
def put_single_data_store_entry(dataStore: str, key: str, customerID: int = None,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Adds the provided datastore entry for the specified store. To use for lists (key, no value) (PUBLIC)
:param str dataStore: Store name
:param str key: Datastore key to set
:param int customerID: Specify datastore to put entry to (default is users customer)
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises StoreNotFoundException: on 404
:returns: {"offset": 494, "limit": 414, "responseCode": 200, "count": 83, "metaData": {"additionalProperties": {}}, "messages": [{"message": "Produce each production capital performance walk set mother.", "messageTemplate": "Line use food herself white tree resource.", "field": "Defense measure court his management.", "parameter": {}, "timestamp": 1350632079}], "currentPage": 697, "size": 357}
"""
from requests import put
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/datastores/v1/store/{dataStore}/{key}".format(dataStore=dataStore, key=key)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if customerID:
body.update({"customerID": customerID})
response = put(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response