# Operações Api 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. Version: v1.0.0 ## Servers ``` http://rgbsys.dyndns.info/ger2025-operacao-api-desenvolvimento ``` ## Download OpenAPI description [Operações Api](https://apidocs.ger26.com.br/_bundle/apis/Operacoes/v1.yaml) ## 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. ### Incluir ativos via upload de arquivos - [POST /api/v1/operacoes/{id}/importacoes](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes/post.md): Efetua a inclusão de ativos via upload de arquivos e retorna o id da importação ### Recuperar a lista de arquivos da importação - [GET /api/v1/operacoes/{id}/importacoes/{importacaoId}/arquivos](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes~1%7Bimportacaoid%7D~1arquivos/get.md): Retorna a lista de arquivos informando se ouve erro ou nõ ### Recuperar o resultado das importação de um arquivo - [GET /api/v1/operacoes/{id}/importacoes/{importacaoId}/arquivos/{arquivoId}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes~1%7Bimportacaoid%7D~1arquivos~1%7Barquivoid%7D/get.md): Retorna a lista de ativos importados em um arquivo e se houve erro ou não ### Recuperar o andamento da importação - [GET /api/v1/operacoes/{id}/importacoes/{importacaoId}/andamento](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes~1%7Bimportacaoid%7D~1andamento/get.md): Retorna o andamento da importação ### Atualiza a quantidade de arquivos - [PATCH /api/v1/operacoes/{id}/importacoes/{importacaoId}/quantidade](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes~1%7Bimportacaoid%7D~1quantidade/patch.md): Atualiza a informação da quantidade de arquivos totais que serão importados ### Atualiza a quantidade de arquivos - [PATCH /api/v1/operacoes/{id}/importacoes/{importacaoId}/finalizada](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes~1%7Bimportacaoid%7D~1finalizada/patch.md): Atualiza a informação da quantidade de arquivos totais que serão importados ### Registra os erros da importação em ativos - [POST /api/v1/operacoes/{id}/importacoes/{importacaoId}/status](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-importacao/paths/~1api~1v1~1operacoes~1%7Bid%7D~1importacoes~1%7Bimportacaoid%7D~1status/post.md): Registra os erros da importação em ativos ## 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. ### Incluir ativos arquivos - [POST /api/v1/operacoes/{id}/ativos](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-ativos/paths/~1api~1v1~1operacoes~1%7Bid%7D~1ativos/post.md): Efetua a inclusão de ativos ## 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. ### Lista as operações ativas - [GET /api/v1/operacoes/{id}/ativos](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes~1%7Bid%7D~1ativos/get.md): Fluxo para listar as operações ativas ### Lista as operações - [GET /api/v1/operacoes](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes/get.md): Lista as operações de acordo com os filtros passados ### Cadastra uma operação - [POST /api/v1/operacoes](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes/post.md): Efetua o cadastramento de uma operação setando o status dela como Incluindo e a situação Pendente. Retorna o identificador e o sequencial ### Altera uma operação - [PUT /api/v1/operacoes](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes/put.md): Efetua a alteração de uma operação ### Recupera os dados de uma operação - [GET /api/v1/operacoes/{id}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes~1%7Bid%7D/get.md): Recupera todas as informações de uma operação, inclusive seus ativos ### Exclui uma operação - [DELETE /api/v1/operacoes/{id}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes~1%7Bid%7D/delete.md): Exclui uma operação e todos os seus ativos ### Altera a situação de uam operação - [PATCH /api/v1/operacoes/{id}/situacao/{situacao}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes~1%7Bid%7D~1situacao~1%7Bsituacao%7D/patch.md): Alterar a situção de uam operação e o status dos seus ativos ### Altera o status de uma operação - [PATCH /api/v1/operacoes/{id}/status/{statusId}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes/paths/~1api~1v1~1operacoes~1%7Bid%7D~1status~1%7Bstatusid%7D/patch.md): Altera o status de uma operação ## 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. ### Lista os status das operações - [GET /api/v1/operacoes-status](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-status/paths/~1api~1v1~1operacoes-status/get.md): Lista os status das operações definidos no tenant ### Fluxo para criação de um status - [POST /api/v1/operacoes-status](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-status/paths/~1api~1v1~1operacoes-status/post.md): Fluxo para criação de um status ### Fluxo para alteração de um status - [PUT /api/v1/operacoes-status/{id}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-status/paths/~1api~1v1~1operacoes-status~1%7Bid%7D/put.md): Fluxo para alteração de um status ### Fluxo para alteração de um status - [DELETE /api/v1/operacoes-status/{id}](https://apidocs.ger26.com.br/apis/operacoes/v1/operacoes-status/paths/~1api~1v1~1operacoes-status~1%7Bid%7D/delete.md): Fluxo para alteração de um status