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

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

Lista os status das operações

Request

Lista os status das operações definidos no tenant

curl -i -X GET \
  https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes-status

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do status

nomestring or nullrequired

Descrição resumida do status

descricaostring or nullrequired

Descrição do status

statusIdPredecessorstring or nullrequired

Indica o id do status predecessor

idInternointeger or null(NullableOfStatusOperacaoEnum2)required

Indica o id interno

corstring or nullrequired

Cor do status

enviarParaArray of strings or nullrequired

Fluxo do status

alarmesArray of objects or null(ListarOperacaoStatusAlarmeResponse)required

Alarmes do status

alarmes[].​idstring or nullrequired

Id do alarme

alarmes[].​tempointeger(int32)required

Tempo máximo do alarme

alarmes[].​corstring or nullrequired

Cor do alarme

alarmes[].​ativobooleanrequired

Indica se está ativo ou não

Response
application/json
{
  "id": "string",
  "nome": "string",
  "descricao": "string",
  "statusIdPredecessor": "string",
  "idInterno": 0,
  "cor": "string",
  "enviarPara": [
    "string"
  ],
  "alarmes": [
    { … }
  ]
}

Fluxo para criação de um status

Request

Fluxo para criação de um status

Body
required
alarmesArray of objects or null(AlarmeCadastrarRequest)required
alarmes[].​ativobooleanrequired
alarmes[].​tempointeger(int32)required
alarmes[].​corstring or nullrequired
nomestring or nullrequired
descricaostring or nullrequired
statusIdPredecessorstring or nullrequired
corstring or nullrequired
enviarParaArray of strings or nullrequired
curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes-status \
  -H 'Content-Type: application/json' \
  -d '{
    "alarmes": [
      {
        "ativo": true,
        "tempo": 0,
        "cor": "string"
      }
    ],
    "nome": "string",
    "descricao": "string",
    "statusIdPredecessor": "string",
    "cor": "string",
    "enviarPara": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired
Response
application/json
{
  "id": "string"
}

Fluxo para alteração de um status

Request

Fluxo para alteração de um status

Path
idstringrequired
Body
required
idstring or nullrequired
alarmesArray of objects or null(AlarmeAlterarRequest)required
alarmes[].​idstring or nullrequired
alarmes[].​ativobooleanrequired
alarmes[].​tempointeger(int32)required
alarmes[].​corstring or nullrequired
nomestring or nullrequired
descricaostring or nullrequired
statusIdPredecessorstring or nullrequired
corstring or nullrequired
enviarParaArray of strings or nullrequired
curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes-status/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "alarmes": [
      {
        "id": "string",
        "ativo": true,
        "tempo": 0,
        "cor": "string"
      }
    ],
    "nome": "string",
    "descricao": "string",
    "statusIdPredecessor": "string",
    "cor": "string",
    "enviarPara": [
      "string"
    ]
  }'

Responses

OK

Response
No content

Fluxo para alteração de um status

Request

Fluxo para alteração de um status

Path
idstringrequired
curl -i -X DELETE \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes-status/{id}'

Responses

OK

Response
No content