Commit 373bb75d37e07e25e3e5bdd9d40f6b7a016d0564
1 parent
dc14e694
Exists in
master
and in
1 other branch
Documentação dos serviços do domínio SIPAR, melhoria no serviço de criação de bl…
…oco que passou a permitir a sigla da unidade.
Showing
6 changed files
with
362 additions
and
34 deletions
Show diff stats
src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java
| ... | ... | @@ -257,8 +257,8 @@ public class BlocoResource { |
| 257 | 257 | @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) |
| 258 | 258 | @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) |
| 259 | 259 | public Response gerarBloco(@PathParam("unidade") String unidade, NovoBloco bloco) throws Exception{ |
| 260 | - String retorno = seiNativeService.gerarBloco(Constantes.SEI_BROKER, Operacao.GERAR_BLOCO, unidadeResource.consultarCodigo(unidade), bloco.getTipo().getCodigo(), bloco.getDescricao(), bloco.getUnidades(), | |
| 261 | - bloco.getDocumentos(), getSOuN(bloco.isDisponibilizar())); | |
| 260 | + String retorno = seiNativeService.gerarBloco(Constantes.SEI_BROKER, Operacao.GERAR_BLOCO, unidadeResource.consultarCodigo(unidade), bloco.getTipo().getCodigo(), | |
| 261 | + bloco.getDescricao(), unidadeResource.buscarCodigoUnidades(bloco.getUnidades()), bloco.getDocumentos(), getSOuN(bloco.isDisponibilizar())); | |
| 262 | 262 | |
| 263 | 263 | return Response.created(getResourcePath(retorno)).entity(retorno).build(); |
| 264 | 264 | } | ... | ... |
src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java
| ... | ... | @@ -45,20 +45,24 @@ public class SiparResource { |
| 45 | 45 | private static int FALSE = 0; |
| 46 | 46 | |
| 47 | 47 | /** |
| 48 | - * @api {put} /sipar/importados Importar Processo SIPAR | |
| 48 | + * @api {post} /sipar/importados Importar Processo | |
| 49 | 49 | * @apiName importarProcesso |
| 50 | 50 | * @apiGroup SIPAR |
| 51 | 51 | * @apiVersion 2.0.0 |
| 52 | 52 | * |
| 53 | 53 | * @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI). |
| 54 | - * | |
| 55 | - * @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111 | |
| 54 | + * | |
| 55 | + * @apiParam (Header Parameters) {String} content-type Informar text/plain | |
| 56 | + * @apiParam (Request Body) {String} processo Número do processo a ser importado | |
| 56 | 57 | * |
| 57 | - * @apiExample {curl} Exemplo de requisição: | |
| 58 | - * curl -i http://<host>/sei-broker/service/sipar/importados | |
| 58 | + * @apiExample Exemplo de requisição: | |
| 59 | + * endpoint: [POST] http://<host>/sei-broker/service/sipar/importados | |
| 60 | + * | |
| 61 | + * body: | |
| 62 | + * 33902112492200241 | |
| 59 | 63 | * |
| 60 | 64 | * @apiSuccessExample {json} Success-Response: |
| 61 | - * HTTP/1.1 204 No Content | |
| 65 | + * HTTP/1.1 201 Created | |
| 62 | 66 | * |
| 63 | 67 | * @apiErrorExample {json} Error-Response: |
| 64 | 68 | * HTTP/1.1 500 Internal Server Error |
| ... | ... | @@ -111,17 +115,17 @@ public class SiparResource { |
| 111 | 115 | } |
| 112 | 116 | |
| 113 | 117 | /** |
| 114 | - * @api {put} /processos-fisicos/{processo}/desmigracao 2.Desmigra Processo | |
| 115 | - * @apiName desmigra | |
| 118 | + * @api {delete} /sipar/importados/:processo Cancelar Importação Processo | |
| 119 | + * @apiName cancelarImportacaoProcesso | |
| 116 | 120 | * @apiGroup SIPAR |
| 117 | - * @apiVersion 1.0.0 | |
| 121 | + * @apiVersion 2.0.0 | |
| 118 | 122 | * |
| 119 | - * @apiDescription Desmigra um processo iniciado no SIPAR e transferido para o SEI, permitindo novamente a anexação e tramitação no SIPAR. | |
| 123 | + * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI). | |
| 120 | 124 | * |
| 121 | 125 | * @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111 |
| 122 | 126 | * |
| 123 | 127 | * @apiExample {curl} Exemplo de requisição: |
| 124 | - * curl -i http://<host>/sipar-broker/service/processos-fisicos/33902111111111111/desmigracao | |
| 128 | + * curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241 | |
| 125 | 129 | * |
| 126 | 130 | * @apiSuccessExample {json} Success-Response: |
| 127 | 131 | * HTTP/1.1 204 No Content |
| ... | ... | @@ -143,7 +147,7 @@ public class SiparResource { |
| 143 | 147 | * |
| 144 | 148 | * |
| 145 | 149 | * @apiErrorExample {json} Error-Response: |
| 146 | - * HTTP/1.1 409 Conflict | |
| 150 | + * HTTP/1.1 404 Not Found | |
| 147 | 151 | * { |
| 148 | 152 | * "error":"Mensagem de erro." |
| 149 | 153 | * "code":"código do erro" | ... | ... |
src/main/webapp/api-docs/api_data.js
| ... | ... | @@ -7751,6 +7751,133 @@ define({ "api": [ |
| 7751 | 7751 | "groupTitle": "Processo" |
| 7752 | 7752 | }, |
| 7753 | 7753 | { |
| 7754 | + "type": "delete", | |
| 7755 | + "url": "/sipar/importados/:processo", | |
| 7756 | + "title": "Cancelar Importação Processo", | |
| 7757 | + "name": "cancelarImportacaoProcesso", | |
| 7758 | + "group": "SIPAR", | |
| 7759 | + "version": "2.0.0", | |
| 7760 | + "description": "<p>Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).</p>", | |
| 7761 | + "parameter": { | |
| 7762 | + "fields": { | |
| 7763 | + "Path Parameter": [ | |
| 7764 | + { | |
| 7765 | + "group": "Path Parameter", | |
| 7766 | + "type": "String", | |
| 7767 | + "optional": false, | |
| 7768 | + "field": "processo", | |
| 7769 | + "description": "<p>Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111</p>" | |
| 7770 | + } | |
| 7771 | + ] | |
| 7772 | + } | |
| 7773 | + }, | |
| 7774 | + "examples": [ | |
| 7775 | + { | |
| 7776 | + "title": "Exemplo de requisição:", | |
| 7777 | + "content": "curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241", | |
| 7778 | + "type": "curl" | |
| 7779 | + } | |
| 7780 | + ], | |
| 7781 | + "success": { | |
| 7782 | + "examples": [ | |
| 7783 | + { | |
| 7784 | + "title": "Success-Response:", | |
| 7785 | + "content": "HTTP/1.1 204 No Content", | |
| 7786 | + "type": "json" | |
| 7787 | + } | |
| 7788 | + ] | |
| 7789 | + }, | |
| 7790 | + "error": { | |
| 7791 | + "examples": [ | |
| 7792 | + { | |
| 7793 | + "title": "Error-Response:", | |
| 7794 | + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7795 | + "type": "json" | |
| 7796 | + }, | |
| 7797 | + { | |
| 7798 | + "title": "Error-Response:", | |
| 7799 | + "content": "HTTP/1.1 400 Bad Request\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7800 | + "type": "json" | |
| 7801 | + }, | |
| 7802 | + { | |
| 7803 | + "title": "Error-Response:", | |
| 7804 | + "content": "HTTP/1.1 404 Not Found\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7805 | + "type": "json" | |
| 7806 | + } | |
| 7807 | + ] | |
| 7808 | + }, | |
| 7809 | + "filename": "branch_homologacao/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java", | |
| 7810 | + "groupTitle": "SIPAR" | |
| 7811 | + }, | |
| 7812 | + { | |
| 7813 | + "type": "post", | |
| 7814 | + "url": "/sipar/importados", | |
| 7815 | + "title": "Importar Processo", | |
| 7816 | + "name": "importarProcesso", | |
| 7817 | + "group": "SIPAR", | |
| 7818 | + "version": "2.0.0", | |
| 7819 | + "description": "<p>Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).</p>", | |
| 7820 | + "parameter": { | |
| 7821 | + "fields": { | |
| 7822 | + "Header Parameters": [ | |
| 7823 | + { | |
| 7824 | + "group": "Header Parameters", | |
| 7825 | + "type": "String", | |
| 7826 | + "optional": false, | |
| 7827 | + "field": "content-type", | |
| 7828 | + "description": "<p>Informar text/plain</p>" | |
| 7829 | + } | |
| 7830 | + ], | |
| 7831 | + "Request Body": [ | |
| 7832 | + { | |
| 7833 | + "group": "Request Body", | |
| 7834 | + "type": "String", | |
| 7835 | + "optional": false, | |
| 7836 | + "field": "processo", | |
| 7837 | + "description": "<p>Número do processo a ser importado</p>" | |
| 7838 | + } | |
| 7839 | + ] | |
| 7840 | + } | |
| 7841 | + }, | |
| 7842 | + "examples": [ | |
| 7843 | + { | |
| 7844 | + "title": "Exemplo de requisição:\t", | |
| 7845 | + "content": "endpoint: [POST] http://<host>/sei-broker/service/sipar/importados\n\nbody:\n33902112492200241", | |
| 7846 | + "type": "json" | |
| 7847 | + } | |
| 7848 | + ], | |
| 7849 | + "success": { | |
| 7850 | + "examples": [ | |
| 7851 | + { | |
| 7852 | + "title": "Success-Response:", | |
| 7853 | + "content": "HTTP/1.1 201 Created", | |
| 7854 | + "type": "json" | |
| 7855 | + } | |
| 7856 | + ] | |
| 7857 | + }, | |
| 7858 | + "error": { | |
| 7859 | + "examples": [ | |
| 7860 | + { | |
| 7861 | + "title": "Error-Response:", | |
| 7862 | + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7863 | + "type": "json" | |
| 7864 | + }, | |
| 7865 | + { | |
| 7866 | + "title": "Error-Response:", | |
| 7867 | + "content": "HTTP/1.1 400 Bad Request\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7868 | + "type": "json" | |
| 7869 | + }, | |
| 7870 | + { | |
| 7871 | + "title": "Error-Response:", | |
| 7872 | + "content": "HTTP/1.1 409 Conflict\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7873 | + "type": "json" | |
| 7874 | + } | |
| 7875 | + ] | |
| 7876 | + }, | |
| 7877 | + "filename": "branch_homologacao/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java", | |
| 7878 | + "groupTitle": "SIPAR" | |
| 7879 | + }, | |
| 7880 | + { | |
| 7754 | 7881 | "type": "get", |
| 7755 | 7882 | "url": "/:unidade/series", |
| 7756 | 7883 | "title": "Listar séries", |
| ... | ... | @@ -8157,12 +8284,17 @@ define({ "api": [ |
| 8157 | 8284 | "groupTitle": "Unidade" |
| 8158 | 8285 | }, |
| 8159 | 8286 | { |
| 8160 | - "type": "put", | |
| 8161 | - "url": "/usuarios/ativar", | |
| 8287 | + "type": "post", | |
| 8288 | + "url": "/usuarios/ativos", | |
| 8162 | 8289 | "title": "Ativar usuário", |
| 8163 | 8290 | "name": "ativarUsuario", |
| 8164 | 8291 | "group": "Usuario", |
| 8165 | 8292 | "version": "2.0.0", |
| 8293 | + "permission": [ | |
| 8294 | + { | |
| 8295 | + "name": "RO_SEI_BROKER_ADM" | |
| 8296 | + } | |
| 8297 | + ], | |
| 8166 | 8298 | "description": "<p>Este método reativa usuários.</p>", |
| 8167 | 8299 | "parameter": { |
| 8168 | 8300 | "fields": { |
| ... | ... | @@ -8194,7 +8326,7 @@ define({ "api": [ |
| 8194 | 8326 | "examples": [ |
| 8195 | 8327 | { |
| 8196 | 8328 | "title": "Exemplo de requisição:\t", |
| 8197 | - "content": "endpoint: http://<host>/sei-broker/service/usuarios/ativar\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8329 | + "content": "endpoint: http://<host>/sei-broker/service/usuarios/ativos\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8198 | 8330 | "type": "json" |
| 8199 | 8331 | } |
| 8200 | 8332 | ], |
| ... | ... | @@ -8230,6 +8362,11 @@ define({ "api": [ |
| 8230 | 8362 | "name": "atribuirProcesso", |
| 8231 | 8363 | "group": "Usuario", |
| 8232 | 8364 | "version": "2.0.0", |
| 8365 | + "permission": [ | |
| 8366 | + { | |
| 8367 | + "name": "RO_SEI_BROKER" | |
| 8368 | + } | |
| 8369 | + ], | |
| 8233 | 8370 | "description": "<p>Este método atribui o processo a um usuário.</p>", |
| 8234 | 8371 | "parameter": { |
| 8235 | 8372 | "fields": { |
| ... | ... | @@ -8307,6 +8444,11 @@ define({ "api": [ |
| 8307 | 8444 | "name": "buscarUsuario", |
| 8308 | 8445 | "group": "Usuario", |
| 8309 | 8446 | "version": "2.0.0", |
| 8447 | + "permission": [ | |
| 8448 | + { | |
| 8449 | + "name": "RO_SEI_BROKER" | |
| 8450 | + } | |
| 8451 | + ], | |
| 8310 | 8452 | "description": "<p>Este método realiza a uma busca pelo login do usuário.</p>", |
| 8311 | 8453 | "parameter": { |
| 8312 | 8454 | "fields": { |
| ... | ... | @@ -8361,12 +8503,17 @@ define({ "api": [ |
| 8361 | 8503 | "groupTitle": "Usuario" |
| 8362 | 8504 | }, |
| 8363 | 8505 | { |
| 8364 | - "type": "put", | |
| 8365 | - "url": "/usuarios/desativar", | |
| 8506 | + "type": "delete", | |
| 8507 | + "url": "/usuarios/ativos", | |
| 8366 | 8508 | "title": "Desativar usuário", |
| 8367 | 8509 | "name": "desativarUsuario", |
| 8368 | 8510 | "group": "Usuario", |
| 8369 | 8511 | "version": "2.0.0", |
| 8512 | + "permission": [ | |
| 8513 | + { | |
| 8514 | + "name": "RO_SEI_BROKER_ADM" | |
| 8515 | + } | |
| 8516 | + ], | |
| 8370 | 8517 | "description": "<p>Este método desativa usuários.</p>", |
| 8371 | 8518 | "parameter": { |
| 8372 | 8519 | "fields": { |
| ... | ... | @@ -8398,7 +8545,7 @@ define({ "api": [ |
| 8398 | 8545 | "examples": [ |
| 8399 | 8546 | { |
| 8400 | 8547 | "title": "Exemplo de requisição:\t", |
| 8401 | - "content": "endpoint: http://<host>/sei-broker/service/usuarios/desativar\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8548 | + "content": "endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/ativos/andre.guimaraes\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8402 | 8549 | "type": "json" |
| 8403 | 8550 | } |
| 8404 | 8551 | ], |
| ... | ... | @@ -8428,12 +8575,17 @@ define({ "api": [ |
| 8428 | 8575 | "groupTitle": "Usuario" |
| 8429 | 8576 | }, |
| 8430 | 8577 | { |
| 8431 | - "type": "post", | |
| 8432 | - "url": "/usuarios/excluir", | |
| 8578 | + "type": "delete", | |
| 8579 | + "url": "/usuarios/:login", | |
| 8433 | 8580 | "title": "Excluir usuário", |
| 8434 | 8581 | "name": "excluirUsuario", |
| 8435 | 8582 | "group": "Usuario", |
| 8436 | 8583 | "version": "2.0.0", |
| 8584 | + "permission": [ | |
| 8585 | + { | |
| 8586 | + "name": "RO_SEI_BROKER_ADM" | |
| 8587 | + } | |
| 8588 | + ], | |
| 8437 | 8589 | "description": "<p>Este método realiza a exclusão de usuários.</p>", |
| 8438 | 8590 | "parameter": { |
| 8439 | 8591 | "fields": { |
| ... | ... | @@ -8465,7 +8617,7 @@ define({ "api": [ |
| 8465 | 8617 | "examples": [ |
| 8466 | 8618 | { |
| 8467 | 8619 | "title": "Exemplo de requisição:\t", |
| 8468 | - "content": "endpoint: http://<host>/sei-broker/service/usuarios/excluir\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8620 | + "content": "endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/andre.guimaraes\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8469 | 8621 | "type": "json" |
| 8470 | 8622 | } |
| 8471 | 8623 | ], |
| ... | ... | @@ -8501,6 +8653,11 @@ define({ "api": [ |
| 8501 | 8653 | "name": "incluirUsuario", |
| 8502 | 8654 | "group": "Usuario", |
| 8503 | 8655 | "version": "2.0.0", |
| 8656 | + "permission": [ | |
| 8657 | + { | |
| 8658 | + "name": "RO_SEI_BROKER_ADM" | |
| 8659 | + } | |
| 8660 | + ], | |
| 8504 | 8661 | "description": "<p>Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes.</p>", |
| 8505 | 8662 | "parameter": { |
| 8506 | 8663 | "fields": { |
| ... | ... | @@ -8568,6 +8725,11 @@ define({ "api": [ |
| 8568 | 8725 | "name": "listarUsuarios", |
| 8569 | 8726 | "group": "Usuario", |
| 8570 | 8727 | "version": "2.0.0", |
| 8728 | + "permission": [ | |
| 8729 | + { | |
| 8730 | + "name": "RO_SEI_BROKER" | |
| 8731 | + } | |
| 8732 | + ], | |
| 8571 | 8733 | "description": "<p>Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico".</p>", |
| 8572 | 8734 | "parameter": { |
| 8573 | 8735 | "fields": { | ... | ... |
src/main/webapp/api-docs/api_data.json
| ... | ... | @@ -7751,6 +7751,133 @@ |
| 7751 | 7751 | "groupTitle": "Processo" |
| 7752 | 7752 | }, |
| 7753 | 7753 | { |
| 7754 | + "type": "delete", | |
| 7755 | + "url": "/sipar/importados/:processo", | |
| 7756 | + "title": "Cancelar Importação Processo", | |
| 7757 | + "name": "cancelarImportacaoProcesso", | |
| 7758 | + "group": "SIPAR", | |
| 7759 | + "version": "2.0.0", | |
| 7760 | + "description": "<p>Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).</p>", | |
| 7761 | + "parameter": { | |
| 7762 | + "fields": { | |
| 7763 | + "Path Parameter": [ | |
| 7764 | + { | |
| 7765 | + "group": "Path Parameter", | |
| 7766 | + "type": "String", | |
| 7767 | + "optional": false, | |
| 7768 | + "field": "processo", | |
| 7769 | + "description": "<p>Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111</p>" | |
| 7770 | + } | |
| 7771 | + ] | |
| 7772 | + } | |
| 7773 | + }, | |
| 7774 | + "examples": [ | |
| 7775 | + { | |
| 7776 | + "title": "Exemplo de requisição:", | |
| 7777 | + "content": "curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241", | |
| 7778 | + "type": "curl" | |
| 7779 | + } | |
| 7780 | + ], | |
| 7781 | + "success": { | |
| 7782 | + "examples": [ | |
| 7783 | + { | |
| 7784 | + "title": "Success-Response:", | |
| 7785 | + "content": "HTTP/1.1 204 No Content", | |
| 7786 | + "type": "json" | |
| 7787 | + } | |
| 7788 | + ] | |
| 7789 | + }, | |
| 7790 | + "error": { | |
| 7791 | + "examples": [ | |
| 7792 | + { | |
| 7793 | + "title": "Error-Response:", | |
| 7794 | + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7795 | + "type": "json" | |
| 7796 | + }, | |
| 7797 | + { | |
| 7798 | + "title": "Error-Response:", | |
| 7799 | + "content": "HTTP/1.1 400 Bad Request\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7800 | + "type": "json" | |
| 7801 | + }, | |
| 7802 | + { | |
| 7803 | + "title": "Error-Response:", | |
| 7804 | + "content": "HTTP/1.1 404 Not Found\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7805 | + "type": "json" | |
| 7806 | + } | |
| 7807 | + ] | |
| 7808 | + }, | |
| 7809 | + "filename": "branch_homologacao/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java", | |
| 7810 | + "groupTitle": "SIPAR" | |
| 7811 | + }, | |
| 7812 | + { | |
| 7813 | + "type": "post", | |
| 7814 | + "url": "/sipar/importados", | |
| 7815 | + "title": "Importar Processo", | |
| 7816 | + "name": "importarProcesso", | |
| 7817 | + "group": "SIPAR", | |
| 7818 | + "version": "2.0.0", | |
| 7819 | + "description": "<p>Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).</p>", | |
| 7820 | + "parameter": { | |
| 7821 | + "fields": { | |
| 7822 | + "Header Parameters": [ | |
| 7823 | + { | |
| 7824 | + "group": "Header Parameters", | |
| 7825 | + "type": "String", | |
| 7826 | + "optional": false, | |
| 7827 | + "field": "content-type", | |
| 7828 | + "description": "<p>Informar text/plain</p>" | |
| 7829 | + } | |
| 7830 | + ], | |
| 7831 | + "Request Body": [ | |
| 7832 | + { | |
| 7833 | + "group": "Request Body", | |
| 7834 | + "type": "String", | |
| 7835 | + "optional": false, | |
| 7836 | + "field": "processo", | |
| 7837 | + "description": "<p>Número do processo a ser importado</p>" | |
| 7838 | + } | |
| 7839 | + ] | |
| 7840 | + } | |
| 7841 | + }, | |
| 7842 | + "examples": [ | |
| 7843 | + { | |
| 7844 | + "title": "Exemplo de requisição:\t", | |
| 7845 | + "content": "endpoint: [POST] http://<host>/sei-broker/service/sipar/importados\n\nbody:\n33902112492200241", | |
| 7846 | + "type": "json" | |
| 7847 | + } | |
| 7848 | + ], | |
| 7849 | + "success": { | |
| 7850 | + "examples": [ | |
| 7851 | + { | |
| 7852 | + "title": "Success-Response:", | |
| 7853 | + "content": "HTTP/1.1 201 Created", | |
| 7854 | + "type": "json" | |
| 7855 | + } | |
| 7856 | + ] | |
| 7857 | + }, | |
| 7858 | + "error": { | |
| 7859 | + "examples": [ | |
| 7860 | + { | |
| 7861 | + "title": "Error-Response:", | |
| 7862 | + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7863 | + "type": "json" | |
| 7864 | + }, | |
| 7865 | + { | |
| 7866 | + "title": "Error-Response:", | |
| 7867 | + "content": "HTTP/1.1 400 Bad Request\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7868 | + "type": "json" | |
| 7869 | + }, | |
| 7870 | + { | |
| 7871 | + "title": "Error-Response:", | |
| 7872 | + "content": "HTTP/1.1 409 Conflict\n{\n\t\t\"error\":\"Mensagem de erro.\"\n\t\t\"code\":\"código do erro\"\n}", | |
| 7873 | + "type": "json" | |
| 7874 | + } | |
| 7875 | + ] | |
| 7876 | + }, | |
| 7877 | + "filename": "branch_homologacao/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java", | |
| 7878 | + "groupTitle": "SIPAR" | |
| 7879 | + }, | |
| 7880 | + { | |
| 7754 | 7881 | "type": "get", |
| 7755 | 7882 | "url": "/:unidade/series", |
| 7756 | 7883 | "title": "Listar séries", |
| ... | ... | @@ -8157,12 +8284,17 @@ |
| 8157 | 8284 | "groupTitle": "Unidade" |
| 8158 | 8285 | }, |
| 8159 | 8286 | { |
| 8160 | - "type": "put", | |
| 8161 | - "url": "/usuarios/ativar", | |
| 8287 | + "type": "post", | |
| 8288 | + "url": "/usuarios/ativos", | |
| 8162 | 8289 | "title": "Ativar usuário", |
| 8163 | 8290 | "name": "ativarUsuario", |
| 8164 | 8291 | "group": "Usuario", |
| 8165 | 8292 | "version": "2.0.0", |
| 8293 | + "permission": [ | |
| 8294 | + { | |
| 8295 | + "name": "RO_SEI_BROKER_ADM" | |
| 8296 | + } | |
| 8297 | + ], | |
| 8166 | 8298 | "description": "<p>Este método reativa usuários.</p>", |
| 8167 | 8299 | "parameter": { |
| 8168 | 8300 | "fields": { |
| ... | ... | @@ -8194,7 +8326,7 @@ |
| 8194 | 8326 | "examples": [ |
| 8195 | 8327 | { |
| 8196 | 8328 | "title": "Exemplo de requisição:\t", |
| 8197 | - "content": "endpoint: http://<host>/sei-broker/service/usuarios/ativar\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8329 | + "content": "endpoint: http://<host>/sei-broker/service/usuarios/ativos\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8198 | 8330 | "type": "json" |
| 8199 | 8331 | } |
| 8200 | 8332 | ], |
| ... | ... | @@ -8230,6 +8362,11 @@ |
| 8230 | 8362 | "name": "atribuirProcesso", |
| 8231 | 8363 | "group": "Usuario", |
| 8232 | 8364 | "version": "2.0.0", |
| 8365 | + "permission": [ | |
| 8366 | + { | |
| 8367 | + "name": "RO_SEI_BROKER" | |
| 8368 | + } | |
| 8369 | + ], | |
| 8233 | 8370 | "description": "<p>Este método atribui o processo a um usuário.</p>", |
| 8234 | 8371 | "parameter": { |
| 8235 | 8372 | "fields": { |
| ... | ... | @@ -8307,6 +8444,11 @@ |
| 8307 | 8444 | "name": "buscarUsuario", |
| 8308 | 8445 | "group": "Usuario", |
| 8309 | 8446 | "version": "2.0.0", |
| 8447 | + "permission": [ | |
| 8448 | + { | |
| 8449 | + "name": "RO_SEI_BROKER" | |
| 8450 | + } | |
| 8451 | + ], | |
| 8310 | 8452 | "description": "<p>Este método realiza a uma busca pelo login do usuário.</p>", |
| 8311 | 8453 | "parameter": { |
| 8312 | 8454 | "fields": { |
| ... | ... | @@ -8361,12 +8503,17 @@ |
| 8361 | 8503 | "groupTitle": "Usuario" |
| 8362 | 8504 | }, |
| 8363 | 8505 | { |
| 8364 | - "type": "put", | |
| 8365 | - "url": "/usuarios/desativar", | |
| 8506 | + "type": "delete", | |
| 8507 | + "url": "/usuarios/ativos", | |
| 8366 | 8508 | "title": "Desativar usuário", |
| 8367 | 8509 | "name": "desativarUsuario", |
| 8368 | 8510 | "group": "Usuario", |
| 8369 | 8511 | "version": "2.0.0", |
| 8512 | + "permission": [ | |
| 8513 | + { | |
| 8514 | + "name": "RO_SEI_BROKER_ADM" | |
| 8515 | + } | |
| 8516 | + ], | |
| 8370 | 8517 | "description": "<p>Este método desativa usuários.</p>", |
| 8371 | 8518 | "parameter": { |
| 8372 | 8519 | "fields": { |
| ... | ... | @@ -8398,7 +8545,7 @@ |
| 8398 | 8545 | "examples": [ |
| 8399 | 8546 | { |
| 8400 | 8547 | "title": "Exemplo de requisição:\t", |
| 8401 | - "content": "endpoint: http://<host>/sei-broker/service/usuarios/desativar\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8548 | + "content": "endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/ativos/andre.guimaraes\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8402 | 8549 | "type": "json" |
| 8403 | 8550 | } |
| 8404 | 8551 | ], |
| ... | ... | @@ -8428,12 +8575,17 @@ |
| 8428 | 8575 | "groupTitle": "Usuario" |
| 8429 | 8576 | }, |
| 8430 | 8577 | { |
| 8431 | - "type": "post", | |
| 8432 | - "url": "/usuarios/excluir", | |
| 8578 | + "type": "delete", | |
| 8579 | + "url": "/usuarios/:login", | |
| 8433 | 8580 | "title": "Excluir usuário", |
| 8434 | 8581 | "name": "excluirUsuario", |
| 8435 | 8582 | "group": "Usuario", |
| 8436 | 8583 | "version": "2.0.0", |
| 8584 | + "permission": [ | |
| 8585 | + { | |
| 8586 | + "name": "RO_SEI_BROKER_ADM" | |
| 8587 | + } | |
| 8588 | + ], | |
| 8437 | 8589 | "description": "<p>Este método realiza a exclusão de usuários.</p>", |
| 8438 | 8590 | "parameter": { |
| 8439 | 8591 | "fields": { |
| ... | ... | @@ -8465,7 +8617,7 @@ |
| 8465 | 8617 | "examples": [ |
| 8466 | 8618 | { |
| 8467 | 8619 | "title": "Exemplo de requisição:\t", |
| 8468 | - "content": "endpoint: http://<host>/sei-broker/service/usuarios/excluir\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8620 | + "content": "endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/andre.guimaraes\n\nbody:\n{\n\t\"codigo\":\"1234\",\n\t\"nome\":\"André Luís Fernandes Guimarães\",\n\t\"login\":\"andre.guimaraes\"\n}", | |
| 8469 | 8621 | "type": "json" |
| 8470 | 8622 | } |
| 8471 | 8623 | ], |
| ... | ... | @@ -8501,6 +8653,11 @@ |
| 8501 | 8653 | "name": "incluirUsuario", |
| 8502 | 8654 | "group": "Usuario", |
| 8503 | 8655 | "version": "2.0.0", |
| 8656 | + "permission": [ | |
| 8657 | + { | |
| 8658 | + "name": "RO_SEI_BROKER_ADM" | |
| 8659 | + } | |
| 8660 | + ], | |
| 8504 | 8661 | "description": "<p>Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes.</p>", |
| 8505 | 8662 | "parameter": { |
| 8506 | 8663 | "fields": { |
| ... | ... | @@ -8568,6 +8725,11 @@ |
| 8568 | 8725 | "name": "listarUsuarios", |
| 8569 | 8726 | "group": "Usuario", |
| 8570 | 8727 | "version": "2.0.0", |
| 8728 | + "permission": [ | |
| 8729 | + { | |
| 8730 | + "name": "RO_SEI_BROKER" | |
| 8731 | + } | |
| 8732 | + ], | |
| 8571 | 8733 | "description": "<p>Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico".</p>", |
| 8572 | 8734 | "parameter": { |
| 8573 | 8735 | "fields": { | ... | ... |
src/main/webapp/api-docs/api_project.js
src/main/webapp/api-docs/api_project.json