LeadAPIValidationUtilOOB - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura

    • A inclusão de script LeadAPIValidationUtilOOB fornece métodos que são chamados pela REST API do lead para validar registros de lead e registros de item de linha de lead associados quando eles são criados (POST) ou atualizados (PATCH).

    Se você quiser personalizar como os registros de lead são validados quando os métodos API de lead são chamados, substitua os métodos nesta inclusão de script na inclusão de script LeadAPIValidationUtil. Os nomes dos métodos que você está substituindo na inclusão de script LeadAPIValidationUtil devem ser os mesmos que aqueles no arquivo de inclusão de script LeadAPIValidationUtilOOB.

    Esta API é fornecida no namespace sn_lead_mgmt_core. Para acessar a API, o plug-in Lead Management Data Model (sn_lead_mgmt_core) deve ser ativado na instância e o usuário de chamada deve ter a função sn_lead_mgmt_core.lead_integrator.

    Para obter informações adicionais sobre Gestão de leads, consulte Using Lead Management.

    LeadAPIValidationUtilOOB – validLeadObjectForPatchCall (Objeto leadObject)

    Valida os campos aprovados para um lead especificado e seus itens de linha associados ao atualizar um registro de lead usando o endpoint PATCH da API de lead.

    Este método é acionado pelo método processUpdateLead() na inclusão de script LeadAPIValidationUtilOOB. Este método executa várias validações, como:
    • Verifica se há campos obrigatórios
    • Verifica se o número de telefone e o endereço de e-mail estão no formato apropriado.
    • Verifica os campos de opção e de referência, ignorando quaisquer valores inválidos.
    • Valida a fase e gera um erro se o usuário tentar qualificar um lead.
    Tabela 1. Parâmetros
    Nome Tipo Descrição
    leadObject Objeto Campos a serem atualizados no registro de lead especificado e nos registros de item de linha de lead associados. Para obter uma lista dos campos que podem ser aprovados e os requisitos associados, consulte lead – PATCH /sn_lead_mgmt_core/lead/{sys_id}.
    Tabela 2. Retornos
    Tipo Descrição
    <JSON object> Resultados da validação.
    {
  "errors": [Array],
  "indexesOfleadLineItemsForInsertion": [Array] 
}
    <JSON object>.erros Detalhes dos erros detectados ao validar o lead aprovado e o objeto de item de linha de lead. Retorna uma matriz vazia se nenhum erro for detectado.
    Por exemplo:
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    Essas mensagens de erro estão localizadas na inclusão de script LeadAPIConstantsOOB.

    Tipo de dados: matriz de objetos
    <JSON object>.indexesOfleadLineItemsForInsertion Índices de novos itens de linha de lead que precisam ser inseridos no leadObject.

    Tipo de dados: matriz de números inteiros

    O exemplo de código a seguir mostra onde adicionar seu código personalizado para o método validLeadObjectForPatchCall() na inclusão de script LeadAPIValidationUtil.

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here

validateLeadObjectForPatchCall: function(leadObject) { 
// Add your custom code here
}, 

type: 'LeadAPIValidationUtil' 

});

    LeadAPIValidationUtilOOB – validLeadObjectForPostCall (Objeto leadObject)

    Valida os campos aprovados para um lead especificado e seus itens de linha associados ao criar um registro de lead usando o endpoint POST da API de lead.

    Este método é acionado pelo método processCreateLead() na inclusão de script LeadAPIValidationUtilOOB. Este método executa várias validações, como:
    • Verifica se há campos obrigatórios.
    • Verifica se o número de telefone e o endereço de e-mail estão no formato apropriado.
    • Verifica os campos de opção e de referência, ignorando quaisquer valores inválidos.
    Tabela 3. Parâmetros
    Nome Tipo Descrição
    leadObject Objeto Campos a serem inseridos no novo registro de lead e nos registros de item de linha de lead associados. Para obter uma lista dos campos que podem ser aprovados e os requisitos associados, consulte lead – POST /sn_lead_mgmt_core/lead.
    Tabela 4. Retornos
    Tipo Descrição
    Matriz Detalhes dos erros detectados ao validar o lead aprovado e o objeto de item de linha de lead. Retorna uma matriz vazia se nenhum erro for detectado.
    Por exemplo:
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    Essas mensagens de erro estão localizadas na inclusão de script LeadAPIConstantsOOB.

    O exemplo de código a seguir mostra onde adicionar seu código personalizado para o método validLeadObjectForPostCall() na inclusão de script LeadAPIValidationUtil.

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here 

validateLeadObjectForPostCall: function(leadObject) { 
// Add your custom code
}, 

type: 'LeadAPIValidationUtil' 

});