docs.jsonld
type: ApiDocumentation
title: Relatable API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Map
supported class: Garden
supported class: Machine
supported class: Model
supported class: ModelObject
supported class: NoteNotebook
supported class: Observatory
supported class: Room
supported class: SeedTray
supported class: Studio
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous

Map
type: Class
title: Map
supported property: SupportedProperty
  property: Map/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Map/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Map/document
  title: document
  required: false
  readable: true
  writeable: true
  description: Serialized canvas state: nodes, edges, pan/zoom (see relational_canvas.js persist()).
supported property: SupportedProperty
  property: Map/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Map/hash
  title: hash
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Map/person
  title: person
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Map/room
  title: room
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Map/dropzone
  title: dropzone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Map/holdingGroundCount
  title: holdingGroundCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Map/careBeltCount
  title: careBeltCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Map/revision
  title: revision
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Map resource.
  method: GET
  returns: Map
  title: getMap
supported operation: Operation
  description: Updates the Map resource.
  expects: Map
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Map
  title: patchMap
supported operation: Operation
  type: DeleteAction
  description: Deletes the Map resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMap

Map/summary
type: Property
domain: Map
the hydra core vocabulary: summary
range: string

Map/explanation
type: Property
domain: Map
the hydra core vocabulary: explanation
range: string

Map/document
type: Property
domain: Map
the hydra core vocabulary: document

Map/priority
type: Property
domain: Map
the hydra core vocabulary: priority
range: integer

Map/hash
type: Property
domain: Map
the hydra core vocabulary: hash
range: string

Map/person
type: Property
domain: Map
the hydra core vocabulary: person

Map/room
type: Link
domain: Map
the hydra core vocabulary: room
max cardinality: 1
range: Room

Map/dropzone
type: Property
domain: Map
the hydra core vocabulary: dropzone
range: boolean

Map/holdingGroundCount
type: Property
domain: Map
the hydra core vocabulary: holdingGroundCount
range: integer

Map/careBeltCount
type: Property
domain: Map
the hydra core vocabulary: careBeltCount
range: integer

Map/revision
type: Property
domain: Map
the hydra core vocabulary: revision
range: integer

Garden
type: Class
title: Garden
supported property: SupportedProperty
  property: Garden/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Garden/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Garden/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Garden resource.
  method: GET
  returns: Garden
  title: getGarden
supported operation: Operation
  description: Updates the Garden resource.
  expects: Garden
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Garden
  title: patchGarden
supported operation: Operation
  type: DeleteAction
  description: Deletes the Garden resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteGarden

Garden/summary
type: Property
domain: Garden
the hydra core vocabulary: summary
range: string

Garden/priority
type: Property
domain: Garden
the hydra core vocabulary: priority
range: integer

Garden/explanation
type: Property
domain: Garden
the hydra core vocabulary: explanation
range: string

Machine
type: Class
title: Machine
supported property: SupportedProperty
  property: Machine/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Machine/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Machine/hash
  title: hash
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Machine/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Machine/room
  title: room
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Machine resource.
  method: GET
  returns: Machine
  title: getMachine
supported operation: Operation
  description: Updates the Machine resource.
  expects: Machine
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Machine
  title: patchMachine
supported operation: Operation
  type: DeleteAction
  description: Deletes the Machine resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMachine

Machine/summary
type: Property
domain: Machine
the hydra core vocabulary: summary
range: string

Machine/explanation
type: Property
domain: Machine
the hydra core vocabulary: explanation
range: string

Machine/hash
type: Property
domain: Machine
the hydra core vocabulary: hash
range: string

Machine/priority
type: Property
domain: Machine
the hydra core vocabulary: priority
range: integer

Machine/room
type: Link
domain: Machine
the hydra core vocabulary: room
max cardinality: 1
range: Room

Model
type: Class
title: Model
supported property: SupportedProperty
  property: Model/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Model/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Model/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Model/room
  title: room
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Model/hash
  title: hash
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Model resource.
  method: GET
  returns: Model
  title: getModel
supported operation: Operation
  description: Updates the Model resource.
  expects: Model
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Model
  title: patchModel
