API - Com escopo, global

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 46 min. de leitura

    • . API GenerationAPI Fornece suporte para conversão de PDF e manipulação de campos PDF.

    Esta API faz parte do ServiceNow Plug-in Utilitários de geração de PDF (com.snc.apppdfgenerator) e é fornecido no sn_pdfgeneratorutils namespace. O plug-in é ativado por padrão.

    Use o. glide.pdf.url.whitelistPropriedade para adicionar uma camada extra de validação para garantir se qualquer URL externa introduzida deve ser incluída no PDF gerado. Se a propriedade do sistema glide.pdf.url.whitelisting.enabled estiver definida como verdadeira, o PDF não processará o conteúdo da URL, a menos que esteja listado no campo Valor da propriedade do sistema com.snc.pdf.whitelisted_urls. Essas propriedades estão listadas na tabela Propriedades do sistema [sys_properties]. Para obter mais informações, consulte Available system properties.

    Nota:
    O tamanho máximo do PDF é de 50 MB.
    Os métodos nesta classe habilitam as seguintes tarefas:
    Nota:
    Esses métodos também podem ser usados para documentos criados por itens que não são do catálogo.
    APIs relacionadas:

    PDF GenerationAPI – PDF GenerationAPI()

    Instancia um novo API GenerationAPI objeto.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como criar um API GenerationAPI objeto.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

    PDF – convertToPDF(cadeia de caracteres html, cadeia de caracteres targetTable, cadeia de caracteres targetTableSysId, cadeia de caracteres pdfName, cadeia de caracteres fontFamilySysId, Documento do objeto)

    Converte uma cadeia de caracteres HTML em um documento PDF.

    Este método cria um PDF usando o tamanho de página A4 – 595 x 842 pontos. O conteúdo será truncado se exceder esse tamanho.

    Para gerar um PDF com configurações adicionais, como tamanho da página, orientação e números de página, use ConvertToPDFWithCabeçadoRodaFooter() .

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    html Cadeia de caracteres HTML para converter em um documento PDF.
    targetTable Cadeia de caracteres Nome da tabela na qual anexar o PDF convertido .
    TargetTableSysId Cadeia de caracteres Sys_id do registro ao qual anexar o PDF convertido.
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    SysId da fontFamilySysId Cadeia de caracteres Opcional. Sys_id da família de fontes a ser usada para o PDF. Este sys_id é da tabela Família de fontes de geração de PDF [sys_pdf_generation_font_family].

    Padrão: Nenhum
    DocuConfiguration Objeto Opcional. Objeto que contém uma configuração de sumário e uma configuração de número de página.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    ConfiguraçãoDocumento.AcessórioHabilitado Booliano Opcional. Sinalizador que indica se o PDF gerado deve ser formatado para oferecer suporte à acessibilidade. Quando esse recurso estiver habilitado, os marcadores de acessibilidade estarão disponíveis na árvore de marcadores de PDF para ajudar os usuários que dependem de leitores de tela para navegar, entender e interagir com os documentos PDF gerados.
    Valores válidos:
    • Verdadeiro: O PDF gerado está formatado para acessibilidade.
    • Falso: O PDF gerado não está formatado para acessibilidade.

    Padrão: falso
    DocumentConfiguration.toc_config Cadeia de caracteres Opcional. Sys_id da configuração do sumário a ser usada para o PDF. Este sys_id é da tabela de Configuração do sumário [doc_toc_config].

    Padrão: Nenhum
    DocumentConfiguration.page_number_config Cadeia de caracteres Opcional. Sys_id da configuração do número de página a ser usada para o PDF. Este sys_id é da tabela Configuração de número de página [doc_page_number_config].

    Padrão: Nenhum
    Tabela 3. Retornos
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo PDF se a conversão for bem-sucedida, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>. ​attachment_id Se a conversão HTML for bem-sucedida, sys_id do PDF convertido e anexado. O arquivo está listado na tabela de anexos [sys_attachment].

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Falha na conversão. – Nenhum PDF criado. Certifique-se de que os valores fornecidos estejam precisos.
    • A conversão foi bem-sucedida. – O HTML convertido com sucesso em PDF.
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.
    • O <URL> não está listado no URL da lista de permissões. Verifique a propriedade da lista de permissões de URL: "Glide.pdf.url.whitelisting.enabled" e "com.snc.pdf.whitelisted_urls" – Se a propriedade do sistema glide.pdf.url.whitelisting.enabled estiver definida como verdadeira, o PDF não processará o conteúdo da URL, a menos que esteja listado no campo Valor da propriedade do sistema com.snc.pdf.whitelisted_urls. Essas propriedades estão listadas na tabela Propriedades do sistema [sys_properties].

    Tipo de dados: Cadeia de caracteres
    <Object>.request_id Sys_id do registro de solicitação do produtor de mudança .

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como converter HTML em PDF e anexá-lo a um registro na tabela Incidente [incidente].

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var result = v.convertToPDF(html, "incident", "<target_sys_id>", "myPDF");
gs.info(JSON.stringify(result));

    Saída:

    {"attachment_id":"<sys_id>","message":"Conversion is successful.","request_id":"<change_sys_id>","status":"success"}

    PDF GenerationAPI – convertToPDFsync(cadeia de caracteres html, cadeia de caracteres targetTable, cadeia de caracteres targetTableSysId, cadeia de caracteres pdfName, cadeia de caracteres fontFamilySysId, Documento do objeto)

    Prepara um trabalho que converte uma cadeia de caracteres HTML em um documento PDF de forma assíncrona. O processamento assíncrono permite que você trabalhe na instância enquanto a conversão de PDF está em andamento. Isso é especialmente útil para exportações de PDF maiores.

    Esta API cria um PDF usando o tamanho de página A4 – 595 x 842 pontos. O conteúdo será truncado se exceder esse tamanho.

    Para gerar um PDF com configurações adicionais, como tamanho da página, orientação e números de página, use ConvertToPDFWithCabeçadoFooAsync() .

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    html Cadeia de caracteres HTML para converter em um documento PDF.
    targetTable Cadeia de caracteres Nome da tabela na qual anexar o PDF convertido .
    TargetTableSysId Cadeia de caracteres Sys_id do registro ao qual anexar o PDF convertido.
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    SysId da fontFamilySysId Cadeia de caracteres Opcional. Sys_id da família de fontes a ser usada para o PDF. Este sys_id é da tabela Família de fontes de geração de PDF [sys_pdf_generation_font_family].

    Padrão: Nenhum
    DocuConfiguration Objeto Opcional. Objeto que contém uma configuração de sumário e uma configuração de número de página.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    ConfiguraçãoDocumento.AcessórioHabilitado Booliano Opcional. Sinalizador que indica se o PDF gerado deve ser formatado para oferecer suporte à acessibilidade. Quando esse recurso estiver habilitado, os marcadores de acessibilidade estarão disponíveis na árvore de marcadores de PDF para ajudar os usuários que dependem de leitores de tela para navegar, entender e interagir com os documentos PDF gerados.
    Valores válidos:
    • Verdadeiro: O PDF gerado está formatado para acessibilidade.
    • Falso: O PDF gerado não está formatado para acessibilidade.

    Padrão: falso
    DocumentConfiguration.toc_config Cadeia de caracteres Opcional. Sys_id da configuração do sumário a ser usada para o PDF. Este sys_id é da tabela de Configuração do sumário [doc_toc_config].

    Padrão: Nenhum
    DocumentConfiguration.page_number_config Cadeia de caracteres Opcional. Sys_id da configuração do número de página a ser usada para o PDF. Este sys_id é da tabela Configuração de número de página [doc_page_number_config].

    Padrão: Nenhum
    Tabela 5. Retornos
    Tipo Descrição
    Objeto Objeto que indica se a conversão de PDF está em andamento. Você pode revisar o status da conversão na tabela Status de geração de PDF [sys_pdf_generation_status].
    {
  "message": "String",
  "request_id": "String"
}
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • A conversão de HTML para PDF está em andamento. – A solicitação para converter HTML em um documento PDF foi bem-sucedida.
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.
    • O <URL> não está listado no URL da lista de permissões. Verifique a propriedade da lista de permissões de URL: "Glide.pdf.url.whitelisting.enabled" e "com.snc.pdf.whitelisted_urls" – Se a propriedade do sistema glide.pdf.url.whitelisting.enabled estiver definida como verdadeira, o PDF não processará o conteúdo da URL, a menos que esteja listado no campo Valor da propriedade do sistema com.snc.pdf.whitelisted_urls. Essas propriedades estão listadas na tabela Propriedades do sistema [sys_properties].

    Tipo de dados: Cadeia de caracteres
    <Object>.request_id Sys_id do registro de solicitação do produtor de mudança .

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como enfileirar uma tarefa que converte HTML em PDF. Quando a conversão for concluída, o PDF chamado "myPDF" será anexado ao registro de destino na tabela Incidente [incidente].

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var result = v.convertToPDFAsync(html, "incident", "<target_sys_id>", "myPDF");
gs.info(JSON.stringify(result));

    Saída:

    {"message":"HTML to PDF Conversion is in progress.","request_id":"<sys_id>"}

    PDF GenerationAPI – convertToPDFWithHeaderFooter(Cadeia de caracteres html, cadeia de caracteres targetTable, cadeia de caracteres targetTableSysId, cadeia de caracteres pdfName, objeto headerFooterInfo, cadeia de caracteres fontFamilySysId, Object documentConfiguration)

    Converte uma cadeia de caracteres HTML em um PDF com conteúdo de cabeçalho e rodapé.

    Use este método para gerar PDFs com configurações de página:
    • Informações de cabeçalho e rodapé
    • Tamanhos da margem
    • Orientação
    • Enumeração
    • Tamanho da página
    Tabela 6. Parâmetros
    Nome Tipo Descrição
    html Cadeia de caracteres HTML para converter em um documento PDF.
    targetTable Cadeia de caracteres Nome da tabela na qual anexar o PDF convertido .
    TargetTableSysId Cadeia de caracteres Sys_id do registro ao qual anexar o PDF convertido.
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    CabeçadoRodaFoanteInfo Objeto Define os detalhes do cabeçalho e rodapé do PDF.
    {
  "FooterImageAlignment": "String",
  "FooterImageAttachmentId": "String",
  "FooterImageHeight": "String",
  "FooterText": "String",
  "FooterTextAlignment": "String",
  "GeneratePageNumber": "String",
  "HeaderImageAlignment": "String",
  "HeaderImageAttachmentId": "String",
  "HeaderImageHeight": "String",
  "LeftOrRightMargin": "String",
  "PageOrientation": "String",
  "PageSize": "String",
  "TopOrBottomMargin": "String"
}
    CabeçadoRodaRodaInfo. ​RodaAlinhamento de imagem Cadeia de caracteres Define a posição da imagem no rodapé.
    Valores válidos:
    • BOTTOM_CENTER: Posicione a imagem no centro inferior do rodapé.
    • BOTTOM_LEFT: Posicione a imagem na área inferior esquerda do rodapé.
    • BOTTOM_RIGHT: Posicione a imagem na área inferior direita do rodapé.
    • TOP_CENTER: Posicione a imagem no centro superior do rodapé.
    • TOP_LEFT: Posicione a imagem na área superior esquerda do rodapé.
    • TOP_RIGHT: Posicione a imagem na área superior direita do rodapé.
    CabeçadoRodaRodaInfo. ​Rodapé ImageAttachmentId Cadeia de caracteres Sys_id da imagem do rodapé na tabela de anexos [sys_attachment].Para determinar se o tipo de arquivo é compatível com sua instância, navegue até Propriedades do sistema , Segurança e verifique se ele está listado em Lista de extensões de arquivo (separadas por vírgulas) que podem ser anexadas campo.
    CabeçadoRodaRodaInfo. ​Altura da imagem do rodapé Cadeia de caracteres Altura da imagem do rodapé.

    Padrão: 50 pontos
    CabeçadoRodaRodaInfo. ​RodaTexto Cadeia de caracteres Texto do rodapé a ser colocado na parte inferior de cada página PDF.
    CabeçadoRodaRodaInfo. ​Alinhamento de texto do rodapé Cadeia de caracteres Define a posição do texto no rodapé. Certifique-se de que este valor não corresponda ou entre em conflito com a área fornecida em headerFooterInfo.FooterImageAlignment.
    Valores válidos:
    • BOTTOM_CENTER: Posicione o texto no centro inferior do rodapé.
    • BOTTOM_LEFT: Posicione o texto na área inferior esquerda do rodapé.
    • BOTTOM_RIGHT: Posicione o texto na área inferior direita do rodapé.
    • TOP_CENTER: Posicione o texto no centro superior do rodapé.
    • TOP_LEFT: Posicione o texto na área superior esquerda do rodapé.
    • TOP_RIGHT: Posicione o texto na área superior direita do rodapé.
    CabeçadoRodaRodaInfo. ​GeneratePageNumber Cadeia de caracteres Sinalizador que indica se um número de página PDF deve ser gerado.
    Valores válidos:
    • Verdadeiro: Gere números de página.
    • Falso: Não gere números de página.

    Padrão: verdadeiro
    CabeçadoRodaRodaInfo. ​HeaderImageAlignment Cadeia de caracteres Define a posição da imagem no cabeçalho.
    Valores válidos:
    • Centro: Posicione a imagem no centro do cabeçalho.
    • Esquerda: Posicione a imagem no lado esquerdo do cabeçalho.
    • Direita: Posicione a imagem no lado direito do cabeçalho.
    CabeçadoRodaRodaInfo. ​HeaderImageAttachmentId Cadeia de caracteres Sys_id da imagem do cabeçalho na tabela de anexos [sys_attachment].Para determinar se o tipo de arquivo é compatível com sua instância, navegue até Propriedades do sistema , Segurança e verifique se ele está listado em Lista de extensões de arquivo (separadas por vírgulas) que podem ser anexadas campo.
    CabeçadoRodaRodaInfo. ​HeaderImageHeight Cadeia de caracteres Altura da imagem do cabeçalho.

    Padrão: 50 pontos
    CabeçadoRodaRodaInfo. ​OrRightMargin Cadeia de caracteres Tamanho das margens esquerda e direita. Se posicionados no lado esquerdo ou direito da página, os detalhes do cabeçalho/rodapé serão colocados nesta área.

    Padrão: 36 pontos
    CabeçadoRodaRodaInfo. ​PageOrientation Cadeia de caracteres Orientação da página.
    Valores válidos:
    • RETRATO
    • PAISAGEM

    Padrão: Retrato
    CabeçadoRodaRodaInfo. ​Tamanho da página Cadeia de caracteres Tamanho da página do documento.
    Valores válidos:
    • A4 – 595 x 842 pontos
    • CARTA – 612 x 792 pontos
    • RAZÃO - Pontos 792 x 1224

    O conteúdo será truncado se exceder o tamanho da página.
    CabeçadoRodaRodaInfo. ​TopOrBottomMargin Cadeia de caracteres Tamanho das margens superior e inferior. Os detalhes do cabeçalho e rodapé são colocados nesta área.

    Padrão: 72 pontos
    SysId da fontFamilySysId Cadeia de caracteres Opcional. Sys_id da família de fontes a ser usada para o PDF. Este sys_id é da tabela Família de fontes de geração de PDF [sys_pdf_generation_font_family].

    Padrão: Nenhum
    DocuConfiguration Objeto Opcional. Objeto que contém uma configuração de sumário e uma configuração de número de página.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    ConfiguraçãoDocumento.AcessórioHabilitado Booliano Opcional. Sinalizador que indica se o PDF gerado deve ser formatado para oferecer suporte à acessibilidade. Quando esse recurso estiver habilitado, os marcadores de acessibilidade estarão disponíveis na árvore de marcadores de PDF para ajudar os usuários que dependem de leitores de tela para navegar, entender e interagir com os documentos PDF gerados.
    Valores válidos:
    • Verdadeiro: O PDF gerado está formatado para acessibilidade.
    • Falso: O PDF gerado não está formatado para acessibilidade.

    Padrão: falso
    DocumentConfiguration.toc_config Cadeia de caracteres Opcional. Sys_id da configuração do sumário a ser usada para o PDF. Este sys_id é da tabela de Configuração do sumário [doc_toc_config].

    Padrão: Nenhum
    DocumentConfiguration.page_number_config Cadeia de caracteres Opcional. Sys_id da configuração do número de página a ser usada para o PDF. Este sys_id é da tabela Configuração de número de página [doc_page_number_config].

    Padrão: Nenhum
    Tabela 7. Retornos
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo PDF se a conversão for bem-sucedida, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>. ​attachment_id Se a conversão HTML for bem-sucedida, sys_id do PDF convertido e anexado. O arquivo está listado na tabela de anexos [sys_attachment].

    Tipo de dados: Cadeia de caracteres
    <Object>. ​mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Falha na conversão. – Nenhum PDF criado. Certifique-se de que os valores fornecidos estejam precisos.
    • A conversão foi bem-sucedida. – O HTML convertido com sucesso em PDF.
    • O alinhamento da imagem e o alinhamento do texto não podem estar na mesma região com o mesmo alinhamento: <footerImageAlignment value> – Certifique-se de que headerFooterInfo.​FooterImageAlignmente. headerFooterInfo.​FooterTextAlignmentos valores não estão na mesma área.
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Alinhamento de imagem de rodapé inválido: <invalid_option> fornecido. – Forneça uma opção válida no headerFooterInfo.​FooterImageAlignmentpropriedade.
    • Alinhamento de texto de rodapé inválido: " <invalid_option> e " foi fornecido. – Forneça uma opção válida no headerFooterInfo.​footerTextAlignmentpropriedade.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Não é possível obter a imagem do rodapé. <value provided> - Certifique-se de que o sys_id foi fornecido para headerFooterInfo.​footerImageIdé preciso.
    • Não é possível obter a imagem do cabeçalho. <value provided> - Certifique-se de que o sys_id foi fornecido para headerFooterInfo.​headerImageIdé preciso.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.
    • O <URL> não está listado no URL da lista de permissões. Verifique a propriedade da lista de permissões de URL: "Glide.pdf.url.whitelisting.enabled" e "com.snc.pdf.whitelisted_urls" – Se a propriedade do sistema glide.pdf.url.whitelisting.enabled estiver definida como verdadeira, o PDF não processará o conteúdo da URL, a menos que esteja listado no campo Valor da propriedade do sistema com.snc.pdf.whitelisted_urls. Essas propriedades estão listadas na tabela Propriedades do sistema [sys_properties].

    Tipo de dados: Cadeia de caracteres
    <Object>.request_id Sys_id do registro de solicitação do produtor de mudança .

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como converter HTML em um PDF chamado "myPDF" e adicionar o PDF como anexo a um registro na tabela Incidente [incidente]. O PDF contém cabeçalho e rodapé fornecidos por meio de anexo.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var hfInfo = new Object();
hfInfo["HeaderImageAttachmentId"] = "<hdrImgAttSysId>";
hfInfo["HeaderImageAlignment"] = "left";
hfInfo["FooterImageAttachmentId"] = "<ftrImgAttSysId>";
hfInfo["FooterImageAlignment"] = "TOP_CENTER";
hfInfo["FooterText"] = "Sample Footer Message";
hfInfo["PageSize"] = "A4";
hfInfo["GeneratePageNumber"] = "false";
hfInfo["TopOrBottomMargin"] = "36";
hfInfo["LeftOrRightMargin"] = "24";

