Sumário

...

Índice

exclude	Sumá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

icon	false

A API de Parâmetros retorna todos os parâmetros do sistema presente na classe de parâmetros e nas tabelas: 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

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url's Utilizada:

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GPARAMETROSSISTEMA
linenumbers	true

{
    "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": ""
            }
        },
        {
            "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
                }
            ],
            "scopegroup": "Global",
{
                "groupname": {
                "name": "GParametrosSistema""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>"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemagparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        }
    ]
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GPARAMS
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "codescope": "VERSAOBASEGlobal",
            "typesystemParameterId": "StringTamanho Chave Simetrica",
            "code": "Tamanho 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":      {
                    "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

language	js
firstline	1
title	Resultado (JSON) - GPARAMS
linenumbers	true

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

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GMAILPARAMS
linenumbers	true

{
    "hasNext": false,
        "itemsscope": ["Global",
        {
            "scope"systemParameterId": "GlobalBASE",
            "code": "SERVIDORSMTPBASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Servidor SMTPTipo do Banco de Dados"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "172.16.90.148MS SQL"
                }
            ],
            "group": {
                "name": "GmailparamsGparams",
                "displayName": "Parâmetros do Sistema (GmailparamsGparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "UNIFIEDLOGON",
            "code": "USUARIOUNIFIEDLOGON",
            "type": "StringInt16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "UsuárioUtilizacao de Unifieldlogon"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "mestre"0
                }
            ],
            "group": {
                "name": "GmailparamsGparams",
                "displayName": "Parâmetros do Sistema (GmailparamsGparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "PORTOMSG",
            "code": "INTERVALOPORTOMSG",
            "type": "Int32Int16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "IntervaloNº do Porto P/ Envio/Receb. de Mensagens"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": null9020
                }
            ],
            "group": {
                "name": "GmailparamsGparams",
                "displayName": "Parâmetros do Sistema (GmailparamsGparams)",
                "customData": ""
            }
        },
        ]
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GDEPPAR
linenumbers	true

{
{
             "hasNext": false,
    "items": [
        {
            "scope": "CompanyGlobal",
            "companyIDsystemParameterId": "1UPCASELOGIN",
            "code": "MASCARADEPUPCASELOGIN",
            "type": "StringBoolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "MáscaraLogin dos Códigos de Departamentoé Case-Insensitive?"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "###"false
                }
            ],
            "group": {
                "name": "GdepparGparams",
                "displayName": "Parâmetros do Sistema (GdepparGparams)",
                "customData": ""
            }
        },
    ]
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GCCUPARGMAILPARAMS
linenumbers	true

{
    "hasNext": falsetrue,
    "items": [
        {
            "scope": "CompanyGlobal",
            "companyIDsystemParameterId": "1SERVIDORSMTP",
            "code": "MASCARACCSERVIDORSMTP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Máscara do Centro de CustoServidor SMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "###maia.bh01.local"
                }
            ],
            "group": {
                "name": "GccuparGmailparams",
                "displayName": "Parâmetros do Sistema (GccuparGmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "CompanyGlobal",
            "companyIDsystemParameterId": "1USUARIO",
            "code": "LOOKUPTODOSUSUARIO",
            "type": "BooleanString",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "LookupUsuário"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false"breno.batista"
                }
            ],
            "group": {
                "name": "GccuparGmailparams",
                "displayName": "Parâmetros do Sistema (GccuparGmailparams)",
                "customData": ""
            }
        },
     ]
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GGOOGLESERVICE
linenumbers	true

