Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice:

...

Objetivo:

...

Este documento tem como finalidade, demonstrar o utilização da API Rest HealthCheck evidenciando os serviços:

  • /api/v1/healthcheck/License

Configuração:

...

     

HTML
<script type="text/javascript" language="javascript">
/* @license ! jQuery-mutate - v0.0.2 - 
* Licensed under the MIT license
* http://www.opensource.org/licenses/mit-license.php
* Date: 2015-04-19 */

!function(t){mutate_event_stack=[{name:"width",handler:function(a){var e=t(a);return e.data("mutate-width")||e.data("mutate-width",e.width()),e.data("mutate-width")&&e.width()!=e.data("mutate-width")?(e.data("mutate-width",e.width()),!0):!1}},{name:"height",handler:function(a){var e=t(a);return e.data("mutate-height")||e.data("mutate-height",e.height()),e.data("mutate-height")&&e.height()!=e.data("mutate-height")?(e.data("mutate-height",e.height()),!0):void 0}},{name:"top",handler:function(a){var e=t(a);return e.data("mutate-top")||e.data("mutate-top",e.css("top")),e.data("mutate-top")&&e.css("top")!=e.data("mutate-top")?(e.data("mutate-top",e.css("top")),!0):void 0}},{name:"bottom",handler:function(a){var e=t(a);return e.data("mutate-bottom")||e.data("mutate-bottom",e.css("bottom")),e.data("mutate-bottom")&&e.css("bottom")!=e.data("mutate-bottom")?(e.data("mutate-bottom",e.css("bottom")),!0):void 0}},{name:"right",handler:function(a){var e=t(a);return e.data("mutate-right")||e.data("mutate-right",e.css("right")),e.data("mutate-right")&&e.css("right")!=e.data("mutate-right")?(e.data("mutate-right",e.css("right")),!0):void 0}},{name:"left",handler:function(a){var e=t(a);return e.data("mutate-left")||e.data("mutate-left",e.css("left")),e.data("mutate-left")&&e.css("left")!=e.data("mutate-left")?(e.data("mutate-left",e.css("left")),!0):void 0}},{name:"hide",handler:function(a){var e=t(a),r=e.is(":hidden"),d=void 0==e.data("prev-hidden")?r:e.data("prev-hidden");return e.data("prev-hidden",r),r&&r!=d?!0:void 0}},{name:"show",handler:function(a){var e=t(a),r=e.is(":visible"),d=void 0==e.data("prev-visible")?r:e.data("prev-visible");return e.data("prev-visible",r),r&&r!=d?!0:void 0}},{name:"scrollHeight",handler:function(a){var e=t(a);return e.data("prev-scrollHeight")||e.data("prev-scrollHeight",e[0].scrollHeight),e.data("prev-scrollHeight")&&e[0].scrollHeight!=e.data("prev-scrollHeight")?(e.data("prev-scrollHeight",e[0].scrollHeight),!0):void 0}},{name:"scrollWidth",handler:function(a){var e=t(a);return e.data("prev-scrollWidth")||e.data("prev-scrollWidth",e[0].scrollWidth),e.data("prev-scrollWidth")&&e[0].scrollWidth!=e.data("prev-scrollWidth")?(e.data("prev-scrollWidth",e[0].scrollWidth),!0):void 0}},{name:"scrollTop",handler:function(a){var e=t(a);return e.data("prev-scrollTop")||e.data("prev-scrollTop",e[0].scrollTop()),e.data("prev-scrollTop")&&e[0].scrollTop()!=e.data("prev-scrollTop")?(e.data("prev-scrollTop",e[0].scrollTop()),!0):void 0}},{name:"scrollLeft",handler:function(a){var e=t(a);return e.data("prev-scrollLeft")||e.data("prev-scrollLeft",e[0].scrollLeft()),e.data("prev-scrollLeft")&&e[0].scrollLeft()!=e.data("prev-scrollLeft")?(e.data("prev-scrollLeft",e[0].scrollLeft()),!0):void 0}}]}(jQuery);
HTML
/* @license ! jQuery-mutate - v0.0.1 - 
* Licensed under the MIT license
* http://www.opensource.org/licenses/mit-license.php
* Date: 2015-04-19 */

