Skip to content

Datasets_DeleteDataset

DELETE
/v1/accounts/{account}/datasets/{dataset}
curl --request DELETE \
--url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example \
--header 'X-API-Key: <X-API-Key>'

Deletes a mixture, or retires an upload or a merged dataset: it leaves every list and its episodes leave every mixture, but nothing is erased, and versions that pin its episodes keep resolving. A merged dataset is retired with the uploads it holds (QUA-3511), which then answer NOT_FOUND; an upload bound to append to it that it does not hold (not appended yet, or taken back out before merges were final) is unbound. Refused with FAILED_PRECONDITION while another mixture reads it by name (for a merged dataset, also a pin of one of its uploads’ tags; any other source left on one of them reads nothing and does not hold it); a mixture that reads it through a label source stops reading it. An upload merged into another is not deleted on its own (FAILED_PRECONDITION naming the merged dataset). A dataset whose episodes are references of Tasks (Dataset.task_references) is refused too unless sent with force, which removes those references.

account
required
string

The account id.

dataset
required
string

The dataset id.

etag
string

The dataset’s current etag, when the caller wants the guard.

force
boolean

Delete it even though its episodes are references of Tasks (Dataset.task_references), removing those references; the Tasks stay. Without it, such a dataset is refused (FAILED_PRECONDITION). Reingests and the ingest report live under uploads and are never deleted here.

OK

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}