Change routes: create, get, list

Reference for Change, one group of Change routes.

Change.create

Creates a Change. Verb page.

Text

POST /{namespace}/changes

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

Inputs

Input	Type	Required	Description
`base`	Version	required	The Version it was drafted against.
`decision`	Decision		Every merged Change traces back to the Decision that authorized it.

Returns

Output	Type	Required	Description
`change`	Change	required	The Change.

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/changes \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"base":"version_4HTEMs14G4"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "change": {
    "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "$type": "Change",
    "status": "Open",
    "base": "version_4HTEMs14G4"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Change.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Change.get

Returns one Change by id. Verb page.

Text

GET /{namespace}/changes/{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 Change.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`change`	Change	required	The Change.

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/changes/change_3Ex8uVSOyQ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Change",
  "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
  "change": {
    "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "$type": "Change",
    "status": "Open",
    "base": "version_4HTEMs14G4"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "up": "https://api.sb/leaseline.app/changes"
  },
  "actions": {
    "merge": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ/merge",
    "revert": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ/revert",
    "review": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ/review"
  }
}

Change.list

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

Text

GET /{namespace}/changes

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
`changes`	list of Change	required	One page of Changes.

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/changes?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Change",
  "changes": [
    {
      "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
      "$type": "Change",
      "status": "Open",
      "base": "version_4HTEMs14G4"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "change_3Ex8uVSOyQ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/changes?limit=20",
    "next": "https://api.sb/leaseline.app/changes?after=change_3Ex8uVSOyQ"
  }
}

Change.createCopy Anchor Link

Change.getCopy Anchor Link

Change.listCopy Anchor Link

Change.create

Change.get

Change.list