DeleteFile
Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
No |
The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID. You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation. |
10000 |
| ProjectIdentifier |
string |
No |
The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation. |
dw_project |
| FileId |
integer |
Yes |
The file ID. You can call the ListFiles operation to obtain the folder ID. |
10000201 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned result. |
||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| DeploymentId |
integer |
If the file has already been submitted, the DeleteFile operation also triggers an asynchronous deletion process in the scheduling system. You must use the DeploymentId returned by the DeleteFile operation to call GetDeployment and poll the status of the triggered asynchronous deletion process. If this field is empty, the file has been deleted and no further polling is required. |
1000000001 |
| RequestId |
string |
The request ID. Used for troubleshooting when an error occurs. |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
The error message. |
The connection does not exist. |
| Success |
boolean |
Indicates whether the call was successful. Valid values:
|
true |
| ErrorCode |
string |
The error code. |
Invalid.Tenant.ConnectionNotExists |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"DeploymentId": 1000000001,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "The connection does not exist.",
"Success": true,
"ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.