Skip to content

List Situations

GET
/api/divinity/authored-library/situations

Return every registered situation with headline counts.

Successful Response

AuthoredLibrarySituationListResponse

Response body for GET /situations.

object
situations
required
Situations
Array<object>
AuthoredLibrarySituationSummary

Lightweight situation entry for the GET /situations list response.

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
variantCount
required
Variantcount
integer
genreVariantCount
required
Genrevariantcount
integer
sourcePath
required
Sourcepath
string