Associação com Grupos de Dispositivos

1. Obter grupos associados ao dispositivo acionador

Descrição:

Retorna os grupos de dispositivos associados ao dispositivo acionador.

• GET /api/v1/triggerDevices/{idTrigger}/deviceGroups

Quando Usar:

• Para verificar quais dispositivos reagem a este acionador.

• Em contextos de auditoria ou configuração.

Obter grupos associados ao dispositivo acionador

get

Obter grupos associados ao dispositivo acionador

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

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/triggerDevices/{idTrigger}/deviceGroups

HTTPcURLJavaScriptPython

GET /api/v1/triggerDevices/{idTrigger}/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,
        "triggerDeviceId": 1,
        "deviceGroupId": 1
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

2. Cria um grupo ao dispositivo acionador

Descrição:

Associa um ou mais grupos de dispositivos ao dispositivo acionador.

• POST /api/v1/triggerDevices/{idTrigger}/deviceGroups

Quando Usar:

• Para definir quais dispositivos serão acionados quando esse equipamento for ativado.

Associar um grupo existente ao dispositivo acionador

post

Para obter os grupos existentes utilize o GET/api/v1/deviceGroups, caso seja necessário criar um novo grupo utilize o POST/api/v1/deviceGroups.

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

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

deviceGroupIdinteger · int64Opcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/triggerDevices/{idTrigger}/deviceGroups

HTTPcURLJavaScriptPython

POST /api/v1/triggerDevices/{idTrigger}/deviceGroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "deviceGroupId": 1
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "triggerDeviceId": 1,
    "deviceGroupId": 1
  }
}

3. Remove todos os grupos do dispositivo acionador

Descrição:

Remove todos os grupos de dispositivos associados ao acionador.

• DELETE /api/v1/triggerDevices/{idTrigger}/deviceGroups

Quando Usar:

• Para redefinir completamente as associações do acionador.

Remover todos os grupos do dispositivo acionador

delete

Remover todos os grupos do dispositivo acionador

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

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/triggerDevices/{idTrigger}/deviceGroups

HTTPcURLJavaScriptPython

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

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

4. Remove grupo do dispositivo acionador

Descrição:

Remove um único grupo de dispositivos do acionador.

• DELETE /api/v1/triggerDevices/{idTrigger}/deviceGroups/{idDeviceGroup}

Quando Usar:

• Para ajustes pontuais nas permissões de acionamento.

Remover grupo do dispositivo acionador

delete

Remover grupo do dispositivo acionador

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

idDeviceGroupinteger · 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/triggerDevices/{idTrigger}/deviceGroups/{idDeviceGroup}

HTTPcURLJavaScriptPython

DELETE /api/v1/triggerDevices/{idTrigger}/deviceGroups/{idDeviceGroup} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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