Exemplos do campo de pesquisa externa em um formulário personalizado

Última atualização: 14 de abril de 2025

Criado para:

  • Administrador

Um campo de pesquisa externo em um formulário personalizado chama uma API externa e retorna valores como opções em um campo suspenso. Os usuários que trabalham com o objeto ao qual o formulário personalizado está anexado podem selecionar uma ou mais dessas opções na lista suspensa.

This article provides examples of using the External lookup field to call the same instance of Workfront or a public API. You can also use the External lookup to communicate with an external system such as Jira, Salesforce, or ServiceNow.

For more information about adding an External lookup field to a custom form and additional definitions of the external lookup components, see Create a custom form.

Set up an External lookup field for the same instance of Workfront

You can use the External lookup to bring data from your Workfront instance into the custom form.

Usar valores de campo nativos do Workfront na pesquisa externa

Este exemplo demonstra como chamar a API do Workfront e preencher uma lista de projetos em um campo de Pesquisa externa, filtrado por status usando o valor do campo personalizado "Consulta de status" e um termo de pesquisa por meio de $$QUERY.

  1. Abra o formulário personalizado.

  2. No lado esquerdo da tela, encontre Pesquisa externa e arraste-a para uma seção da tela.

  3. Insira o Rótulo e o Nome do campo.

  4. Selecione o Formato para o campo.

  5. Insira a chamada de API no campo URL da API base.

    • Use $$HOST para fazer referência à mesma instância do Workfront em que o formulário personalizado está.
    • Use $$QUERY para filtrar dinamicamente os resultados com base na entrada do usuário.

    Exemplo de chamada de API
    $$HOST/attask/api/v15.0/project/search?status={DE:Status Query}&description=$$QUERY

  6. Revise as Dependências para os campos referenciados na chamada de API.

    Um campo de dependência pode ser qualquer campo personalizado ou nativo disponível no objeto. Por exemplo, ao criar um formulário personalizado para grupos que inclui um campo de pesquisa externo, os campos de dependência podem incluir quaisquer campos disponíveis em um grupo.

    Neste exemplo, {DE:Status Query} será substituído dinamicamente pelo valor do campo personalizado "Consulta de status" para o grupo atual. Assim, quando o formulário é anexado ao Grupo A, {DE:Status Query} é substituído pelo valor definido no campo "Consulta de status" para esse grupo.

  7. Selecione o Método HTTP.

    Isto provavelmente será Obter.

  8. Insira o Caminho JSON para obter os resultados da sua chamada à API.

    Exemplo
    $.data[*].name

    NOTE
    As informações do Cabeçalho não são necessárias para uma chamada para a mesma instância do Workfront.

  9. Clique em Aplicar.

    Configuração da chamada de API para o Workfront no formato personalizado

    Quando o formulário personalizado é adicionado a um objeto do Workfront (neste exemplo, um projeto), ele é semelhante a este.

    Formulário personalizado com campo de pesquisa externo

    Opções de pesquisa externa com base no status

Usar valores de campo personalizado na pesquisa externa

This example shows you to call the Workfront API and bring data from a custom field into your External lookup field. The example custom field is called "Custom Colors."

  1. Abra o formulário personalizado.

  2. No lado esquerdo da tela, encontre Pesquisa externa e arraste-a para uma seção da tela.

  3. Insira o Rótulo e o Nome do campo.

  4. Selecione o Formato para o campo.

  5. Insira a chamada da URL da API no campo URL da API de base.

    Exemplo
    $$HOST/attask/api/v18.0/PORT/search?ID={portfolioID}&fields=parameterValues

  6. Revise as Dependências dos campos aos quais este campo de pesquisa faz referência na API.

    Um campo de dependência pode ser qualquer campo personalizado ou nativo existente na página de detalhes do objeto.

  7. Selecione o Método HTTP.

    Isto provavelmente será Obter.

  8. Insira o Caminho JSON para obter os resultados da sua chamada à API.

    Exemplo
    $.data[*].parameterValues.["DE:Combo Colors"]

    • "parameterValues" refere-se a qualquer campo personalizado no Workfront para o objeto em que você está.
    • Neste exemplo, "DE:Combo Colors" é o campo personalizado específico que contém os valores que você deseja recuperar.
    NOTE
    As informações do Cabeçalho não são necessárias para uma chamada para a mesma instância do Workfront.

  9. Clique em Aplicar.

    Quando o formulário personalizado é adicionado a um objeto do Workfront, todos os valores do campo "Cores de combinação" são exibidos na lista suspensa do campo Pesquisa externa.