Todas as coleções
APIs, Segurança e Gestão de TI
APIs
Como obter internal ID de um campo via API
Como obter internal ID de um campo 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 obter o Internal ID de um campo:

  • Identifique o ID do seu Pipe;

  • Utilize queries na API para identificar os Internal IDs dos campos.

Como obter Internal IDs de campos

É possível obte-los 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 obter os Internal IDs

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.

Na API do Pipefy

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

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_ids;

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

Vamos supor que queremos obter o Internal ID do campo Nome do solicitante.

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

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?