All Products
Search

This Product

    DataWorks:DeleteFile

    Document Center

    DataWorks:DeleteFile

    Last Updated:Jan 12, 2026

    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.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ProjectIdlongNo

    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
    ProjectIdentifierstringNo

    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
    FileIdlongYes

    The file ID. You can call the ListFiles operation to obtain the folder ID.

    		10000201

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned result.

    HttpStatusCodeinteger

    The HTTP status code.

    		200
    DeploymentIdlong

    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
    RequestIdstring

    The request ID. Used for troubleshooting when an error occurs.

    		0000-ABCD-EFG****
    ErrorMessagestring

    The error message.

    		The connection does not exist.
    Successboolean

    Indicates whether the call was successful. Valid values:

    • true: success.
    • false: failure.
    		true
    ErrorCodestring

    The error code.

    		Invalid.Tenant.ConnectionNotExists

    Examples

    Sample success responses

    JSONformat

    {
  "HttpStatusCode": 200,
  "DeploymentId": 1000000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

    Error codes

    HTTP status codeError codeError messageDescription
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
    429Throttling.ApiThe request for this resource has exceeded your available limit.-
    429Throttling.SystemThe DataWorks system is busy. Try again later.-
    429Throttling.UserYour request is too frequent. Try again later.-
    500InternalError.SystemAn internal system error occurred. Try again later.-
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

    For a list of error codes, visit the Service error codes.