!function(a){function b(){var c=mutate;"undefined"!=c.event_stack&&c.event_stack.length&&a.each(c.event_stack,function(a,b){mutate.add_event(b)}),c.event_stack=[],a.each(c.stack,function(b,d){a(d.selector).each(function(a,b){c.events[d.event_name](b)===!0?d.callback&&d.callback(b,d):d.false_callback&&d.false_callback(b,d)})}),setTimeout(b,mutate.speed)}mutate={speed:100,event_stack:mutate_event_stack,stack:[],events:{},add_event:function(a){mutate.events[a.name]=a.handler},add:function(a,b,c,d){mutate.stack[mutate.stack.length]={event_name:a,selector:b,callback:c,false_callback:d}}},b(),a.fn.extend({mutate:function(){var b=!1,c=arguments[1],d=this,e=arguments[2]?arguments[2]:function(){};return"extend"==arguments[0].toLowerCase()?(mutate.add_event(c),this):(a.each(a.trim(arguments[0]).split(" "),function(a,f){b=f,mutate.add(b,d,c,e)}),this)}})}(jQuery);
</script>
HTML
<style type="text/css">
.expand-container{
margin-top:5px !important;
font-weight: normal !important;
}

.expand-control{
margin-bottom: 5px !important;
}

pre{
white-space: inherit !important;
}

table tr:nth-child(odd), table tr:nth-child(odd) > *{
   background: transparent !important;
border: 0 !important;
}

.pdl .codeContent .gutter{
    border-right: 1px solid #ccc !important;
}

.wiki-content .innerCell {
    overflow-y: hidden;
}

.HiddenDiv .confluence-information-macro {
    width: calc(100% - 25px);
    background: #fff !important; 
    border: 0 !important;
    -moz-border-radius: 0px !important;
    -webkit-border-radius: 0px !important;
    border-radius: 0px !important;
    color: #333;
    margin: 10px 0 1em 0;
    min-height: 20px;
    padding: 10px;
    position: relative;
}

.HiddenDiv .confluence-information-macro .confluence-information-macro pre{
    display: none;
}
.HiddenDiv .wiki-content a:link, .HiddenDiv .wiki-content a, .HiddenDiv .tab-nav-link, .HiddenDiv .current{
     color: #000 !important; 
}

.wiki-content a:link {
    color: #000 !important;
}

.lastDiv + pre{
    font-family: inherit;
}

.white-container{
    -moz-box-shadow: 2px 2px 2px #aaa;
    -webkit-box-shadow: 2px 2px 2px #aaa;
    box-shadow: 2px 2px 2px #aaa;
}

.confluence-embedded-file-wrapper .confluence-embedded-image{
    max-width: 100% !important;
    max-height: 100%;
}

</style>
HTML
<div style="border:1px solid #aab8c6;padding:5px;-moz-border-radius: 5px;-webkit-border-radius: 5px;border-radius: 5px;background: #f7f7f7">      
      <div style="background:#f7f7f7;width:calc(100% - 10px);height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 1px solid #aab8c6;margin-bottom:14px">
           <span style="float:left"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/149881483/settings.png?version=1&modificationDate=1509720640465&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px">Configuração</span>
     </div>
<div style="border: 1px solid #aab8c6">      
       <div style="background:#f7f7f7;width:calc(100% - 10px);height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <span style="float:left;margin-top: 4px"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/190516500/info.png?version=1&modificationDate=1509568958717&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 3px">Informações Gerais</span>
      </div>
<div style="background:#f0f0f0;width:calc(100% - 10px);height:auto;min-height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <div><span style="float:left;margin-top: 4px;font-weight:normal !important"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/190516500/programming-code-signs.png?version=1&modificationDate=1509568429032&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 4px;font-weight:normal !important">Serviço <b>/License/</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv22', 'img22');"><img id="img22" name="img22" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
      </div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv22" class="HiddenDiv" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;">
