store#

Autogenerated API

argus_api.lib.datastores.v1.store.store.delete_data_store_entries(dataStore: str, key: str, customerID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Deletes the provided datastore entries from the specified store. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • key (list) – Entries to delete from the specified store

  • customerID (int) – Customer the entries belong to (defaults to the user’s customer)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.store.store.get_entries_from_store(dataStore: str, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, userID: int = None, key: str = None, fromKey: str = None, toKey: str = None, startTimestamp: str = None, endTimestamp: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, countTimeout: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns datastore entries for the specified store, matching the search criteria. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • userID (list) – Restrict search to entries which were last updated by specified users.

  • key (list) – Restrict search to entries with the specified keys.

  • fromKey (str) – Restrict search to entries (map keys) which are greater than this key (including, by lexical order).

  • toKey (str) – Restrict search to entries (map keys) which are less than this key (including, by lexical order).

  • startTimestamp (str) – Restrict search to entries which were last updated after this timestamp (including). Allows unix timestamp (milliseconds), ISO timestamp, or relative time notation. See https://docs.mnemonic.no/x/AQDXAQ

  • endTimestamp (str) – Restrict search to entries which were last updated before this timestamp (including). Allows unix timestamp (milliseconds), ISO timestamp, or relative time notation. See https://docs.mnemonic.no/x/AQDXAQ

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • countTimeout (int) – Max wait in seconds for the count query to run. Set the value to -1 to skip counting (count will be returned -1). Set the value to 0 to execute the count query as long as the service allows, max allowed timeout value is 30 (seconds), default value is 0. (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.store.store.get_entries_from_store_simplified(dataStore: str, customerID: int = None, key: str = None, limit: int = 25, offset: int = None, includeDeleted: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns datastore entries for the specified store, matching query parameters. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • customerID (list) – Limit search to entries belonging to the specified customers

  • key (list) – Limit search to the specified entry keys

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted/expired entries

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.store.store.get_single_entry(dataStore: str, key: str, customerID: int = None, includeDeleted: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns the specified datastore entry for the specified store, or null if it does not exist (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • key (str) – Key to identify entry

  • customerID (int) – Customer the entry belongs to (defaults to the user’s customer)

  • includeDeleted (bool) – Return deleted/expired entry

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.store.store.put_data_store_entries(dataStore: str, customerID: int = None, entries: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Adds or updates the provided datastore entries for the specified store. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • customerID (int) – Entries will be bound to the provided customer. If not set, defaults to bind to the current user’s customer (or none, if the datastore is global).

  • entries (list) – Entries to add/update. If an entry for a given customer and key already exists the entry will be updated. Otherwise, a new entry will be added.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.store.store.put_single_data_store_entry(dataStore: str, key: str, customerID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : put_single_data_store_entry is an alias for put_single_data_store_list_entry. Exists only for backward compatibility - do not use - use put_single_data_store_list_entry instead.

argus_api.lib.datastores.v1.store.store.put_single_data_store_entry_1(dataStore: str, key: str, value: str, customerID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : put_single_data_store_entry_1 is an alias for put_single_data_store_map_entry. Exists only for backward compatibility - do not use - use put_single_data_store_map_entry instead.

argus_api.lib.datastores.v1.store.store.put_single_data_store_list_entry(dataStore: str, key: str, customerID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Adds the provided datastore entry to the specified store. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • key (str) – Entry to add to the specified store

  • customerID (int) – Customer the entry belongs to (defaults to the user’s customer)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.store.store.put_single_data_store_map_entry(dataStore: str, key: str, value: str, customerID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Updates the provided datastore entry for the specified store. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • key (str) – Key to identify entry

  • value (str) – Value to set for the specified entry

  • customerID (int) – Customer the entry belongs to (defaults to the user’s customer)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON