Histórico da Página
...
Serviço de leitura de schema de tabelas físicas;
GET /api/trep/v1/dbdataproviders/schematableRecebe
Application/JSON
Retorna
Application/JSON
Esse método é utilizado para retornar o schema (estrutura) de uma tabela localizada fisicamente em um determinado provedor de dados.
No Json de entrada devem ser enviadas os seguintes informações:
- providerParams: Parâmetros do provedor de dados. Devem ser enviados os parâmetros recuperados pelo serviço acima "GET /api/trep/v1/dbdataproviders/parameters".
- tableSourceName: Nome da tabela do banco de dados;
tablesSourceGetRelations: Lista de todas as tabelas físicas cadastradas no dicionário de dados do relatório. Através dessa lista, todas os relacionamentos entre essas tabelas poderão ser recuperados automaticamente. Evitando assim, o cadastro manual dos relacionamentos.
Informações title Exemplo de json de entrada {
“providerParams” : [{
“name” : “aliasName”,
“description” : “Nome do alias do RM”,
“value” : “CorporeRM”,
“isPassword” : false,
}],
"tableSourceName": "PFUNC",
"tablesSourceGetRelations": [
{"tableSourceName", "PFUNC"},
{"tableSourceName", "PFUNC"}
]
}
No JSON de retorno, deve constar as seguintes informações:
schemaTable: objeto contendo as seguinte informações:
- tableSourceName: Nome da tabela de banco de dados;
- tableSourceDescription: Descrição da tabela de banco de dados. Essa informação pode ser recuperada de um dicionário de dados.
- columns: lista contendo as seguinte informações:
- columnName: Nome da coluna;
- columnDescription: Descrição da coluna da tabela. Essa informação pode ser recuperada de um dicionário de dados.
- columnType: tipo da coluna;
- schemaRelations: lista contendo as seguinte informações:testSuccess: Informa se o teste do bem sucedido. Pode ser true ou false
- relationName: Nome do relacionamento recuperado de um dicionário de dados;
- parentTableSourceName: Nome da tabela pai em um relacionamento;
- childTableSourceName: Nome da tabela filha em um relacionamento;
- parentColumns: lista de colunas da tabela pai em um relacionamento contendo as seguinte informações:
- columnName
- childColumns: lista de colunas filhas em um relacionamento contendo as seguinte informações:
- columnName
Informações | ||
---|---|---|
| ||
{ “schemaTable” : { "tableSourceName": "PFUNC", "tableSourceDescription": "Funcionários", "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"}] }, “relations” : [{ "relationName": "PFUNC_PFDEPEND", "parentSourceName": "PFUNC", "childSourceName": "PFDEPEND", "parentColumns": [{"columnName": "CODCOLIGAGA"}, {"columnName": "CHAPA"}], "childColumns": [{"columnName": "CODCOLIGAGA"}, {"columnName": "CHAPA"}], ] |
“testSuccess” : true;
...