{
    "hasNext": false,
   {
            "items": [
        {
            "scope": "CompanyGlobal",
            "companyIDsystemParameterId": "1SENHA",
            "code": "SERVERPROXYSENHA",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Nome do servidor proxySenha de Conexão no Servidor SMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "nullM\\DB\\01Q\\BBX\\CE\\B7T\\80\\EC\\EC\\94\\25\\DD\\DB"
                }
            ],
            "group": {
                "name": "GgoogleserviceGmailparams",
                "displayName": "Parâmetros do Sistema (GgoogleserviceGmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "CompanyGlobal",
            "companyIDsystemParameterId": "1AUTENTICACAO",
            "code": "PORTPROXYAUTENTICACAO",
            "type": "Int16Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "PortaTempo dode servidor proxyatualização"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": nulltrue
                }
            ],
            "group": {
                "name": "GgoogleserviceGmailparams",
                "displayName": "Parâmetros do Sistema (GgoogleserviceGmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "CompanyGlobal",
            "companyIDsystemParameterId": "1DOMINIO",
            "code": "USERPROXYDOMINIO",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "UsuárioDomínio para autenticaçãoconexão nocom proxyservidor SMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "mestreBH01"
                }
            ],
            "group": {
                "name": "GgoogleserviceGmailparams",
                "displayName": "Parâmetros do Sistema (GgoogleserviceGmailparams)",
                "customData": ""
            }
        },
    ]
}

1.1.2 - Order(Resultado ordenado)

Informações

title	Parâ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 ...

infoiconfalse

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GDEPPAR
linenumbers	true

{
    "hasNext": false,

Informações

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "codescope": "Chave Criptografia SimetricaCompany",
            "typesystemParameterId": "String1|MASCARADEP",
            "companyID": "1",
            "code": "MASCARADEP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ArmazenaMáscara dos chaveCódigos de criptografia simétrica para todos os Servers.Departamento"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "<E><K>A9CPrB4DxF97G/PSV7ng6A==</K><IV>082KMtFVWr/nPPqdVMULxA==</IV></E>##"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGdeppar",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGdeppar)",
                "customData": ""
            }
        },
        {
            "codescope": "Compressao HabilitadaCompany",
            "typesystemParameterId": "Boolean6|MASCARADEP",
            "descriptioncompanyID": ["6",
                {"code": "MASCARADEP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ChaveMáscara responsáveldos porCódigos determinar se dados trafegados entre Server e Client serão compactados.de Departamento"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false"####"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGdeppar",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGdeppar)",
                "customData": ""
            }
        },
        {
            "codescope": "Concatena filtro de perfil com ANDCompany",
            "typesystemParameterId": "Boolean7|MASCARADEP",
            "descriptioncompanyID": ["7",
                {"code": "MASCARADEP",
              "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "QuandoMáscara marcado, soma os filtros de perfil [\"AND\" Lógico]dos Códigos de Departamento"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false"####"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGdeppar",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGdeppar)",
                "customData": ""
            }
        }
    ]
}

Bloco de código

language	js

firstline

title
1

1.1.2 Order (Desc)

Resultado (JSON) - GCCUPAR
linenumbers	true

{
    "hasNext":

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "codescope": "Usuário do Help WikiCompany",
            "typesystemParameterId": "1|MASCARACC",
            "companyID": "1",
            "code": "MASCARACC",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "UsuárioMáscara do Centro Helpde WikiCusto"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "##.#.#.#"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGccupar",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGccupar)",
                "customData": ""
            }
        },
        {
            "codescope": "UsuárioCompany",
            "typesystemParameterId": "String1|LOOKUPTODOS",
            "descriptioncompanyID": [
"1",
            "code": "LOOKUPTODOS",
     {
       "type": "Boolean",
            "languagedescription": "pt-BR",[
                {
    "descriptionText                "language": "Usuário do proxypt-BR",
                    "descriptionText": "Lookup"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""false
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistemaGccupar",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGccupar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "codesystemParameterId": "6|MASCARACC",
            "companyID": "Url do Help Wiki6",
            "code": "MASCARACC",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "UrlMáscara do HelpCentro de WikiCusto"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "###"
                }
            ],
            "scopegroup": {
                "name": "GlobalGccupar",
                "groupdisplayName": { "Parâmetros do Sistema (Gccupar)",
                "namecustomData": "GParametrosSistema",
"
            }
        },
        {
            "displayNamescope": "Parâmetros do Sistema (RMSSystemParameter)",
"Company",
            "systemParameterId": "6|LOOKUPTODOS",
            "companyID": "6",
            "customDatacode": "LOOKUPTODOS",
            }
 "type": "Boolean",
           }
    ]
}