<strong>Objetivo:</strong> Testar a conexão com o banco de dados<br>
<strong>Detalhamento:</strong> Para consumir o serviço <b>/License/</b> utilize a seguinte rota: <b>/api/v1/healthcheck/license/</b>.<br>
<strong>Exemplo de Utilização:</strong>
HTML
<div style="background: #fff; padding:10px;text-align:center;width:calc(100% - 25px);margin:10px 0px;">

Image Added

HTML
</div>
</div>
</div>
</div>
<div style="padding:7px"></div>
<div style="border: 1px solid #aab8c6">      
       <div style="background:#f7f7f7;width:calc(100% - 10px);height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <span style="float:left;margin-top: 4px"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/309398329/preference.png?version=1&modificationDate=1509369965368&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 3px">Parâmetros</span>
      </div>
<div style="background:#f0f0f0;width:calc(100% - 10px);height:auto;min-height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <div><span style="float:left;margin-top: 4px;font-weight:normal !important"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/309398329/cube.png?version=1&modificationDate=1509370590936&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 4px;font-weight:normal !important">AliasName <b>(Opcional)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv18', 'img18');"><img id="img18" name="img18" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
      </div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv18" class="HiddenDiv" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;">
<strong>Descrição:</strong> Nome do Alias<br>
<strong>Tipo:</strong> Cadeia de Caracteres (String)<br>
<strong>Como Usar:</strong> Esse parâmetro é do tipo <strong>Cadeia de Caracteres</strong>, ou seja, deve-se utilizar um valor alfanumérico que represente o nome do Alias utilizado ao consumir o serviço <b>/Database/</b>.<br>
<strong>Exemplo de Utilização:</strong> CorporeRM
</div>
</div>
</div>
<div style="padding:7px"></div>
<div style="border: 1px solid #aab8c6">      
       <div style="background:#f7f7f7;width:calc(100% - 10px);height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <span style="float:left;margin-top: 4px"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/309398329/preference.png?version=1&modificationDate=1509369965368&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 3px">Retorno</span>
      </div>
<div style="background:#f0f0f0;width:calc(100% - 10px);height:auto;min-height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <div><span style="float:left;margin-top: 4px;font-weight:normal !important"><img style="width: 16px; height: 16px; margin-top:3px" src="/download/attachments/190516500/programming-code-signs.png?version=1&modificationDate=1509568429032&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 4px;font-weight:normal !important">Retorno</span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv6', 'img6');"><img id="img6" name="img6" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
      </div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv6" class="HiddenDiv" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;">
<strong>Descrição:</strong> Retorno do serviço <b>/Database/</b>.<br>
<strong>Tipo:</strong> Cadeia de Caracteres (String)
<div style="background: #fff; padding:10px;text-align:center;width:calc(100% - 25px);margin:10px 0px">

Estrutura de retorno [FI003 - Sucesso]:

Informações
iconfalse
Bloco de código
languagejs
firstline1
titleRetorno (Sucesso)
linenumberstrue
{
    "status": "Banco de Dados Ativo",
    "message": {
        "code": "FI003",
        "message": "Sucesso",
        "detailedMessage": "Tentativa de conexão com o banco de dados realizado com sucesso!",
        "details": []
    }
}

Estrutura de retorno [FW004 - Alerta]:

