info.apidoc
3.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/**
* @api {get} /info/versao Consultar versão
* @apiName getNumeroVersao
* @apiGroup Info
* @apiVersion 2.0.0
*
* @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível.
*
* @apiExample {curl} Exemplo de requisição:
* curl -i http://<host>/sei-broker/service/info/versao
*
* @apiSuccess {String} versao Número da versão.
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/
/**
* @api {get} /info/conexoes/mysql Testar conexão MySQL
* @apiName testMySQLConnection
* @apiGroup Info
* @apiVersion 2.0.0
*
* @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco.
*
* @apiExample {curl} Exemplo de requisição:
* curl -i http://<host>/sei-broker/service/info/conexoes/mysql
*
* @apiSuccess {String} versao Número de versão do MySQL.
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/
/**
* @api {get} /info/conexoes/oracle Testar conexão Oracle
* @apiName testOracleConnection
* @apiGroup Info
* @apiVersion 2.0.0
*
* @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco.
*
* @apiExample {curl} Exemplo de requisição:
* curl -i http://<host>/sei-broker/service/info/conexoes/oracle
*
* @apiSuccess {String} versao Número de versão do Oracle.
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/
/**
* @api {get} /info/conexoes/sei Testar conexão SEI
* @apiName testSEIConnection
* @apiGroup Info
* @apiVersion 2.0.0
*
* @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades.
*
* @apiExample {curl} Exemplo de requisição:
* curl -i http://<host>/sei-broker/service/info/conexoes/sei
*
* @apiSuccess {String} mensagem Mensagem de sucesso.
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/
/**
* @api {get} /info/requests Listar Requests
* @apiName getUltimosRequests
* @apiGroup Info
* @apiVersion 2.0.0
*
* @apiDescription Lista os requests recebidos pelo broker.
*
*
* @apiParam (Query Parameters) {String} [operacao] nome do método acessado
* @apiParam (Query Parameters) {String} [origem] usuário que originou a requisição
* @apiParam (Query Parameters) {int} [pag=1] número da página
* @apiParam (Query Parameters) {int} [itens=50] quantidade de itens listados por página
*
* @apiExample {curl} Exemplo de requisição:
* curl -i http://<host>/sei-broker/service/info/requests
*
* @apiSuccess {String} mensagem Mensagem de sucesso.
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/