Sumário

...

Índice

exclude	Sumário

Objetivo

...

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

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" e GPARAMS"
É necessário utilizar o filtro "group.name" para informar qual servidor de parâmetros a API irá utilizar para apresentar os parâmetros.

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/glb/v1/system-parameters?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 Postman

Image RemovedImage Added	Image RemovedImage Added

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": [
        {
            "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": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "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
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "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": "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": [
        {
            "code": "VERSAOBASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Gparams.Versaobase"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "12.1.23.0"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParams",
                "displayName": "Parâmetros do Sistema (GParams)",
                "customData": ""
            }
        },
        {
            "code": "ERROSATUALIZ",
            "type": "Int16",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Erros de Atualizacao"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParams",
                "displayName": "Parâmetros do Sistema (GParams)",
                "customData": ""
            }
        },
        {
            "code": "BASE",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Tipo do Banco de Dados"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "MS SQL"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParams",
                "displayName": "Parâmetros do Sistema (GParams)",
                "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/glb/v1/system-parameters?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/glb/v1/system-parameters?group.name=gparametrossistema&order=code

Informações

icon	false
title	Exemplo Postman

Image RemovedImage Added

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": "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": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "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": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "code": "Concatena filtro de perfil com AND",
            "type": "Boolean",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Quando marcado, soma os filtros de perfil [\"AND\" Lógico]"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "scope": "Global",
            "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/glb/v1/system-parameters?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/glb/v1/roles?order=-id

Informações

icon	false
title	Exemplo Postman

Image RemovedImage Added

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": "Usuário do Help Wiki",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário do Help Wiki"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "code": "Usuário",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Usuário do proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "code": "Url do Help Wiki",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Url do Help Wiki"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "scope": "Global",
            "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/glb/v1/system-parameters?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/glb/v1/system-parameters?group.name=gparametrossistema&code=Servidor

Informações

icon	false
title	Exemplo Postman

Image RemovedImage Added

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": [
        {
            "code": "Servidor",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "Servidor de proxy"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": ""
                }
            ],
            "scope": "Global",
            "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/glb/v1/system-parameters?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/glb/v1/system-parameters?group.name=gparametrossistema&page=1&pageSize=2

Informações

icon	false
title	Exemplo Postman

Image RemovedImage Added

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",
            "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": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
            }
        },
        {
            "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
                }
            ],
            "scope": "Global",
            "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/glb/v1/system-parameters?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/glb/v1/system-parameters?group.name=gparametrossistema&fields=code

Informações

icon	false
title	Exemplo Postman

Image RemovedImage Added

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"
        },
        {
            "code": "Criptografia Habilitada"
        },
        {
            "code": "Chave Criptografia Simetrica"
        },
        {
            "code": "Tamanho Chave Simetrica"
        },
        {
            "code": "Nivel Log Comunicacao"
        },
        {
            "code": "Tamanho Minimo Compressao"
        },
        {
            "code": "Servidor"
        },
        {
            "code": "Porta"
        },
        {
            "code": "Domínio"
        },
        {
            "code": "Usuário"
        },
        {
            "code": "Senha"
        },
        {
            "code": "Url do Help Wiki"
        },
        {
            "code": "Usuário do Help Wiki"
        },
        {
            "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)"
        },
        {
            "code": "Intervalo em minutos de pulling ao  host (client)"
        },
        {
            "code": "Endereço Alternativo do Licence Server"
        }
    ]
}

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/glb/v1/system-parameters?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/glb/v1/system-parameters?group.name=gparametrossistema&fields=code&order=-code

Informações

icon	false
title	Exemplo Postman

Image RemovedImage Added

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": "Usuário do Help Wiki"
        },
        {
            "code": "Usuário"
        },
        {
            "code": "Url do Help Wiki"
        },
        {
            "code": "Tamanho Minimo Compressao"
        },
        {
            "code": "Tamanho Chave Simetrica"
        },
        {
            "code": "Sistema de mensagens habilitado"
        },
        {
            "code": "Servidor"
        },
        {
            "code": "Senha do usuário Help Wiki"
        },
        {
            "code": "Senha"
        },
        {
            "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"
        },
        {
            "code": "Domínio do usuário Help Wiki"
        },
        {
            "code": "Domínio"
        },
        {
            "code": "Criptografia Habilitada"
        },
        {
            "code": "Concatena filtro de perfil com AND"
        },
        {
            "code": "Compressao Habilitada"
        },
        {
            "code": "Chave Criptografia Simetrica"
        }
    ]
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 13

Nova versão 14

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)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 13

Nova versão 14

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)