claim.key · Umwelt docs

Reference/Queries/claim.key

claim.keyquerysince 0.1

The stable keys of a claim, computed by the engine.

Command lineTypeScript.NET

Request

umwelt call story.umw claim.key '{
  "claim": {
    "subject": "bob",
    "predicate": "stole",
    "object": { "kind": "entity", "id": "necklace" },
    "polarity": true
  }
}'

Request

const result = await client.claimKey({ claim: theft });

Request

var result = engine.ClaimKey(new ClaimKeyPayload { Claim = theft });

Response

{
  "claimKey": "9190cc6f09646e8a3c8a74744d3e40477182a00d36dfdaa214b9fcdb99b0f5dd",
  "slotKey": "1ec1655c01d034e62795d7a4cb3d0d5624fb1354a7a3c9c77b12108d5785e0a3"
}

Payload

Field	Type	Description
`claim`required	Claim	The claim, by its parts: subject, predicate, object and polarity.

Result

Field	Type	Description
`claimKey`always	string	Identifies the claim, whatever its polarity.
`slotKey`always	string	Identifies its subject and predicate.

Rules

Polarity is not part of the key. A claim and its negation have the same claimKey.

Ask the engine instead of hashing. The canonical form tells 1 from 1.0, which not every language can. A key from this operation is always the one the engine uses.

It reads nothing. The answer depends only on the claim: no project and no file are involved.

Errors

VALIDATION_FAILEDThe payload is malformed.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also