LeadAPIProcessUtilOOB - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 6 min. de leitura

    • . LeadAPIProcessUtilOOB a inclusão de script fornece métodos que são chamados pelo lead REST API para recuperar registros de lead e seus registros de item de linha de lead associados.

    Se você quiser personalizar como os registros de lead são recuperados quando API do Lead os métodos são chamados, substitua os métodos nesta inclusão de script no LeadAPIProcessUtil inclusão de script. Os nomes dos métodos que você está substituindo no LeadAPIProcessUtil a inclusão de script deve ser igual às do LeadAPIProcessUtilOOB arquivo de inclusão de script.

    Esta API é fornecida no sn_lead_mgmt_core namespace. Para acessar a API, o plug-in Modelo de dados de gestão de leads (sn_lead_mgmt_core) deve ser ativado na instância e o usuário chamador 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.

    LeadAPIProcessUtilOOB - processCreateLead (Object requestBody)

    Processa o corpo da solicitação e cria um lead e todos os itens de linha associados, com base nos parâmetros aprovados.

    Os registros são inseridos nas seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]
    Tabela 1. Parâmetros
    Nome Tipo Descrição
    requestBody Objeto Corpo da solicitação do lead e seus itens de linha de lead relacionados a serem criados.

    Para obter detalhes sobre o conteúdo deste objeto, consulte Lead - PUBLICAR /sn_lead_mgmt_core/lead.
    Tabela 2. Retornos
    Tipo Descrição
    Objeto JSON Detalhes do lead salvo e dos registros de item de linha do lead.

    Tipo de dados: Objeto

    {
  "body": {Object},
  "status": "String"
}
    Corpo.<JSONobject> Corpo da resposta.

    Resposta bem-sucedida: Todos os campos no registro de lead solicitado e todos os campos nos registros de item de linha de lead associados. Para obter uma descrição dos campos retornados, consulte Lead - PUBLICAR /sn_lead_mgmt_core/lead.

    Resposta de erro: Lista de erros detectados ao tentar processar a solicitação. Essas mensagens de erro são definidas em LeadAPIConstants inclusão de script.

    Tipo de dados: Objeto
    <JSONobject>.status Código de status da resposta.

    Esses códigos de status são definidos em LeadAPIConstants inclusão de script.

    Tipo de dados: Cadeia de caracteres

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

processCreateLead: function(requestBody) { 
// Add your custom code 
}, 

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB - processGetAllLeads (Object queryParams, cadeia de caracteres requestUrl)

    Recupera todos os registros de lead e registros de item de linha associados com base nos critérios de filtro aprovados. Este método retorna todos os campos nos registros associados.

    Os detalhes do registro são obtidos das seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]
    Tabela 3. Parâmetros
    Nome Tipo Descrição
    queryParams Objeto Objeto que contém os parâmetros de consulta a serem aplicados ao recuperar os registros de lead. Estes são os parâmetros de consulta passados no Lead - OBTENHA /sn_lead_mgmt_core/lead endpoint.
    Por exemplo: 
    {
  "sysparm_fields":["first_name,last_name,sys_id,lead_line_items"],
  "sysparm_query":["lead_type=new_business"],
  "sysparm_offset":["2"],"sysparm_limit":["25"]
}
    SolicitUrl Cadeia de caracteres URL da solicitação. Passe este URL quando estiver processando uma resposta paginada para que o método tenha os links para todas as páginas na resposta.
    Tabela 4. Retornos
    Tipo Descrição
    Objeto JSON Detalhes do lead solicitado e dos registros de item de linha do lead.

    Tipo de dados: Objeto

    {
  "body": [Array],
  "contentRange": "String",
  "links": "String", 
  "status": "String",
  "totalCount": "Number" 
}

    Se ocorrerem erros ao processar a solicitação, o objeto JSON conterá somente o. corpo e. status parâmetros.
    Corpo.<JSONobject> Corpo da resposta.

    Resposta bem-sucedida: Uma matriz de objetos com cada objeto contendo um registro de lead e todos os registros de item de linha de lead associados. Todos os campos no registro de lead solicitado e todos os campos nos registros de item de linha de lead associados são retornados. Para obter uma descrição dos campos retornados, consulte Lead - OBTENHA /sn_lead_mgmt_core/lead.

    Resposta de erro: Lista de erros detectados ao tentar processar a solicitação. Essas mensagens de erro são definidas em LeadAPIConstants inclusão de script.

    Tipo de dados: Matriz de objetos
    Intervalo.contentRange <JSONobject> Intervalo do conteúdo retornado em uma chamada paginada.

    Por exemplo: Se o deslocamento for igual a 2 e o limite for igual a 3, o valor desse parâmetro será os itens 3-5.

    Tipo de dados: Cadeia de caracteres
    Links.<JSONobject> No caso de uma resposta paginada, links separados por vírgulas para cada página contida na resposta.
    Por exemplo:
    <https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=0&sysparm_limit=20>;rel="self",
