Versões comparadas

Chave

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

Sumário

...


Índice
excludeSumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

Para mais informações sobre consumo de Licença, Veja Aqui.


1 - Método

     Foi implementado na API de Perfil somente o método GET.

...

Informações
iconfalse
  • A API de Parâmetros retorna todos os parâmetros do sistema presente na classe de parâmetros e nas tabelas: ""GPARAMETROSSISTEMA" e GPARAMS" GPARAMETROSSISTEMA, GPARAMS, GMAILPARAMS, GDEPPAR, GCCUPAR e GGOOGLESERVICE.
  • É necessário utilizar o filtro "group.name" para informar qual servidor de parâmetros a API irá utilizar para apresentar os parâmetros.
  • A propriedade systemParameterId é composta pela companyId|parameterCode, onde companyId é a Coligada e parameterCode é o nome do parâmetro. Nos parâmetros da GPARAMETROSSISTEMA eGPARAMS, não é possível informar a companyId, pois são parâmetros globais, que independem de coligada.

1.1 - GET

...

1.1.1 - Get All (Recuperar todos os parâmetros do sistema)

...

Informações
iconfalse
title1.1.1 GetAll
Expandir
Image Removed
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glbframework/v1/system-parameterssystemParameters?group.name={{tabela}}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url's Utilizada: 

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GPARAMETROSSISTEMA
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "Compressao Habilitada",
            "code": "Compressao Habilitada",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Chave responsável por determinar se dados trafegados entre Server e Client serão compactados."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemagparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "codescope": "Criptografia HabilitadaGlobal",
            "typesystemParameterId": "BooleanCriptografia Habilitada",
            "descriptioncode": [ "Criptografia Habilitada",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Chave responsável por determinar se dados trafegados entre Server e Client serão criptografados."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemagparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Chave Criptografia Simetrica",
            "code": "Chave Criptografia Simetrica",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Armazena chave de criptografia simétrica para todos os Servers."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "<E><K>A9CPrB4DxF97G/PSV7ng6A==</K><IV>082KMtFVWr/nPPqdVMULxA==</IV></E>"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemagparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
    ]
}
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GPARAMS
linenumberstrue
{
    "hasNext": true    {
            "scope": "Global",
    "items": [
        "systemParameterId": "Tamanho Chave {Simetrica",
            "code": "VERSAOBASETamanho Chave Simetrica",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Gparams.VersaobaseArmazena o tamanho da chave de criptografia simétrica utilizada (Valores possíveis: 128 / 192 / 256)."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "12.1.23.0128"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParamsgparametrossistema",
                "displayName": "Parâmetros do Sistema (GParamsRMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "codescope": "ERROSATUALIZGlobal",
            "typesystemParameterId": "Int16Nivel Log Comunicacao",
            "descriptioncode": [
"Nivel Log Comunicacao",
              {"type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Erros de AtualizacaoDetermina a quantidade de informações de logs que será armazenada a cada comunicação. Quanto mais alto o nível, mais informações (Valores possíveis: 0 / 1 / 2 / 3)."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParamsgparametrossistema",
                "displayName": "Parâmetros do Sistema (GParamsRMSSystemParameter)",
                "customData": ""
            }
        },
    ]
}
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GPARAMS
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "VERSAOBASE",
            "code": "BASEVERSAOBASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tipo do Banco de DadosGparams.Versaobase"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "MS SQL12.1.23.0"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParamsGparams",
                "displayName": "Parâmetros do Sistema (GParamsGparams)",
                "customData": ""
            }
        },
      ]
}

