Para inserir ou atualizar entidades com campos dinâmicos de opções pré-cadastradas, é necessário saber todas as opções disponíveis. Para tanto, existe um endpoint específico na API do Ploomes.

Antes de listar as opções de um determinado campo, vamos pegar algum deles como exemplo. A requisição abaixo lista todos os campos de Opções pré-cadastradas de Clientes:

https://api2.ploomes.com/Fields?$filter=TypeId+eq+7+and+EntityId+eq+1

Note que para cada campo existirá a propriedade 'OptionsTableId'. É ela que precisamos para listar todas as opções cadastradas para este campo. O campo em questão é o 'Porte', que é customizado para esta conta. Se quisermos então saber quais todos os 'Portes' cadastrados, precisamos fazer outra requisição 'GET' para o seguinte endereço:

https://api2.ploomes.com/Fields@OptionsTables?$expand=Options&$filter=Id+eq+2922

O retorno neste caso foi o seguinte:

Com isso, sabemos que se quisermos inserir uma empresa e informar que é de porte Grande, devemos inserir o objeto campo no array de campos da seguinte maneira:

{
  'FieldKey' : 'contact_D6A14C01-2617-4629-A851-BC58DDD72B72',
  'IntegerValue' : 38466
}

O FieldKey 'contact_D6A14C01-2617-4629-A851-BC58DDD72B72' é a chave do campo encontrada no GET em Fields e o Id '3866' representa o Porte 'G' no GET de OptionsTables, e a propriedade usada é o 'IntegerValue'.

Encontrou sua resposta?