Skip to content
Ishvana Ishvana Docs

Get Situation Detail

GET
/api/divinity/authored-library/situations/{situation_key}

Return full situation detail including every variant (universal + genre).

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
situation_key
required
Situation Key
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

AuthoredLibrarySituationDetail

Full situation detail for GET /situations/{situation_key}.

object
situationKey
required
Situationkey
string
agent
required
Agent
string
Allowed values: hawken lorekeeper lagan gamemaster worldknowledge shared marketing email
description
required
Description
string
handlerBinding
required
AuthoredLibraryHandlerBindingModel

Handler-binding descriptor for API consumers.

object
handlerName
required
Handlername
string
matchKind
required
Matchkind
string
Allowed values: rule_id_prefix rule_id_set kind query_id always
matchValue
required
Matchvalue
string
targetField
required
Targetfield
string
Allowed values: message summary suggestion explanation body
supportedAlgorithms
required
Supportedalgorithms
Array<string>
Allowed values: hash_deterministic round_robin weighted_random user_preference
contextSlots
required
Contextslots
Array<object>
AuthoredLibraryContextSlotModel

A declared context slot on a situation.

object
name
required
Name
string
type
required
Type
string
Allowed values: string integer float boolean severity enum
required
required
Required
boolean
description
Description
string
""
enumValues
Enumvalues
Array<string>
variants
required
Variants
Array<object>
AuthoredLibraryVariantModel

A single variant as exposed through the API.

source reports whether the variant came from the bundled pack, a user override, or a community pack. source_pack is the filename (bundled) or pack id (community). editorial_status (M15) reports the variant’s shadow-review state — defaults to "approved" for backwards compat with pre-M15 clients.

object
id
required
Id
string
text
required
Text
string
tags
Tags
Array<string>
severityFilter
Severityfilter
Array<string>
Allowed values: error warning info
weight
Weight
number
default: 1
isDefault
Isdefault
boolean
engineVersionMin
Engineversionmin
string
default: 0.0.0
source
required
Source
string
Allowed values: bundled user community
sourcePack
required
Sourcepack
string
genre
Any of:
string
editorialStatus
Editorialstatus
string
default: approved
Allowed values: approved unreviewed flagged
sourcePath
required
Sourcepath
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