Software routes: update, delete
The Software Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.
Reference for Software, one group of Software routes.
Software.update
Changes the given properties of a Software. Verb page.
PATCH /{namespace}/ software/ {id}Path: id. Body, as JSON: the other inputs. Emits Software.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Software. |
name | string | The name of the Product. | |
promise | text | What the Customer can rely on. | |
headless | boolean | True when it ships without screens of its own. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
software | Software | required | The Software. |
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
curl -X PATCH https: //api.sb/ leaseline.app/ software/ software_D5qhJn6mF5 \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"headless": true}'{
"api": "https: //api.sb/ leaseline.app",
"software": {
"$id": "https: //api.sb/ leaseline.app/ software/ software_D5qhJn6mF5",
"$type": "Software",
"name": "Leaseline",
"promise": "No renewal slips past its date.",
"status": "draft",
"headless": true
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Software.update",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}Software.delete
Deletes a Software: a soft delete that keeps its history, undone by Thing.restore. Verb page.
DELETE /{namespace}/ software/ {id}Path: id. Emits Software.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Software. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
software | Software | required | The Software. |
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
curl -X DELETE https: //api.sb/ leaseline.app/ software/ software_D5qhJn6mF5 \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"{
"api": "https: //api.sb/ leaseline.app",
"software": {
"$id": "https: //api.sb/ leaseline.app/ software/ software_D5qhJn6mF5",
"$type": "Software",
"name": "Leaseline",
"promise": "No renewal slips past its date.",
"status": "draft"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Software.delete",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}