Skip to content
Ishvana Ishvana Docs

Get Ruleset

GET
/api/creative/mechanics/rulesets/{ruleset_id}

Get a ruleset by ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
ruleset_id
required
Ruleset Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Ruleset
object
id
required
Id
string
projectId
required
Projectid
string
name
required
Name
string
>= 1 characters <= 200 characters
description
Description
string
""
version
Version
string
default: 1.0
stats
required
Stats
Array<object>
StatDefinition
object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
abbreviation
required
Abbreviation
string
>= 1 characters <= 10 characters
category
required
Category
string
>= 1 characters
valueType
StatValueType
string
default: integer
Allowed values: integer float dice_step
minValue
Minvalue
number
0
maxValue
Maxvalue
number
default: 100
defaultValue
Defaultvalue
number
default: 10
description
Description
string
""
sortOrder
Sortorder
integer
0
formulas
required
Formulas
Array<object>
FormulaDefinition
object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
expression
required
Expression
string
>= 1 characters
category
required
Category
string
>= 1 characters
description
Description
string
""
outputType
FormulaOutputType
string
default: integer
Allowed values: integer float dice boolean
resources
required
Resources
Array<object>
ResourceDefinition
object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
abbreviation
required
Abbreviation
string
>= 1 characters <= 10 characters
maxFormula
required
Maxformula
string
>= 1 characters
currentTracking
Currenttracking
boolean
default: true
description
Description
string
""
categories
required
Categories
Array<object>
MagicSystemWing
object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
parentKey
Any of:
string
color
Color
string
""
sortOrder
Sortorder
integer
0
description
Description
string
""
rules
Rules
string
""
baseCost
Basecost
string
""
loreEntryId
Loreentryid
string
""
templates
required
Templates
Array<object>
MechanicalTemplate
object
entryType
required
Entrytype
string
>= 1 characters
label
Label
string
""
statKeys
required
Statkeys
Array<string>
formulaKeys
required
Formulakeys
Array<string>
extraFields
Extrafields
Array<object>
default:
ExtraFieldDefinition
object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
fieldType
ExtraFieldType
string
default: text
Allowed values: integer float text formula select
defaultValue
Defaultvalue
string
""
options
Any of:
Array<string>
description
Description
string
""
diceSystem
Dicesystem
string
""
outcomeMapping
Any of:
DiceOutcomeMapping

Defines how individual die faces map to categorical outcomes.

For a d10 pool system: faces 1-10 map to bands like Critical Success, Advantage, Neutral, Consequence, Critical Failure — each with a weight that determines net outcome when advantages and consequences cancel.

object
dieFaces
required
Diefaces
integer
>= 2 <= 100
bands
required
Bands
Array<object>
>= 1 items
DiceOutcomeBand

A range of die face values with a categorical meaning and weight.

Example: on a d10, faces 8-9 are “Advantage” with weight +1.

object
name
required
Name
string
>= 1 characters <= 50 characters
minValue
required
Minvalue
integer
>= 1
maxValue
required
Maxvalue
integer
>= 1
weight
Weight
integer
0
color
Color
string
default: #6b7280
dcTiers
Dctiers
Array<object>
default:
DcTier

A named difficulty threshold (e.g., Easy=15, Normal=25, Hard=35).

object
label
required
Label
string
>= 1 characters <= 50 characters
value
required
Value
integer
modifiers
Modifiers
Array<object>
default:
ModifierDefinition

A modifier/feat/ability definition — part narrative, part mechanical.

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
category
Category
string
default: general
description
Description
string
""
maxRank
Maxrank
integer
default: 1 >= 1 <= 20
effects
Effects
Array<object>
default:
ModifierEffect

A single mechanical effect of a modifier (stat modifier, pool bonus, etc.).

object
effectType
required
ModifierEffectType
string
Allowed values: stat_modifier pool_bonus dc_modifier reroll narrative
targetStat
Any of:
string
modifierType
Any of:
ModifierType
string
Allowed values: flat multiply override
value
Value
number
0
perRank
Perrank
boolean
description
Description
string
""
prerequisites
Prerequisites
Array<string>
default:
loreEntryId
Loreentryid
string
""
abilities
Abilities
Array<object>
default:
AbilityDefinition

An ability/technique/spell — active things characters do.

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 200 characters
category
Category
string
default: general
description
Description
string
""
mechanics
Mechanics
string
""
tier
Tier
integer
0 <= 10
maxRank
Maxrank
integer
default: 1 >= 1 <= 20
propertyValues
Propertyvalues
object
key
additional properties
Array<string>
costResource
Costresource
string
""
costAmount
Costamount
integer
0
upkeepAmount
Upkeepamount
integer
0
tags
Tags
Array<string>
default:
prerequisites
Prerequisites
Array<string>
default:
effects
Effects
Array<object>
default:
ModifierEffect

A single mechanical effect of a modifier (stat modifier, pool bonus, etc.).

object
effectType
required
ModifierEffectType
string
Allowed values: stat_modifier pool_bonus dc_modifier reroll narrative
targetStat
Any of:
string
modifierType
Any of:
ModifierType
string
Allowed values: flat multiply override
value
Value
number
0
perRank
Perrank
boolean
description
Description
string
""
loreEntryId
Loreentryid
string
""
systemProperties
Systemproperties
Array<object>
default:
SystemProperty

A structured property for the magic system (e.g., Range, Duration, Element).

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
options
required
Options
Array<object>
PropertyOption

A single selectable option within a system property.

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
label
required
Label
string
>= 1 characters <= 100 characters
allowMultiple
Allowmultiple
boolean
isStandard
Isstandard
boolean
sortOrder
Sortorder
integer
0
tierLabels
Tierlabels
Array<object>
default:
TierLabel

A named power tier (e.g., 0=Cantrip, 1=Novice, 5=Legendary).

object
level
required
Level
integer
<= 10
label
required
Label
string
>= 1 characters <= 50 characters
statGroups
Statgroups
Array<object>
default:
StatGroup

A user-defined grouping for stats and formulas (e.g., Physical, Mental, Social).

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
modifierCategories
Modifiercategories
Array<object>
default:
StatGroup

A user-defined grouping for stats and formulas (e.g., Physical, Mental, Social).

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
abilityCategories
Abilitycategories
Array<object>
default:
StatGroup

A user-defined grouping for stats and formulas (e.g., Physical, Mental, Social).

object
key
required
Key
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
name
required
Name
string
>= 1 characters <= 100 characters
loreEntryId
Any of:
string
isActive
Isactive
boolean
default: true
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object