Todos os produtos
Search
Central de documentação

DataWorks:DeleteFile

Última atualização: Sep 29, 2026

Exclui um arquivo do Data Studio. Se o arquivo tiver sido submetido, um processo assíncrono será acionado para excluir o arquivo no sistema de agendamento. O valor do parâmetro DeploymentId retornado é usado para chamar a operação GetDeployment a fim de consultar o status do processo assíncrono.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ProjectId

integer

Não

O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o ID.

Você deve especificar este parâmetro ou o parâmetro ProjectIdentifier para identificar o espaço de trabalho do DataWorks ao chamar esta operação.

10000

ProjectIdentifier

string

Não

O nome do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para consultar o nome.

Você deve especificar este parâmetro ou o parâmetro ProjectId para identificar o espaço de trabalho do DataWorks ao chamar esta operação.

dw_project

FileId

integer

Sim

O ID do arquivo. Você pode chamar a operação ListFiles para obter o ID do arquivo.

10000201

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O resultado retornado.

HttpStatusCode

integer

O código de status HTTP.

200

DeploymentId

integer

Se o arquivo já tiver sido submetido, a operação DeleteFile também aciona um processo de exclusão assíncrono no sistema de agendamento. Você deve usar o DeploymentId retornado pela operação DeleteFile para chamar GetDeployment e consultar o status do processo de exclusão assíncrono acionado.

Se este campo estiver vazio, o arquivo foi excluído e nenhuma outra consulta é necessária.

1000000001

RequestId

string

O ID da solicitação. Usado para solução de problemas quando ocorre um erro.

0000-ABCD-EFG****

ErrorMessage

string

A mensagem de erro.

The connection does not exist.

Success

boolean

Indica se a chamada foi bem-sucedida. Valores válidos:

  • true: sucesso.

  • false: falha.

true

ErrorCode

string

O código de erro.

Invalid.Tenant.ConnectionNotExists

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

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. Acesso negado. Autorize o acesso.
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.