supported operation: Operation
  type: DeleteAction
  description: Deletes the Model resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteModel

Model/summary
type: Property
domain: Model
the hydra core vocabulary: summary
range: string

Model/explanation
type: Property
domain: Model
the hydra core vocabulary: explanation
range: string

Model/priority
type: Property
domain: Model
the hydra core vocabulary: priority
range: integer

Model/room
type: Link
domain: Model
the hydra core vocabulary: room
max cardinality: 1
range: Room

Model/hash
type: Property
domain: Model
the hydra core vocabulary: hash
range: string

ModelObject
type: Class
title: ModelObject
supported property: SupportedProperty
  property: ModelObject/model
  title: model
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/associationType
  title: associationType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/associationId
  title: associationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/color
  title: color
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/done
  title: done
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/icon
  title: icon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/updated
  title: updated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ModelObject/parentObject
  title: parentObject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/digesting
  title: digesting
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/resistance
  title: resistance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/dialogue
  title: dialogue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/acceptance
  title: acceptance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/hash
  title: hash
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ModelObject/mailbox
  title: mailbox
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/impact
  title: impact
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/value
  title: value
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/approach
  title: approach
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/awareness
  title: awareness
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/mastery
  title: mastery
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/imageGenerating
  title: imageGenerating
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/imageGenerationJobId
  title: imageGenerationJobId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ModelObject/reflection
  title: reflection
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/studio
  title: studio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/tree
  title: tree
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/seedTray
  title: seedTray
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/observatory
  title: observatory
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/universe
  title: universe
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/externalVideoUrl
  title: externalVideoUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/externalUrl
  title: externalUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ModelObject/externalUrlTitle
  title: externalUrlTitle
  required: false
  readable: true
  writeable: true
supported operation: Operation

ModelObject/model
type: Link
domain: ModelObject
the hydra core vocabulary: model
max cardinality: 1
range: Model

ModelObject/name
type: Property
domain: ModelObject
the hydra core vocabulary: name
range: string

ModelObject/associationType
type: Property
domain: ModelObject
the hydra core vocabulary: associationType
range: string

ModelObject/associationId
type: Property
domain: ModelObject
the hydra core vocabulary: associationId
range: string

ModelObject/priority
type: Property
domain: ModelObject
the hydra core vocabulary: priority
range: integer

ModelObject/color
type: Property
domain: ModelObject
the hydra core vocabulary: color
range: string

ModelObject/done
type: Property
domain: ModelObject
the hydra core vocabulary: done
range: string

ModelObject/explanation
type: Property
domain: ModelObject
the hydra core vocabulary: explanation
range: string

ModelObject/icon
type: Property
domain: ModelObject
the hydra core vocabulary: icon
range: string

ModelObject/updated
type: Property
domain: ModelObject
the hydra core vocabulary: updated
range: dateTime

ModelObject/parentObject
type: Property
domain: ModelObject
the hydra core vocabulary: parentObject
max cardinality: 1
range: ModelObject

ModelObject/digesting
type: Property
domain: ModelObject
the hydra core vocabulary: digesting
range: boolean

ModelObject/resistance
type: Property
domain: ModelObject
the hydra core vocabulary: resistance
range: boolean

ModelObject/dialogue
type: Property
domain: ModelObject
the hydra core vocabulary: dialogue
range: boolean

ModelObject/acceptance
type: Property
domain: ModelObject
the hydra core vocabulary: acceptance
range: boolean

ModelObject/hash
type: Property
domain: ModelObject
the hydra core vocabulary: hash
range: string

ModelObject/mailbox
type: Property
domain: ModelObject
the hydra core vocabulary: mailbox

ModelObject/impact
type: Property
domain: ModelObject
the hydra core vocabulary: impact
range: boolean

ModelObject/value
type: Property
domain: ModelObject
the hydra core vocabulary: value
range: boolean

ModelObject/approach
type: Property
domain: ModelObject
the hydra core vocabulary: approach
range: boolean

ModelObject/awareness
type: Property
domain: ModelObject
the hydra core vocabulary: awareness
range: boolean