1.1.3 - Filter (Resultado filtrado)

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items  "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Lookup"
                }
            ],
            "value": [
        {
        {
       "code": "Servidor",
            "typelanguage": "Stringpt-BR",
            "description        "parameterValue": [false
                {}
            ],
            "languagegroup": "pt-BR",
  {
                  "descriptionTextname": "Servidor de proxyGccupar",
                }
       "displayName": "Parâmetros do Sistema (Gccupar)",
     ],
            "valuecustomData": [""
            }
        {},
        {
            "languagescope": "pt-BRCompany",
                    "parameterValue"systemParameterId": "7|MASCARACC",
              "companyID": "7",
  }
            ]"code": "MASCARACC",
            "scopetype": "GlobalString",
            "groupdescription": {[
                 "name": "GParametrosSistema",
{
                    "displayNamelanguage": "Parâmetros do Sistema (RMSSystemParameter)pt-BR",
                "customData    "descriptionText": "Máscara do Centro de Custo"
                }
        }
    ]
}

1.1.4 - Paginação

Informações

title	Parâ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

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
,
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "###"
                }
            ],
            "group": {
                "name": "Gccupar",
                "displayName": "Parâmetros do Sistema (Gccupar)",
                 "codecustomData": "Compressao Habilitada",
            "type": "Boolean",
}
        }
    ]
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON) - GGOOGLESERVICE
linenumbers	true

{
    "descriptionhasNext": [true,
      "items": [
          {
                    "languagescope": "pt-BRCompany",
                    "descriptionTextsystemParameterId": "Chave responsável por determinar se dados trafegados entre Server e Client serão compactados.""1|SERVERPROXY",
            "companyID": "1",
            "code": "SERVERPROXY",
   }
            ]"type": "String",
            "valuedescription": [
                {
                    "language": "pt-BR",
                    "parameterValuedescriptionText": false "Nome do servidor proxy"
                }
            ],
            "scopevalue": "Global",[
            "group":    {
                    "namelanguage": "GParametrosSistemapt-BR",
                    "displayNameparameterValue": "Parâmetros do Sistema (RMSSystemParameter)",urano.bh01.local"
                "customData": ""}
            }],
        },
    "group": {
   {
             "codename": "Criptografia HabilitadaGgoogleservice",
                "typedisplayName": "BooleanParâmetros do Sistema (Ggoogleservice)",
                "descriptioncustomData": [
""
            }
        {},
        {
            "languagescope": "pt-BRCompany",
                    "descriptionTextsystemParameterId": "Chave responsável por determinar se dados trafegados entre Server e Client serão criptografados.""1|PORTPROXY",
            "companyID": "1",
            "code": "PORTPROXY",
   }
            ]"type": "Int16",
            "valuedescription": [
                {
                    "language": "pt-BR",
                    "parameterValuedescriptionText": false
  "Porta do servidor proxy"
                }
            ],
            "scope": "Global"value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 8080
                }
            ],
            "group": {
                "name": "GParametrosSistemaGgoogleservice",
                "displayName": "Parâmetros do Sistema (RMSSystemParameterGgoogleservice)",
                "customData": ""
            }
        },
        ]
}

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

Informações

title	Parâ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