1.1.2 - Order(Resultado ordenado)

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações
iconfalse
title1.1.2 Order (Asc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name{{tabela}}&order={{campo}}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/system-parameters?group.name=gparametrossistema&order=code

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
  {
            "scope": "Global",
            "systemParameterId": "BASE",
            "code": "BASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tipo do Banco de Dados"
             {
   }
         "code": "Chave Criptografia Simetrica"],
            "typevalue": "String",
            "description": [
[
                  {
                    "language": "pt-BR",
                    "descriptionTextparameterValue": "Armazena chave de criptografia simétrica para todos os Servers.MS SQL"
                }
            ],
            "valuegroup": [{
                { "name": "Gparams",
                    "languagedisplayName": "pt-BRParâmetros do Sistema (Gparams)",
                    "parameterValuecustomData": "<E><K>A9CPrB4DxF97G/PSV7ng6A==</K><IV>082KMtFVWr/nPPqdVMULxA==</IV></E>"
            }
    }
    },
        ],{
            "scope": "Global",
            "groupsystemParameterId": {"UNIFIEDLOGON",
                "namecode": "GParametrosSistemaUNIFIEDLOGON",
                "displayNametype": "Parâmetros do Sistema (RMSSystemParameter)Int16",
                "customDatadescription": ""[
            }
    {
    },
        {
            "code": "Compressao Habilitada",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ChaveUtilizacao responsável por determinar se dados trafegados entre Server e Client serão compactados.de Unifieldlogon"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false0
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGparams",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGparams)",
                "customData": ""
            }
        },
        {
            "codescope": "Concatena filtro de perfil com ANDGlobal",
            "systemParameterId": "PORTOMSG",
            "code": "PORTOMSG",
            "type": "BooleanInt16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Quando marcado,do somaPorto os filtrosP/ Envio/Receb. de perfil [\"AND\" Lógico]"Mensagens"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false9020
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGparams",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGparams)",
                "customData": ""
            }
        },
     ]
}
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name{{tabela}}&order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/system-parameters?group.name=gparametrossistema&order=-code

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [   {
            "scope": "Global",
            "systemParameterId": "UPCASELOGIN",
            "code": "UPCASELOGIN",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
        {
            "codedescriptionText": "UsuárioLogin do Help Wiki",
é Case-Insensitive?"
                }
     "type": "String"       ],
            "descriptionvalue": [
                {
                    "language": "pt-BR",
                    "descriptionTextparameterValue": "Usuário do Help Wiki"false
                }
            ],
            "valuegroup": [{
                 {"name": "Gparams",
                    "languagedisplayName": "pt-BRParâmetros do Sistema (Gparams)",
                    "parameterValuecustomData": ""
            }
    }
    }
    ]
}
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GMAILPARAMS
linenumberstrue
{
    "hasNext": ]true,
    "items": [
       "scope": "Global", {
            "groupscope": {"Global",
                "namesystemParameterId": "GParametrosSistemaSERVIDORSMTP",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "code": "UsuárioSERVIDORSMTP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "UsuárioServidor do proxySMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "maia.bh01.local"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGmailparams",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGmailparams)",
                "customData": ""
            }
        },
        {
            "codescope": "Url do Help WikiGlobal",
            "typesystemParameterId": "StringUSUARIO",
            "descriptioncode": ["USUARIO",
             "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Url do Help WikiUsuário"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "breno.batista"
                }
            ],
            "scopegroup": "Global",{
                "groupname": {"Gmailparams",
                "namedisplayName": "GParametrosSistemaParâmetros do Sistema (Gmailparams)",
                "displayNamecustomData": "Parâmetros do Sistema (RMSSystemParameter)""
            }
        },
        {
            "customDatascope": "Global",
            }
"systemParameterId": "SENHA",
            } "code": "SENHA",
    ]
}

1.1.3 - Filter (Resultado filtrado)

Informações
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name={{tabela}}&{{campo}}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Valor: Servidor

