Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
branch - master for most enrollments. The file will still be visible on historical views.
See Datasets Core Concepts for details on using branches and transactions.
To delete a File from a specific Branch specify the Branch's name as branchName. A new delete Transaction
will be created and committed on this branch.
To delete a File using a manually opened Transaction, specify the Transaction's resource identifier
as transactionRid. The transaction must be of type DELETE. This is useful for deleting multiple files in a
single transaction. See createTransaction to
open a transaction.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write.
stringThe Resource Identifier (RID) of a Dataset.
stringThe path to a File within Foundry. Examples: my-file.txt, path/to/my-file.jpg, dataframe.snappy.parquet.
stringThe name of the Branch on which to delete the File. Defaults to master for most enrollments.
stringThe Resource Identifier (RID) of the open delete Transaction on which to delete the File.
1
2
3
curl -X DELETE \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files/My Folder/my-file.csv?branchName=master&transactionRid=ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4"| Error Name | ||
|---|---|---|
Branch | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested branch could not be found, or the client token does not have access to it. | |
| Parameters | datasetRid, branchName | |
File | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested file could not be found on the given branch, or the client token does not have access to it. | |
| Parameters | datasetRid, branchName, path | |
Open | Error Code | CONFLICT |
| Status Code | 409 | |
| Description | A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. | |
| Parameters | datasetRid, branchName | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The given parameters are individually valid but cannot be used in the given combination. | |
| Parameters | validCombinations, providedParameters | |
Dataset | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested dataset could not be found, or the client token does not have access to it. | |
| Parameters | datasetRid | |
Transaction | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested transaction could not be found on the dataset, or the client token does not have access to it. | |
| Parameters | datasetRid, transactionRid | |
File | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested file could not be found on the given transaction range, or the client token does not have access to it. | |
| Parameters | datasetRid, startTransactionRid, endTransactionRid, path | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The given transaction type is not valid. Valid transaction types are `SNAPSHOT`, `UPDATE`, `APPEND`, and `DELETE`. | |
| Parameters | datasetRid, transactionRid, transactionType | |
Transaction | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The given transaction is not open. | |
| Parameters | datasetRid, transactionRid, transactionStatus | |
Open | Error Code | CONFLICT |
| Status Code | 409 | |
| Description | A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. | |
| Parameters | datasetRid, branchName | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to create a transaction on this dataset. | |
| Parameters | datasetRid, branchName | |
Abort | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to abort the given transaction on the given dataset. | |
| Parameters | datasetRid, transactionRid | |
Commit | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to commit the given transaction on the given dataset. | |
| Parameters | datasetRid, transactionRid | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. | |
| Parameters | branchName | |
Delete | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not delete the File. | |
| Parameters | datasetRid, filePath | |
See Errors for a general overview of errors in the platform.