Exportar Relatório

O relatório será gerado conforme as configurações dos campos setados. Os parâmetros de busca são os mesmos do método load_objects. O método HTTP usado é o POST.

POST /report_generate.fcgi

Parâmetros

  • object (string) : Tipo do objeto a ser criado. Consulte o tópico Lista de Objetos para uma lista completa dos tipos de objeto disponíveis.
  • values (array de objetos JSON) : Cada elemento deve ser um objeto JSON representando o objeto a ser criado. Cada chave deve ser um campo válido do objeto e os valores devem ter o tipo apropriado. Todos os objetos JSON devem ter os mesmos campos.

Resposta

  • object (string) : Esse campo representa o tipo de relatório que será gerado, por exemplo, "users".
  • file_name (string) : Esse campo representa o nome do arquivo de saída (opcional).
  • delimiter (string) : Esse campo representa o tipo de delimitador de campo, similar a estrutura de um arquivo .csv, por exemplo: ";" ou "," (opcional).
  • header (string) : Esse campo representa o cabeçalho do relatório (opcional).
  • line_break (string) : Esse campo representa a quebra de linha, podendo ser um simples "\n" (opcional).
  • columns (objeto JSON) : Esse campo determina as colunas que serão mostradas no relatório (muito similar ao campo fields do método load_objects). Este campo é um array que contém objetos, estes objetos possuem os seguintes campos:
    • field (string) : Esse campo pertence ao objeto columns e representa o nome do campo que será gerado.
    • type (string) : Este campo pertence ao objeto columns e determina o tipo da coluna. Pode ser: "object_fileld" (Campo de coluna normal), "counter" (Contador de registros) e "fixed" (Campo fixo).
      • object_field (string) : Este é um campo de coluna normal. Este objeto terá dois campos, field e object, do tipo string, que representam a coluna e tabela respectivamente.
      • counter (string) : Este objeto terá dois campo opcionais inteiros: offset (representa valor inicial do contador. Padrão: 0) e step (representa o passo do contador. Padrão: 1).
      • fixed (string) : Este objeto contem um campo obrigatório do tipo string que representa o valor fixo da coluna.
    • format (objeto JSON) : Este campo pertence ao objeto columns, e determina como a coluna será formatada e apresenta (opcional). Este objetos possui os seguintes campos:
      • adjustment (string) : Esse campo representa se a coluna deve estar alinha a esquerda, direita ou nenhum ajuste deve ser feito(opcional).
      • fill (string) : Esse campo determina o valor do preenchimento dos espaços vazios, por exemplo: "0" (opcional).
      • format (string) : Esse campo representa a formatação do coluna, por exemplo: "%d : dia, %m : mês, %Y : ano, %H : horas, %M : minutos, %S: segundos" (opcional).
      • width (int) : Esse campo representa o ajuste do tamanho da coluna (opcional).

Exemplo de requisição

Gerando relatório:

$.ajax({
  url: "/report_generate.fcgi?session=" + session,
  type: 'POST',
  contentType: 'application/json',
  data: JSON.stringify({
      order:["ascending","name"],
        "where":{
              "users":{},
              "groups":{},
              "time_zones":{}
          },
          object:"users",
          delimiter:";",
          line_break:"\\r\\n",
          header:"Nome (Usuário);Código (Usuário)",
          file_name:"",
          join:"LEFT",
          columns:[
            {
                type:"object_field",
                object:"users",
                field:"name",
                format:{
                    adjustment:1,
                    width:50,
                    fill:" ",
                    format:"%s"
                }
              },
              {
                type:"object_field",
                object:"users",
                field:"id",
                format:{
                    adjustment:2,
                    width:5,
                    fill:"0",
                    format:"%s"
                }
              }
          ]
  })
});