Centro de suporte da Workiva

Introdução

Este artigo explica como substituir um arquivo no Wdata usando as APIs da Workiva. Você recuperará o arquivo existente, desimportará e excluirá o arquivo e, em seguida, carregará uma nova versão.

Pré-requisitos

Antes de começar, verifique se você concluiu todas as etapas do guia Importing Workiva API Collections into Postman. Isso garante que sua coleção de APIs e variáveis de ambiente estejam configuradas corretamente.

Autenticação

1. Abra o espaço de trabalho do Postman e confirme se está usando o ambiente correto.
2. Expanda a coleção IAM Services, abra a pasta oauth2 e selecione a solicitação Retrieve a token.
3. Clique em Send para gerar seu token de autenticação. O token é armazenado automaticamente na variável de ambiente {{access_token}} e será usado em todas as chamadas de API subsequentes.

Observação: os tokens expiram após 600 segundos (10 minutos). Quando isso acontecer, basta repetir esta etapa para gerar um novo.

Recuperar o ID do arquivo usando a API Retrieve a List of Files (Recuperar uma lista de arquivos)

Antes de fazer upload ou substituir um arquivo em uma tabela Wdata, confirme se o arquivo já existe. Você pode fazer isso usando a API Retrieve a List of Files para localizar o arquivo e obter seu File ID.

Siga as etapas abaixo.

1. Abra o ponto de extremidade da API
   • Acesse Wdata API → File → Retrieve a List of Files.
2. Insira os parâmetros necessários
   • TableId: o ID de sua tabela Wdata
   • SearchText: o nome do arquivo (por exemplo, Control Table (3).csv)
3. Executar a solicitação
   • A API retornará todos os arquivos que correspondem à sua pesquisa.
4. Localizar o ID do arquivo
   • Na resposta JSON, procure por:
     • id → o ID do arquivo
     • name → confirma o arquivo correto

(Opcional) Verificar no Wdata
Abra o conjunto de dados na interface do usuário e confirme se o ID do arquivo corresponde.

Desimportar o arquivo usando o ID do arquivo

Use o ponto de extremidade Unimport a single file para remover um arquivo importado de uma tabela Wdata. Essa etapa prepara a tabela para receber um arquivo de substituição.

1. No Postman, abra a solicitação Unimport a single file.
2. Em Path Variables, defina:
   • TableId para o ID de sua tabela Wdata.
   • FileId para o ID do arquivo recuperado na etapa anterior.
3. Clique em Send para executar a solicitação.
4. No corpo da resposta, confirme que o registro do arquivo agora mostra um status atualizado (por exemplo, movido de volta para staged). 
   
5. Em Wdata → Datasets, abra o conjunto de dados e verifique se o arquivo não é mais exibido como importado. 
   

Excluir o arquivo usando o ID do arquivo

1. No Postman, abra a solicitação Delete a single file.
2. Em Path Variables, cole o mesmo fileId.
3. Envie a solicitação.
4. Confirme se o corpo da resposta retorna que fileId, isso confirma que o arquivo foi excluído da tabela.

Opcional: Desimporte e exclua o arquivo em uma única etapa usando force=true

Por padrão, quando um arquivo não é importado, ele é removido da tabela e retorna ao modo de preparação, mas não é excluído. Para remover permanentemente o arquivo como parte de uma única operação, inclua o parâmetro de consulta force.

Quando force=true é especificado, o arquivo é desimportado e excluído em uma única solicitação. Não é necessária uma chamada separada à API Delete a single file.

Exemplo:

DELETE /api/v1/table/{tableId}/import/{fileId}?force=true 

Faça upload do novo arquivo

Após remover o arquivo anterior, siga as etapas do guia Upload and Import a File para fazer upload e importar a nova versão.