Timeline event types

Retrieving timeline event type objects

class EventTypeMixin

This class defines all functions related to BlueConic event types.

get_event_type(event_type_id)

Gets the event type with the event type ID and returns it as a BlueConic event type.

Parameters: event_type_id (str) – The ID of the desired event type
Raises: HTTPError: Request fails
Returns: An event type object
Return type: TimelineEvent

Usage:

>>> import blueconic
>>> bc = blueconic.Client()
>>> bc.get_event_type('example-eventType-id')
<blueconic.domain.event_type.TimelineEvent>

get_event_types(start=0, count=10000000, filter_value=None)

Gets all event types and returns them in a generator with all BlueConic event types.

Parameters

start (int, optional) – The event type to start from. Defaults to 0.
count (int, optional) – The number of event types to retrieve. Defaults to 10000000.
filter_value (str, optional) – Only return event types with this string in their name. Defaults to None.

Returns

Iterator with EventType

Return type

Iterator[EventType]

Usage:

>>> import blueconic
>>> bc = blueconic.Client()
>>> bc.get_event_types()
<generator object EventType.get_event_types>

Using timeline event type objects

class EventType

property description

Returns: Returns the description of this event type.
Return type: str

property id

Returns: ID of this object.
Return type: str

property json_schema

Returns: Returns the JSON schema of this event type.
Return type: str

property mapping

Returns: Returns the mapping of this event type.
Return type: str

property name

Returns: Name of this object.
Return type: Optional[str]

property priority

Returns: Returns the priority of this event type.
Return type: str

property properties

Returns: Returns the property types of this event type.
Return type: Sequence[EventTypeProperty]

class EventTypeProperty

property nested_properties

Returns: Returns the nested properties for the event type property. Can be empty when the property does not have any nested properties.
Return type: Optional[EventTypeNestedProperty]

property property_data_sensitivity: Returns the property data sensitivity for the event type property.

property property_description

Returns: Returns the property description for the event type property.
Return type: str

property property_id

Returns: Returns the property id for the event type property.
Return type: str

property property_name

Returns: Returns the property name for the event type property.
Return type: str

property property_type

Returns: Returns the property type for the event type property.
Return type: str

class EventTypeNestedProperty

property identifier

Returns: Returns the property that holds the identifier for the nested property. E.g. productID in case of products.
Return type: str

property properties

Returns: Returns the properties for the nested property.
Return type: Optional[Sequence[EventTypeProperty]]