Url Utilizada: http://localhost:8051/api/glb/v1/system-parameters?group.name=gparametrossistema&code=Servidor

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
        "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Senha de Conexão no Servidor SMTP"
               "code": "Servidor", }
            "type": "String"],
            "descriptionvalue": [
                {
                    "language": "pt-BR",
                    "descriptionTextparameterValue": "Servidor de proxyM\\DB\\01Q\\BBX\\CE\\B7T\\80\\EC\\EC\\94\\25\\DD\\DB"
                }
            ],
            "valuegroup": [{
                {
 "name": "Gmailparams",
                   "languagedisplayName": "pt-BRParâmetros do Sistema (Gmailparams)",
                    "parameterValuecustomData": ""
            }
    }
    },
        ],{
            "scope": "Global",
            "groupsystemParameterId": {"AUTENTICACAO",
                "namecode": "GParametrosSistemaAUTENTICACAO",
                "displayNametype": "Parâmetros do Sistema (RMSSystemParameter)Boolean",
             "description": [
                {
                    "customDatalanguage": "pt-BR",
                    }"descriptionText": "Tempo de atualização"
                }
            ]
}

1.1.4 - Paginação

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name={{tabela}}&page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 2

Valor2: 2

Url Utilizada: http://localhost:8051/api/glb/v1/system-parameters?group.name=gparametrossistema&page=1&pageSize=2

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
,
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": true
                }
         {   ],
            "codegroup": "Compressao Habilitada",
 {
                "typename": "BooleanGmailparams",
                "descriptiondisplayName": [
 "Parâmetros do Sistema (Gmailparams)",
                 {"customData": ""
            }
        "language": "pt-BR"},
        {
            "descriptionTextscope": "ChaveGlobal",
  responsável por determinar se dados trafegados entre Server e Client serão compactados.""systemParameterId": "DOMINIO",
            "code": "DOMINIO",
   }
            ]"type": "String",
            "valuedescription": [
                {
                    "language": "pt-BR",
                    "parameterValuedescriptionText": false"Domínio para conexão com servidor SMTP"
                }
            ],
            "scopevalue": "Global",[
            "group":    {
                  "name  "language": "GParametrosSistemapt-BR",
                    "displayNameparameterValue": "Parâmetros do Sistema (RMSSystemParameter)",BH01"
                "customData": ""}
            }],
         },
   "group": {
    {
            "codename": "Criptografia HabilitadaGmailparams",
                "typedisplayName": "BooleanParâmetros do Sistema (Gmailparams)",
                "descriptioncustomData": [""
            }
    {
    }
    ]
}
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GDEPPAR
linenumberstrue
{
      "hasNext": false,
      "languageitems": "pt-BR",[
        {
            "descriptionTextscope": "ChaveCompany",
 responsável por determinar se dados trafegados entre Server e Client serão criptografados." "systemParameterId": "1|MASCARADEP",
            "companyID": "1",
   }
         "code": "MASCARADEP",
             ]"type": "String",
            "valuedescription": [
                {
                    "language": "pt-BR",
                    "parameterValuedescriptionText": false "Máscara dos Códigos de Departamento"
                }
            ],
            "scopevalue": "Global",[
            "group":    {
                    "namelanguage": "GParametrosSistemapt-BR",
                    "displayNameparameterValue": "Parâmetros do Sistema (RMSSystemParameter)",
##"
                }
            ],
            "customDatagroup": ""{
              }   "name": "Gdeppar",
        }
      ]
}

1.1.5 - Fields (Retorno de campos específicos no resultado) 

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações
iconfalse
title1.1.5 Fields
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name={{tabela}}&fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: code

