Dataset routes: update, delete

Reference for Dataset, one group of Dataset routes.

Dataset.update

Changes the given properties of a Dataset. Verb page.

Text

PATCH /{namespace}/datasets/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Dataset.
`name`	`string`		The name of the Product.
`promise`	`text`		What the Customer can rely on.
`records`	`integer`		How many Things it holds.
`refreshedAt`	`datetime`		When its Sources were last read.

Returns

Output	Type	Required	Description
`dataset`	Dataset	required	The Dataset.

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/ratebook.dev/datasets/dataset_UDQXk0KsJB \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"records":1}'

JSON

{
  "api": "https://api.sb/ratebook.dev",
  "dataset": {
    "$id": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
    "$type": "Dataset",
    "name": "Ratebook",
    "promise": "A rate for any US address in under 100 milliseconds.",
    "status": "draft",
    "records": 1
  },
  "action": {
    "$id": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq",
    "operation": "Dataset.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq"
  }
}

Dataset.delete

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