whoHolds · Umwelt docs

Reference/Queries/whoHolds

whoHoldsquerysince 0.1

Everyone who holds a claim at a position, believers of the opposite included.

Command lineTypeScript.NET

Request

umwelt call story.umw whoHolds '{
  "projectId": "ball",
  "claim": {
    "subject": "bob",
    "predicate": "stole",
    "object": { "kind": "entity", "id": "necklace" },
    "polarity": true
  },
  "at": { "tick": 3 }
}'

Request

const result = await client.whoHolds({ projectId: 'ball', claim: theft, at: { tick: 3 } });

Request

var result = engine.WhoHolds(new WhoHoldsPayload
{
    ProjectId = "ball",
    Claim = theft,
    At = new At { Tick = 3 },
});

Response

[
  {
    "holder": "ana",
    "attitude": "knows",
    "confidence": 1.0,
    "polarity": true,
    "recordId": "ana-saw"
  },
  {
    "holder": "bob",
    "attitude": "knows",
    "confidence": 1.0,
    "polarity": true,
    "recordId": "bob-did"
  },
  {
    "holder": "duchess",
    "attitude": "believes",
    "confidence": 0.8,
    "polarity": false,
    "recordId": "duchess-told"
  }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`claim`	Claim	The claim, by its parts: subject, predicate, object and polarity. Give `claim` or `claimKey`.
`claimKey`	string	The claim by its stable key. See Claim keys.
`at`	Atdefault {}	Where to read: `tick`, an optional `axis`, and `asOfVersion`. Defaults to the latest.
`filter`	WhoHoldsFilterdefault {"attitude":[]}	Narrows the list: `attitude` (any of the ones listed), `polarity`, and `memberOf`, only members of that group at the position.
`timelineId`	stringdefault "main"	The timeline to read.

Result

A list of WhoHoldsItem, each with:

Field	Type	Description
`holder`always	string	Who holds it.
`attitude`always	"knows" \| "believes" \| "suspects" \| "remembers"	How it is held.
`confidence`always	number	Between 0 and 1.
`polarity`always	boolean	True: they hold the claim. False: they hold that it is not so.
`recordId`always	string	The Holding behind it: the latest, in story order.

Rules

Being there is not knowing. Participants of the event, people aware of the subject and members of a group are not listed unless they hold the claim themselves.

Both polarities answer. Someone who holds that the claim is false is listed, with polarity: false. Filter on polarity to keep one side.

Membership is read at the position. With memberOf, a member who left the group before at is not counted.

Errors

VALIDATION_FAILEDThe payload is malformed, or gives neither claim nor claimKey.

NOT_FOUNDThe project 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