Histórico da Página

...

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

/api/v1/healthcheck/Database
/api/v1/healthcheck/Database/{aliasName}

...

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/327324727/fluig_16_16190516500/programming-code-signs.png?version=1&modificationDate=15144931769101509568429032&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 4px;font-weight:normal !important">Atividade <b>Assumir Tarefa<>Serviço <b>/Database/</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> ATestar finalidadea daconexão atividadecom "Assumiro Tarefa"banco é permitir que um Colaborador assuma uma tarefa e consequentemente dê prosseguimento ao fluxo do <strong>Processo</strong>.<br>
<strong>Passo a Passo:</strong> Primeiramente é necessário arrastar a atividade <strong>"Assumir Tarefa"</strong> para o <strong>"Fluxo de Trabalho Sequencial"</strong> em sua fórmula visual.de dados<br>
<strong>Detalhamento:</strong> Para consumir o serviço <b>/Database/</b> utilize a seguinte rota: <b>/api/v1/healthcheck/database/</b>, de forma adicional o parâmetro aliasName pode ser adicionado.<br>
<strong>Exemplo de Utilização (Com o parâmetro AliasName):</strong>

HTML
<div style="background: #fff; padding:10px;text-align:center;width:calc(100% - 25px);margin:10px 0px;">

Image RemovedImage Added

HTML

</div>
Após<strong>Exemplo atividadede terUtilização sido(Sem adicionadao ao fluxo de trabalho, é necessário configurar as propriedades da atividade.
<div styleparâmetro AliasName):</strong>
<div style="background: #fff; padding:10px;text-align:center;width:calc(100% - 25px);margin:10px 0px;">

Image RemovedImage Added

HTML

</div>
No exemplo acima, as propriedades foram preenchidas da seguinte maneira:
</div>
</div>
</div>
<div style="padding:7px"></div>
<div style="border: 1px solid #aab8c6">      
       <div style="background: #fff; padding:10px;text-align:center#f7f7f7;width:calc(100% - 25px10px);margin:10px 0px">

Image Removed

HTML

</div>
Após preencher as propriedades, salve e execute a <strong>Fórmula Visual</strong>. Verifique o resultado do processo. A <strong>Fórmula Visual</strong> deverá executar com sucesso.
<div style="background: #fff; padding:10px;text-align:center;width:calc(100% - 25px);margin:10px 0px">

Image Removed

HTML

</div>
Resultado: A Solicitação 40 que estava com Carlos Philippe Farias Marques agora foi assumida por Stella Vilaca.
<div style="background: #fff; padding:10px;text-align:center;width:calc(100% - 25px);margin:10px 0px">

Image Removed

HTML

</div>
</div>
</div>
</div>
<div style="padding:7px"></div>
<div style="border: 1px solid #aab8c6">      
       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 de Entrada</span>
      </div>
<div style="background:#f7f7f7#f0f0f0;width:calc(100% - 10px);height:30pxauto;color:min-height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <span<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/preferencecube.png?version=1&modificationDate=15093699653681509370590936&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 3px">Parâmetros do Método TakeProcessTask</span>
      </div>
      <div4px;font-weight:normal !important">AliasName <b>(Opcional)</b></span><span style="backgroundfloat:#f0f0f0right;width:calc(100% - 10px);height:auto;min-height:30px;color: #000;font-weight:bold;font-size: 16px;padding:5px;border-bottom: 0px;">
           <div margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv18', 'img18');"><img id="img18" name="img18" style="width:100% 16px; height: 30px16px;border margin-bottomtop:1px solid #d0d0d0;padding-bottom:5px;"><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 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=15093705909361509382756808&api=v2" ></><span></span>div>
      </div>