var result = v.convertToPDFWithHeaderFooter(html, "incident", "<targetTbl_sys_id>", "myPDF", hfInfo);
gs.info(JSON.stringify(result));

    Saída:

    {"attachment_id":"<sys_id>","message":"Conversion is successful.","request_id":"<change_sys_id>","status":"success"}

    PDF GenerationAPI – convertToPDFWithHeaderFooterAsync(cadeia de caracteres html, cadeia de caracteres targetTable, cadeia de caracteres targetTableSysId, cadeia de caracteres pdfName, objeto headerFooterInfo, cadeia de caracteres fontFamilySysId, Object documentConfiguration)

    Prepara um trabalho que converte uma cadeia de caracteres HTML em um PDF com conteúdo de cabeçalho e rodapé de forma assíncrona. O processamento assíncrono permite que você trabalhe na instância enquanto a conversão de PDF está em andamento. Isso é especialmente útil para exportações de PDF maiores.

    Use este método para gerar PDFs com configurações de página:
    • Informações de cabeçalho e rodapé
    • Tamanhos da margem
    • Orientação
    • Enumeração
    • Tamanho da página
    Tabela 8. Parâmetros
    Nome Tipo Descrição
    html Cadeia de caracteres HTML para converter em um documento PDF.
    targetTable Cadeia de caracteres Nome da tabela na qual anexar o PDF convertido .
    TargetTableSysId Cadeia de caracteres Sys_id do registro ao qual anexar o PDF convertido.
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    CabeçadoRodaFoanteInfo Objeto Define os detalhes do cabeçalho e rodapé do PDF.
    {
  "FooterImageAlignment": "String",
  "FooterImageAttachmentId": "String",
  "FooterImageHeight": "String",
  "FooterText": "String",
  "FooterTextAlignment": "String",
  "GeneratePageNumber": "String",
  "HeaderImageAlignment": "String",
  "HeaderImageAttachmentId": "String",
  "HeaderImageHeight": "String",
  "LeftOrRightMargin": "String",
  "PageOrientation": "String",
  "PageSize": "String",
  "TopOrBottomMargin": "String"
}
    CabeçadoRodaRodaInfo. ​RodaAlinhamento de imagem Cadeia de caracteres Define a posição da imagem no rodapé.
    Valores válidos:
    • BOTTOM_CENTER: Posicione a imagem no centro inferior do rodapé.
    • BOTTOM_LEFT: Posicione a imagem na área inferior esquerda do rodapé.
    • BOTTOM_RIGHT: Posicione a imagem na área inferior direita do rodapé.
    • TOP_CENTER: Posicione a imagem no centro superior do rodapé.
    • TOP_LEFT: Posicione a imagem na área superior esquerda do rodapé.
    • TOP_RIGHT: Posicione a imagem na área superior direita do rodapé.
    CabeçadoRodaRodaInfo. ​Rodapé ImageAttachmentId Cadeia de caracteres Sys_id da imagem do rodapé na tabela de anexos [sys_attachment].Para determinar se o tipo de arquivo é compatível com sua instância, navegue até Propriedades do sistema , Segurança e verifique se ele está listado em Lista de extensões de arquivo (separadas por vírgulas) que podem ser anexadas campo.
    CabeçadoRodaRodaInfo. ​Altura da imagem do rodapé Cadeia de caracteres Altura da imagem do rodapé.

    Padrão: 50 pontos
    CabeçadoRodaRodaInfo. ​RodaTexto Cadeia de caracteres Texto do rodapé a ser colocado na parte inferior de cada página PDF.
    CabeçadoRodaRodaInfo. ​Alinhamento de texto do rodapé Cadeia de caracteres Define a posição do texto no rodapé. Certifique-se de que este valor não corresponda ou entre em conflito com a área fornecida em headerFooterInfo.FooterImageAlignment.
    Valores válidos:
    • BOTTOM_CENTER: Posicione o texto no centro inferior do rodapé.
    • BOTTOM_LEFT: Posicione o texto na área inferior esquerda do rodapé.
    • BOTTOM_RIGHT: Posicione o texto na área inferior direita do rodapé.
    • TOP_CENTER: Posicione o texto no centro superior do rodapé.
    • TOP_LEFT: Posicione o texto na área superior esquerda do rodapé.
    • TOP_RIGHT: Posicione o texto na área superior direita do rodapé.
    CabeçadoRodaRodaInfo. ​GeneratePageNumber Cadeia de caracteres Sinalizador que indica se um número de página PDF deve ser gerado.
    Valores válidos:
    • Verdadeiro: Gere números de página.
    • Falso: Não gere números de página.

    Padrão: verdadeiro
    CabeçadoRodaRodaInfo. ​HeaderImageAlignment Cadeia de caracteres Define a posição da imagem no cabeçalho.
    Valores válidos:
    • Centro: Posicione a imagem no centro do cabeçalho.
    • Esquerda: Posicione a imagem no lado esquerdo do cabeçalho.
    • Direita: Posicione a imagem no lado direito do cabeçalho.
    CabeçadoRodaRodaInfo. ​HeaderImageAttachmentId Cadeia de caracteres Sys_id da imagem do cabeçalho na tabela de anexos [sys_attachment].Para determinar se o tipo de arquivo é compatível com sua instância, navegue até Propriedades do sistema , Segurança e verifique se ele está listado em Lista de extensões de arquivo (separadas por vírgulas) que podem ser anexadas campo.
    CabeçadoRodaRodaInfo. ​HeaderImageHeight Cadeia de caracteres Altura da imagem do cabeçalho.

    Padrão: 50 pontos
    CabeçadoRodaRodaInfo. ​OrRightMargin Cadeia de caracteres Tamanho das margens esquerda e direita. Se posicionados no lado esquerdo ou direito da página, os detalhes do cabeçalho/rodapé serão colocados nesta área.

    Padrão: 36 pontos
    CabeçadoRodaRodaInfo. ​PageOrientation Cadeia de caracteres Orientação da página.
    Valores válidos:
    • RETRATO
    • PAISAGEM

    Padrão: Retrato
    CabeçadoRodaRodaInfo. ​Tamanho da página Cadeia de caracteres Tamanho da página do documento.
    Valores válidos:
    • A4 – 595 x 842 pontos
    • CARTA – 612 x 792 pontos
    • RAZÃO - Pontos 792 x 1224

    O conteúdo será truncado se exceder o tamanho da página.
    CabeçadoRodaRodaInfo. ​TopOrBottomMargin Cadeia de caracteres Tamanho das margens superior e inferior. Os detalhes do cabeçalho e rodapé são colocados nesta área.

    Padrão: 72 pontos
    SysId da fontFamilySysId Cadeia de caracteres Opcional. Sys_id da família de fontes a ser usada para o PDF. Este sys_id é da tabela Família de fontes de geração de PDF [sys_pdf_generation_font_family].

    Padrão: Nenhum
    DocuConfiguration Objeto Opcional. Objeto que contém uma configuração de sumário e uma configuração de número de página.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    ConfiguraçãoDocumento.AcessórioHabilitado Booliano Opcional. Sinalizador que indica se o PDF gerado deve ser formatado para oferecer suporte à acessibilidade. Quando esse recurso estiver habilitado, os marcadores de acessibilidade estarão disponíveis na árvore de marcadores de PDF para ajudar os usuários que dependem de leitores de tela para navegar, entender e interagir com os documentos PDF gerados.
    Valores válidos:
    • Verdadeiro: O PDF gerado está formatado para acessibilidade.
    • Falso: O PDF gerado não está formatado para acessibilidade.

    Padrão: falso
    DocumentConfiguration.toc_config Cadeia de caracteres Opcional. Sys_id da configuração do sumário a ser usada para o PDF. Este sys_id é da tabela de Configuração do sumário [doc_toc_config].

    Padrão: Nenhum
    DocumentConfiguration.page_number_config Cadeia de caracteres Opcional. Sys_id da configuração do número de página a ser usada para o PDF. Este sys_id é da tabela Configuração de número de página [doc_page_number_config].

    Padrão: Nenhum
    Tabela 9. Retornos
    Tipo Descrição
    Objeto
    <Object>. ​mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • A conversão de HTML para PDF está em andamento. – A solicitação para converter HTML em um documento PDF foi bem-sucedida.
    • O alinhamento da imagem e o alinhamento do texto não podem estar na mesma região com o mesmo alinhamento: <footerImageAlignment value> – Certifique-se de que headerFooterInfo.​FooterImageAlignmente. headerFooterInfo.​FooterTextAlignmentos valores não estão na mesma área.
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Alinhamento de imagem de rodapé inválido: <invalid_option> fornecido. – Forneça uma opção válida no headerFooterInfo.​FooterImageAlignmentpropriedade.
    • Alinhamento de texto de rodapé inválido: " <invalid_option> e " foi fornecido. – Forneça uma opção válida no headerFooterInfo.​footerTextAlignmentpropriedade.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Não é possível obter a imagem do rodapé. <value provided> - Certifique-se de que o sys_id foi fornecido para headerFooterInfo.​footerImageIdé preciso.
    • Não é possível obter a imagem do cabeçalho. <value provided> - Certifique-se de que o sys_id foi fornecido para headerFooterInfo.​headerImageIdé preciso.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.
    • O <URL> não está listado no URL da lista de permissões. Verifique a propriedade da lista de permissões de URL: "Glide.pdf.url.whitelisting.enabled" e "com.snc.pdf.whitelisted_urls" – Se a propriedade do sistema glide.pdf.url.whitelisting.enabled estiver definida como verdadeira, o PDF não processará o conteúdo da URL, a menos que esteja listado no campo Valor da propriedade do sistema com.snc.pdf.whitelisted_urls. Essas propriedades estão listadas na tabela Propriedades do sistema [sys_properties].

    Tipo de dados: Cadeia de caracteres
    <Object>.request_id Sys_id do registro de solicitação do produtor de mudança .

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como enfileirar uma tarefa que converte HTML em PDF. O PDF contém cabeçalho e rodapé fornecidos por meio de anexo. Quando a conversão for concluída, o PDF chamado "myPDF" será anexado ao registro de destino na tabela Incidente [incidente].

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var hfInfo = new Object();
hfInfo["HeaderImageAttachmentId"] = "<hdrImgAttSysId>";
hfInfo["HeaderImageAlignment"] = "left";
hfInfo["FooterImageAttachmentId"] = "<ftrImgAttSysId>";
hfInfo["FooterImageAlignment"] = "TOP_CENTER";
hfInfo["FooterText"] = "Sample Footer Message";
hfInfo["PageSize"] = "A4";
hfInfo["GeneratePageNumber"] = "false";
hfInfo["TopOrBottomMargin"] = "36";
hfInfo["LeftOrRightMargin"] = "24";

