custom_data

Adds new CustomData record(s)

Code
Parameters
----------
data : list<dict>, required
    [{"name": str, required,
      "value": dict, required,
      "reference_id": uuid, optional,
      "id": uuid, optional cannot conflict, use update if you need to override},
    ...]

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list<dict>, echo your added data with assigned uuids

Deletes custom data record(s)

Code
Parameters
----------
ids : list<UUID>, required
    UUIDs of CustomData records to be deleted

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    {"deleted": ['uuids', 'deleted', 'records'],
     "notfound": ['uuids', 'not', 'found']}

Queries existing CustomData record(s)

Code
Parameters
----------
id : uuid, optional
ids : list<uuid>, optional
name : str, optional
reference_id : uuid, optional

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list<dict>, found CustomData results

Summarized counts of CustomData records grouped by name order by count descending

Code
Returns
-------
success : bool
    True if successful, false if not
data : list
    [["name", count], ["name2", count2], ...]

Updates existing CustomData record(s)

Code
Parameters
----------
data : dict<dict>, required
    {"existing uuid":
      {"value": dict, keys will be updated by default,
       "replace_value": bool, optional, if true then value will replace rather than update
       "reference_id": uuid, optional,
       "name": str, optional
      },
    ...}

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    {"updated": ['uuids', 'updated', 'records'],
     "notfound": ['uuids', 'not', 'found']}