Beta.workflow v3.settings

Read-only public configuration, independent of API response models.

Settings Objects

@dataclass(frozen=True)
class Settings()

Read-only configuration with detached, JSON-safe export using Python field names.

StageSettings Objects

@dataclass(frozen=True)
class StageSettings(Settings)

Read-only public configuration for a workflow stage.

StartStageSettingsV1 Objects

@dataclass(frozen=True)
class StartStageSettingsV1(StageSettings)

Start has no public configuration fields.

AnnotationStageSettingsV1 Objects

@dataclass(frozen=True)
class AnnotationStageSettingsV1(StageSettings)

Annotation stages have no public configuration fields.

ReviewStageSettingsV1 Objects

@dataclass(frozen=True)
class ReviewStageSettingsV1(StageSettings)

Review stages have no public configuration fields.

ExternalStageSettingsV1 Objects

@dataclass(frozen=True)
class ExternalStageSettingsV1(StageSettings)

External stages have no public configuration fields.

CompleteStageSettingsV1 Objects

@dataclass(frozen=True)
class CompleteStageSettingsV1(StageSettings)

Complete terminals have no public configuration fields.

ArchiveStageSettingsV1 Objects

@dataclass(frozen=True)
class ArchiveStageSettingsV1(StageSettings)

Archive terminals have no public configuration fields.

SkipStageSettingsV1 Objects

@dataclass(frozen=True)
class SkipStageSettingsV1(StageSettings)

Skip terminals have no public configuration fields.

UnknownStageSettings Objects

@dataclass(frozen=True)
class UnknownStageSettings(StageSettings)

Unfamiliar settings; to_dict returns a detached copy with original keys.

version

@property
def version() -> Optional[int]

Settings contract version, if supplied by an unfamiliar stage.

PercentageRouterStageSettingsV1 Objects

@dataclass(frozen=True, init=False)
class PercentageRouterStageSettingsV1(StageSettings)

Probabilities by pathway UUID, expressed as fractions summing to one.

pathway_probabilities

@property
def pathway_probabilities() -> Mapping[UUID, float]

Read-only probabilities for this router’s outgoing pathways.

CollaboratorRouterStageSettingsV1 Objects

@dataclass(frozen=True)
class CollaboratorRouterStageSettingsV1(StageSettings)

Collaborator routers have no public configuration fields.

Get Started

General

Data

Ontologies

Projects

Labels

DICOM