var result = v.convertToPDFWithHeaderFooterAsync(html, "incident", "<targetTbl_sys_id>", "myPDF", hfInfo);
gs.info(JSON.stringify(result));

    Saída:

    {"message":"HTML to PDF Conversion is in progress.","request_id":"<sys_id>"}

    PDFGenerationAPI – fillDocumentFields(Object fieldsMap, cadeia de caracteres SYSID, cadeia de caracteres tablename, cadeia de caracteres tableSysId, cadeia de caracteres pdfName)

    Preenche campos em um PDF editável e o anexa ao registro fornecido.

    Use os métodos a seguir para determinar se o PDF pode ser preenchido e obter informações do campo:
    API GenerationAPI fornece métodos de preenchimento adicionais com opções diferentes:
    Tabela 10. Parâmetros
    Nome Tipo Descrição
    CamposMap Objeto Opcional. Mapa de valor-chave por nome de campo PDF e valor a ser preenchido. Use o. GetDocumentFields() método para obter a lista de campos disponíveis.
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    tableName Cadeia de caracteres Nome da tabela que contém o registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    tableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    Tabela 11. Retornos
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo PDF atualizado se bem-sucedido, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>. ​attachment_id Se a operação for bem-sucedida, sys_id do PDF preenchido. O arquivo está listado na tabela de anexos [sys_attachment].

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores válidos:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como preencher campos em um PDF editável.

    var fieldMap = new Object();
