POST

api/genericos/ge/ModeloRelatorio/Salvar

Notas de Implementação:

Método para salvar um modelo de relatório passando os parâmetros através de HttpRequest.

Exemplo de Código: 

             Para utilizar este método é necessário informar os parâmetros e seus respectivos valores na requisição.
            
            Nome ------------------ Descrição ------------------------------------------------------------------------- Tipo ------ Informação Adicional
            codigousuario --------- Código do usuário ----------------------------------------------------------------- string ---- Obrigatório
            grupo ----------------- Grupo do relatório ---------------------------------------------------------------- string ---- Obrigatório
            nomerelatorio --------- Nome do relatório ----------------------------------------------------------------- string ---- Obrigatório
            arquivomodelonome ----- Nome do arquivo a ser salvo ------------------------------------------------------- string ---- Obrigatório
            funcao ---------------- Define se o arquivo será criado ou modificado. "G" para gravar e "M" para modificar string ---- Obrigatório
            modoExecucao ---------- Define o modo de execução, "criar" para criação " " para modificação -------------- string ---- Obrigatório
            codigo ---------------- Código do id do registro que se deseja alterar/substituir ------------------------- string ---- Obrigatório
            localescolhidousuario - Local adicional na pasta CDN escolhida pelo usuário ------------------------------- string ---- Opcional
            sufixo ---------------- Complemento do nome do arquivo ---------------------------------------------------- string ---- Opcional
            arquivomodelo --------- Local do arquivo modelo. Parâmetro utilizado somente na modificação de registro --- string ---- Opcional
            arquivofinal ---------- Local do arquivo final. Parâmetro utilizado somente na modificação de registro ---- string ---- Opcional
            arquivoabrir ---------- Local do arquivo a abrir. Parâmetro utilizado somente na modificação de registro -- string ---- Opcional
            substituirarquivo ----- Define se deve substituir um modelo já registrado --------------------------------- boolean --- Opcional
            padrao ---------------- Define se o relatório será salvo como padrão -------------------------------------- boolean --- Opcional
            desligapdf ------------ Define se deve desligar o formato PDF/A ------------------------------------------- boolean --- Opcional
            
            Exemplo de criação:
            {{URL_API}}/genericos/ge/modelorelatorio/salvar?codigousuario=A00&grupo=EMPRES&nomerelatorio=Exemplo_Envio&arquivomodelonome=AB02409_Empresas_Gerais.rtf&modoExecucao=criar&padrao=true&desligapdf=true&funcao=G&codigo=0

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

Informações das propriedades de retorno.

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Objeto JSON com lista dos dados referente ao modelo criado.

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}