icon	false
title	1.1.5 Fields

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [{
            "scope": "Company",
            "systemParameterId": "1|USERPROXY",
            "companyID": "1",
            "code": "USERPROXY",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário para autenticação no proxy"
                }
            ],
        {
      "value": [
      "code": "Compressao Habilitada"
        },{
        {
            "codelanguage": "Criptografia Habilitada"pt-BR",
        },
         {
   "parameterValue": "breno.batista"
        "code": "Chave Criptografia Simetrica"
        }
    },
        {],
            "codegroup": "Tamanho Chave Simetrica"
 {
             },
   "name": "Ggoogleservice",
    {
            "codedisplayName": "NivelParâmetros do LogSistema Comunicacao(Ggoogleservice)",
        },
         {"customData": ""
            "code": "Tamanho Minimo Compressao"}
        },
        {
            "codescope": "ServidorCompany",
        }    "systemParameterId": "1|PASSWORDPROXY",
         {   "companyID": "1",
            "code": "PortaPASSWORDPROXY",
        },
        {"type": "String",
            "codedescription": "Domínio"[
        },
        {
            "code": "Usuário"
        }"language": "pt-BR",
        {
            "codedescriptionText": "Senha para autenticação no proxy"
                },
          {  ],
            "codevalue": "Url do Help Wiki"
 [
                },{
        {
            "codelanguage": "Usuário do Help Wiki"pt-BR",
                    "parameterValue": "M\\DB\\01Q\\BBX\\CE\\B7T\\80\\EC\\EC\\94\\25\\DD\\DB"
        },
        {}
            "code": "Senha do usuário Help Wiki"
],
             },
        {
            "code": "Domínio do usuário Help Wiki"
        },
        {
            "code": "Concatena filtro de perfil com AND"
        },
        {
            "code": "Sistema de mensagens habilitado"
        },
        {
            "code": "Intervalo em minutos de pulling ao banco (host)"
        },
        {"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

title	Parâ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

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

title	Parâ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

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

title	Parâ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

icon	false
title	1.1.5 Fields

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

title	Parâ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

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "scope": "Company",
    "systemParameterId": "1|MASCARACC",
    "companyID": "1",
    "code": "MASCARACC",
    "type": "String",
    "description": [
        {
            "language": "pt-BR",
            "codedescriptionText": "IntervaloMáscara emdo minutosCentro de pulling aoCusto"
       host (client)"}
    ],
    },"value": [
        {
            "codelanguage": "Endereço Alternativo do Licence Server"
    pt-BR",
    }
    ]
}

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

Informações

title	Parâ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

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

        "parameterValue": "###"
        }
    ],
    "group": {
        "name": "Gccupar",
        "displayName": "Parâmetros do Sistema (Gccupar)",
        "customData": ""
    }
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

linenumbers	true

{
    "id": "testeapiusuario",
    "meta": {
        "resourceType": "User",
        "created": "2018-09-21T16:49:57.336Z",
        "lastModified": "2018-09-21T16:49:57.336Z"
    },{
    "hasNextexternalId": true"0001e",
    "itemsname": [{
        {
  "givenName": "TesteAPI",
          "codefamilyName": "Usuário"
 do  Help Wiki"},
    "userName": "testeapiusuario",
     },"phoneNumbers": [
        {
            "codevalue": "Usuário31974964158"
        },
        {
       ],
     "codeemails": "Url do Help Wiki"
  [
      },
        {
            "codevalue": "Tamanho Minimo Compressao"[email protected]",
        },
        {"type": "string",
            "codeprimary": "Tamanho Chave Simetrica"true
        },
        {
       ],
     "codeactive": "Sistema de mensagens habilitado"true,
        },"groups": [
        {
            "codevalue": "Servidor01",
        },
    "display": "geral"
   {
     }
    ],
    "codetitle": "Senha do usuário Help Wiki"Mr",
        },"manager": [
        {
            "codemanagerId": "Senha01",
        },
        {"displayName": "Geral"
        }
    "code": "Porta"
        },
        {
            "code": "Nivel Log Comunicacao"
        },
        {
            "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"
        },
        {
        ]
}

1.3 - PUT

...

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

...

Informações

icon	false
title	1.3.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 1|MASCARACC

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "scope": "Company",
    "systemParameterId": "1|MASCARACC",
    "companyID": "1",
    "code": "DomínioMASCARACC",
  do usuário Help Wiki""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"
        }
    ]
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 20

Nova versão Atual

Chave

Sumário

Objetivo

1 - Método

1.1 - GET

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

1.1.2 - Order(Resultado ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.2 - Order(Resultado ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

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

1.2 - POST

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

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

1.3 - PUT

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

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 20

Nova versão Atual

Chave

Sumário

Objetivo

1 - Método

1.1 - GET

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

1.1.2 - Order(Resultado ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.2 - Order(Resultado ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

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

1.2 - POST

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

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

1.3 - PUT

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