Associação com Rotas

1. Obter rotas associadas ao dispositivo acionador

Descrição:

Retorna as rotas associadas ao dispositivo acionador.

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

Quando Usar:

• Para consultar quais rotas esse acionador pode ativar.

Obter rotas associados ao dispositivo acionador

get

Obter rotas 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}/routes

HTTPcURLJavaScriptPython

GET /api/v1/triggerDevices/{idTrigger}/routes?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. Associar uma rota ao dispositivo acionador

Descrição:

Associa uma ou mais rotas ao dispositivo acionador.

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

Quando Usar:

• Para definir o fluxo lógico de liberação ao acionar o equipamento.

Associar uma rota existente ao dispositivo acionador

post

Para obter as rotas existentes utilize o GET/api/v1/routes, caso seja necessário criar uma nova rota utilize o POST/api/v1/routes.

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

routeIdinteger · int64Opcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/triggerDevices/{idTrigger}/routes

HTTPcURLJavaScriptPython

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

{
  "routeId": 1
}

application/jsontext/jsonapplication/*+json

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

3. Remove todas as rotas do dispositivo acionador

Descrição:

Remove todas as rotas associadas ao acionador.

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

Quando Usar:

• Para desassociar o acionador de todos os fluxos previamente definidos.

Remover todas as rotas do dispositivo acionador

delete

Remover todas as rotas 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}/routes

HTTPcURLJavaScriptPython

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

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

4. Remove rota do dispositivo acionador

Descrição:

Remove uma rota específica do acionador.

• DELETE /api/v1/triggerDevices/{idTrigger}/routes/{idRoute}

Quando Usar:

• Para modificar ou restringir acessos liberados por esse dispositivo.

Remover rota do dispositivo acionador

delete

Remover rota 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

idRouteinteger · 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}/routes/{idRoute}

HTTPcURLJavaScriptPython

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

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