Versões comparadas

Chave

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

...

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

Máscara de Url: http://{{dominio}}:{{port}}/api/glb/v1/system-parameters?group.name{{groupnameValuetabela}}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url's Utilizada: 

Informações
iconfalse
titleExemplo Postman

Image Modified

Image Modified

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON) - GPARAMETROSSISTEMA
linenumberstrue
{
    "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
languagejs
firstline1
titleResultado (JSON) - GPARAMS
linenumberstrue
{
    "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": ""
            }
        }
    ]
}

...

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

Máscara de Url: http http://{{domíniodominio}}:{{portaport}}/api/glb/v1/roles?system-parameters?group.name{{tabela}}&order={{campo}}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id code

Tipo de Ordenação: Ascendente

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

Informações
iconfalse
titleExemplo Postman

Image RemovedImage Added

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": falsetrue,
    "items": [
        {
            "idcode": "Api_coligada"Chave Criptografia Simetrica",
        },
        {"type": "String",
            "iddescription": "DBA_G"[
        },
        {
            "id": "DP_G"
        }"language": "pt-BR",
        {
            "iddescriptionText": "Perfil1_GArmazena chave de criptografia simétrica para todos os Servers."
        },        }
        {    ],
            "idvalue": "PerfilApi"[
        },
        {
                    "idlanguage": "Teste_Api"
pt-BR",
           }
        ]
}
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/roles?order=-id

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
 "parameterValue": "<E><K>A9CPrB4DxF97G/PSV7ng6A==</K><IV>082KMtFVWr/nPPqdVMULxA==</IV></E>"
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "idcustomData": "Teste_Api"
            }
        },
        {
            "idcode": "PerfilApiCompressao Habilitada",
        },
        {"type": "Boolean",
            "iddescription": "Perfil1_G"[
        },
        {
            "id": "DP_G"
        }"language": "pt-BR",
        {
            "iddescriptionText": "DBA_GChave responsável por determinar se dados trafegados entre Server e Client serão compactados."
        },
        }
            {],
            "idvalue": "Api_coligada"
[
               } {
       ]
}

1.1.3 - Filter (Resultado filtrado)

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

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?{campo}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: id

Valor: DBA_G

Url Utilizada: http://localhost:8051/api/glb/v1/roles?id=DBA_G

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [             "language": "pt-BR",
                    "parameterValue": false
                }
            ],
            "scope": "Global",
            "group": {
                "name": "GParametrosSistema",
                "displayName": "Parâmetros do Sistema (RMSSystemParameter)",
                "customData": ""
        {
    }
        },
        {
            "idcode": "DBA_G"Concatena filtro de perfil com AND",
        }    "type": "Boolean",
    ]
}

1.1.4 - Paginação

Informações
titleParâmetros

Page: Página que será apresentada.

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

Exemplo: ?page=valor1&pageSize=1

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

Page: 1

PageSize: 20

         "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
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
title1.1.4 Paginacao
Postman
Expandir

Domínio: localhost

Porta: 8051

Valor1: 2

Valor2: 2

Url Utilizada: http://localhost:8051/api/glb/v1/roles?page=2&pageSize=2

Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração
Informações
iconfalse
titleExemplo

Image Removed

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
iconfalse
titleExemplo Postman

Image Added

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "idcode": "DBA_0"
Usuário do Help Wiki",
     },
        {"type": "String",
            "iddescription": "DBA_0"
        }
    ]
}

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

Informações
titleParâmetros

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

Exemplo: ?fields=campo1

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

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

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: id

Url Utilizada: http://localhost:8051/api/glb/v1/roles?fields=id

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {[
                {
                    "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": ""
            "id": "Api_coligada"}
        },
        {
            "idcode": "DBA_GUsuário",
        },
        {"type": "String",
            "iddescription": "DP_G"[
        },
        {
            "id": "Perfil1_G"
        }"language": "pt-BR",
        {
            "iddescriptionText": "PerfilApiUsuário do proxy"
        }        }
            ],
            "value": [
                {
                    "idlanguage": "Teste_Api"
pt-BR",
                   } "parameterValue": ""
    ]
}

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

Informações
titleParâmetros

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

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

            }
            ],
            "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
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Valor: Servidor

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

Informações
iconfalse
titleExemplo Postman

Image Added

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "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
titleParâmetros

Page: Página que será apresentada.

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

Exemplo: ?page=valor1&pageSize=1

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

Page: 1

PageSize: 20

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 2

Valor2: 2

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

Informações
iconfalse
titleExemplo Postman

Image Added

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "code": "Compressao Habilitada",
            "type": "Boolean",
            "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
titleParâmetros

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

Exemplo: ?fields=campo1

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

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: code

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

Informações
iconfalse
titleExemplo Postman

Image Added

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "code": "Compressao Habilitada"
        },
        {
            "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
titleParâmetros

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

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

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: code

Valor Campo Order: code

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

Informações
iconfalse
titleExemplo Postman

Image Added

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "code": "Usuário do Help Wiki"
        },
        {
            "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"
        },
Informações
iconfalse
title1.1.6 GetOne
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/roles?filelds={{campo}}&Order={{campo}}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: id

Valor Campo Order: id

Url Utilizada: http://localhost:8051/api/glb/v1/roles?fields=id&order=-id

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "idcode": "Teste_ApiDomínio do usuário Help Wiki"
        },
        {
            "idcode": "PerfilApiDomínio"
        },
        {
            "idcode": "Perfil1_GCriptografia Habilitada"
        },
        {
            "idcode": "DP_GConcatena filtro de perfil com AND"
        },
        {
            "idcode": "DBA_GCompressao Habilitada"
        },
        {
            "idcode": "Api_coligadaChave Criptografia Simetrica"
        }
    ]
}