Lifecycles

Retrieving lifecycle objects

class LifecycleMixin

This class defines all functions related to BlueConic lifecycles.

get_lifecycle(lifecycle_id)

Gets the lifecycle with the lifecycle ID and returns it as a BlueConic lifecycle.

Parameters:

lifecycle_id (str) – The ID of the lifecycle

Raises:

HTTPError: Request fails

Returns:

A lifecycle object

Return type:

Lifecycle

Usage:
>>> import blueconic
>>> bc = blueconic.Client()
>>> lifecycle_id = "ddc79b6e-51bb-4174-acfd-e47c5433a9d0"
>>> my_lifecycle = bc.get_lifecycle(lifecycle_id)
>>> print(my_lifecycle.name)
My lifecycle
get_lifecycles(start=0, count=10000000)

Gets all lifecycles in the system

Raises:

HTTPError: Request fails

Parameters:
  • start (int, optional) – The lifecycle to start from. Defaults to 0.

  • count (int, optional) – The number of lifecycles to retrieve. Defaults to 10000000.

Returns:

Iterator with Lifecycle

Return type:

Iterator[Lifecycle]

Usage:
>>> import blueconic
>>> bc = blueconic.Client()
>>> bc.get_lifecycles()
<generator object Lifecycle.get_lifecycles>

Using lifecycle objects

class Lifecycle

This class represents a BlueConic Lifecycle.

property creation_date
Returns:

The creation date of this object.

Return type:

Optional[datetime]

property creator_username
Returns:

The username that created this object.

Return type:

Optional[str]

property description
Returns:

Description of this object.

Return type:

Optional[str]

property id
Returns:

ID of this object.

Return type:

str

property is_active
Returns:

Returns indication if the lifecycle is active

Return type:

Optional[bool]

property is_deleted
Returns:

Returns indication if the lifecycle is deleted

Return type:

Optional[bool]

property labels
Returns:

The labels this object.

Return type:

Optional[Sequence[str]

property last_modified_date
Returns:

The last modified date of this object.

Return type:

Optional[datetime]

property last_modified_username
Returns:

The last modified username of this object.

Return type:

Optional[str]

property name
Returns:

Name of this object.

Return type:

Optional[str]

property stages
Returns:

Stages in this lifecycle

Return type:

Optional[Sequence[Stage]]

class Stage

This class represents a BlueConic Stage.

property creation_date
Returns:

The creation date of this object.

Return type:

Optional[datetime]

property creator_username
Returns:

The username that created this object.

Return type:

Optional[str]

property description
Returns:

Description of this object.

Return type:

Optional[str]

property id
Returns:

ID of this object.

Return type:

str

property is_deleted
Returns:

Returns indication if a stage is deleted

Return type:

Optional[bool]

property labels
Returns:

The labels this object.

Return type:

Optional[Sequence[str]

property last_modified_date
Returns:

The last modified date of this object.

Return type:

Optional[datetime]

property last_modified_username
Returns:

The last modified username of this object.

Return type:

Optional[str]

property name
Returns:

Name of this object.

Return type:

Optional[str]

property sequence_number
Returns:

Returns the index of the stage in the lifecycle

Return type:

Optional[int]

property touchpoints
Returns:

The touchpoints of this stage

Return type:

Optional[Sequence[Reference]]

class Reference

This class represents a BlueConic Reference.

property id
Returns:

ID of this reference

Return type:

str

property parent_ref
Returns:

Parent of this reference

Return type:

Reference

property type
Returns:

Type of this reference (e.g. goal, connection)

Return type:

str