Url Utilizada: http://localhost:8051/api/glb/v1/system-parameters?group.name=gparametrossistema&fields=code

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items  "displayName": "Parâmetros do Sistema (Gdeppar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "6|MASCARADEP",
            "companyID": "6",
            "code": "MASCARADEP",
            "type": "String",
            "description": [
        {
        {
    "code": "Compressao Habilitada"
        },
        {"language": "pt-BR",
            "code": "Criptografia Habilitada"
      "descriptionText": "Máscara },
dos Códigos de Departamento"
     {
           }
 "code": "Chave Criptografia Simetrica"
        }],
        {
    "value": [
       "code": "Tamanho Chave Simetrica"
        },{
        {
            "codelanguage": "Nivel Log Comunicacao"
        }pt-BR",
        {
            "codeparameterValue": "Tamanho Minimo Compressao####"
        },
        {}
            "code": "Servidor"
],
         },
   "group": {
    {
            "codename": "Porta"
        }Gdeppar",
        {
            "codedisplayName": "Domínio"Parâmetros do Sistema (Gdeppar)",
        },
         {"customData": ""
            "code": "Usuário"}
        },
        {
            "codescope": "SenhaCompany",
            } "systemParameterId": "7|MASCARADEP",
            {"companyID": "7",
            "code": "Url do Help Wiki"MASCARADEP",
        },
        {"type": "String",
            "codedescription": "Usuário do Help Wiki"[
        },
        {
            "code": "Senha do usuário Help Wiki"
        }"language": "pt-BR",
        {
            "codedescriptionText": "DomínioMáscara dodos usuárioCódigos Helpde WikiDepartamento"
        },
        {}
            "code": "Concatena filtro de perfil com AND"],
            "value": [
        },
        {
                    "codelanguage": "Sistema de mensagens habilitado"
pt-BR",
             },
        {"parameterValue": "####"
            "code": "Intervalo em minutos de}
 pulling ao banco (host)"
        }],
            "group": {
                "codename": "Gdeppar"Intervalo,
 em minutos de pulling ao  host (client)"
        },
    "displayName": "Parâmetros do Sistema (Gdeppar)",
    {
            "codecustomData": "Endereço Alternativo do Licence Server""
            }
        }
    ]
}

1.1.6 - Fields &Order (Retornar os campos específicos em ordem)

Informações
titleParâmetros

Expand: Parâmetro responsável pela especialização e ordenação de campos em um resultado.

Exemplo: ?fields=id&order=-id - Nesse exemplo, serão retornados o campo "id" de perfis e em ordem descendente.

Bloco de código
languagejs
firstline1
titleResultado (JSON) - GCCUPAR
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Company",
            "systemParameterId": "1|MASCARACC",
            "companyID": "1",
            "code": "MASCARACC",
            "type": "String",
            "description
