Scenarios¶

Operations on scenarios. Available on the client as client.scenarios.

scenarios.list¶

async def list(analysis_guid: str) -> list[ScenarioResponseDto]

List the scenarios of an analysis.

REST operation: GET /sympheny-app/analysis/{guid}/scenario

Parameters

Returns: list of ScenarioResponseDto

async with AsyncSympheny(username, password) as client:
    scenarios = await client.scenarios.list(analysis_guid)

with Sympheny(username, password) as client:
    scenarios = client.scenarios.list(analysis_guid)

scenarios.create¶

async def create(analysis_guid: str, request: ScenarioRequestDto) -> ScenarioResponseDto

Create a new scenario in an analysis.

REST operation: POST /sympheny-app/analysis/{guid}/scenario

Parameters

Returns: ScenarioResponseDto

async with AsyncSympheny(username, password) as client:
    scenario = await client.scenarios.create(analysis_guid, request)

with Sympheny(username, password) as client:
    scenario = client.scenarios.create(analysis_guid, request)

scenarios.get¶

async def get(scenario_guid: str) -> ScenarioResponseDto

Get scenario details.

REST operation: GET /sympheny-app/scenario/{scenarioGuid}

Parameters

Returns: ScenarioResponseDto

async with AsyncSympheny(username, password) as client:
    scenario = await client.scenarios.get(scenario_guid)

with Sympheny(username, password) as client:
    scenario = client.scenarios.get(scenario_guid)

scenarios.rename¶

async def rename(scenario_guid: str, request: ScenarioRequestDto) -> ScenarioResponseDto

Rename a scenario in place.

REST operation: PUT /sympheny-app/scenarios/{scenarioGuid}

Unlike copy, this sets the scenario's name directly, so it works within the scenario's current analysis without creating a duplicate.

Parameters

Returns: ScenarioResponseDto

async with AsyncSympheny(username, password) as client:
    scenario = await client.scenarios.rename(scenario_guid, request)

with Sympheny(username, password) as client:
    scenario = client.scenarios.rename(scenario_guid, request)

scenarios.delete¶

async def delete(scenario_guid: str) -> Status

Delete a scenario.

REST operation: DELETE /sympheny-app/scenario/{scenarioGuid}

The API returns no data payload for this endpoint even on success, so a missing payload is treated as an empty Status rather than an error.

Parameters

Returns: Status

async with AsyncSympheny(username, password) as client:
    status = await client.scenarios.delete(scenario_guid)

with Sympheny(username, password) as client:
    status = client.scenarios.delete(scenario_guid)

scenarios.copy¶

async def copy(
    scenario_guid: str,
    *,
    analysis_destination_guid: str | None = None,
    name: str | None = None,
) -> ScenarioResponseDto

Copy a scenario, optionally into another analysis.

REST operation: PUT /sympheny-app/scenarios/copy/{scenarioGuid}

Broken as of this writing (to be fixed server-side): the name argument is only applied when analysis_destination_guid is omitted (the copy stays in the source's analysis). When a destination is given, name is ignored and the copy takes the source's name without deduplicating, so copying the same source into one analysis twice fails the scenario_name + analysis_id unique constraint. To place a renamed copy in another analysis: copy into it without a name (the server assigns a unique "... (Copy)" name), then copy that in place with the wanted name.

Parameters

Returns: ScenarioResponseDto

async with AsyncSympheny(username, password) as client:
    scenario = await client.scenarios.copy(scenario_guid)

with Sympheny(username, password) as client:
    scenario = client.scenarios.copy(scenario_guid)