Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...


    • GET /api/trep/v1/dbdataproviders/data

      Recebe

      Application/JSON

      Retorna

      Application/JSON

      Esse método é utilizado para retornar os dados do relatórios. 

      No Json de entrada devem ser enviadas as seguintes informações: 

      • providerParamsParâmetros do provedor de dados.
      • sentenceMember: Objeto contendo as seguinte informações:
        • entityName: Nome da entidade cadastrada no reports que receberá os dados.

        • sqlText: sentença sql a ser disparada no banco de dados;
        • sqlParametersLista de objeto contendo informações dos parâmetros da sentença sql:

          • paramName: Nome do parâmetro da sentença sql;

          • paramValue: Valor do parâmetro da sentença sql;
          • paramType: Tipo do parâmetro;
        • maxRecords: número máximo de registros a serem retornados. Se o valor for < 0 (default), serão retornados todos os registros.
        Informações
        titleExemplo de json de entrada

        {

                    “providerParams” : [{

                    “description” : “Nome do alias do RM”,

                    “value” : “CorporeRM”,

                    “isPassword” : false,

                    }],

                    "sentenceMember": {

                                "entityName": "Funcionarios",

                                "sqlText": "select * from pfunc where codcoligada = :codcol",

                                "sqlParameters": [{

                                            "paramName": "codcol",

                                            "paramValue": "1",

                                            "paramType": "system.Int32"

                                }],

                                maxRecords: 10}

        }

              No JSON de retorno, deve constar as seguintes informações:

      • entityName: Nome da entidade enviada no parâmetros "entityName" do objeto de request;

      • data: Dados recuperadas no banco de dados através da execução da sentença sql enviada no objeto de request:
      • Informações

        Os dados recuperados devem ser retornados no formato xml ou no formato json. É necessário enviar no cabeçalho do http-response o contentda resposta o tipo de conteúdo enviado. Content-type = application/xml ou Content-type = application/json.


Informações
titleExemplo de json de retorno

{

            “schemaSql” “entityName” : {                        "columns": [ {"columnName": "CODCOLIGADA", "columnDescription": "Codigo da coligada", "columnType": "System.Int32"},

                                                 {"columnName": "CHAPA", "columnDescription": "Chapa do funcionario", "columnType": "System.string"},

                                                 {"columnName": "SALARIO", "columnDescription": "Salario do funcionário", "columnType": "System.double"}]

            },

]

Esse método é utilizado na tela de cadastro de entidade do tront-end do reports, ao escolher uma fonte de dados ligada a uma sentença sql:

...

Funcionarios",

              "data": "xml ou json contendo o resultado da execução da sentença sql"

}