Relatórios

Obtendo relatórios

GET: /v1/relatorios/{types}/{offset}/{limit}/

Retorno:

{
  "status": true,
  "data": {
    "SocialAPI": [
      {
        "id": "5218650135974101770",
        "uupfid": "4799192428953130775",
        "type": "servidores",
        "promise": [
          {
            "status": "_done",
            "datetime": "2019-09-18 14:01:36",
            "file": {
              "file_url_pdf": "http://bit.ly/32Qff3i",
              "file_url_original": "https://s3-sa-east-1.amazonaws.com..."
            }
          },
          {
            "status": "_progress",
            "datetime": "2019-09-18 13:50:03"
          },
          {
            "status": "_created",
            "datetime": "2019-09-18 13:46:15"
          }
        ],
        "params": {
          "oeid": "10a847803d538b92eab94d19766737",
          "date_start": null,
          "date_end": null,
          "categoria": null,
          "lotacao": null,
          "fields": [],
          "filter": []
        }
      }
    ]
  }
}

Solicitando um novo relatório

POST: /v1/relatorios/

Validação do body:

• Os campos date_start, date_end, lotacao e categoria são opcionais, para tanto, informar com valor null.
• Tipos de relatórios disponíveis (type):
  • servidores, dinamico, fullfilment
• Cosultar os field e filtros permitidos para cada tipo de relatório

Payload:

{
   "date_start":"aaaa-mm-dd",
   "date_end":"aaaa-mm-dd",
   "lotacao": "SECRETARIA DE SAUDE",
   "categoria": [1, 2],
   "cargo": "PROFESSOR",
   "type":"servidores",
   "fields": [],
   "filters": []
}

Retorno:

Status code: 201

Removendo um relatório

DELETE: /v1/relatorios/{report_id}/

Payload: {empty}

Retorno:

Status code: 204, 404

Collection

{
   "id":"",
   "oid":"",
   "uupfid":"",
   "type":"vhky6p",
   "promise":[
      {
         "status":"done",
         "datetime":"",
         "file":{
            "file_url_pdf":"",
            "file_url_csv":""
         }
      },
      {
         "status":"progress",
         "datetime":""
      },
      {
         "status":"queued",
         "datetime":""
      },
      {
         "status":"created",
         "datetime":""
      }
   ],
   "params":{
      "oeid":"",
      "date_start":"",
      "date_end":""
   },
   "status":[
       {
           "active": true,
           "uupfid": "{uupfid}"
           "data_hora": "2019-09-18 13:46:15"
       }
   ]
}

Layout do relatório de servidores e servidores-inativos

Título: Relatório de Servidores {se algum filtro for informado, concatenar o nome aqui, ex: "por Categoria"/"por Lotação"}

Órgão: {nome_do_oid_token} Entidade: {nome_do_oeid_token}

Caso algum filtro seja aplicado: Intervalo: {data_inicio}/{data_fim} Categoria: {categoria} Cargo: {cargo_nome}

CPF;Matrícula;Nome;Sexo;Nascimento;