dispositions · Umwelt docs

Reference/Queries/dispositions

dispositionsquerysince 0.1

How a holder stands toward others at a position: their current Dispositions, optionally toward one target or along one dimension.

Command lineTypeScript.NET

Request

umwelt call story.umw dispositions '{
  "projectId": "ball",
  "holder": "duchess",
  "target": "bob",
  "at": { "tick": 5 }
}'

Request

const result = await client.dispositions({ projectId: 'ball', holder: 'duchess', target: 'bob', at: { tick: 5 } });

Request

var result = engine.Dispositions(new DispositionsPayload
{
    ProjectId = "ball",
    Holder = "duchess",
    Target = "bob",
    At = new At { Tick = 5 },
});

Response

[
  {
    "kind": "disposition",
    "id": "01a1cbd8-63eb-7582-b85c-f6eb411602a1",
    "projectId": "ball",
    "timelineId": "main",
    "eventId": "01a1cbd8-63eb-7582-b85c-f6d27a940591",
    "holder": "duchess",
    "target": "bob",
    "dimension": "trust",
    "value": 0.9,
    "position": { "tick": 5 },
    "provenance": { "origin": { "kind": "system", "name": "umwelt:disposition" } },
    "recordedAt": 8
  }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`holder`required	string	The agent or group asked about.
`target`	string	Only the Dispositions toward this entity.
`dimension`	string	Only this dimension, such as `trust`.
`at`	Atdefault {}	Where to read: `tick`, an optional `axis`, and `asOfVersion`. Defaults to the latest.
`timelineId`	stringdefault "main"	The timeline to read.

Result

A list of Record, each with:

Field	Type	Description
`kind`always	"disposition"	Always a Disposition.
`holder`always	string	Who feels it: the holder asked about.
`target`always	string	Toward whom.
`dimension`always	string	Along which dimension, such as `trust` or `fear`.
`value`always	any JSON	The current value, as your application set it.
`id`always	string	The record’s id.
`eventId`always	string	The event it was written in.
`position`always	Position	Where it was set in the story.
`recordedAt`always	integer	The version that wrote it.
`provenance`always	Provenance	Who or what set it.

Ordered by target, then dimension. An empty list when the holder feels nothing toward the target asked about.

Rules

The current value only. For each target and dimension, the newest active Disposition at the position. Earlier values stay readable at earlier positions.

One direction. What a holder feels toward a target says nothing about what the target feels toward them.

The feelings of a perspective, alone. The same records perspective returns in dispositions, without its Holdings, awareness and memberships.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project, holder or timeline does not exist, or the draft read was purged.

INVALID_STATEThe timeline read is a draft that was promoted. details.promotedInto names the timeline to read instead.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also