Sumário

...

Índice

exclude	Sumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API de Parâmetros para configurar o GED.

1 - Método

...

Para configurar o GED será usada a API de Parâmetros. Nessa API, é necessário utilizar o filtro "group.name" para informar qual servidor de parâmetros a API irá utilizar para apresentar os parâmetros.

...

Informações

icon	false

A propriedade systemParameterId é composta pela companyIdpelo group.CustomData|parameterCode, onde companyId é a Coligada group.CustomData é o parâmetro (HCPARAMETROS.NOMECOLUNA) 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 coligadacampo a ser alterado do parâmetro.

A tabela que armazena os dados do GED é a HCPARAMETROS. O filtro group.customData deve ser preenchido com o valor do campo HCPARAMETROS.NOMECOLUNA desejado. Veja alguns exemplos abaixo.

1.1 - GET

...

1.1.1 - Get All (Recuperar

...

os parâmetros do GED

...

)

...

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=ConParametrosData&group.customData={{parametro}}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url's Utilizada:

http://localhost:8051/api/framework/v1/systemParameters?group.name=ConParametrosData&group.customData=GED_SERVIDOR

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": false,
"items": [
{
"scope": "Company",
"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.NOMECOLUNA",
"code": "HCPARAMETROS.NOMECOLUNA",
"type": "String",
"description": [
{
"language": "pt-BR",
"descriptionText": "NomeColuna"
}
],
"value": [
{
"language": "pt-BR",
"parameterValue": "GED_SERVIDOR"
}
],
"group": {
"name": "ConParametrosData",
"displayName": "Parâmetros do Sistema (RMSParamsServer)",
"customData": "GED_SERVIDOR"
}
},
{
"scope": "Company",
"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORSTR",
"code": "HCPARAMETROS.VALORSTR",
"type": "String",
"description": [
{
"language": "pt-BR",
"descriptionText": "ValorStr"
}
],
"value": [
{
"language": "pt-BR",
"parameterValue": "BHD050101858"
}
],
"group": {
"name": "ConParametrosData",
"displayName": "Parâmetros do Sistema (RMSParamsServer)",
"customData": "GED_SERVIDOR"
}
},
{
"scope": "Company",
"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORINT",
"code": "HCPARAMETROS.VALORINT",
"type": "Int32",
"description": [
{
"language": "pt-BR",
"descriptionText": "ValorInt"
}
],
"value": [
{
"language": "pt-BR",
"parameterValue": 0
}
],
"group": {
"name": "ConParametrosData",
"displayName": "Parâmetros do Sistema (RMSParamsServer)",
"customData": "GED_SERVIDOR"
}
},
{
"scope": "Company",
"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.TIPOCOLUNA",
"code": "HCPARAMETROS.TIPOCOLUNA",
"type": "String",
"description": [
{
"language": "pt-BR",
"descriptionText": "TipoColuna"
}
],
"value": [
{
"language": "pt-BR"
}
],
"group": {
"name": "ConParametrosData",
"displayName": "Parâmetros do Sistema (RMSParamsServer)",
"customData": "GED_SERVIDOR"
}
},
{
"scope": "Company",
"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.PACOTEPADRAO",
"code": "HCPARAMETROS.PACOTEPADRAO",
"type": "Int32",
"description": [
{
"language": "pt-BR",
"descriptionText": "PacotePadrao"
}
],
"value": [
{
"language": "pt-BR",
"parameterValue": 0
}
],
"group": {
"name": "ConParametrosData",
"displayName": "Parâmetros do Sistema (RMSParamsServer)",
"customData": "GED_SERVIDOR"
}
},
{
"scope": "Company",
"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.IDINTEGRACAO",
"code": "HCPARAMETROS.IDINTEGRACAO",
"type": "Int32",
"description": [
{
"language": "pt-BR",
"descriptionText": "IDIntegracao"
}
],
"value": [
{
"language": "pt-BR",
"parameterValue": 0
}
],
"group": {
"name": "ConParametrosData",
"displayName": "Parâmetros do Sistema (RMSParamsServer)",
"customData": "GED_SERVIDOR"
}
}
]
}

