Skip to content

Operações Api (v1.0.0)

API de Operações

Esta API centraliza a gestão do ciclo de vida de operações e seus ativos, oferecendo funcionalidades completas para:

  • Criação, listagem, consulta, alteração e exclusão de operações.
  • Gerenciamento de ativos, tanto individualmente quanto em massa, por meio de importação.
  • Controle de status, situação e acompanhamento do progresso das importações.
  • Consultas detalhadas, extração de informações e registro de erros no processo.

Todas as operações são protegidas por autenticação e autorização robustas, garantindo segurança, organização e rastreabilidade em todas as etapas do gerenciamento das informações.

Download OpenAPI description
v1.json
v1.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/
http://rgbsys.dyndns.info/ger2025-operacao-api-desenvolvimento/

Operações Importação

Principais funcionalidades disponíveis:

  • Importação de Ativos:
    • Permite o upload de arquivos em lote, vinculando-os a uma operação específica do sistema.
    • Possibilita o acompanhamento detalhado do status e andamento da importação, bem como a consulta de arquivos e itens importados.
    • Permite ajustar metadados da importação, como quantidade de arquivos e finalização do processo.
    • Oferece mecanismos para registrar e consultar eventuais erros ocorridos durante a importação.
    • Todas as operações são restritas a usuários autenticados e com permissões adequadas para consulta ou alteração.
Operations

Operações Ativos

Principais funcionalidades disponíveis:

  • Inclusão de Ativos em Operações:
    • Possibilita importar e vincular arquivos ou registros de ativos a uma operação específica, garantindo que toda a documentação necessária fique centralizada no contexto da operação.
    • Função disponível apenas para usuários devidamente autorizados, cumprindo os critérios de permissão estabelecidos pelo sistema.
    • Geração de respostas padronizadas para sucesso, validação de dados, falhas de autenticação/autorização e casos em que a operação não é localizada.
Operations

Incluir ativos arquivos

Request

Efetua a inclusão de ativos

Path
idstringrequired

Id da operação

Body
required

Arquivos a serem importados

operacaoIdstring or nullrequired

Id da operação

numerostring or nullrequired
valorFacenumber(double)required
vencimentostring(date-time)required
vencimentoUtilstring or null(date-time)required
vencimentoFloatstring or null(date-time)required
vencimentoFloatUtilstring or null(date-time)required
sacadoIdstring or nullrequired
chaveNfestring or nullrequired
situacaointeger(SituacaoAtivoEnum)required
curl -i -X POST \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/ativos' \
  -H 'Content-Type: application/json' \
  -d '{
    "operacaoId": "string",
    "numero": "string",
    "valorFace": 0.1,
    "vencimento": "2019-08-24T14:15:22Z",
    "vencimentoUtil": "2019-08-24T14:15:22Z",
    "vencimentoFloat": "2019-08-24T14:15:22Z",
    "vencimentoFloatUtil": "2019-08-24T14:15:22Z",
    "sacadoId": "string",
    "chaveNfe": "string",
    "situacao": 0
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id da operação criada

sequencialDiariointeger(int32)required

Sequencial diário da operação

cadastrostring(date-time)required

Data da criação da operação

Response
application/json
{
  "id": "string",
  "sequencialDiario": 0,
  "cadastro": "2019-08-24T14:15:22Z"
}

Operações

Principais funcionalidades disponíveis:

  • Consulta de Operações:
    • Listagem de operações com múltiplos filtros (datas, status, tipos, ids, etc.).
    • Busca de detalhes completos de uma operação específica.
  • Cadastro e Alteração:
    • Permite cadastrar novas operações.
    • Altera dados das operações existentes.
  • Exclusão:
    • Remove uma operação e todos os ativos associados.
  • Alteração de Status e Situação:
    • Modifica o status ou situação da operação e de seus ativos relacionados.
Operations

Operações Status

Principais funcionalidades disponíveis:

  • Listar Status de Operação:
    • Consultar todos os status de operação registrados no sistema, facilitando análise e integração com outros módulos.
  • Consultar Detalhes de Status de Operação:
    • Obter informações detalhadas de um status específico, utilizando seu identificador único.
  • Cadastrar Novo Status de Operação:
    • Adicionar um novo status de operação, aumentando a flexibilidade nos fluxos de trabalho.
  • Atualizar Status de Operação:
    • Modificar dados de um status existente, permitindo ajustes conforme regras de negócio.
  • Excluir Status de Operação:
    • Remover um status de operação, ação restrita a usuários autorizados e auditada para garantir segurança.
Operations