...
Esta API irá retornar o resultado de uma consulta SQL cadastrada na base de dados. Está disponível a partir da versão 12.1.28.
1 - Métodos
...
A API de ConsutltaSQL implementa somente o método GET.
...
Informações |
---|
icon | false |
---|
title | 1.1.2 Order (Asc) |
---|
|
Expandir |
---|
Informações |
---|
icon | false |
---|
title | Configuração |
---|
| Máscara de Url: http://{domínio}:{porta}/api/framework/v1/consultaSQLServer/RealizaConsulta/1/1/A/?parameters=CODCOLIGADA%3D0%3BCODCOLIGADA1%3D10 Informações |
---|
icon | false |
---|
title | Exemplo de Configuração |
---|
| Domínio: localhost Porta: 8051 codSentenca: 1 codColigada: 1 codSistema: A Url Utilizada: http://localhost:8051/api/framework/v1/consultaSQLServer/RealizaConsulta/1/1/A/?parameters=CODCOLIGADA%3D0%3BCODCOLIGADA1%3D10 |
|
Informações |
---|
icon | false |
---|
title | Exemplo de Resultado |
---|
| Expandir |
---|
title | Ver resultado JSON... |
---|
| Bloco de código |
---|
language | js |
---|
firstline | 1 |
---|
title | Resultado (JSON) |
---|
linenumbers | true |
---|
| [
{
"CODCOLIGADA": 0,
"NOMEFANTASIA": "COLIGADA GLOBAL"
},
{
"CODCOLIGADA": 1,
"NOMEFANTASIA": "TOTVS SA"
},
{
"CODCOLIGADA": 6,
"NOMEFANTASIA": "INSTITUTO TOTVS DE ENSINO SA"
},
{
"CODCOLIGADA": 7,
"NOMEFANTASIA": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA"
}
] |
|
|
|
|
1.1.3 - Context (Contexto para execução da sentença SQL)
Informações |
---|
|
As Sentenças SQL cadastradas na Coligada Global (coligada zero) são executadas levando em consideração todas as coligadas que o usuário possui permissão. Exemplo: Um usuário possui permissão na coligada 1 e na coligada 2 e possui filtro por perfil cadastrados em ambas as coligadas. Ao executar uma sentença da Coligada Global o sistema irá restringir o resultado de acordo com os filtros cadastrados em ambas as coligadas. Caso o usuário queira restringir o resultado levando em consideração apenas uma coligada específica, basta informar a coligada no contexto conforme mostrado abaixo.
Context: contexto para execução da sentença SQL, deve ser informado como URL encode. Exemplos: http://{domínio}:{porta}/api/framework/v1/consultaSQLServer/RealizaConsulta/1/0/A/?context=CODCOLIGADA%3D1 http://{domínio}:{porta}/api/framework/v1/consultaSQLServer/RealizaConsulta/1/0/A/?parameters=chapa%3D00001&context=CODCOLIGADA%3D1 http://{domínio}:{porta}/api/framework/v1/consultaSQLServer/RealizaConsulta/1/0/A/?context=CODCOLIGADA%3D1¶meters=chapa%3D00001
Nota |
---|
title | Importante saber que: |
---|
| - Sentenças SQL cadastradas em uma coligada específica, por exemplo Coligada 1, sempre será executada no contexto da Coligada 1 mesmo que seja informada uma outra coligada no contexto.
- Sentenças SQL cadastradas na Coligada Global será executada preferencialmente na coligada informada no contexto.
Na dúvida consulte o quadro a seguir: Coligada da Sentença SQL | Coligada informada no Contexto | Coligada que será Considerada |
---|
0 | null | 0 | 0 | 1 | 1 | 1 | null | 1 | 1 | 2 | 1 |
|
Aviso |
---|
| Disponível a partir das versões 12.1.31.260. 12.1.32.205, 12.1.33.127 e 12.1.34 |
|