Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductBuild and shipMapping

Mapping routes: create, get, list

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

Reference for Mapping, one group of Mapping routes.

Mapping.create

Creates a Mapping. Verb page.

Text
POST /{namespace}/mappings

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

Inputs

InputTypeRequiredDescription
verbstringThe Verb it serves, such as Meeting.book; a Verb has many Mappings, ranked.
fieldsjsonEach outside field or event and the Noun property or Event it maps to.
directionstringboth still keeps db.sb the record; the outside tool never becomes a second one.
converttextHow a value changes on the way, such as cents to money or a picklist to closed values.
rankintegerOrder tried when the preferred Mapping fails or finds nothing; the Policy orders it by cost per accepted result.
preferredbooleanTrue for the Mapping a Verb tries first.
doorstringHow the outside endpoint is classed; an unclassed write is one-way and waits its delay window.
sourceSourceA Source reaches the registry’s Nouns and Verbs through its Mappings, one per Verb it serves.

Returns

OutputTypeRequiredDescription
mappingMappingrequiredThe Mapping.

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/ratebook.dev/mappings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"Meeting.book"}'
JSON
{
  "api": "https://api.sb/ratebook.dev",
  "mapping": {
    "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
    "$type": "Mapping",
    "verb": "Meeting.book",
    "fields": {}
  },
  "action": {
    "$id": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq",
    "operation": "Mapping.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq"
  }
}

Mapping.get

Returns one Mapping by id. Verb page.

Text
GET /{namespace}/mappings/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
mappingMappingrequiredThe Mapping.

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/ratebook.dev/mappings/mapping_WOromrQi6J \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Mapping",
  "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
  "mapping": {
    "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
    "$type": "Mapping",
    "verb": "Meeting.book",
    "fields": {}
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
    "up": "https://api.sb/ratebook.dev/mappings"
  }
}

Mapping.list

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

Text
GET /{namespace}/mappings

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
mappingslist of MappingrequiredOne page of Mappings.

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/ratebook.dev/mappings?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Mapping",
  "mappings": [
    {
      "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
      "$type": "Mapping",
      "verb": "Meeting.book",
      "fields": {}
    }
  ],
  "meta": {
    "limit": 20,
    "after": "mapping_WOromrQi6J"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/mappings?limit=20",
    "next": "https://api.sb/ratebook.dev/mappings?after=mapping_WOromrQi6J"
  }
}

Mapping

Previous

update, delete

Next