Skip to content

Relationship programs: update, delete

The Relationship Verbs update, delete as MCP do programs, with inputs, result, refusals and an example.

Reference for Relationship, one group of Relationship programs.

Relationship.update

Changes the given properties of a Relationship. Verb page.

Text
do: return await $.Relationship.update(input)

Emits Relationship.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Relationship.
predicatestringThe name read from the source, such as makes.
inversestringThe name read from the target, such as madeBy.
provenancestringWho asserted it: Stated, Ratified, Inferred, or Observed.

Returns

OutputTypeRequiredDescription
relationshipRelationshiprequiredThe Relationship.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Relationship.update({ id: 'relationship_iUVcHztTJh', provenance: 'Stated' })"
  }
}

Relationship.delete

Deletes a Relationship: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
do: return await $.Relationship.delete(input)

Emits Relationship.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Relationship.

Returns

OutputTypeRequiredDescription
relationshipRelationshiprequiredThe Relationship.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Relationship.delete({ id: 'relationship_iUVcHztTJh' })"
  }
}