Grupo de Dispositivos

O DeviceGroup é responsável pelo gerenciamento de grupos de dispositivos de controle de acesso, permitindo que múltiplos dispositivos sejam organizados logicamente para ações coordenadas, como liberar simultaneamente portas de emergência, catracas ou sensores.

Essa funcionalidade permite mais flexibilidade na definição de regras e na execução de comandos para múltiplos dispositivos ao mesmo tempo.

1. Obter grupo de dispositivos por filtro

Descrição:

Esse endpoint permite consultar uma lista de grupos de dispositivos cadastrados no sistema, com a possibilidade de aplicar filtros para refinar os resultados.

• GET /api/v1/deviceGroups

Quando Usar:

• Exibir uma lista paginada ou completa dos grupos de dispositivos disponíveis.

• Buscar grupos específicos com base em critérios.

• Popular dropdowns ou listagens em telas de gestão de dispositivos.

• Obter dados para análise, auditoria ou verificação de configuração dos grupos.

Obter grupo de dispositivos por filtro

get

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta

PageSizeinteger · int32ObrigatórioDefault: 10

PageNumberinteger · int32ObrigatórioDefault: 1

EnabledbooleanOpcionalDefault: true

SortOrderstringOpcionalDefault: asc

SortFieldstringObrigatórioDefault: id

ValuestringOpcional

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

get

/api/v1/deviceGroups

HTTPcURLJavaScriptPython

GET /api/v1/deviceGroups?PageSize=10&PageNumber=1&SortField=id HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "data": [
      {
        "id": 1,
        "isEnabled": true,
        "groupCode": 1,
        "groupDescription": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

2. Cria novo grupo de dispositivos

Descrição:

Esse endpoint permite criar um novo grupo de dispositivos no sistema. Um grupo pode representar um conjunto de dispositivos físicos (como portas, catracas ou sensores) que compartilham uma lógica comum de controle de acesso.

• POST /api/v1/deviceGroups

Quando Usar:

• Registrar um novo agrupamento de dispositivos para facilitar a administração e as regras de acionamento.

• Organizar dispositivos por setores, andares ou finalidades (ex: Grupo de Emergência, Grupo Administrativo).

• Definir permissões ou comportamentos em conjunto para múltiplos dispositivos.

Cria novo grupo de dispositivo

post

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

groupCodeinteger · int32Opcional

groupDescriptionstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/deviceGroups

HTTPcURLJavaScriptPython

POST /api/v1/deviceGroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "groupCode": 1,
  "groupDescription": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "groupCode": 1,
    "groupDescription": "text"
  }
}

3. Obter grupo de dispositivo por id

Descrição:

Esse endpoint permite consultar os detalhes de um grupo de dispositivos específico, utilizando seu identificador único (id).

• GET /api/v1/deviceGroups/{id}

Quando Usar:

• Recuperar informações detalhadas de um grupo de dispositivos previamente criado.

• Obter dados para edição ou visualização em telas administrativas.

Obter grupo de dispositivo por id

get

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

get

/api/v1/deviceGroups/{id}

HTTPcURLJavaScriptPython

GET /api/v1/deviceGroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "groupCode": 1,
    "groupDescription": "text"
  }
}

4. Atualiza grupo de dispositivo por id

Descrição:

Atualiza os dados de um grupo de dispositivos já existente, identificando-o pelo seu id

• PUT /api/v1/deviceGroups/{id}

Quando Usar:

• Editar informações de um grupo de dispositivos.

• Manter atualizado o cadastro de agrupamentos de dispositivos conforme mudanças operacionais.

Atualiza grupo de dispositivo

put

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

idinteger · int64Opcional

groupCodeinteger · int32Opcional

groupDescriptionstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/deviceGroups/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/deviceGroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "id": 1,
  "groupCode": 1,
  "groupDescription": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "groupCode": 1,
    "groupDescription": "text"
  }
}

5. Desabilita grupo de dispositivo por id

Descrição:

Desabilita um grupo de dispositivos, tornando-o inativo no sistema.

• DELETE /api/v1/deviceGroups/{id}

Quando Usar:

• Desativar temporária ou permanentemente um grupo de dispositivos.

• Impedir o uso de dispositivos vinculados ao grupo sem excluí-los do sistema.

Desabilita grupo de dispositivo

delete

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

400

Bad Request

application/json

delete

/api/v1/deviceGroups/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/deviceGroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": true
}

6. Habilita grupo de dispositivo

Descrição:

Habilita novamente um grupo de dispositivos previamente desabilitado.

• PUT /api/v1/deviceGroups/{id}/enablements

Quando Usar:

• Reativar um grupo de dispositivos, liberando novamente seu uso.

• Restaurar o funcionamento de dispositivos agrupados após manutenção ou desativação temporária.

Habilita grupo de dispositivo

put

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

400

Bad Request

application/json

put

/api/v1/deviceGroups/{id}/enablements

HTTPcURLJavaScriptPython

PUT /api/v1/deviceGroups/{id}/enablements HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": true
}