Custom Action¶
Execução da Custom Action¶
Introdução¶
Acionando Ações Customizadas¶
Como dito anteriormente, Consultas Customizadas não oferecem suporte a efetuar requisões que alterem dados do Cosmos Pro, essa limitação existe para que os recursos como Armazenamento de Cache do Resultado da Consulta, Paginação, Filtros , Ordenação e etc sejam possiveis.Porem em certas ocasiões, as operações CRUD da Cosmos Pro Web API (que são baseadas no Modelo de Dados) também não atendem a necessidade da integração.
Utilize Ações Customizadas para acionar tarefas previamente desenvolvidas através do Portal Web do Cosmos Pro.
Requisição¶
-
Url¶
-
Parâmetros da Url
- [porta] = 9191
- [nomedacustomaction] = string (nome da custom action criada)
-
-
Método de Envio da Requisição¶
Post -
Cabeçalhos da Requisição (Header)¶
| Nome | Valor | Observação |
|---|---|---|
| Content-Type | application/xml, application/json ou text/plain | Especifica o tipo de dados do corpo da requisição HTTP. |
| Accept | application/xml, application/json ou text/plain | Especifica o tipo de dados do corpo da resposta HTTP. |
| 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
Accept application/json
Authorization Bearer 58c7baf4-9d64-ea11-840e-00155d0cb303
-
Corpo da Requisição¶
Objeto a ser enviado ao Cosmos Pro, respeitando o formato especificado no header "Content-Type" da requisição HTTP.
???+ warning "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 que representa a resposta do processamento da ação customizada no formato correspondente ao solicitado no herader "Accept" da requisição.
???+ success "Exemplo de Resposta com Sucesso"
HTTP Status Code Motivo Observação
200 Dados Processados com sucesso.
json
{
"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
Header 'Content-Type' (application/x-www-form-urlencoded) não suportado para essa API.
Desenvolvimento da Custom Action¶
Introdução¶
Desenvolvendo uma Custom Action 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 action, clique no menu Configurações > Custom Action.
Custom Action¶
Ao acessar a custom action irá ser listado todas as custom action desenvolvidas, e poderá desenvolver uma nova custom action clicando no botão Adicionar Custom Action.
Desenvolvendo uma Custom Action¶
Abaixo iremos criar uma custom action.
???+ note "Abaixo Exemplo de Criação de Custom Action" Abaixo ao clicar nas guias, poderá verificar exemplos de como criar uma custom action com suas devidas configurações.
Titulo: DRE
Comando Sql: Set @CustomActionResponseContent = @CustomActionReceivedContent
Ativo: True
Tipos de Entrada (Clica no + para adicionar)
Ativo | Tipos Permitidos | Botão
True | Json | Salvar
Tipos de Saída (Clica no + para adicionar)
Ativo | Tipos Permitidos | Botão
True | Json | Salvar