update_life_phase#

Lifecycle.update_life_phase(request)#

Update a life cycle phase for a specific life cycle.

Available Since: 2026R1

Parameters:

requestUpdateLifePhaseRequest: Request object containing project, phase name, and one or more of the following optional parameters: new phase name, new description, new duration, new duration units, new number of cycles, new cycle type and results archive file name.

Returns:

:
SherlockCommonService_pb2.ReturnCode: Status code of the response. 0 for success.

Return type:

ReturnCode

Examples

>>> from ansys.sherlock.core.types.lifecycle_types import UpdateLifePhaseRequest
>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> response = sherlock.lifecycle.update_life_phase(
>>>     UpdateLifePhaseRequest(
>>>         project="Tutorial Project",
>>>         phase_name="Thermal",
>>>         new_phase_name="Environmental",
>>>         new_num_of_cycles = 100,
>>>         new_cycle_type="PER DAY",
>>>         new_description="new description",
>>>         new_duration=24,
>>>         new_duration_units="hr",
>>>         result_archive_file_name="Tutorial Project Results 10_7_2025"
>>>     )
>>> )
>>> assert response.value == 0