switching

Edit a break-even — what it says, how it is known or what it compares is proposed again

patch/workspaces/{id}/questions/{questionId}/break-evens/{breakEvenId}

Request

  • Base URL: https://api.swingfactor.ai/v1
  • URL: https://api.swingfactor.ai/v1/workspaces/{id}/questions/{questionId}/break-evens/{breakEvenId}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workspace's id (a UUID).

questionIdstring uuid required

The question's id (a UUID).

breakEvenIdstring uuid required

The break-even's id (a UUID).

Request body

thresholdnumber
consequencestring
basis'derived' | 'published' | 'criterion' | 'asserted'

How it is known: derived (its arithmetic shown), published, a published criterion, or asserted by a named party — which records that they say so, not that they are right.

derivationstring
sourcestring
assertedBystring
belowOutcomestring
aboveOutcomestring
everyScenarioboolean

It holds whichever scenario happens. Never with a scenario. Neither: not stated.

measuredAgainststring
reasonstring

Why — kept in the history.

Response

The break-even.

idstring uuid required
workspaceIdstring uuid required
questionIdstring uuid required
variableIdstring uuid required
thresholdnumber required
horizon'transition' | 'early' | 'medium' | 'long' | 'every' | 'null' nullable

The matched horizon: transition (Day One), early adjustment, medium term, long run, or every horizon. None: not stated — never every.

consequencestring required

What changes at the threshold.

basis'derived' | 'published' | 'criterion' | 'asserted' required

How it is known: derived (its arithmetic shown), published, a published criterion, or asserted by a named party — which records that they say so, not that they are right.

derivationstring nullable

For a derived one: the arithmetic.

sourcestring nullable

Where it is published, or asserted.

assertedBystring nullable

For an asserted one: who draws the line.

belowOutcomestring nullable

What occurs below the threshold.

aboveOutcomestring nullable

What occurs above it.

configurationIdstring uuid nullable

For a break-even comparing no options: the configuration it holds under.

scenarioIdstring uuid nullable
everyScenarioboolean
measuredAgainststring nullable

What it is measured against: compared with a range’s baseline, never bridged.

status'proposed' | 'accepted' | 'rejected' required

Changes only by a person’s decision.

decidedBystring uuid
decidedByNamestring
decidedAtstring
createdBystring uuid
createdAtstring required
draftIdstring uuid

Set where SwingFactor drafted it.

updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.