Informações
iconfalse
Bloco de código
languagejs
firstline1
titleRetorno (Sucesso)
linenumberstrue
{
    "status": "Banco de Dados Ativo",
    "message": {
        "code": "FW004",
        "message": "Alerta",
        "detailedMessage": "Erro ao efetuar login\r\nUsuário e senha não cadastrados para este serviço: RMServices ",
        "details": [
            {
                "code": "FE007",
                "message": "Stack Trace",
                "detailedMessage": "   em RM.Lib.Server.RMSLoginServer.InternalExecuteService(DbAlias dbAlias, String serviceId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 241\r\n   em RM.Lib.Server.RMSLoginServer.ExecuteService(String alias, String serviceId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 200\r\n   em RM.Lib.Server.RMSHealthCheckMod.ServiceAuthenticate(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 333\r\n   em RM.Lib.Server.RMSHealthCheckMod.CheckDatabase(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 195",
                "details": []
            },
            {
                "code": "FE007",
                "message": "Stack Trace",
                "detailedMessage": "   em RM.Lib.Server.RMSServer.GetServiceUserLoginInfo(IDbServices dbs, String serviceId, String& usr, String& pwd, String& codAcesso) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSServer.cs:linha 458\r\n   em RM.Lib.Server.RMSLoginServer.InternalExecuteService(DbAlias dbAlias, String serviceId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 216",
                "details": []
            }
        ]
    }
}

Estrutura de retorno [FE006 - Erro]:

Informações
iconfalse
Bloco de código
languagejs
firstline1
titleRetorno (Erro)
linenumberstrue
{
    "code": "FE006",
    "message": "Erro",
    "detailedMessage": "RMSHealthCheck - Método CheckDatabase()",
    "helpUrl": "",
    "details": [
        {
            "code": "FE007",
            "message": "Stack Trace",
            "detailedMessage": "   em RM.Lib.Server.RMSHealthCheckMod.CheckDatabase(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 224\r\n   em RM.Lib.Server.RMSHealthCheckServer.CheckDatabase(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Servers\\RMSHealthCheckServer.cs:linha 51\r\n   em RM.Lib.Server.healthcheck.CheckDatabase(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Api's\\healthcheck.cs:linha 109",
            "helpUrl": "",
            "details": []
        }
    ]
}

Estrutura de retorno [FE009 - Erro]:

Informações
iconfalse
Bloco de código
languagejs
firstline1
titleRetorno (Erro)
linenumberstrue
{
    "code": "FE009",
    "message": "Erro",
    "detailedMessage": "Alias do banco de dados não encontrado !",
    "helpUrl": "",
    "details": [
        {
            "code": "FE007",
            "message": "Stack Trace",
            "detailedMessage": "   em RM.Lib.Server.RMSSecurityUtilsMod.GetDbAlias(String alias) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSSecurityUtilsMod.Login.cs:linha 145\r\n   em RM.Lib.Server.RMSLoginServer.GetDbAlias(String alias) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 81\r\n   em RM.Lib.Server.RMSLoginServer.ExecuteService(String alias, String serviceId) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSLoginServer.cs:linha 198\r\n   em RM.Lib.Server.RMSHealthCheckMod.ServiceAuthenticate(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 333\r\n   em RM.Lib.Server.RMSHealthCheckMod.CheckDatabase(String aliasName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\HealthCheck\\Modules\\RMSHealthCheckMod.cs:linha 195",
            "helpUrl": "",
            "details": []
        }
    ]
}
HTML
</div>
</div>
</div>
</div>
</div>
HTML
<script type="text/javascript" language="javascript">

Show = function(divName, imgName){
window["currentElement"] = divName;
if(typeof divName === "string"){
	if(document.getElementById(divName).offsetHeight < 2){
     $("#" + divName).animate({height: $("#" + divName).get(0).scrollHeight + 7});
     $("#" + divName).css("visibility", "visible")
     $("#" + imgName).attr('src', '/download/attachments/309398329/remove.png?version=1&modificationDate=1509386912062&api=v2');  
     $(".HiddenDiv .tab-nav-link").on("click", function(){
          window["currentElement"] = $(this).parents().find(".HiddenDiv").attr("id");
     });  
	 $(".HiddenDiv .confluence-information-macro").mutate('height',function (element,info){
          this.selector.each(function(index, element){
             if($(this).parent().attr("id") == window["currentElement"])
             $(this).parent().height($(this).outerHeight() + 61);
          });		
     });
    }
    else{
     $("#" + divName).animate({height: "0px"});
     $("#" + divName).css("visibility", "hidden")
     $("#" + imgName).attr('src', '/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2');
    }
}
}
</script>