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

...

...
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
                }
            ],
            "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": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "Nivel Log Comunicacao",
            "code": "Nivel Log Comunicacao",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Determina 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
                }
            ],
            "group": {
                "name": "gparametrossistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        }
    ]
}

Bloco de código

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

{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "VERSAOBASE",
            "code": "VERSAOBASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Gparams.Versaobase"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "12.1.23.0"
                }
            ],
            "group": {
                "name": "Gparams",
                "displayName": "Parâmetros do Sistema (Gparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "BASE",
            "code": "BASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tipo do Banco de Dados"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "MS SQL"
                }
            ],
            "group": {
                "name": "Gparams",
                "displayName": "Parâmetros do Sistema (Gparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "UNIFIEDLOGON",
            "code": "UNIFIEDLOGON",
            "type": "Int16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Utilizacao de Unifieldlogon"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "group": {
                "name": "Gparams",
                "displayName": "Parâmetros do Sistema (Gparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "PORTOMSG",
            "code": "PORTOMSG",
            "type": "Int16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Nº do Porto P/ Envio/Receb. de Mensagens"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 9020
                }
            ],
            "group": {
                "name": "Gparams",
                "displayName": "Parâmetros do Sistema (Gparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "UPCASELOGIN",
            "code": "UPCASELOGIN",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Login é Case-Insensitive?"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "group": {
                "name": "Gparams",
                "displayName": "Parâmetros do Sistema (Gparams)",
                "customData": ""
            }
        }
    ]
}

Bloco de código

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

{
    "hasNext": true,
    "items": [
        {
            "scope": "Global",
            "systemParameterId": "SERVIDORSMTP",
            "code": "SERVIDORSMTP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Servidor SMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "maia.bh01.local"
                }
            ],
            "group": {
                "name": "Gmailparams",
                "displayName": "Parâmetros do Sistema (Gmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "USUARIO",
            "code": "USUARIO",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "breno.batista"
                }
            ],
            "group": {
                "name": "Gmailparams",
                "displayName": "Parâmetros do Sistema (Gmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "SENHA",
            "code": "SENHA",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Senha de Conexão no Servidor SMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "M\\DB\\01Q\\BBX\\CE\\B7T\\80\\EC\\EC\\94\\25\\DD\\DB"
                }
            ],
            "group": {
                "name": "Gmailparams",
                "displayName": "Parâmetros do Sistema (Gmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "AUTENTICACAO",
            "code": "AUTENTICACAO",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tempo de atualização"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": true
                }
            ],
            "group": {
                "name": "Gmailparams",
                "displayName": "Parâmetros do Sistema (Gmailparams)",
                "customData": ""
            }
        },
        {
            "scope": "Global",
            "systemParameterId": "DOMINIO",
            "code": "DOMINIO",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Domínio para conexão com servidor SMTP"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "BH01"
                }
            ],
            "group": {
                "name": "Gmailparams",
                "displayName": "Parâmetros do Sistema (Gmailparams)",
                "customData": ""
            }
        }
    ]
}

Bloco de código

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

{
    "hasNext": false,
    "items": [
        {
            "scope": "Company",
            "systemParameterId": "1|MASCARADEP",
            "companyID": "1",
            "code": "MASCARADEP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Máscara dos Códigos de Departamento"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "##"
                }
            ],
            "group": {
                "name": "Gdeppar",
                "displayName": "Parâmetros do Sistema (Gdeppar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "6|MASCARADEP",
            "companyID": "6",
            "code": "MASCARADEP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Máscara dos Códigos de Departamento"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "####"
                }
            ],
            "group": {
                "name": "Gdeppar",
                "displayName": "Parâmetros do Sistema (Gdeppar)",
                "customData": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "7|MASCARADEP",
            "companyID": "7",
            "code": "MASCARADEP",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Máscara dos Códigos de Departamento"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "####"
                }
            ],
            "group": {
                "name": "Gdeppar",
                "displayName": "Parâmetros do Sistema (Gdeppar)",
                "customData": ""
            }
        }
    ]
}

Bloco de código

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

{
    "hasNext": true,
    "items": [
        {
            "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": ""
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "1|LOOKUPTODOS",
            "companyID": "1",
            "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": "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

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

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

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 (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",
            "descriptionText": "Máscara do Centro de Custo"
        }
    ],
    "value": [
        {
            "language": "pt-BR",
            "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

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

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 22

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

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.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.3 - PUT

1.3.1 - Put (

Atualiza o valor do parâmetro)