Skip to content
Ishvana Ishvana Docs

Load Character Sheet

GET
/api/creative/sheets/{sheet_id}

Load a filled character sheet by ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sheet_id
required
Sheet Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

CharacterSheetLoadResponse

Response containing a loaded character sheet with data.

object
id
required
Id

Sheet ID

string
name
required
Name

Character name

string
templateName
required
Templatename

Source template

string
layout
required
SheetLayout

Sheet layout

object
pageTitle
required
Pagetitle

Sheet title

string
layoutGrid
required
SheetLayoutGrid

CSS Grid definition

object
template
required
Template

Grid template areas

Array<Array<string>>
columns
required
Columns

CSS grid-template-columns value

string
gap
Gap

CSS grid gap

string
default: 16px
components
required
Components

Layout components

Array<object>
SheetComponent

A single component in a character sheet layout.

object
id
required
Id

Unique component identifier

string
gridArea
required
Gridarea

CSS Grid area name

string
type
required
Type

Component type from the library

string
label
Any of:
string
fields
Any of:
Array<string>
stats
Any of:
Array<string>
placeholder
Any of:
string
rows
Any of:
integer
columns
Any of:
integer
columnHeaders
Any of:
Array<string>
modifierFormula
Any of:
string
Allowed values: dnd half fifth none
version
Version

Schema version

string
default: 1.0
createdAt
Any of:
string
data
required
Data

Filled-in field values

object
key
additional properties
any
entryId
Any of:
string

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