fieldMap["Address"] = "Address value here";
fieldMap["State"] = "State value here";

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.fillDocumentFields(fieldMap, "<attachmentSysId>", "<tableName>", "<tableSysId>", "pdfName");
gs.info(JSON.stringify(result));

    Saída:

    {"attachment_id":"<sys_id>","message":"Request completed successfully.","status":"success"}

    API – fillDocumentFieldsAndFlatten(Object fieldsMap, cadeia de caracteres SYSID, cadeia de caracteres tablename, cadeia de caracteres tablename, cadeia de caracteres tableSysId, cadeia de caracteres pdfName, achatar objeto)

    Preenche campos em um PDF editável, nivela os campos de dados e os anexa ao registro fornecido.

    Use os métodos a seguir para determinar se o PDF pode ser preenchido e obter informações do campo:
    API GenerationAPI fornece métodos de preenchimento adicionais com opções diferentes:
    Tabela 12. Parâmetros
    Nome Tipo Descrição
    CamposMap Objeto Opcional. Mapa de valor-chave por nome de campo PDF e valor a ser preenchido. Use o. GetDocumentFields() método para obter a lista de campos disponíveis.
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    tableName Cadeia de caracteres Nome da tabela que contém o registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    tableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    achatar Objeto Opcional. O nivelamento de campos permite bloquear os campos para que outros usuários não possam alterar as informações. Especifique a chave como "FlattenType" e forneça uma opção de nivelamento como uma cadeia de caracteres.
    Valores válidos:
    • Donot_flatten - Não achata nenhum campo.
    • Partially_flatten - Planilha somente os campos modificados.
    • Fully_flatten - Planifica todos os campos.

    Padrão: Fully_flatten

    {
  "FlattenType": "String" 
}
    Tabela 13. Retornos
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo PDF atualizado se bem-sucedido, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>. ​attachment_id Se a operação for bem-sucedida, sys_id do PDF preenchido. O arquivo está listado na tabela de anexos [sys_attachment].

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores válidos:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como preencher campos e nivelar um PDF editável.

    var fieldMap = new Object();
