Skill routes · StartupBuilder

Reference for Skill.

Noun	System	Run by
Skill	Workforce	People Lead

Skill.create

Creates a Skill. Verb page.

Text

POST /{namespace}/skills

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

Inputs

Input	Type	Required	Description
`level`	`integer`		How well the Worker performs it.

Returns

Output	Type	Required	Description
`skill`	Skill	required	The Skill.

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 POST https://api.sb/leaseline.app/skills \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"level":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "skill": {
    "$id": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
    "$type": "Skill",
    "level": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Skill.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Skill.get

Returns one Skill by id. Verb page.

Text

GET /{namespace}/skills/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Skill.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`skill`	Skill	required	The Skill.

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 https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Skill",
  "$id": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
  "skill": {
    "$id": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
    "$type": "Skill",
    "level": 1
  },
  "links": {
    "self": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
    "up": "https://api.sb/leaseline.app/skills"
  }
}

Skill.list

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

Text

GET /{namespace}/skills

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

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`skills`	list of Skill	required	One page of Skills.

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 "https://api.sb/leaseline.app/skills?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Skill",
  "skills": [
    {
      "$id": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
      "$type": "Skill",
      "level": 1
    }
  ],
  "meta": {
    "limit": 20,
    "after": "skill_xBqG4zTxBA"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/skills?limit=20",
    "next": "https://api.sb/leaseline.app/skills?after=skill_xBqG4zTxBA"
  }
}

Skill.update

Changes the given properties of a Skill. Verb page.

Text

PATCH /{namespace}/skills/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Skill.
`level`	`integer`		How well the Worker performs it.

Returns

Output	Type	Required	Description
`skill`	Skill	required	The Skill.

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/skills/skill_xBqG4zTxBA \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"level":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "skill": {
    "$id": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
    "$type": "Skill",
    "level": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Skill.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Skill.delete

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

Text

DELETE /{namespace}/skills/{id}

Path: id. Emits Skill.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Skill.

Returns

Output	Type	Required	Description
`skill`	Skill	required	The Skill.

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 DELETE https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "skill": {
    "$id": "https://api.sb/leaseline.app/skills/skill_xBqG4zTxBA",
    "$type": "Skill",
    "level": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Skill.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Skill.createCopy Anchor Link

Skill.getCopy Anchor Link

Skill.listCopy Anchor Link

Skill.updateCopy Anchor Link

Skill.deleteCopy Anchor Link

Skill.create

Skill.get

Skill.list

Skill.update

Skill.delete