Relationship routes: update, delete

Reference for Relationship, one group of Relationship routes.

Relationship.update

Changes the given properties of a Relationship. Verb page.

Text

PATCH /{namespace}/relationships/{id}

Path: id. Body, as JSON: the other inputs. Emits Relationship.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Relationship.
`predicate`	`string`		The name read from the source, such as `makes`.
`inverse`	`string`		The name read from the target, such as `madeBy`.
`provenance`	`string`		Who asserted it: `Stated`, `Ratified`, `Inferred`, or `Observed`.

Returns

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provenance":"Stated"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "relationship": {
    "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
    "$type": "Relationship",
    "predicate": "Example predicate",
    "inverse": "Example inverse",
    "provenance": "Stated"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Relationship.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Relationship.delete

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