fieldMap["Last Name First Name Middle Initial"] = "Tuter Abel E.";
fieldMap["Date of Birth"] = "08101952";
fieldMap["US SSN"] = "111-22-9999";
fieldMap["Address"] = "PO Box 344";
fieldMap["City"] = "Jerome";
fieldMap["State"] = "AZ";
fieldMap["Zip"] = "86331";

var flatten = new Object();
flatten["FlattenType"] = "partially_flatten";

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.fillDocumentFieldsAndFlatten(fieldMap, "<attachmentSysId>", "<tableName>", "<tableSysId>", "pdfName", flatten);
gs.info(JSON.stringify(result));

    Saída:

    "attachment_id":"<sys_id>","message":"Request completed successfully.","status":"success"

    AppGenerationAPI – fillFieldsAndMergeSignature(Object fieldsMap, cadeia de caracteres SYSID, cadeia de caracteres tablename, cadeia de caracteres tableSysId, cadeia de caracteres pdfName, PdfSolicitante MergeSignSolicitante, Objeto achatar)

    Preenche campos em um PDF editável, adiciona imagem de assinatura, nivela os campos de dados e a anexa ao registro fornecido.

    Use os métodos a seguir para determinar se o PDF pode ser preenchido e obter informações do campo:
    API GenerationAPI fornece métodos de preenchimento adicionais com opções diferentes:
    Tabela 14. Parâmetros
    Nome Tipo Descrição
    CamposMap Objeto Opcional. Mapa de valor-chave por nome de campo PDF e valor a ser preenchido. Use o. GetDocumentFields() método para obter a lista de campos disponíveis.
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    tableName Cadeia de caracteres Nome da tabela que contém o registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    tableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    Nome do pdf Cadeia de caracteres Nome para fornecer o PDF.

    Padrão: Sys_id do PDF na tabela de anexos [sys_attachment].
    solicitante ​Solicitante do PdfMergeSign Entrada de assinatura retornada de PdfMergeSignSolicitante .
    achatar Objeto Opcional. O nivelamento de campos permite bloquear os campos para que outros usuários não possam alterar as informações. Especifique a chave como "FlattenType" e forneça uma opção de nivelamento como uma cadeia de caracteres.
    Valores válidos:
    • Donot_flatten - Não achata nenhum campo.
    • Partially_flatten - Planilha somente os campos modificados.
    • Fully_flatten - Planifica todos os campos.

    Padrão: Fully_flatten

    {
  "FlattenType": "String" 
}
    Tabela 15. Retornos
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo PDF atualizado se bem-sucedido, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>. ​attachment_id Se a operação for bem-sucedida, sys_id do PDF preenchido. O arquivo está listado na tabela de anexos [sys_attachment].

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores válidos:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como preencher campos com assinatura com configurações padrão para nivelar completamente os campos.

    var fieldMap = new Object();