Informações
iconfalse
title1.1.6 GetOne
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name={{tabela}}&fields={campo}&Order={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: code

Valor Campo Order: code

Url Utilizada: http://localhost:8051/api/glb/v1/system-parameters?group.name=gparametrossistema&fields=code&order=-code

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
        {
        "code": "Usuário do Help Wiki"
             }"language": "pt-BR",
        {
            "codedescriptionText": "UsuárioMáscara do Centro de Custo"
        },
        {}
            "code": "Url do Help Wiki"],
            "value": [
        },
        {
            "code": "Tamanho Minimo Compressao"
        }"language": "pt-BR",
        {
            "codeparameterValue": "Tamanho Chave Simetrica##.#.#.#"
        },
        {}
            "code": "Sistema de mensagens habilitado"
],
             },
  "group": {
      {
            "codename": "Servidor"
        }Gccupar",
        {
            "codedisplayName": "SenhaParâmetros do usuário Help Wiki"Sistema (Gccupar)",
        },
         {"customData": ""
            "code": "Senha"}
        },
        {
            "codescope": "PortaCompany",
        }    "systemParameterId": "1|LOOKUPTODOS",
         {   "companyID": "1",
            "code": "LOOKUPTODOS",
            "type": "Nivel Log Comunicacao"Boolean",
            "description": [
        },
        {
            "code": "Intervalo em minutos de pulling ao banco (host)"
        },
        {
            "code": "Intervalo em minutos de pulling ao  host (client)"
        },
        {
            "code": "Endereço Alternativo do Licence Server"
        },
        {
            "code": "Domínio do usuário Help Wiki"
        },        {
                    "language": "pt-BR",
                    "descriptionText": "Lookup"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "Gccupar",
                "displayName": "Parâmetros do Sistema (Gccupar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "6|MASCARACC",
            "companyID": "6",
            "code": "MASCARACC",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Máscara do Centro de Custo"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "###"
                }
            ],
            "group": {
                "name": "Gccupar",
                "displayName": "Parâmetros do Sistema (Gccupar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "6|LOOKUPTODOS",
            "companyID": "6",
            "code": "LOOKUPTODOS",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Lookup"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "Gccupar",
                "displayName": "Parâmetros do Sistema (Gccupar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "7|MASCARACC",
            "companyID": "7",
            "code": "MASCARACC",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Máscara do Centro de Custo"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "###"
                }
            ],
            "group": {
                "name": "Gccupar",
                "displayName": "Parâmetros do Sistema (Gccupar)",
                "customData": ""
            }
        }
    ]
}
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GGOOGLESERVICE
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Company",
            "systemParameterId": "1|SERVERPROXY",
            "companyID": "1",
            "code": "SERVERPROXY",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Nome do servidor proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "urano.bh01.local"
                }
            ],
            "group": {
                "name": "Ggoogleservice",
                "displayName": "Parâmetros do Sistema (Ggoogleservice)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "1|PORTPROXY",
            "companyID": "1",
            "code": "PORTPROXY",
            "type": "Int16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Porta do servidor proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 8080
                }
            ],
            "group": {
                "name": "Ggoogleservice",
                "displayName": "Parâmetros do Sistema (Ggoogleservice)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "1|USERPROXY",
            "companyID": "1",
            "code": "USERPROXY",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário para autenticação no proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "breno.batista"
                }
            ],
            "group": {
                "name": "Ggoogleservice",
                "displayName": "Parâmetros do Sistema (Ggoogleservice)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "1|PASSWORDPROXY",
            "companyID": "1",
            "code": "PASSWORDPROXY",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Senha para autenticação no proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "M\\DB\\01Q\\BBX\\CE\\B7T\\80\\EC\\EC\\94\\25\\DD\\DB"
                }
            ],
            "group": {
                "name": "Ggoogleservice",
                "displayName": "Parâmetros do Sistema (Ggoogleservice)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "1|DOMAIN",
            "companyID": "1",
            "code": "DOMAIN",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Domínio de rede"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "bh01"
                }
            ],
            "group": {
                "name": "Ggoogleservice",
                "displayName": "Parâmetros do Sistema (Ggoogleservice)",
                "customData": ""
            }
        }
    ]
}

1.1.2 - Order(Resultado ordenado)

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações
iconfalse
title1.1.2 Order (Asc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name={{tabela}}&order={{campo}}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters?group.name=gparametrossistema&order=code

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "Alterar senha próximo login ao alterar no cadastro",
            "code": "Alterar senha próximo login ao alterar no cadastro",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Define se deverá forçar a alteração de senha no próximo login ao alterar a senha no cadastro de usuários"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Aplicar tema default para todos usuários",
            "code": "Aplicar tema default para todos usuários",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Aplicar tema default para todos usuários"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "App Id do Facebook",
            "code": "App Id do Facebook",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Id do Aplicativo do Facebook"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "App Key do LinkedIn",
            "code": "App Key do LinkedIn",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Chave da API do LinkedIn"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "App Key do Twitter",
            "code": "App Key do Twitter",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Chave da API do Twitter"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        }
    ]
}
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name={{tabela}}&order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters?group.name=gparametrossistema&order=-code

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "Validar complexidade de senha no cadastro",
            "code": "Validar complexidade de senha no cadastro",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Define se o sistema deve validar a complexidade de senha no cadastro de usuários"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Utilizar planilhas Excel",
            "code": "Utilizar planilhas Excel",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Habilita a utilização de planilhas Excel"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": true
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Utilizar Host para envio de e-mails WIN32",
            "code": "Utilizar Host para envio de e-mails WIN32",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Define se deverá utilizar o host para enviar e-mails WIN32"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Utilizar cliente TS",
            "code": "Utilizar cliente TS",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Quando marcado utiliza o IP do client TS para obter licença no License Server"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Usuário para Integração Protheus",
            "code": "Usuário para Integração Protheus",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário utilizado na integração do RM com o Protheus"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        }
    ]
}

1.1.3 - Filter (Resultado filtrado)

...