ModelObject/mastery
type: Property
domain: ModelObject
the hydra core vocabulary: mastery
range: boolean

ModelObject/imageGenerating
type: Property
domain: ModelObject
the hydra core vocabulary: imageGenerating
range: boolean

ModelObject/imageGenerationJobId
type: Property
domain: ModelObject
the hydra core vocabulary: imageGenerationJobId
range: string

ModelObject/reflection
type: Property
domain: ModelObject
the hydra core vocabulary: reflection
range: string

ModelObject/studio
type: Link
domain: ModelObject
the hydra core vocabulary: studio
max cardinality: 1
range: Studio

ModelObject/tree
type: Property
domain: ModelObject
the hydra core vocabulary: tree

ModelObject/seedTray
type: Link
domain: ModelObject
the hydra core vocabulary: seedTray
max cardinality: 1
range: SeedTray

ModelObject/observatory
type: Link
domain: ModelObject
the hydra core vocabulary: observatory
max cardinality: 1
range: Observatory

ModelObject/universe
type: Property
domain: ModelObject
the hydra core vocabulary: universe

ModelObject/externalVideoUrl
type: Property
domain: ModelObject
the hydra core vocabulary: externalVideoUrl
range: string

ModelObject/externalUrl
type: Property
domain: ModelObject
the hydra core vocabulary: externalUrl
range: string

ModelObject/externalUrlTitle
type: Property
domain: ModelObject
the hydra core vocabulary: externalUrlTitle
range: string

ModelObject/previewImageUrl
type: Property
domain: ModelObject
the hydra core vocabulary: previewImageUrl
range: string

ModelObject/showingKind
type: Property
domain: ModelObject
the hydra core vocabulary: showingKind
range: string

ModelObject/note
type: Property
domain: ModelObject
the hydra core vocabulary: note
range: boolean

ModelObject/notePinned
type: Property
domain: ModelObject
the hydra core vocabulary: notePinned
range: boolean

ModelObject/tags
type: Property
domain: ModelObject
the hydra core vocabulary: tags

ModelObject/notebooks
type: Link
domain: ModelObject
the hydra core vocabulary: notebooks
range: NoteNotebook

NoteNotebook
type: Class
title: NoteNotebook
supported property: SupportedProperty
  property: NoteNotebook/name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a NoteNotebook resource.
  method: GET
  returns: NoteNotebook
  title: getNoteNotebook
supported operation: Operation
  description: Updates the NoteNotebook resource.
  expects: NoteNotebook
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: NoteNotebook
  title: patchNoteNotebook
supported operation: Operation
  type: DeleteAction
  description: Deletes the NoteNotebook resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteNoteNotebook

NoteNotebook/name
type: Property
domain: NoteNotebook
the hydra core vocabulary: name
range: string

Observatory
type: Class
title: Observatory
supported property: SupportedProperty
  property: Observatory/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Observatory/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Observatory/hash
  title: hash
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Observatory/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Observatory/pathway
  title: pathway
  required: false
  readable: true
  writeable: false
  description: Pathway items (video ModelObjects); ordered by priority ascending.
supported operation: Operation
  type: FindAction
  description: Retrieves a Observatory resource.
  method: GET
  returns: Observatory
  title: getObservatory
supported operation: Operation
  description: Updates the Observatory resource.
  expects: Observatory
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Observatory
  title: patchObservatory
supported operation: Operation
  type: DeleteAction
  description: Deletes the Observatory resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteObservatory

Observatory/summary
type: Property
domain: Observatory
the hydra core vocabulary: summary
range: string

Observatory/explanation
type: Property
domain: Observatory
the hydra core vocabulary: explanation
range: string

Observatory/hash
type: Property
domain: Observatory
the hydra core vocabulary: hash
range: string

Observatory/priority
type: Property
domain: Observatory
the hydra core vocabulary: priority
range: integer

Observatory/pathway
type: Property
domain: Observatory
the hydra core vocabulary: pathway
range: ModelObject

