apollo.cannedvalues package¶

Module contents¶

Contains possible interactions with the Apollo Canned Values Module

class apollo.cannedvalues.CannedValuesClient(webapolloinstance, **requestArgs)¶

add_value(value, metadata='')¶

Add a canned value

Parameters:	value (str) – New canned value metadata (str) – Optional metadata
Return type:	dict
Returns:	A dictionnary containing canned value description

delete_value(id_number)¶

Update a canned value

Parameters:	id_number (int) – canned value ID number
Return type:	dict
Returns:	an empty dictionary

get_values()¶

Get all canned values available in this Apollo instance

Return type:	list of dicts
Returns:	list of canned value info dictionaries

show_value(value)¶

Get a specific canned value

Parameters:	value (str) – Canned value to show
Return type:	dict
Returns:	A dictionnary containing canned value description

update_value(id_number, new_value, metadata=None)¶

Update a canned value

Parameters:	id_number (int) – canned value ID number new_value (str) – New canned value value metadata (str) – Optional metadata
Return type:	dict
Returns:	an empty dictionary