Como limpar campos em massa via API
Douglas Aliot avatar
Escrito por Douglas Aliot
Atualizado há mais de uma semana

🔐 Disponível para todos os planos

🎯 Para quem quer atualizar informações de cards em massa

⏩ Resumo:

Aprenda a tirar o máximo proveito da API do Pipefy para realizar consultas e ações para limpar campos em massa:

  • Identifique o ID do seu Pipe;

  • Utilize queries na API para identificar os IDs dos campos que deseja limpar;

  • Use mutations para limpar os valores dos campos indicados;

  • Atente-se ao volume de chamadas de API disponíveis em seu plano.

Como limpar campos em massa

É possível limpar campos em massa utilizando a API do Pipefy (GraphiQL). Na API, é possível realizar consultas (queries) e ações (mutations) em seus processos. Saiba mais sobre como usar a API do Pipefy.

📢 Atenção: Para que você possa utilizar a API, você precisa ter a função de administrador na empresa. Saiba mais sobre funções e permissões no Pipefy.

Apesar de ser necessário um pouco de código, neste artigo você encontrará todos os passos necessários para que você faça as atualizações.

Você vai precisar realizar algumas ações dentro do pipe que deseja limpar os campos e depois na API do Pipefy.

Dentro do pipe que deseja atualizar cards

Para começar, você precisará do ID do pipe que quer limpar os campos em massa. Acessando o pipe, você encontrará o ID na URL.

Você também precisará do ID do card que contém os campos a serem limpados. Abra o card. O ID está localizado no final da URL.

Na API do Pipefy

Agora que você já tem o ID do pipe e dos cards que quer atualizar, você vai precisar realizar uma query para identificar os IDs dos campos que quer atualizar.

📢 Atenção: Recomendamos que teste um card antes de adicionar outros, assim você pode consultar os resultados e garantir que não terá problemas ao atualizar mais cards em massa. Sugerimos que faça as alterações em levas de até 30 cards, assim você evita o bloqueio do seu IP.

Acesse a API e siga as instruções abaixo:

Na parte esquerda da tela, você precisará colar a seguinte query, substituindo o ID do pipe pelo código que identificou no primeiro passo, dentro do pipe.

{
pipe(id: ID do Pipe) {
id
name
start_form_fields {
label
id
internal_id
}labels {
name
id
}
phases {
name
fields {
label
id
internal_id
}
}
}
}

A query deverá estar parecida com esta:

No lado direito, você terá a lista com as informações solicitadas:

  • Os campos do formulário inicial com os IDs, Etiquetas e internal_id;

  • Os campos das fases com os IDs, Etiquetas e internal_id.

Você precisará do ID do campo que quer atualizar, então procure na lista o valor necessário. Vamos supor que queremos atualizar os valores no campo Nome do solicitante.

O ID do campo Nome do solicitante, na Formulário Inicial, é nome_do_solicitante.

Com as informações que você tem em mãos, você pode construir a mutation a seguir alterando as informações.
​Para limpar os campos, é necessário que a informação no campo new_value seja igual a aspas duplas (""):

mutation{
updateCardField(input:{
card_id:ID do card
field_id:"ID do campo"
new_value:""
})
}

Após rodar a query no GraphiQL, esse será o resultado:

📢 Atenção: Atente-se ao rodar atualizações ou consultas em massa, uma vez que as chamadas de API consomem parte dos limites do seu plano. Saiba mais sobre os limites dos planos.

Conteúdos relacionados

🎓 Aprenda a fazer muito mais com os cursos gratuitos da Pipefy Academy!

🌎 Faça parte da Comunidade do Pipefy para tirar dúvidas, compartilhar sugestões, ficar por dentro das novidades e dividir seu conhecimento com pessoas do mundo todo!

Respondeu à sua pergunta?