fieldMap["Address_Salutation"] = "Address value here";

var paramMap = new Object();
paramMap["FlattenType"] = "partially_flatten";

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;
requestor.createRequest("<attachmentSysId>", "incident", "<tableSysId>", "filledPdf");
requestor.addSignatureMapping(6, 40, 50, 188, 44, "<signatureSysId>");

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.fillFieldsAndMergeSignature(fieldMap, "<attachmentSysId>", "incident", "<tableSysId>", requestor, "filledPdf", paramMap);
gs.info(JSON.stringify(result));
    Saída:
    {"attachment_id":"5440d993dbed3010d66be1191396194e","message":"Request completed successfully.","status":"success"}

    AppGenerationAPI – getDocumentFields(cadeia de caracteres SYSID)

    Obtém uma lista de campos editáveis em um documento PDF. Permite listar campos PDF editáveis sem abrir manualmente o arquivo para verificar.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    Tabela 17. Retornos
    Tipo Descrição
    Objeto Objeto que contém o ID do PDF assinado, caso contrário, mensagem de erro. 
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.campos Se a solicitação for bem-sucedida, liste com o nome de cada campo no PDF.

    Tipo de dados: Matriz de cadeias de caracteres

    "fields": ["field_name"]
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como recuperar campos em um anexo PDF.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.getDocumentFields("attachmentSysId");
gs.info(JSON.stringify(result));

    Saída:

    {"message":"Request completed successfully.","fields":["NP_formFillable","reset","print","1SSN","Signature.1","5sigDate","Check Box21"],"status":"success"}

    AppGenerationAPI – getDocumentFieldsType(cadeia de caracteres SYSID)

    Obtém o tipo de campo do conjunto de campos editáveis de um documento PDF.

    Tabela 18. Parâmetros
    Nome Tipo Descrição
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    Tabela 19. Retornos
    Tipo Descrição
    Objeto Objeto que contém cada tipo de campo PDF, se bem-sucedido, caso contrário, mensagem de erro. 
    {
  "fields_type": {Object},
  "message": "String",
  "status": "String"
}
    <Object>.fields_type Objeto que lista cada campo no PDF especificado se bem-sucedido, mensagem de erro caso contrário.

    Tipo de dados: Objeto

    "fields_type": {
  "<field type>": {Object},
}
    <Object>.fields_type. ​<field> Objeto que contém o número de página de cada campo. O nome do <field> representa o rótulo do campo, por exemplo, "SSN" ou um rótulo automatizado que representa o tipo.

    Tipo de dados: Objeto

    "<field>": { 
  "fieldsDetails": [Array], // Check boxes, radio buttons, choice boxes only
  "pageNumber": "String",
  "type": "String"
}
    <Object>.fields_type. ​Detalhes.Campos <field> Lista de objetos que contêm o nome do campo e o valor correspondente de cada opção para tipos de campo de escolha.
    Tipos aplicáveis:
    • Caixa de seleção
    • Caixa de seleção
    • Caixa de combinação
    • Seleção múltipla

    Tipo de dados: Matriz

    "fieldsDetails": [ 
  "fieldName": "String",
  "value": "String"
]
    <Object>.fields_type. ​FieldsDetalesDentesDepoCampo.NomeCampo <field> Nome de um campo de escolha.

    Tipo de dados: Cadeia de caracteres
    <Object>.fields_type. ​NomeDetaDetaDepoDentosCampos.Valor <field> Valor de um campo de escolha.

    Tipo de dados: Cadeia de caracteres
    <Object>.fields_type. ​<field>.pagenumber Número da página do PDF correspondente a este campo.

    Tipo de dados: Cadeia de caracteres
    <Object>.fields_type. ​<field>.type Tipo de campo PDF.
    Valores possíveis:
    • check_box
    • choice_box
    • combo_box
    • multi_select_choice_box
    • push_button
    • radio_button
    • assinatura
    • texto

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como recuperar tipos de campo em um anexo PDF. Os resultados incluem retornos manuais para legibilidade e são truncados para brevidade.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.getDocumentFieldsType("<attachmentSysId>");
gs.info(JSON.stringify(result));

    Saída:

    {"fields_type":{"1ADDLINE2.25":{"pageNumber":2,"type":"text"},"1ADDLINE2.24":{"pageNumber":2,"type":"text"},
"1ADDLINE2.23":{"pageNumber":2,"type":"text"},"1ADDLINE2.22":{"pageNumber":2,"type":"text"},
"1ADDLINE2.11":{"pageNumber":2,"type":"text"},
"Check Box1":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":2,"type":"check_box"},
"4consentDate.6":{"pageNumber":4,"type":"text"},"4consentDate.7":{"pageNumber":4,"type":"text"},
"3SSN.9":{"pageNumber":3,"type":"text"},"3SSN.8":{"pageNumber":3,"type":"text"},"3SSN.7":{"pageNumber":3,"type":"text"},
"pageNumber":2,"type":"check_box"},"Check Box8":{"fieldsDetails":[{"fieldName":"Off"},{"fieldName":"yes"}],
"4planAdminDate.8":{"pageNumber":4,"type":"text"},"4planAdminDate.7":{"pageNumber":4,"type":"text"},
"1FirstName_ID.7":{"pageNumber":2,"type":"text"},
"Check Box9":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"1LN.1":{"pageNumber":2,"type":"text"},"1LN.2":{"pageNumber":2,"type":"text"},
"Check Box11":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"1LN.9":{"pageNumber":2,"type":"text"},
"Check Box17":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"Check Box16":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"1LN.7":{"pageNumber":2,"type":"text"},"Check Box19":{"fieldsDetails":[{"fieldName":"Yes"}],
"1LN.8":{"pageNumber":2,"type":"text"},"Check Box18":{"fieldsDetails":[{"fieldName":"Yes"}],
"print":{"pageNumber":2,"type":"push_button"},"4planAdministrator.1":{"pageNumber":4,"type":"text"},
"1TaxID.9":{"pageNumber":2,"type":"text"},"4SSN.1":{"pageNumber":3,"type":"text"},"4SSN.2":{"pageNumber":3,"type":"text"},
"Signature.1":{"pageNumber":4,"type":"text"},"1ZIP.2":{"pageNumber":2,"type":"text"},"1ZIP.3":{"pageNumber":2,"type":"text"},
"message":"Request completed successfully.","status":"success"}

    AppGenerationAPI – getFilledDocumentWithSignatureAsBase64(Object fieldsMap, cadeia de caracteres SYSID, PdfMergeSignSolicitante, Objeto planificado)

    Preenche campos em um PDF editável, cria uma imagem e a converte em um PDF codificado em Base64.

    A codificação base64 permite gerar um PDF como uma cadeia de caracteres em um documento de texto, como HTML ou JSON, sem danificar a sintaxe de caracteres binários.

    Use os métodos a seguir para determinar se o PDF pode ser preenchido e obter informações do campo:
    API GenerationAPI fornece métodos de preenchimento adicionais com opções diferentes:
    Tabela 20. Parâmetros
    Nome Tipo Descrição
    CamposMap Objeto Opcional. Mapa de valor-chave por nome de campo PDF e valor a ser preenchido. Use o. GetDocumentFields() método para obter a lista de campos disponíveis.
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    solicitante ​Solicitante do PdfMergeSign Entrada de assinatura retornada de PdfMergeSignSolicitante .
    achatar Objeto Opcional. O nivelamento de campos permite bloquear os campos para que outros usuários não possam alterar as informações. Especifique a chave como "FlattenType" e forneça uma opção de nivelamento como uma cadeia de caracteres.
    Valores válidos:
    • Donot_flatten - Não achata nenhum campo.
    • Partially_flatten - Planilha somente os campos modificados.
    • Fully_flatten - Planifica todos os campos.

    Padrão: Fully_flatten

    {
  "FlattenType": "String" 
}
    Tabela 21. Retornos
    Tipo Descrição
    Cadeia de caracteres Se for bem-sucedido, o PDF convertido para o formato Base64 será adicionado à tabela de anexos [sys_attachment]. O conteúdo reflete o anexo PDF fornecido com campos e assinatura preenchidos. Os campos não são editáveis, a menos que uma opção de nivelamento alternativa tenha sido fornecida com o. flattenparâmetro.
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores válidos:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • O registro de destino fornecido [<tableName> - <targetTableSysId>] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • Nenhum formulário associado ao pdf para preencher. SysId: <sys_id>
    • Não há campos editáveis com nomes especificados. Verifique e tente novamente. nomes dos campos: <field names>
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como carregar dois campos em um anexo PDF, nivelar os campos e converter o PDF para o formato Base64.

    var mymap = new Object();
mymap["City"] = "City value here";
mymap["State"] = "XX";

// create a requestor
var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;
requestor.createRequest("<sys_id>", "tableName", "<tableSysId>", "pdfName");
requestor.addSignatureMapping(6, 40, 50, 188, 44, "<signImgSysId>");
var processedRequestObj = requestor.processRequest();

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

var result = v.getFilledDocumentWithSignatureAsBase64(mymap, "<attachmentSysId>", processedRequestObj);
gs.info (JSON.stringify(result));

    PDFGenerationAPI – getPdfPageSizes(SYSID de cadeia de caracteres)

    Obtém o tamanho da página de um documento PDF.

    Tabela 22. Parâmetros
    Nome Tipo Descrição
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    Tabela 23. Retornos
    Tipo Descrição
    Objeto Objeto que contém o tamanho de cada página se bem-sucedido, mensagem de erro caso contrário. 
    {
  "pages_size": {Object},
  "message": "String",
  "status": "String"
}
    <Object>.pages_size Se a operação for bem-sucedida, a largura e a altura de cada página PDF em pontos. O número da página é retornado como uma cadeia de caracteres e os valores de medição são retornados como tipos de dados numéricos.

    Tipo de dados: Objeto

    "pages_size": {"<page number>":[<width>,<height>]}
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como exibir a largura e a altura de cada página em um anexo PDF.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.getPdfPageSizes ("<attachmentSysId>");
gs.info(JSON.stringify(result));

    Saída:

    {"pages_size":{"1":[612,792],"2":[612,792],"3":[612,792],"4":[612,792],"5":[612,792]},"message":"Request completed successfully.","status":"success"}

    AppGenerationAPI – isDocumentFillable(cadeia de caracteres SYSID)

    Verifica se o documento PDF contém campos editáveis.

    Tabela 24. Parâmetros
    Nome Tipo Descrição
    Sys ID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    Tabela 25. Retornos
    Tipo Descrição
    Objeto Objeto que contém o tamanho de cada página se bem-sucedido, mensagem de erro caso contrário. 
    {
  "document_editable": "String",
  "message": "String",
  "status": "String"
}
    <Object>. ​document_editable Se a operação for bem-sucedida, sinalize indicando se o documento é editável.
    Valores válidos:
    • Verdadeiro: O documento PDF tem campos editáveis.
    • Falso: O documento PDF não tem campos editáveis.

    Tipo de dados: Valor booliano fornecido como uma cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como determinar se os campos de documento PDF são editáveis.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.isDocumentFillable("<attachmentSysId>");
gs.info(JSON.stringify(result));

    Saída:

    {"message":"Request completed successfully.","document_editable":"true","status":"success"}

    AppGenerationAPI – Redact (Object inputJson)

    Aplica a revisão a um documento PDF com base nas coordenadas do retângulo fornecido, nas palavras-chave de pesquisa ou em ambos. Uma cópia editada do PDF original é gerada na tabela de anexos [sys_attachment].

    Nota:
    • Os resultados da revisão podem incluir um bloco de texto redigido em branco inesperado que substitui o texto não destinado a ser redigido. Se este evento ocorrer, você poderá selecionar manualmente o conteúdo para revisão usando highlightedSectionsOu o plug-in Utilitários de geração de PDF. Para obter mais informações, consulte Redact data from documents.
    • Este método não é compatível com a revisão em PDFs que contêm imagens JBIG2.
    Tabela 26. Parâmetros
    Nome Tipo Descrição
    inputJson Objeto Identifica o PDF e seu conteúdo a ser redigido.
    {
  "sysId": "String",
  "highlightedSections": [Array],
  "searchedKeywords": [Array]
}
    InputJson.SYSID Cadeia de caracteres Sys_id de um PDF na tabela de anexos [sys_attachment].
    InputJson. Secçõesrealçadas Matriz de objetivos Lista de coordenadas de retângulos fornecidas como um objeto. Cada coordenada representa o local do conteúdo a ser redigido em cada página.
    Opcional se incluir o. searchedKeywordspropriedade.
    [
   {
     "pageNumber": Number,
     "x": Number,
     "y": Number,
     "width": Number,
     "height": Number
   }
]
    InputJson. Secçõesrealçadas. Número de página Número Número da página do PDF que contém o conteúdo a ser selecionado para revisão.
    InputJson. Secçõesrealçadas. x Número O eixo X (posição horizontal) do retângulo de revisão no PDF em pontos. O valor no canto inferior esquerdo da página PDF é 0. Por exemplo, um valor de 306 Coloca o retângulo aproximadamente no centro horizontal de uma página PDF tamanho carta.
    InputJson. Secçõesrealçadas. . Número O eixo Y (posição vertical) do retângulo de revisão no PDF em pontos. O valor no canto inferior esquerdo da página PDF é 0. Por exemplo, um valor de 396 Coloca o retângulo aproximadamente no centro vertical de uma página PDF tamanho carta.
    InputJson. Secçõesrealçadas. largura Número A largura do retângulo de revisão está em pontos. Este valor aumenta o tamanho do retângulo horizontalmente a partir do ponto inferior esquerdo no qual os eixos x e y se cruzam.
    InputJson. Secçõesrealçadas. altura Número Altura do retângulo de revisão em pontos. Este valor aumenta o tamanho do retângulo verticalmente a partir do ponto inferior esquerdo no qual os eixos x e y se cruzam.
    InputJson. BusarchedKeywords Matriz Lista de uma ou mais cadeias de caracteres usadas para encontrar texto para redação. O tamanho do retângulo de revisão corresponde à altura e à largura do texto que é bloqueado como resultado.
    Opcional se incluir o. highlightedSectionspropriedade.
    Nota:
    Em alguns casos, cadeias de caracteres de texto que contêm caracteres especiais ou pontuação, como "itens:" e. "PDF." não foram redigidos. Como alternativa, você pode remover o caractere da cadeia de caracteres ou realçar a área para remover o texto.
    Tabela 27. Retornos
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo PDF atualizado se bem-sucedido, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>. ​attachment_id Se a operação for bem-sucedida, sys_id do PDF preenchido. O arquivo está listado na tabela de anexos [sys_attachment].

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Não é possível analisar este formato – Não é possível processar uma imagem incorporada no PDF. O PDF contém uma ou mais imagens em um formato incompatível, como uma imagem JBIG2.
    • Exceção ao ler o conteúdo do documento de origem. Cabeçalho do PDF não encontrado. – O anexo de entrada fornecido não é um PDF válido. Forneça o sys_id do anexo correto.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] não passou na verificação de segurança. O PDF não passou na verificação antivírus.
    • A solicitação não pode prosseguir porque o anexo com sys_id [(0)] está com verificação de segurança pendente. O PDF requer uma verificação antivírus.
    • Solicitação concluída com sucesso – A operação foi bem-sucedida.
    • Indefinido - O sys_id fornecido não existe ou não é um anexo PDF.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • Sucesso - A operação foi bem-sucedida.
    • Falha - A operação não foi bem-sucedida. . messagefornece detalhes.

    Tipo de dados: Cadeia de caracteres

    O exemplo a seguir mostra como redigir por retângulo e palavra-chave. No PDF redigido, as áreas selecionadas na página 2 estão bloqueadas. A cadeia de caracteres "23" é redigida em qualquer página em que foi encontrada.

    var pdfRequest = {
  sysId: 'e4b3ae35fc128210f877789781ea59f3',
  highlightedSections: [
    {
      "pageNumber": 2,
      "x": 261.75,
      "y": 480,
      "width": 21,
      "height": 14.25
    },
    {
      "pageNumber": 2,
      "x": 249,
      "y": 390.75,
      "width": 63.75,
      "height": 15.75
    }
    // Add more coordinates as needed
  ],
  searchedKeywords: ['23']
};

// Convert the JSON object to a string
var jsonRequest = JSON.stringify(pdfRequest);
gs.info('JSON Request: ' + jsonRequest + '\n');

var PDFRedaction = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = PDFRedaction.redact(jsonRequest);
gs.info(JSON.stringify(result));

    Saída:

    JSON Request: {"sysId":"e4b3ae35fc128210f877789781ea59f3","highlightedSections":[{"pageNumber":2,"x":261.75,"y":480,"width":21,"height":14.25},{"pageNumber":2,"x":249,"y":390.75,"width":63.75,"height":15.75}],"searchedKeywords":[23]}

{"attachment_id":"1744ae35fc128210f877789781ea59fc","message":"Request completed successfully.","status":"success"}