Linha RM

Atalhos

Páginas filhas
  • API de Parâmetros

Versões comparadas

Versão antiga 21

changes.mady.by.user Karina Dos Santos Costa

Gravado em

comparado com

Nova versão 22

changes.mady.by.user Karina Dos Santos Costa

Gravado em

Chave

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

...

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor Campo Fields: code

Valor Campo Order: code

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

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

1.2 - POST

...

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

...

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

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

1.3 - PUT

...

1.3.1 - Put (Atualizar um usuário)

...

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 1|MASCARACC

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

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "scope": "Company",
    "systemParameterId": "1|MASCARACC",
    "companyID": "1",
    "code": "MASCARACC",
    "type": "String",
    "description": [
        {
            "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": ""
    }
}