<div style="background: #e2e2e2;">
<div   <spanid="hiddenDiv18" class="HiddenDiv" style="floatvisibility:lefthidden;font-size:inherit;height: 0px; line-height: 30px; padding-left: 5px;margin-top background: 4px;font-weight:normal !important">CompanyId <b>(Opcional)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv3', 'img3');"><img id="img3" name="img3" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span><#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="backgroundborder: #e2e2e2; 1px solid #aab8c6">      
<div id="hiddenDiv3"       <div style="visibilitybackground:hidden#f7f7f7;heightwidth: 0px; line-calc(100% - 10px);height: 30px; padding-leftcolor: 5px; background: #e2e2e2#000;font-weight:normal">
<strong>Descrição:</strong> Código da Empresa.<br>
<strong>Tipo:</strong> Inteiro<br>
<strong>Como Usar:</strong> Esse parâmetro é do tipo <strong>Inteiro</strong>, ou seja, deve-se utilizar um valor numérico que represente o Código da Empresa vinculada ao <strong>Processo</strong>.<br>
<strong>Valor Utilizado na Requisição:</strong> N/A<br>
<strong>Exemplo de Utilização:</strong> (Qualquer valor numérico que represente o Código da Empresa)
</div>
</div>
<div style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;padding-top:5px"><spanbold;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/309398329/cube190516500/programming-code-signs.png?version=1&modificationDate=15093705909361509568429032&api=v2" /></span>
           <span style="float:left;font-size:inherit;padding-left:5px;margin-top: 4px;font-weight:normal !important">ProcessInstanceId <b>(Obrigatório)</b><>Retorno</span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv4hiddenDiv6', 'img4img6');"><img id="img4img6" name="img4img6" 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="hiddenDiv4HiddenDiv" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> NúmeroRetorno do da Solicitaçãoserviço <b>/Database/</b>.<br>
<strong>Tipo:</strong> Inteiro<br>
<strong>Como Usar:</strong> Esse parâmetro é do tipo <strong>Inteiro</strong>, ou seja, deve-se utilizar um valor numérico que represente o Número da Solicitação do <strong>Processo</strong>.<br>
<strong>Valor Utilizado na Requisição:</strong> 40<br>
</div>
</div>
<div style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;padding-top:5px"><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">ThreadSequence <b>(Obrigatório)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv5', 'img5');"><img id="img5" name="img5" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv5" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.<br>
<strong>Tipo:</strong> Inteiro<br>
<strong>Como Usar:</strong> Esse parâmetro é do tipo <strong>Inteiro</strong>, ou seja, deve-se utilizar um valor numérico que represente o valor da existência de uma atividade paralela no <strong>Processo</strong>.<br>
<strong>Valor Utilizado na Requisição:</strong> 0<br>
</div>
</div>
<div style="width:100%;height: 30px;padding-top:5px"><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>
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

icon	false

Bloco de código

language	js
firstline	1
title	Retorno (Sucesso)
linenumbers	true

{
    "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

icon	false

Bloco de código

language	js
firstline	1
title	Retorno (Sucesso)
linenumbers	true

{
    "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",

<span style="float:left;font-size:inherit;padding-left:5px;margin-top: 4px;font-weight:normal !important">UserId <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 style="background: #e2e2e2;"> <div id="hiddenDiv18" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal"> <strong>Descrição:</strong> Matrícula do usuário que vai executar a tarefa.<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 a Matrícula do Usuário que vai executar a tarefa vinculada ao <strong>Processo</strong>.<br> <strong>Valor Utilizado na Requisição:</strong> N/A<br> <strong>Exemplo de Utilização:</strong> (Qualquer usuário ativo cadastrado no FLUIG) </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;">

   "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",

<span

style=

"detailedMessage"

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 do Método TakeProcessTask</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;">

   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": []
            }

<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>

 ]
    }
}

Estrutura de retorno [FE006 - Erro]:

Informações

icon	false

Bloco de código

language	js
firstline	1
title	Retorno (Erro)
linenumbers	true