Room
type: Class
title: Room
supported property: SupportedProperty
  property: Room/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/purpose
  title: purpose
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/expectations
  title: expectations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/practices
  title: practices
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/shares
  title: shares
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/asks
  title: asks
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/stumbles
  title: stumbles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/experiences
  title: experiences
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/rules
  title: rules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/lightsoff
  title: lightsoff
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Room/description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Room resource.
  method: GET
  returns: Room
  title: getRoom
supported operation: Operation
  description: Updates the Room resource.
  expects: Room
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Room
  title: patchRoom
supported operation: Operation
  type: DeleteAction
  description: Deletes the Room resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteRoom

Room/summary
type: Property
domain: Room
the hydra core vocabulary: summary
range: string

Room/priority
type: Property
domain: Room
the hydra core vocabulary: priority
range: integer

Room/purpose
type: Property
domain: Room
the hydra core vocabulary: purpose
range: string

Room/expectations
type: Property
domain: Room
the hydra core vocabulary: expectations
range: string

Room/practices
type: Property
domain: Room
the hydra core vocabulary: practices
range: string

Room/shares
type: Property
domain: Room
the hydra core vocabulary: shares
range: string

Room/asks
type: Property
domain: Room
the hydra core vocabulary: asks
range: string

Room/stumbles
type: Property
domain: Room
the hydra core vocabulary: stumbles
range: string

Room/experiences
type: Property
domain: Room
the hydra core vocabulary: experiences
range: string

Room/rules
type: Property
domain: Room
the hydra core vocabulary: rules
range: string

Room/lightsoff
type: Property
domain: Room
the hydra core vocabulary: lightsoff
range: boolean

Room/description
type: Property
domain: Room
the hydra core vocabulary: description
range: string

SeedTray
type: Class
title: SeedTray
supported property: SupportedProperty
  property: SeedTray/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SeedTray/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SeedTray/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a SeedTray resource.
  method: GET
  returns: SeedTray
  title: getSeedTray
supported operation: Operation
  description: Updates the SeedTray resource.
  expects: SeedTray
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: SeedTray
  title: patchSeedTray
supported operation: Operation
  type: DeleteAction
  description: Deletes the SeedTray resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteSeedTray

SeedTray/summary
type: Property
domain: SeedTray
the hydra core vocabulary: summary
range: string

SeedTray/explanation
type: Property
domain: SeedTray
the hydra core vocabulary: explanation
range: string

SeedTray/priority
type: Property
domain: SeedTray
the hydra core vocabulary: priority
range: integer

Studio
type: Class
title: Studio
supported property: SupportedProperty
  property: Studio/summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Studio/explanation
  title: explanation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Studio/hash
  title: hash
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Studio/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Studio/machineMuted
  title: machineMuted
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Studio resource.
  method: GET
  returns: Studio
  title: getStudio
supported operation: Operation
  description: Updates the Studio resource.
  expects: Studio
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Studio
  title: patchStudio
supported operation: Operation
  type: DeleteAction
  description: Deletes the Studio resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteStudio

Studio/summary
type: Property
domain: Studio
the hydra core vocabulary: summary
range: string

Studio/explanation
type: Property
domain: Studio
the hydra core vocabulary: explanation
range: string

Studio/hash
type: Property
domain: Studio
the hydra core vocabulary: hash
range: string

Studio/priority
type: Property
domain: Studio
the hydra core vocabulary: priority
range: integer

Studio/machineMuted
type: Property
domain: Studio
the hydra core vocabulary: machineMuted
range: boolean

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/map
  title: getMapCollection
  description: The collection of Map resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/garden
  title: getGardenCollection
  description: The collection of Garden resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/machine
  title: getMachineCollection
  description: The collection of Machine resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/model
  title: getModelCollection
  description: The collection of Model resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/modelObject
  title: getModelObjectCollection
  description: The collection of ModelObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/noteNotebook
  title: getNoteNotebookCollection
  description: The collection of NoteNotebook resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/observatory
  title: getObservatoryCollection
  description: The collection of Observatory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/room
  title: getRoomCollection
  description: The collection of Room resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/seedTray
  title: getSeedTrayCollection
  description: The collection of SeedTray resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/studio
  title: getStudioCollection
  description: The collection of Studio resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/map
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Map
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Map resources.
  method: GET
  returns: Collection
  title: getMapCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Map resource.
  expects: Map
  method: POST
  returns: Map
  title: postMap