Informações
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name={{tabela}}&{{campo}}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Valor: Servidor

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters?group.name=gparametrossistema&code=Servidor

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "Url do Help Wiki",
            "code": "Url do Help Wiki",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Url do Help Wiki"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        }
    ]
}

1.1.4 - Paginação

...

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name={{tabela}}&page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 2

Valor2: 2

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters?group.name=gparametrossistema&page=1&pageSize=2

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "Compressao Habilitada",
            "code": "Compressao Habilitada",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Chave responsável por determinar se dados trafegados entre Server e Client serão compactados."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Criptografia Habilitada",
            "code": "Criptografia Habilitada",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Chave responsável por determinar se dados trafegados entre Server e Client serão criptografados."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Chave Criptografia Simetrica",
            "code": "Chave Criptografia Simetrica",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Armazena chave de criptografia simétrica para todos os Servers."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "<E><K>A9CPrB4DxF97G/PSV7ng6A==</K><IV>082KMtFVWr/nPPqdVMULxA==</IV></E>"
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Tamanho Chave Simetrica",
            "code": "Tamanho Chave Simetrica",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Armazena o tamanho da chave de criptografia simétrica utilizada (Valores possíveis: 128 / 192 / 256)."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "128"
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        }
    ]
}

1.1.5 - Fields (Retorno de campos específicos no resultado) 

...

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações
iconfalse
title1.1.5 Fields
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name={{tabela}}&fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: code

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters?group.name=gparametrossistema&fields=code

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "code": "Compressao Habilitada",
            "type": "Boolean",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Criptografia Habilitada",
            "type": "Boolean",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Chave Criptografia Simetrica",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "<E><K>A9CPrB4DxF97G/PSV7ng6A==</K><IV>082KMtFVWr/nPPqdVMULxA==</IV></E>"
                }
            ]
        },
        {
            "code": "Tamanho Chave Simetrica",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "128"
                }
            ]
        },
        {
            "code": "Nivel Log Comunicacao",
            "type": "Int32",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ]
        },
        {
            "code": "Tamanho Minimo Compressao",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "800"
                }
            ]
        },
        {
            "code": "Servidor",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Porta",
            "type": "Int32",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ]
        },
        {
            "code": "Domínio",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Usuário",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Senha",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Url do Help Wiki",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Usuário do Help Wiki",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Senha do usuário Help Wiki",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Domínio do usuário Help Wiki",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Concatena filtro de perfil com AND",
            "type": "Boolean",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Sistema de mensagens habilitado",
            "type": "Boolean",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Intervalo em minutos de pulling ao banco (host)",
            "type": "Int32",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 10
                }
            ]
        },
        {
            "code": "Intervalo em minutos de pulling ao  host (client)",
            "type": "Int32",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 10
                }
            ]
        },
        {
            "code": "Endereço Alternativo do Licence Server",
            "type": "String",
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        }
    ]
}

1.1.6 - Fields &Order (Retornar os campos específicos em ordem)

...

Informações
titleParâmetros

Expand: Parâmetro responsável pela especialização e ordenação de campos em um resultado.

Exemplo: ?fields=id&order=-id - Nesse exemplo, serão retornados o campo "id" de perfis e em ordem descendente.

