Exportando e convertendo registros em tipos de dados complexos

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 3 min. de leitura

    • Use parâmetros de URL para exportar registros de tabela e convertê-los em tipos de dados complexos, como JSON, XML, PDF, CSV e XLS.

    Exportando registros como tipos de dados complexos

    Você pode usar uma solicitação HTTP GET para recuperar registros de uma tabela e colocá-los em um formato especificado. Por exemplo, use o parâmetro PDF em uma solicitação GET para exportar registros de uma tabela como arquivos PDF; use o parâmetro XLS para exportar registros de uma tabela como arquivos XLS. Por exemplo, para recuperar uma lista de registros de incidentes como arquivos XLS, emita um HTTP GET usando o seguinte URL: https://instance_name.service-now.com/incident.do?XLS. O arquivo retornado é incident.xls. incident.do é basicamente um GET que retorna uma lista dos registros da tabela de incidentes. O parâmetro XLS converte esses registros em arquivos XLS.

    A sintaxe geral é: https://<serviceNow-instance-name> /<table-name> .fazer?<Data-type-parameter>

    Parâmetros de URL

    A tabela a seguir mostra parâmetros de URL que você pode usar em solicitações GET, filtros que você pode usar para filtrar registros de tabela indesejados no retorno e um indicador que indica se você pode POSTar o tipo de dados diretamente em uma tabela. O parâmetro se torna a extensão do arquivo retornado, por exemplo, usar o parâmetro XLS retorna um arquivo no formulário<table-name> .xls.
    Tabela 1. Parâmetros de URL
    Tipo de dados Parâmetro Filtros válidos POST direto na tabela?
    CSV CSV sysparm_query, sysparm_view Y
    Excel XLS, EXCEL, XLSX sysparm_query, sysparm_view Y
    JSON JSONv2 Vários. Consulte API de recuperação de dados JSON. Y
    PDF PDF sysparm_query, sysparm_view N
    RSS RSS sysparm_query, sysparm_view e muito mais. Consulte Como limitar os resultados com uma exibição. N
    XML XML, XSD, SCHEMA sysparm_query, useUnloadFormat N

    Para obter mais informações sobre como recuperar e converter registros de tabela no formato de arquivo JSON, consulte JSONv2 Web Service.

    Para obter mais informações sobre como recuperar e converter registros de tabela no formato de arquivo RSS, consulte Gerador de feed RSS.

    Convertendo registros em PDFs

    Para exportação em PDF, há uma distinção entre direcionar uma tabela e direcionar sua lista. Para gerar um PDF de uma lista de registros, sufixe o destino com _list. Para direcionar um único registro, você deve especificar o parâmetro sys_id para identificar o registro para o qual você está gerando o PDF.

    Filtros

    Todos os parâmetros de URL funcionam com filtros que permitem exportar um subconjunto de registros de tabela. Por exemplo, sysparm_query=active=true em uma solicitação GET exporta somente registros ativos. O exemplo a seguir exporta somente registros de incidentes ativos em um formato do Excel: https://instance_name.service-now.com/incident.do?EXCEL&sysparm_query=active=true.

    A sintaxe geral é: https://<serviceNow-instance-name> /<table_list> .fazer?<Data-type-parameter> e<filter>

    Os filtros incluem:
    • sysparm_query: filtra os dados usando a consulta codificada antes de exportar arquivos, por exemplo, sysparm_query=active=true exporta somente registros ativos.
    • sysparm_view: especifique o nome de uma exibição de lista para controlar quais campos são retornados. Por exemplo, para retornar a exibição ESS, use sysparm_view=ess.
    • useUnloadFormat: indica que o formato XML retornado é um formato de descarregamento. O formato de descarregamento é o mesmo que você obtém quando, em uma lista na IU, seleciona Exportar > XML > ... Você pode importar arquivos XML formatados para descarregamento de volta para as tabelas. Para habilitar o formato de descarregamento de um URL, use o parâmetro de URL useUnloadFormat=true, por exemplo, https://instance_name.service-now.com/incident.do?XML&useUnloadFormat=true.

    Exemplo de consultas GET

    Tabela 2. Exemplos de solicitação GET
    Tipo de dados Consulta de exemplo
    CSV https://instance_name.service-now.com/incident.do?CSV&sysparm_query=active=true
    Excel https://instance_name.service-now.com/incident.do?XLS&sysparm_query=active=true
    PDF https://instance_name.service-now.com/incident.do?PDF&sysparm_view=ess
    RSS https://instance_name.service-now.com/incident.do?RSS&sysparm_view=ess
    XML https://instance_name.service-now.com/incident.do?XML&sysparm_query=active=true

    Arquivos retornados

    As consultasGET retornam registros de uma tabela no formato especificado na solicitação. Por exemplo, uma consulta que usa o parâmetro XLS retorna um registro de tabela em um arquivo com a extensão .xls.

    O cabeçalho Content-Disposition na resposta exibe o nome do arquivo e a extensão do arquivo retornado. O nome do arquivo é baseado na tabela da qual você exporta, como incident.xls, incident.pdf ou incident.xml.

    Exportando dados para tabelas

    Você pode POSTar os seguintes tipos de dados diretamente nas tabelas:
    • CSV
    • Excel
    • JSON

    Os cabeçalhos do arquivo devem corresponder às colunas de campo na tabela de destino. Para obter mais informações, consulte Publicação de arquivos CSV ou Excel diretamente em um conjunto de importação.