Entrypoint/garden
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Garden
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Garden resources.
  method: GET
  returns: Collection
  title: getGardenCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Garden resource.
  expects: Garden
  method: POST
  returns: Garden
  title: postGarden

Entrypoint/machine
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Machine
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Machine resources.
  method: GET
  returns: Collection
  title: getMachineCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Machine resource.
  expects: Machine
  method: POST
  returns: Machine
  title: postMachine

Entrypoint/model
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Model
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Model resources.
  method: GET
  returns: Collection
  title: getModelCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Model resource.
  expects: Model
  method: POST
  returns: Model
  title: postModel

Entrypoint/modelObject
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ModelObject
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ModelObject resources.
  method: GET
  returns: Collection
  title: getModelObjectCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ModelObject resource.
  expects: ModelObject
  method: POST
  returns: ModelObject
  title: postModelObject
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Note resources.
  method: GET
  returns: Collection
  title: getNoteCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Note resource.
  expects: Note
  method: POST
  returns: Note
  title: postNote

Entrypoint/noteNotebook
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: NoteNotebook
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of NoteNotebook resources.
  method: GET
  returns: Collection
  title: getNoteNotebookCollection
supported operation: Operation
  type: CreateAction
  description: Creates a NoteNotebook resource.
  expects: NoteNotebook
  method: POST
  returns: NoteNotebook
  title: postNoteNotebook

Entrypoint/observatory
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Observatory
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Observatory resources.
  method: GET
  returns: Collection
  title: getObservatoryCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Observatory resource.
  expects: Observatory
  method: POST
  returns: Observatory
  title: postObservatory

Entrypoint/room
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Room
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Room resources.
  method: GET
  returns: Collection
  title: getRoomCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Room resource.
  expects: Room
  method: POST
  returns: Room
  title: postRoom

Entrypoint/seedTray
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SeedTray
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of SeedTray resources.
  method: GET
  returns: Collection
  title: getSeedTrayCollection
supported operation: Operation
  type: CreateAction
  description: Creates a SeedTray resource.
  expects: SeedTray
  method: POST
  returns: SeedTray
  title: postSeedTray

Entrypoint/studio
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Studio
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Studio resources.
  method: GET
  returns: Collection
  title: getStudioCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Studio resource.
  expects: Studio
  method: POST
  returns: Studio
  title: postStudio

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

SupportedProperty
property: ModelObject/previewImageUrl
title: previewImageUrl
required: false
readable: true
writeable: true
description: Open Graph / oEmbed thumbnail URL for pathway display (e.g. observatory video-from-URL items).

SupportedProperty
property: ModelObject/showingKind
title: showingKind
required: false
readable: true
writeable: true

SupportedProperty
property: ModelObject/note
title: note
required: false
readable: true
writeable: true

SupportedProperty
property: ModelObject/notePinned
title: notePinned
required: false
readable: true
writeable: true

SupportedProperty
property: ModelObject/tags
title: tags
required: false
readable: true
writeable: true

SupportedProperty
property: ModelObject/notebooks
title: notebooks
required: false
readable: true
writeable: true

Operation
type: FindAction
description: Retrieves a ModelObject resource.
method: GET
returns: ModelObject
title: getModelObject

Operation
description: Updates the ModelObject resource.
expects: ModelObject
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: ModelObject
title: patchModelObject

Operation
type: DeleteAction
description: Deletes the ModelObject resource.
method: DELETE
returns: owl:Nothing
title: deleteModelObject

Operation
type: FindAction
description: Retrieves a Note resource.
method: GET
returns: Note
title: getNote

Operation
description: Updates the Note resource.
expects: Note
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: Note
title: patchNote

Operation
type: DeleteAction
description: Deletes the Note resource.
method: DELETE
returns: owl:Nothing
title: deleteNote