Informações
iconfalse
title1.1.6 GetOne
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name={{tabela}}&fields={campo}&Order={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: code

Valor Campo Order: code

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters?group.name=gparametrossistema&fields=code&order=-code

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "code": "Validar complexidade de senha no cadastro",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Define se o sistema deve validar a complexidade de senha no cadastro de usuários"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Utilizar planilhas Excel",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Habilita a utilização de planilhas Excel"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": true
                }
            ]
        },
        {
            "code": "Utilizar Host para envio de e-mails WIN32",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Define se deverá utilizar o host para enviar e-mails WIN32"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Utilizar cliente TS",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Quando marcado utiliza o IP do client TS para obter licença no License Server"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Usuário para Integração Protheus",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário utilizado na integração do RM com o Protheus"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Usuário do Help Wiki",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário do Help Wiki"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Usuário",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário do proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Usuário",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário para acesso ao servidor de SMS"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Usar o fluxo de atendimento do Agilis",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usar o fluxo de atendimento do Agilis"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "Usar a integração com o SharePoint. (Funciona somente com a versão 2003 do MS Sharepoint)",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usar a integração com o SharePoint"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ]
        },
        {
            "code": "URL Veja Mais",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Configurações para Central de Ajuda customizada"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Url do Help Wiki",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Url do Help Wiki"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "URL Busca inicial",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Configurações para Central de Ajuda customizada"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "URL Busca Avançada",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Configurações para Central de Ajuda customizada"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "URL Base",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Configurações para Central de Ajuda customizada"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Título da Página",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Configurações para Central de Ajuda customizada"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ]
        },
        {
            "code": "Tempo para desconexão automática (min)",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tempo em mitutos que determina inatividade do usuário  para desconexão automática"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ]
        },
        {
            "code": "Tempo espera (min) p/ lock (necessário logoff)",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tempo espera (min) p/ lock, pode variar do valor configurado ao seu dobro do seu tempo para executar a ação."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 10
                }
            ]
        },
        {
            "code": "Tamanho mínimo da senha",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tamanho mínimo da senha do usuário (mínimo de 6 caracteres)"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 6
                }
            ]
        },
        {
            "code": "Tamanho Minimo Compressao",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Determina o menor tamanho de mensagem (Bytes) que será comprimida (A compressão não é muito eficiente abaixo deste nível)."
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "800"
                }
            ]
        }
    ]
}

1.2 - POST

...

1.2.1 - Post (Atualiza o valor de um parâmetro)

...

Informações
iconfalse
title1.2.1 Post
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "scope": "Company",
    "systemParameterId": "1|MASCARACC",
    "companyID": "1",
    "code": "MASCARACC",
    "type": "String",
    "description": [
        {
            "language": "pt-BR",
            "descriptionText": "Máscara do Centro de Custo"
        }
    ],
    "value": [
        {
            "language": "pt-BR",
            "parameterValue": "###"
        }
    ],
    "group": {
        "name": "Gccupar",
        "displayName": "Parâmetros do Sistema (Gccupar)",
        "customData": ""
    }
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": "testeapiusuario",
    "meta": {
        "resourceType": "User",
        "created": "2018-09-21T16:49:57.336Z",
        "lastModified": "2018-09-21T16:49:57.336Z"
    },
    "externalId": "0001e",
    "name": {
        "givenName": "TesteAPI",
        "familyName": "Usuário"
    },
    "userName": "testeapiusuario",
    "phoneNumbers": [
        {
            "value": "31974964158"
        }
    ],
    "emails": [
        {
            "value": "[email protected]",
            "type": "string",
            "primary": true
        }
    ],
    "active": true,
    "groups": [
        {
            "value": "01",
            "display": "geral"
        }
    ],
    "title": "Mr",
    "manager": [
        {
            "managerId": "01",
            "displayName": "Geral"
        }
    ]
}

1.3 - PUT

...

1.3.1 - Put (Atualiza o valor do parâmetro)

...

Informações
iconfalse
title1.3.1 Post
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters/{id}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 1|MASCARACC

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters/1|MASCARACC

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "scope": "Company",
    "systemParameterId": "1|MASCARACC",
    "companyID": "1",
    "code": "MASCARACC",
    "type": "String",
    "description": [
        {
            "codelanguage": "Domíniopt-BR",
        },
    "descriptionText": "Máscara do Centro de {Custo"
        }
    "code": "Criptografia Habilitada"],
        },"value": [
        {
            "codelanguage": "Concatena filtro de perfil com AND"
pt-BR",
             },"parameterValue": "###"
        {}
       ],
     "codegroup": "Compressao Habilitada"{
        }"name": "Gccupar",
        {
    "displayName": "Parâmetros do Sistema (Gccupar)",
        "codecustomData": "Chave Criptografia Simetrica"
        }
    ]
}