api.datastores.v1.store package

Submodules

api.datastores.v1.store.store module

Autogenerated API

api.datastores.v1.store.store.delete_data_store_entries(dataStore: str, key: list = None, customerID: int = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Deletes the specified datastore entries for the specified store. (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • key (list) – Datastore keys to delete
  • customerID (int) – Specify datastore to delete entries from (default is users customer)
Raises:
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}

api.datastores.v1.store.store.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[source]

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

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • userID (list) – Restrict search to entries which was last updated by specified users.
  • key (list) – Restrict search to the specified key (entries).
  • 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 (int) – Restrict search to entries which are last updated after this timestamp (including).
  • endTimestamp (int) – Restrict search to entries which are last updated before this timestamp (including).
  • 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.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • 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).
Raises:
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}

api.datastores.v1.store.store.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[source]

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

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • customerID (list) – Limit search to entries for the specified customers
  • key (list) – Limit search to the specified entry keys
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • includeDeleted (bool) – Include deleted/expired keys
Raises:
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}

api.datastores.v1.store.store.get_single_entry(dataStore: str, key: str, customerID: int = None, includeDeleted: bool = 'True', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

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

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • key (str) – Key to search
  • customerID (int) – Search specified customer store for this key (default is users customer)
  • includeDeleted (bool) – Include deleted/expired key
Raises:
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}

api.datastores.v1.store.store.put_data_store_entries(dataStore: str, customerID: int = None, entries: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

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

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • customerID (int) – 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)
  • entries (list) – Entries to add
Raises:
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}

api.datastores.v1.store.store.put_single_data_store_entry(dataStore: str, key: str, customerID: int = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Adds the provided datastore entry for the specified store. To use for lists (key, no value) (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • key (str) – Datastore key to set
  • customerID (int) – Specify datastore to put entry to (default is users customer)
Raises:
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}

Module contents