<https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=20&sysparm_limit=20>;rel="last",
<https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=20&sysparm_limit=20>;rel="next"

    Tipo de dados: Cadeia de caracteres
    <JSONobject>.status Código de status da resposta.

    Esses códigos de status são definidos em LeadAPIConstants inclusão de script.

    Tipo de dados: Cadeia de caracteres
    TotalCount.totalCount <JSONobject> Número total de registros de lead retornados pelo método.

    Tipo de dados: Número (inteiro)

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

processGetAllLeads: function(queryParams, requestUrl) { 
// Add your custom code here 
}, 

type: 'LeadAPIProcessUtil' 
});

    LeadAPIProcessUtilOOB - processGetLeadById (ID de cadeia de caracteres)

    Recupera o registro de lead especificado e seus registros de item de linha associados. Este método retorna todos os campos nos registros associados.

    Os detalhes do registro são obtidos das seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]
    Tabela 5. Parâmetros
    Nome Tipo Descrição
    id Cadeia de caracteres Sys_id do registro de lead a ser recuperado.

    Tabela: Lead [sn_lead_mgmt_core_lead]
    Tabela 6. Retornos
    Tipo Descrição
    Objeto JSON Detalhes do lead solicitado e dos registros de item de linha do lead.

    Tipo de dados: Objeto

    {
  "body": {Object},
  "status": "String"
}
    Corpo.<JSONobject> Corpo da resposta.

    Resposta bem-sucedida: Todos os campos no registro de lead solicitado e todos os campos nos registros de item de linha de lead associados. Para obter uma descrição dos campos retornados, consulte Lead - OBTER /sn_lead_mgmt_core/lead/.

    Resposta de erro: Lista de erros detectados ao tentar processar a solicitação. Essas mensagens de erro são definidas em LeadAPIConstants inclusão de script.

    Tipo de dados: Objeto
    <JSONobject>.status Código de status da resposta.

    Esses códigos de status são definidos em LeadAPIConstants inclusão de script.

    Tipo de dados: Cadeia de caracteres

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here

processGetLeadById: function(id) { 
  // Add your custom code here
}, 

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB - processUpdateLead (Object requestBody, ID da cadeia de caracteres)

    Processa o corpo da solicitação e atualiza o lead especificado e todos os itens de linha associados, com base nos parâmetros aprovados.

    Os registros são atualizados nas seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]
    Tabela 7. Parâmetros
    Nome Tipo Descrição
    requestBody Objeto Corpo da solicitação do lead e seus campos de item de linha de lead relacionados para atualizar.

    Para obter detalhes sobre o conteúdo deste objeto, consulte Lead - PATCH /sn_lead_mgmt_core/lead/.
    id Cadeia de caracteres Sys_id do registro do lead a ser atualizado.

    Tabela: Lead [sn_lead_mgmt_core_lead]
    Tabela 8. Retornos
    Tipo Descrição
    Objeto JSON Detalhes do lead salvo e dos registros de item de linha do lead.

    Tipo de dados: Objeto

    {
  "body": {Object},
  "status": "String"
}
    Corpo.<JSONobject> Corpo da resposta.

    Resposta bem-sucedida: Todos os campos do registro de lead atualizado e todos os campos nos registros de item de linha de lead associados (atualizados ou não). Para obter uma descrição dos campos retornados, consulte Lead - PATCH /sn_lead_mgmt_core/lead/.

    Resposta de erro: Lista de erros detectados ao tentar processar a solicitação. Essas mensagens de erro são definidas em LeadAPIConstants inclusão de script.

    Tipo de dados: Objeto
    <JSONobject>.status Código de status da resposta.

    Esses códigos de status são definidos em LeadAPIConstants inclusão de script.

    Tipo de dados: Cadeia de caracteres

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

    var LeadAPIProcessUtil = Class.create();

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, {

// Define overriding functions here 

processUpdateLead: function(requestBody, id) { 
// Add your custom code here
},

type: 'LeadAPIProcessUtil' 

});