Request

AssociateCategoryPropertyValueToAssocationInfoRequest

Bases: BaseRequest

Class for AssociateCategoryPropertyValueToAssocationInfoRequest

Attributes:

Name	Type	Description
Entity1Id	uuid	Identifier of the entity 1
Entity2Id	uuid	Identifier of the entity 2
AssociationType	AssociationType	Association type
PropertyTypeId	uuid	Property type identifier
Value	str	Value
AssociationAction	AssociationAction	Association action
OverwriteSingleValue	bool	Overwrite single value

AssociateCategoryPropertyValueToEntityRequest dataclass

Bases: BaseRequest

Class for AssociateCategoryPropertyValueToEntityRequest

Attributes:

Name	Type	Description
EntityId	uuid	Identifier of the entity
EntityType	Entities	Entity type
PropertyTypeId	uuid	Property type identifier
Value	str	Value
AssociationAction	AssociationAction	Association action
OverwriteSingleValue	bool	Overwrite single value

AssociateEntitiesOneToManyRequest dataclass

Bases: BaseRequest

Class for AssociateEntitiesOneToManyRequest

Attributes:

Name	Type	Description
Entity1Id	uuid	Identifier of the entity 1
Entity2Ids	list[uuid]	List of identifiers of the entity 2
AssociationType	AssociationType	Association type
AssociationAction	AssociationAction	Association action

AssociateEntitiesRequest dataclass

Bases: BaseRequest

Class for AssociateEntitiesRequest

Attributes:

Name	Type	Description
Entity1Id	uuid	Identifier of the entity 1
Entity2Id	uuid	Identifier of the entity 2
AssociationType	AssociationType	Association type
AssociationAction	AssociationAction	Association action

EntitiesDeleteRequest dataclass

Bases: BaseRequest

Class for EntitiesDeleteRequest

Attributes:

Name	Type	Description
Ids	list[uuid]	List of identifiers

EntitiesListRequest dataclass

Bases: ListRequestBase

Class for EntitiesListRequest

Attributes:

Name	Type	Description
Ids	Optional(list[uuid]	List of identifiers
Relations	int	Relations to be included
AssociationInfos	int	AssociationInfos to be included
Filters	str	Filters to be applied

EntitiesListRequestByCategory dataclass

Bases: ListRequestBase

Class for EntitiesListRequestByCategory

Attributes:

Name	Type	Description
Ids	Optional(list[uuid]	List of identifiers
Relations	int	Relations to be included
AssociationInfos	int	AssociationInfos to be included
Filters	str	Filters to be applied
Categories	list[uuid]	List of categories

EntityGetRequest dataclass

Bases: BaseRequest

Class for EntityGetRequest

Attributes:

Name	Type	Description
Id	uuid	Identifier of the entity
Relations	int	Relations to be included
AssociationInfos	int	AssociationInfos to be included

ListRequestBase

Bases: BaseRequest

Base class for list requests

Attributes:

Name	Type	Description
Order	str	Order of the list
Offset	int	Offset of the list
Limit	int	Limit of the list

check_mandatory_parameters(obj, mandatory_parameters, logger=None)

Function to check mandatory parameters. Used on data received by API calls