...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.NOMECOLUNA",
            "code": "HCPARAMETROS.NOMECOLUNA",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "NomeColuna"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "GED_SERVIDOR"
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORSTR",
            "code": "HCPARAMETROS.VALORSTR",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ValorStr"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "BHD050101858"
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORINT",
            "code": "HCPARAMETROS.VALORINT",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ValorInt"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.TIPOCOLUNA",
            "code": "HCPARAMETROS.TIPOCOLUNA",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "TipoColuna"
                }
            ],
            "value": [
                {
                    "language": "pt-BR"
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },

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": [
        {
            "languagescope": "pt-BRCompany",
            "descriptionTextsystemParameterId": "Máscara do Centro de Custo"
 GED_SERVIDOR|HCPARAMETROS.PACOTEPADRAO",
       }
    ],
    "valuecode": [
        {"HCPARAMETROS.PACOTEPADRAO",
            "languagetype": "pt-BRInt32",
            "parameterValuedescription": "###"[
        }
     ],
   {
     "group": {
               "namelanguage": "Gccuparpt-BR",
        "displayName": "Parâmetros do Sistema (Gccupar)",
        "customDatadescriptionText": "PacotePadrao"
              }
}

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": {
        "value": [
                {
           "resourceType": "User",
        "createdlanguage": "2018-09-21T16:49:57.336Zpt-BR",
         "lastModified": "2018-09-21T16:49:57.336Z"
       },
    "externalIdparameterValue": "0001e",0
     "name": {
          "givenName": "TesteAPI", }
        "familyName": "Usuário"
    }],
    "userName": "testeapiusuario",
        "phoneNumbersgroup": [{
        {
            "valuename": "31974964158ConParametrosData",
        }
    ],
    "emailsdisplayName": [
"Parâmetros do   Sistema (RMSParamsServer)",
    {
            "valuecustomData": "[email protected]",GED_SERVIDOR"
            "type": "string",
}
        },
       "primary": true{
        }
    ],
    "activescope": true"Company",
    "groups": [
        {"systemParameterId": "GED_SERVIDOR|HCPARAMETROS.IDINTEGRACAO",
            "valuecode": "01HCPARAMETROS.IDINTEGRACAO",
            "displaytype": "geralInt32",
           }
 "description": [
      ],
    "title": "Mr",
    "manager": [{
        {
            "managerIdlanguage": "01pt-BR",
                    "displayNamedescriptionText": "GeralIDIntegracao"
         }
     ]
}

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": [  }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "group": {
        {
            "language": "pt-BR",
            "descriptionText": "Máscara do Centro de Custo"
        }
    ],
    "value": [
        {
            "language": "pt-BR",
    "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        }
    ]
}

1.2 - POST

...

Alguns parâmetros do GED são alterados pelo campo HCPARAMETROS.VALORSTR, outros devem ser armazenados no campo HCPARAMETROS.VALORINT.

Parâmetros a serem atualizados em HCPARAMETROS.VALORINT:

GED_ATIVA_INTEGRACAO_FLUIG
GED_ATIVACERTIFICACAOVISAO
GED_COD_PASTA_RAIZ
GED_CODEMPRESA
GED_FLUXOAPROVACAOVISAO
GED_TIPOLOG

Parâmetros a serem atualizados em HCPARAMETROS.VALORSTR:

GED_COD_GRUPO_USUARIO
GED_MATRICULA
GED_PORTA
GED_PORTA_FTP
GED_SENHA
GED_SERVIDOR
GED_TIPO_PROTOCOLO
GED_USUARIO
GED_USERPASSWORD

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

{
	"code": "HCPARAMETROS.VALORSTR",
	"value": [
	    {
	        "parameterValue": "BHD050101852"
		}
	],
	"group": {
		"name": "ConParametrosData",
		"displayName": "",
		"customData": "GED_SERVIDOR"
	}
}

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

{
    "scope": "Company",
    "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORSTR",
    "code": "HCPARAMETROS.VALORSTR",
    "type": "String",
    "description": [
        {
            "language": "pt-BR",
            "descriptionText": "ValorStr"
        }
    ],
    "value": [
        {
            "language": "pt-BR",
            "parameterValue": "BHD050101852"
        }
    ],
    "group": {
        "name": "ConParametrosData",
        "displayName": "Parâmetros do Sistema (RMSParamsServer)",
        "customData": "GED_SERVIDOR"
    }
}

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/{systemParameterId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: GED_SERVIDOR|HCPARAMETROS.VALORSTR

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters/GED_SERVIDOR|HCPARAMETROS.VALORSTR

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

{
	"code": "HCPARAMETROS.VALORSTR",
	"value": [
	    {
	        "parameterValue": "###BHD050101853"
        		}
    	],
    	"group": {
        		"name": "GccuparConParametrosData",
        		"displayName": "Parâmetros do Sistema (Gccupar)",
        		"customData": "GED_SERVIDOR"
    	}
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

Sumário

Objetivo

1 - Método

1.1 - GET

1.1.1 - Get All (Recuperar

os parâmetros do GED

)

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

1.3 - PUT

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

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 2

Nova versão Atual

Chave

Sumário

Objetivo

1 - Método

1.1 - GET

1.1.1 - Get All (Recuperar

os parâmetros do GED

)

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

1.3 - PUT

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

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)