Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarRelationship

Relationship routes: create, get, list

The Relationship Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Relationship, one group of Relationship routes.

Relationship.create

Creates a Relationship. Verb page.

Text
POST /{namespace}/relationships

Body, as JSON: the inputs. Emits Relationship.created.

Inputs

InputTypeRequiredDescription
predicatestringrequiredThe name read from the source, such as makes.
inversestringrequiredThe name read from the target, such as madeBy.
provenancestringWho asserted it: Stated, Ratified, Inferred, or Observed.
verbVerbA Relationship reads through a Verb whose forms name it from each side, such as makes and madeBy.

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

Terminal
curl -X POST https://api.sb/leaseline.app/relationships \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"predicate":"Example predicate","inverse":"Example inverse"}'
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"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Relationship.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Relationship.get

Returns one Relationship by id. Verb page.

Text
GET /{namespace}/relationships/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Relationship.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

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

Terminal
curl https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Relationship",
  "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
  "relationship": {
    "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
    "$type": "Relationship",
    "predicate": "Example predicate",
    "inverse": "Example inverse"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
    "up": "https://api.sb/leaseline.app/relationships"
  }
}

Relationship.list

Returns Relationships, newest first, one page at a time. Verb page.

Text
GET /{namespace}/relationships

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
relationshipslist of RelationshiprequiredOne page of Relationships.

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

Terminal
curl "https://api.sb/leaseline.app/relationships?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Relationship",
  "relationships": [
    {
      "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
      "$type": "Relationship",
      "predicate": "Example predicate",
      "inverse": "Example inverse"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "relationship_iUVcHztTJh"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/relationships?limit=20",
    "next": "https://api.sb/leaseline.app/relationships?after=relationship_iUVcHztTJh"
  }
}

Relationship

Previous

update, delete

Next