Klineo/Docs
Open app ↗

API schemas

SharedSimulationStudy

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
share Yes object Additional properties rejected
share.slug Yes string —
share.visibility Yes string Allowed: PRIVATE, PUBLIC
share.expiresAt Yes string Format: date-time
share.disclosure Yes object Additional properties rejected
share.disclosure.includeDrivers Yes boolean —
share.disclosure.includeTreasury Yes boolean —
share.disclosure.includePolicy Yes boolean —
study Yes object Additional properties rejected
study.id Yes string Min length: 3; Max length: 160
study.version Yes integer Minimum: 1
study.status Yes OperatingSystemRecordStatus —
study.payload Yes DisclosedSimulationStudy —
study.artifactHash Yes Hash —
study.sourceArtifactHash Yes Hash —
study.updatedAt Yes string Format: date-time
disclosure Yes object Additional properties rejected
disclosure.includeDrivers Yes boolean —
disclosure.includeTreasury Yes boolean —
disclosure.includePolicy Yes boolean —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/SharedSimulationStudy in the OpenAPI contract.