Custom View¶
Execução da Custom View¶
Introdução¶
Consumindo Consultas Customizadas¶
Quando a necessidade exige que o formato dos dados retornados pela consulta (requisição HTTP) não necessáriamente remeta ao formato de qualquer entidade do modelo de dados do Portal Cosmos Pro, porém ainda é necessário a utilização de suporte a funções avançadas de consultas do lado server da API como Paginação e Ordenação dos resultados da consulta, utilize o endpoint OData CustomViews da Cosmos Pro Web API, esse endpoint possui capacidade de execução de Consultas Customizadas previamente desenvolvidas através do portal Web do Portal Cosmos Pro.
Não é possível alterar dados através da execução de Comsultas Customizadas do Portal Cosmos Pro.
Requisição¶
-
Url¶
-
Parâmetros da Url
- [porta] = 9191
- [nomedacustomview] = string (nome da custom view criada)
-
Informação
O valor "Teste" fornecido para o parametro Name da ação ExecuteAndReceiveData da URL base da requisição é apenas exemplo.
| Nome | Valor | Observação |
|---|---|---|
| Content-Type | application/json | Tipo de conteúdo da requisição. |
| Authorization | Bearer [Token] | Token de Autenticação obtido junto ao Administrador do Inquilino Cosmos Pro. |
???+ warning "Exemplo"
Nome Valor Observação
Content-Type application/json
Authorization Bearer 58c7baf4-9d64-ea11-840e-00155d0cb303
-
Corpo da Requisição¶
No corpo da requisição HTTP deve-se enviar um objeto JSON com uma elemento para cada parametro necessário para execução da CustomView.
???+ optional-class "Exemplo" { "Parameters": { "datainicial":"2017-07-24T00:00:00.000", "datafinal":"2017-07-25T00:00:00.000" } }
Resposta¶
-
Códigos de Estado Possíveis de Resposta¶
| HTTP Status Code | Motivo | Observação |
|---|---|---|
| 200 | Query Executada com Sucesso. | |
| 400 | Requisição mal formatada | O elemento message do objeto JSON retornado possui mais detalhes sobre a resposta. |
| 401 | Não autorizado | Acesso não autorizado |
| 500 | Requisição não processada |
-
Corpo da Resposta¶
Um objeto JSON que representa um array com a coleção de registros retornados pela execução da CustomView é anexado ao corpo da resposta HTTP.
???+ success "Exemplo de Resposta com Sucesso"
HTTP Status Code Motivo Observação
200 Dados Processados com sucesso.
json
{
"@odata.context": "https://portal.cosmospro.com.br:9191/odata/$metadata#CustomViewDataRows",
"value": [
{
"InResultId": 1,
"ExecutionGuid": "00000000-0000-0000-0000-000000000000",
"teste": 1
}
]
}
Para causar o erro coloquei um dos parânetros incorretos como verá abaixo.
{
"Parameters":
{
"dataInicial":"2017-07-24T00:00:00.000",
"datafinal":"2017-07-25T00:00:00.000"
}
}
???+ danger "Exemplo de Resposta com Erro"
HTTP Status Code Motivo Observação
400 Requisição mal formatada
Nos detalhes trará um texto com o erro informado
Parâmetro(s) dataInicial inexistentes para a CustomView:teste.
Desenvolvimento da Custom View¶
Introdução¶
Desenvolvendo uma Custom View do Portal Web¶
Desenvolvendo tarefas através do Portal Web do Cosmos Pro para utilizar nas Ações Customizadas da API.
Menu¶
Para acessar a custom view, clique no menu Configurações > Custom View.
Custom View¶
Ao acessar a custom view irá ser listado todas as custom view desenvolvidas, e poderá desenvolver uma nova custom view clicando no botão Adicionar Custom View.
Desenvolvendo uma Custom View¶
Abaixo iremos criar uma custom view.
???+ note "Abaixo Exemplo" Abaixo ao clicar nas guias, poderá verificar exemplos de como criar uma custom view com suas devidas configurações.
Titulo: Teste
Comando Select: select 1 as teste where @datainicial = '2017-07-24T00:00:00.000' and @datafinal = '2017-07-25T00:00:00.000'
Obs. É necessário salvar para liberar a aba de parâmetros.
Tipos de Entrada (Clica no + para adicionar)
Nome do Parâmetro | Tipo do Parâmetro |
datainicial | DateTime | Salvar
datafinal | DateTime | Salvar
Lembrando que o parâmetro cadastrado será o mesmo utilizado no Json da API.
Volta para a tela do SQL e clica em salvar.