United tool

get_united_tool(organization_id, relations=0, id=None, logger=None, session=None, orm_entities=False)

Get detail of united tool

Parameters:

Name	Type	Description	Default
organization_id	str	Organization identifier	required
relations	int	Flag sum of associated enities type. Use Entities enum type.	0
id	str	UnitedTool identifier	None
session		SQLAlchemy session	None
orm_entities	bool	If True, return mapping models, else domain models	False

Returns:

Type	Description
	Dictionary with 2 keys. [entities]: a list of UnitedToolModel entities (if orm_entities==True) or a list of UnitedTool (if orm_entities=False). [total]: record count.

get_united_tools(organization_id, relations=0, ids=None, order=None, offset=0, limit=100, filters=None, logger=None, session=None, orm_entities=False)

Get list of united_tools

Parameters:

Name	Type	Description	Default
organization_id	str	Organization identifier	required
relations	int	Flag sum of associated enities type. Use Entities enum type.	0
ids	List[str]	List of identifiers of united tools. If empty, load all data.	None
order	str	Order field	None
offset	int	Index of first record	0
limit	int	Number of records to be returned	100
filters	str	JSON string with query filter	None
session		SQLAlchemy session	None
orm_entities	bool	If True, return mapping models, else domain models	False

Returns:

Type	Description
	Dictionary with 2 keys. [entities]: a list of UnitedToolModel entities (if orm_entities==True) or a list of UnitedToolModel (if orm_entities=False). [total]: record count.

save_united_tool(organization_id, payload, logger=None, session=None)

Save united tool

Parameters:

Name	Type	Description	Default
organization_id	uuid)	Organization identifier	required
payload	UnitedTool)	UnitedTool object	required
logger		Logger instance	None
session	SQLAlchemy	SQLAlchemy session	None

Returns:

Type	Description
	UnitedTool (UnitedTool) : UnitedTool object