API Reference

Delete File

DELETE/api/v2/datasets/{datasetRid}/files/{filePath}

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.

Advanced Usage

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.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

filePath

string

The path to a File within Foundry.

Query parameters

branchName

string

optional

The name of the Branch on which to delete the File. Defaults to master for most enrollments.

transactionRid

string

optional

The Resource Identifier (RID) of the open delete Transaction on which to delete the File.

Examples

Request

Copied!

curl -X DELETE \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files/2020/09/30/trades.csv?branchName=master&transactionRid=ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4"

Error responses

Error Name
`BranchNotFound`	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`
`FileNotFoundOnBranch`	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`
`OpenTransactionAlreadyExists`	Error Code	`CONFLICT`
	Status Code	404
	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`
`DeleteFilePermissionDenied`	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.