Skip to content

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.

Text
PATCH /{namespace}/software/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Software.
namestringThe name of the Product.
promisetextWhat the Customer can rely on.
headlessbooleanTrue when it ships without screens of its own.

Returns

OutputTypeRequiredDescription
softwareSoftwarerequiredThe Software.

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 PATCH https://api.sb/leaseline.app/software/software_D5qhJn6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"headless":true}'
JSON
{
  "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.

Text
DELETE /{namespace}/software/{id}

Path: id. Emits Software.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Software.

Returns

OutputTypeRequiredDescription
softwareSoftwarerequiredThe Software.

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 DELETE https://api.sb/leaseline.app/software/software_D5qhJn6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "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"
  }
}