LeadAPIProcessUtilOOB - com escopo

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

    • A inclusão de script LeadAPIProcessUtilOOB fornece métodos que são chamados pela REST API do lead 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 os métodos API de lead são chamados, substitua os métodos nesta inclusão de script na inclusão de script LeadAPIProcessUtil. Os nomes dos métodos que você está substituindo na inclusão de script LeadAPIProcessUtil devem ser os mesmos que aqueles no arquivo de inclusão de script LeadAPIProcessUtilOOB.

    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.

    LeadAPIProcessUtilOOB - processCreateLead (objeto requestBody)

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

    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 – POST /sn_lead_mgmt_core/lead.
    Tabela 2. Retornos
    Tipo Descrição
    Objeto JSON Detalhes do lead salvo e dos registros de item de linha de lead.

    Tipo de dados: objeto

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.corpo 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 – POST /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 na inclusão de script LeadAPIConstants.

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

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

    Tipo de dados: cadeia de caracteres

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

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

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB - processGetAllLeads (objeto 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 passados. 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 endpoint lead – GET /sn_lead_mgmt_core/lead.
    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"]
}
    requestUrl Cadeia de caracteres URL da solicitação. Passe este URL ao processar 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 de lead.

    Tipo de dados: objeto

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

    Se ocorrer um erro durante o processamento da solicitação, o objeto JSON conterá somente os parâmetros de corpo e status.
    <JSONobject>.corpo 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 – GET /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 na inclusão de script LeadAPIConstants.

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

    Por exemplo: se deslocamento=2 e limite=3, o valor deste parâmetro será os itens 3-5.

    Tipo de dados: cadeia de caracteres
    <JSONobject>.links No caso de uma resposta paginada, links separados por vírgula 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 na inclusão de script LeadAPIConstants.

    Tipo de dados: cadeia de caracteres
    <JSONobject>.totalCount 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 o método processGetAllLeads() na inclusão de script LeadAPIProcessUtil.

    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 os 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 de lead.

    Tipo de dados: objeto

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.corpo 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 – GET /sn_lead_mgmt_core/lead/{sys_id}.

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

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

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

    Tipo de dados: cadeia de caracteres

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

    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 (objeto requestBody, ID de 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 Solicitar corpo do lead e seus campos de item de linha de lead relacionado a serem atualizados.

    Para obter detalhes sobre o conteúdo deste objeto, consulte lead – PATCH /sn_lead_mgmt_core/lead/{sys_id}.
    id Cadeia de caracteres Sys_id do registro de 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 de lead.

    Tipo de dados: objeto

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.corpo 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/{sys_id}.

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

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

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

    Tipo de dados: cadeia de caracteres

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

    var LeadAPIProcessUtil = Class.create();

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, {

// Define overriding functions here 

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

type: 'LeadAPIProcessUtil' 

});