{
    "code": "FE006",
    "message": "Erro",

<span

style=

"detailedMessage"

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>

: "RMSHealthCheck - Método CheckDatabase()",
    "helpUrl": "",
    "details": [
        {

</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 método TakeProcessTask.<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 com sucesso (Webservice):

Informações

icon	false

Bloco de código

language	xml
firstline	1
title	Retorno (Sucesso)
linenumbers	true

<result>OK</result>

Estrutura de retorno com erro (Webservice):

Informações

icon	false

Bloco de código

language	xml
firstline	1
title	Retorno (Erro)
linenumbers	true

<result>Tarefa não encontrada</result>

 "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

icon	false

Bloco de código

language	js
firstline	1
title	Retorno (Erro)
linenumbers	true

{
    "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 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">Atributos de 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 style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;"><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">Status <b>(Sucesso e Alertas)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv3', 'img3');"><img id="img3" name="img3" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv3" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Situação de um Banco de Dados.<br>
<strong>Tipo:</strong> String<br>
<strong>Possíveis Valores:</strong><br>
&bull; Banco de Dados Ativo<br>
&bull; Banco de Dados Inativo<br>
<strong>Informações relevantes:</strong> O status se refere a situação de um banco de dados. Caso a conexão com o banco de dados tenha sido realizada com sucesso o status de Ativo será apresentado, caso contrário o status de Inativo será apresentado.<br>
</div>
</div>
<div style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;padding-top:5px"><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">Message - Code <b>(Sucesso, Alertas e Erros)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv4', 'img4');"><img id="img4" name="img4" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv4" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Código da Mensagem<br>
<strong>Tipo:</strong> String<br>
<strong>Possíveis Valores:</strong><br>
&bull; FI00X (Informação)<br>
&bull; FW00X (Alerta)<br>
&bull; FE00X (Erro)<br>
<strong>Informações relevantes:</strong> O status se refere ao código da mensagem retornado pela api. Os códigos apresentados podem ser de informação (no caso de sucesso), de alerta (no caso de algum erro de negócio acontecer) e de erro (no caso de alguma exceção não tratada.
</div>
</div>
<div style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;padding-top:5px"><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">Message - Message <b>(Sucesso, Alertas e Erros)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv5', 'img5');"><img id="img5" name="img5" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv5" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Descrição do Código<br>
<strong>Tipo:</strong> String<br>
<strong>Possíveis Valores:</strong><br>
&bull; Sucesso<br>
&bull; Alerta<br>
&bull; Erro<br>
<strong>Informações relevantes:</strong> O atributo message, nada mais é do que a descrição do código apresentado. O código FI00X indica sucesso ao consumir a api e sucesso ao aplicar corretamente a regra de negócio, o código FW00X indica sucesso ao consumir a api, porém falha na aplicação da regra de negócio e o código FE00X indica falha no consumo da api.
</div>
</div>
<div style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;padding-top:5px"><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">Message - DetailedMessage <b>(Sucesso, Alertas e Erros)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv90', 'img90');"><img id="img90" name="img90" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv90" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Mensagem detalhada<br>
<strong>Tipo:</strong> String<br>
<strong>Possíveis Valores:</strong><br>
&bull; No caso de sucesso: Tentativa de conexão com o banco de dados realizado com sucesso!<br>
&bull; No caso de alertas e erros: Variados valores.<br>
<strong>Informações relevantes:</strong> O atributo detailedMessage trás uma descrição mais amigável do resultado do consumo da api. A mensagem de sucesso é unica e padronizada, enquanto que as mensagens de alerta e de erro podem ser variadas, devido as variadas possibilidades de retorno.
</div>
</div>
<div style="width:100%;height: 30px;border-bottom:1px solid #d0d0d0;padding-bottom:5px;padding-top:5px"><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">Message - HelpUrl <b>(Erros)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv91', 'img91');"><img id="img91" name="img91" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv91" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Url de Ajuda<br>
<strong>Tipo:</strong> String<br>
<strong>Possíveis Valores:</strong><br>
&bull; Uma Url qualquer<br>
<strong>Informações relevantes:</strong> O atributo helpUrl é uma página da internet que explique melhor uma funcionalidade, ou um erro apresentado, afim de ajudar o usuário a entender melhor uma funcionalidade para o correto uso da mesma, ajudá-lo a reportar à Totvs algum erro evidenciado pela api.
</div>
</div>
<div style="width:100%;height: 30px;padding-top:5px"><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">Message - Details <b>(Sucesso, Alertas e Erros)</b></span><span style="float:right;margin-top: 4px;padding-right:5px;cursor:pointer" onclick="Show('hiddenDiv92', 'img92');"><img id="img92" name="img92" style="width: 16px; height: 16px; margin-top: 3px" src="/download/attachments/309398329/add.png?version=1&modificationDate=1509382756808&api=v2"></span></div>
<div style="background: #e2e2e2;">
<div id="hiddenDiv92" style="visibility:hidden;height: 0px; line-height: 30px; padding-left: 5px; background: #e2e2e2;font-weight:normal">
<strong>Descrição:</strong> Detalhes sobre a mensagem apresentada.<br>
<strong>Tipo:</strong> Cadeia de Caracteres (String)<br>
<strong>Possíveis Valores:</strong><br>
&bull; Um conjunto qualquer de mensagens.<br>
<strong>Informações relevantes:</strong> O atributo Details é uma lista de mensagens que corroboram com a mensagem detalhada. Essas mensagens, por exemplo, podem ser o trecho de código onde o erro aconteceu.

HTML

</div>
</div>
</div>
</div>
</div>

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave