{"info":{"_postman_id":"70f1eeef-7a37-41db-b0ef-cc1fec843fd8","name":"Documentação da API do Portal de Telemetria (11/2025)","description":"

Esta documentação descreve a utilização e exemplifica o uso dos endpoints básicos da API REST do Portal de Telemetria.

Estes são responsáveis por interagir com as diversas entidades do Portal, como prover acesso aos registros de Histórico de Dados e Alarmes, valores dos Dados coletados pelo Portal, informações de Conectores, Dispositivos, Dados e Alarmes, além de outras interações diversas.

Para maiores informações sobre os recursos do Portal de Telemetria, acesse o Manual do Usuário.

Recomendamos que antes de utilizar essa documentação, seja feita a leitura e compressão dos conceitos básicos do Portal de Telemetria

Em caso de dúvidas, entre em contato conosco através dos nossos canais de suporte.

Configuração da URL Base da API

O Portal de Telemetria é acessado através de uma URL que inicia com o subdomínio \"app\". Por exemplo, o Portal de Telemetria da HI está disponível em:

https://app.telemetria.hitecnologia.com.br/

Para acessar a API e realizar requisições aos endpoints documentados, substitua o subdomínio \"app\" por \"api\":

https://api.telemetria.hitecnologia.com.br/

Clientes White Label

Para implementações White Label, utilize a mesma lógica de substituição do subdomínio. Se seu Portal de Telemetria está hospedado em:

https://app.nomedaempresa.com.br/

A URL base da API correspondente será:

https://api.nomedaempresa.com.br/

\n
Importante: Certifique-se de utilizar a URL específica da sua instalação para todas as chamadas à API.
\n

Métodos de Autenticação

Na API do Portal de Telemetria existem dois métodos de autenticação para utilização dos endpoints:

Autenticação Básica

O primeiro método é conhecido como Basic Authentication, ou Autenticação Básica, sendo este o método de autenticação mais comum do protocolo HTTP.

Neste método, deve ser incluído no cabeçalho(header) de cada requisição para a API, a constante Authorization: Basic seguida pelas informações do e-mail e senha do usuário de autenticação(do Portal) no formato e-mail:senha e codificados em Base 64(a senha do usuário já deve estar codificada em Base 64 também).

Exemplo:

teste@teste.com.br:teste123 codificado em Base 64 = dGVzdGVAdGVzdGUuY29tLmJyOnRlc3RlMTIz

Portanto, o conteúdo final a ser utilizado no cabeçalho da requisição seria:

\n
Authorization: Basic dGVzdGVAdGVzdGUuY29tLmJyOnRlc3RlMTIz
\n

JSON Web Token (JWT)

O segundo método é gerando um JSON Web Token (JWT), que é reutilizável. Neste formato é passado no corpo da requisição do endpoint de login em formato JSON os campos \"email\" e \"password\" (sendo a senha já em codificada em Base 64) para se obter um token autenticado e válido. A URL para realizar esta requisição de POST e obter as informações desejadas é a seguinte:

https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login/

Na resposta dessa requisição, serão retornados os campos token, expiration_at, refresh_expiration_at, além de outros anexos. O token deve ser passado em cada requisição através de um cabeçalho(header) específico conforme exemplo abaixo:

\n
Authorization: Bearer (conteúdo do token)
\n

É necessário se atentar à validade do token para sempre mantê-lo válido através do endpoint de atualização de token:

https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login_refresh/

Para mais informações de como usar o login com token, acesse a Gerência de Usuários e Controle de Acesso.

Restrições e Limitações da API

Para manter a integridade da API do Portal de Telemetria, algumas restrições e limitações são impostas na sua utilização:

Número de Requisições

Todos os endpoints da API possuem um limite de requisições (throttling) em sua utilização. Estes limites se diferenciam para requisições em endpoints que lidam com registros históricos e os demais endpoints da API.

Além disso, as requisições são contabilizadas em duas janelas de tempo, sendo uma por minuto e outra no período de 24 horas.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tipo de Requisição	Limitação
Endpoints de Histórico	Máximo de 1 requisição por minuto ou 288 por dia (em média, 1 requisição a cada 5 minutos)
Endpoints de Comandos (Escrita e Reconhecimento de Alarme)	Máximo de 6 requisição por minuto ou 1.440 por dia (em média, 1 requisição por minuto)
Demais endpoints	Máximo de 2 requisições por minuto ou 1.440 por dia (em média, 1 requisição por minuto)

Caso ultrapasse o limite do número de requisições, será retornado um erro HTTP de código 429.

É importante que ao receber o primeiro retorno HTTP 429, a sua integração aguarde uma nova janela de requisições para não ocorrer no mesmo erro.

Número de Registros

Para os endpoints de histórico, existe um limite do número de registros que podem ser retornados em uma única requisição de acordo com o tipo de histórico:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tipo de Histórico	Limitação
Histórico de Dados	Até 90 mil registros
Histórico de Alarmes	Até 30 mil registros
Histórico de Eventos	Até 10 mil registros

Neste caso, pode-se utilizar a paginação da API para se trabalhar com um conjunto máximo de registros definidos ou caso seja retornado exatamente um número de registros igual ao limite, deve-se considerar utilizar filtros mais restritos ou realizar outras requisições.

Período de Consulta

Para os endpoints de histórico, existe um limite do período de registros que podem ser consultados. Neste caso, os endpoints de histórico utilizam os seguintes períodos máximos:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tipo de Histórico	Limitação
Histórico de Dados	Até 30 dias
Histórico de Alarmes	Até 30 dias
Histórico de Eventos	Até 7 dias

Se não for especificado um período de consulta para os endpoints de histórico, automaticamente a API irá considerar a consulta pelas últimas 24 horas de registros.

Paginação

Em nossos endpoints de listagem, podem ser utilizados alguns parâmetros na requisição que aplicam uma paginação nos resultados retornados pela API e permitem utilizá-la de maneira mais eficiente:

Número de páginas:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Descrição
page_size	Valor inteiro com o número máximo de registros que devem ser retornados na coleção(tamanho da página).
page	Valor inteiro com o número da página a serem retornados na coleção. Deve ser utilizado em conjunto com page.

Exemplo de requisição para o endpoint de Histórico de Dados(documentado a seguir):

https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?data_id=999&page=2&page_size=50

Exemplo de resposta(simplificado):

{\n    \"count\": 100,\n    \"previous_page\": null,\n    \"previous_page_number\": null,\n    \"next_page\": \"https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?data_id=999&page=2&page_size=50\",\n    \"next_page_number\": 2,\n    \"results\": [\n        {\n            ...\n        }\n    ]\n}\n\n

Blocos de registros:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Descrição
limit	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
offset	Valor inteiro com o deslocamento de registros a serem retornados na coleção. Deve ser utilizado em conjunto com limit.

Exemplo de requisição para o endpoint do Histórico de Dados(documentado a seguir):

https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?data_id=999&offset=0&limit=50

Exemplo de resposta(simplificado):

{\n    \"count\": 100,\n    \"previous_page\": null,\n    \"previous_page_offset\": null,\n    \"next_page\": \"https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?data_id=999&offset=0&limit=50\",\n    \"next_page_offset\": 50,\n    \"results\": [\n        {\n            ...\n        }\n    ]\n}\n\n

Obtendo o ID(identificador) e referência dos Recursos na API

Normalmente, nos endpoints da API, deve-se utilizar o ID(identificador) ou referencia do(s) recurso(s) como Conectores, Dispositivos, Dados e Alarmes. que se deseja acessar, filtrar, etc.

O identificador de um recurso é um número inteiro e pode ser obtido diretamente na URL apresentada na página de cadastro do recurso desejado.

Vamos há alguns exemplos:

Conector de ID = 1

https://app.telemetria.com.br/dashboard/edit/connector/1#edit

Dispositivo de ID = 15

https://app.telemetria.com.br/dashboard/edit/connector/1/device/15#edit

Dado de ID = 250

https://app.telemetria.com.br/dashboard/edit/connector/1/device/15/data/250#edit

Alarme de ID = 1500

https://app.telemetria.com.br/dashboard/edit/connector/1/device/15/data/250/alarm/1500#edit

Já a referência de um recurso é um hash de 8 caracteres que o identifica unicamente no contexto de um Conector(no caso de Dispositivos, Dados e Alarmes) e no contexto de um Contrato(no caso de Conectores).

Exemplo: 8a92fd7f

Na API, esta referência é encontrada em um atributo chamado reference_id presente no objeto JSON de representação de cada recurso.

A opção por utilizar o reference_id ao invés do ID dos recursos é extremamente útil principalmente no cenário em que são utilizados Conectores de Instância de Modelo.

Neste cenário, o reference_id é igual entre os Dispositivos, Dados e Alarmes do Conector de Modelo e seus Conectores de Instância, o que viabiliza a reutilização do mesmo código para tratar Conectores de Instância diferentes.

Porém, é importante observar que, caso se opte por utilizar o reference_id para obter os recursos de um Conector de Instância de Modelo, deve-se utilizar nos filtros ou payloads dos endpoints o ID desse Conector ou o seu próprio reference_id para que a API atue exatamente nos recursos desejados.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20304836","collectionId":"70f1eeef-7a37-41db-b0ef-cc1fec843fd8","publishedId":"2s93sc4CAy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0072C7"},"publishDate":"2023-06-13T14:06:30.000Z"},"item":[{"name":"Históricos(Dados, Alarmes e Eventos)","item":[{"name":"Histórico de Valores de Dados","event":[{"listen":"test","script":{"id":"98536164-5290-448e-a0cc-158a714282fa","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r",""],"type":"text/javascript"}}],"id":"632e5792-63c0-4345-9e0d-6321f8924720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"email@email.com"},{"key":"password","value":"(senhaembase64)"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?contract_id=(contract_id)&data_ids=9998,9999&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00","description":"

Este endpoint é o responsável por obter os registros no Histórico de Dados conforme os valores coletados pelo Portal para os mesmos(para os Dados que possuem o histórico habilitado em sua configuração) e também considerando os filtros informados no endpoint.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
data_id	Inteiro	Identificador do Dado (ID) no Portal. Este ID é único e distinto para cada Dado.
date_time	Data/Hora	Data/hora (no formato ISO 8601) do registro.
value	String	Valor associado ao Dado do registro.

Ordenação

Por padrão, a API retorna os registros de histórico ordenados de maneira decrescente em relação a data/hora(date_time) dos registros, ou seja, do registro mais recente para o mais antigo.

É possível utilizar um parâmetro na URL para alterar este comportamento chamado ordering e passando o atributo date_time para que então os registros sejam retornados de maneira ascendente(do registro mais antigo para o mais novo):

https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?data_id=(data_id)&start=2023-02-03T00:00:00+00:00&end=2023-05-03T23:59:59+00:00&ordering=date_time

\n","urlObject":{"path":["data_history",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID da Área de Processo

\n","type":"text/plain"},"key":"process_area_id","value":"(process_area_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"disabled":true,"description":{"content":"

ID do Dado

\n","type":"text/plain"},"key":"data_id","value":"(data_id)"},{"description":{"content":"

IDs dos Dados separados por vírgula. Ex: data_ids=9998,9999

\n","type":"text/plain"},"key":"data_ids","value":"9998,9999"},{"description":{"content":"

Data/hora Inicial do período a ser filtrado

\n","type":"text/plain"},"key":"start","value":"2023-03-01T00:00:00+00:00"},{"description":{"content":"

Data/hora Final do período a ser filtrado

\n","type":"text/plain"},"key":"end","value":"2023-03-01T23:59:59+00:00"}],"variable":[]}},"response":[{"id":"87242cae-1ec2-434c-a98e-2b5431c156e3","name":"Histórico de Valores de Dados","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic dXXXdDpANTXXXHJk","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/data_history/?contract_id=10&data_ids=9998,9999&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00","protocol":"https","host":["api","telemetria","hitecnologia","com","br"],"path":["rest","v1","data_history",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"process_area_id","value":"9","description":"ID da Área de Processo","disabled":true},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"data_id","value":"9999","description":"ID do Dado","disabled":true},{"key":"data_ids","value":"9998,9999","description":"IDs dos Dados separados por vírgula. Ex: data_ids=9998,9999"},{"key":"start","value":"2023-03-01T00:00:00+00:00","description":"Data/hora Inicial do período a ser filtrado"},{"key":"end","value":"2023-03-01T23:59:59+00:00","description":"Data/hora Final do período a ser filtrado"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 17:54:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"data_id\": 9998,\n \"date_time\": \"2023-03-01T12:15:51.277695+00:00\",\n \"value\": \"150.00000\"\n },\n {\n \"data_id\": 9999,\n \"date_time\": \"2023-03-01T12:15:51.277695+00:00\",\n \"value\": \"30.50000\"\n },\n {\n \"data_id\": 9999,\n \"date_time\": \"2023-03-01T12:20:21.277695+00:00\",\n \"value\": \"31.75000\"\n },\n ...\n]"}],"_postman_id":"632e5792-63c0-4345-9e0d-6321f8924720"},{"name":"Histórico de Alarmes","event":[{"listen":"test","script":{"id":"3c5862af-152e-4634-88d9-02fdc0c15c53","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r",""],"type":"text/javascript"}}],"id":"ef790d20-988c-4c4c-b84d-e96336d677e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"email@email.com"},{"key":"password","value":"(senhaembase64)"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms_history/?contract_id=(contract_id)&alarm_ids=99998,99999&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00","description":"

Este endpoint é o responsável por obter os registros de eventos de Alarmes identificados pelo Portal conforme os valores coletados para os Dados associados aos Alarmes.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
alarm > id	Inteiro	Identificador do Alarme (ID) no Portal. Este ID é único e distinto para cada Alarme.
alarm > name	String	Nome do Alarme (conforme cadastro no Portal).
alarm_value	String	Valor do Dado associado ao Alarme no momento do registro do evento.
date_time_event	Data/Hora	Data/hora (no formato ISO 8601) de ocorrência do evento do Alarme (quando alarmou, saiu da condição de alarme ou quando foi reconhecido pelo usuário).
system_event_id	Inteiro	Identificador do evento no Portal. No caso do histórico de alarme, será sempre o valor 7 (indicando que é um evento associado ao recurso de Alarme).
system_sub_event_id	Inteiro	Identificador do sub-evento no Portal. No caso do histórico de alarme, poderá indicar um dos seguintes valores: - 12 (condição de alarme atingida) - 13 (condição de alarme normalizada) - 23 (Reconhecimento de Alarme).
user_email	String	Indica o endereço de e-mail do usuário caso se trate de um registro referente ao reconhecimento de Alarme.

Ordenação

Por padrão, a API retorna os registros de histórico ordenados de maneira decrescente em relação a data/hora(date_time_event) dos registros, ou seja, do registro mais recente para o mais antigo.

É possível utilizar um parâmetro na URL para alterar este comportamento chamado ordering e passando o atributo date_time_event para que então os registros sejam retornados de maneira ascendente(do registro mais antigo para o mais novo):

https://api.telemetria.hitecnologia.com.br/rest/v1/alarms_history/?alarm_ids=(alarm_id)&start=2023-03-01T00:00:00+00:00&end=2023-05-03T23:59:59+00:00&ordering=date_time_event

\n","urlObject":{"path":["alarms_history",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID da Área de Processo

\n","type":"text/plain"},"key":"process_area_id","value":"(process_area_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"disabled":true,"description":{"content":"

ID do Dado

\n","type":"text/plain"},"key":"data_id","value":"(data_id)"},{"disabled":true,"description":{"content":"

ID do Alarme

\n","type":"text/plain"},"key":"alarm_id","value":"(alarm_id)"},{"description":{"content":"

IDs dos Alarmes separados por vírgula. Ex: alarm_ids=99998,99999

\n","type":"text/plain"},"key":"alarm_ids","value":"99998,99999"},{"description":{"content":"

Data/hora Inicial do período a ser filtrado

\n","type":"text/plain"},"key":"start","value":"2023-03-01T00:00:00+00:00"},{"description":{"content":"

Data/hora Final do período a ser filtrado

\n","type":"text/plain"},"key":"end","value":"2023-03-01T23:59:59+00:00"}],"variable":[]}},"response":[{"id":"1867a53c-8983-46c7-9cee-7aae1f56b26f","name":"Histórico de Alarmes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic dXXXdDpANTXXXHJk ","type":"text"},{"key":"Content-Length","value":"application/json","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms_history/?contract_id=10&alarm_ids=99998,99999&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["alarms_history",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"process_area_id","value":"9","description":"ID da Área de Processo","disabled":true},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"data_id","value":"9999","description":"ID do Dado","disabled":true},{"key":"alarm_id","value":"99999","description":"ID do Alarme","disabled":true},{"key":"alarm_ids","value":"99998,99999","description":"IDs dos Alarmes separados por vírgula. Ex: alarm_ids=99998,99999"},{"key":"start","value":"2023-03-01T00:00:00+00:00","description":"Data/hora Inicial do período a ser filtrado"},{"key":"end","value":"2023-03-01T23:59:59+00:00","description":"Data/hora Final do período a ser filtrado"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 18:06:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"date_time_event\": \"2023-03-01T18:05:28.272977+00:00\",\n \"alarm_value\": \"1\",\n \"system_event_id\": 7,\n \"system_sub_event_id\": 12,\n \"alarm\": {\n \"id\": 100,\n \"name\": \"ALARME DE TEMPERATURA ALTA\"\n },\n \"user_email\": null\n },\n ...\n]"}],"_postman_id":"ef790d20-988c-4c4c-b84d-e96336d677e7"},{"name":"Histórico de Eventos","event":[{"listen":"test","script":{"id":"3c5862af-152e-4634-88d9-02fdc0c15c53","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"e4ba6aa1-2057-4880-aa0a-654c6b39a1b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"email@email.com"},{"key":"password","value":"(senhaembase64)"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/system_history/?contract_id=(contract_id)&connector_id=(connector_id)&system_event_id=(system_event_id)&system_sub_event_id=(system_sub_event_id)&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00","description":"

Este endpoint é o responsável por obter os registros do histórico de Eventos de Sistema do Portal, tais como:

Conexão e Desconexão dos Conectores;
Alterações em cadastros dos recursos;
Eventuais erros de leitura/aquisição de Dados;
Escrita em Dados;
Etc.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
date_time_event	Data/Hora	Data/hora (no formato ISO 8601) de ocorrência do evento.
message	String	Texto de identificação do evento.
details	String	Texto que detalha o evento caso pertinente.
system_event_id	Inteiro	Identificador do evento no Portal. Principais eventos: - 2: Acesso ao Portal de Telemetria(eventos de conexão/desconexão)
system_sub_event_id	Inteiro	Identificador do sub-evento no Portal associado ao evento. Principais sub-eventos associados ao evento \"Acesso ao Portal de Telemetria\": - 2: Conector online(conectado) - 3: Conector offline (desconectado)
connector > id	Inteiro	Identificador do Conector (ID) no Portal. Este ID é único e distinto para cada Conector.
connector > name	String	Nome do Conector(conforme cadastro no Portal).
data	JSON	Informações do Dado associado ao evento(caso pertinente)
user	JSON	Informações do Usuário associado ao evento(quando pertinente)

Ordenação

Por padrão, a API retorna os registros de histórico ordenados de maneira decrescente em relação a data/hora(date_time_event) dos registros, ou seja, do registro mais recente para o mais antigo.

https://api.telemetria.hitecnologia.com.br/rest/v1/system_history/?contract_id=(contract_id)&connector_id=(connector_id)&system_event_id=2&system_sub_event_id=2&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00&ordering=date_time_event

\n","urlObject":{"path":["system_history",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID da Área de Processo

\n","type":"text/plain"},"key":"process_area_id","value":"(process_area_id)"},{"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

IDs dos Conectores separados por vírgula. Ex: connector_ids=98,99

\n","type":"text/plain"},"key":"connector_ids","value":"98,99"},{"description":{"content":"

ID do evento a ser filtrado. Ex: 2 (evento de Acesso de Conectores ao Portal)

\n","type":"text/plain"},"key":"system_event_id","value":"(system_event_id)"},{"description":{"content":"

ID do sub-evento no Portal a ser filtrado. Ex: 3 (sub-evento de Desconexão do Conector do Portal)

\n","type":"text/plain"},"key":"system_sub_event_id","value":"(system_sub_event_id)"},{"description":{"content":"

Data/hora Inicial do período a ser filtrado

\n","type":"text/plain"},"key":"start","value":"2023-03-01T00:00:00+00:00"},{"description":{"content":"

Data/hora Final do período a ser filtrado

\n","type":"text/plain"},"key":"end","value":"2023-03-01T23:59:59+00:00"}],"variable":[]}},"response":[{"id":"54b85544-e9ee-454a-82ab-5fbf88ab1688","name":"Histórico de Eventos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic dXXXdDpANTXXXHJk ","type":"text"},{"key":"Content-Length","value":"application/json","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/system_history/?contract_id=10&connector_id=99&system_event_id=2&system_sub_event_id=2&start=2023-03-01T00:00:00+00:00&end=2023-03-01T23:59:59+00:00","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["system_history",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"process_area_id","value":"9","description":"ID da Área de Processo","disabled":true},{"key":"connector_id","value":"99","description":"ID do Conector"},{"key":"connector_ids","value":"98,99","description":"IDs dos Conectores separados por vírgula. Ex: connector_ids=98,99","disabled":true},{"key":"system_event_id","value":"2","description":"ID do evento no Portal a ser filtrado"},{"key":"system_sub_event_id","value":"2","description":"ID do sub-evento no Portal a ser filtrado"},{"key":"start","value":"2023-03-01T00:00:00+00:00","description":"Data/hora Inicial do período a ser filtrado"},{"key":"end","value":"2023-03-01T23:59:59+00:00","description":"Data/hora Final do período a ser filtrado"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 18:06:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1000000,\n \"date_time_event\": \"2023-03-01T10:15:12.167468+00:00\",\n \"message\": \"Conector online(conectado)\",\n \"details\": \"\",\n \"system_event_id\": 2,\n \"system_sub_event_id\": 2,\n \"connector\": {\n \"id\": 99,\n \"name\": \"Conector Teste\"\n },\n \"data\": null,\n \"user\": null\n },\n {\n \"id\": 1000001,\n \"date_time_event\": \"2023-03-10T21:14:30.204000+00:00\",\n \"message\": \"Conector offline(desconectado)\",\n \"details\": \"Eventos no dia: 1\",\n \"system_event_id\": 2,\n \"system_sub_event_id\": 3,\n \"connector\": {\n \"id\": 99,\n \"name\": \"Conector Teste\"\n },\n \"data\": null,\n \"user\": null\n },\n ...\n]"}],"_postman_id":"e4ba6aa1-2057-4880-aa0a-654c6b39a1b5"}],"id":"80ade89e-1969-42d5-9d18-4426f1508456","description":"

Uma das principais funcionalidades do Portal de Telemetria é a possibilidade de obter os registros de histórico dos valores de Dados em virtude das coletas realizadas pelo Portal nos equipamentos remotos. Com estes registros em mãos, pode-se realizar uma análise e tratamento mais personalizados.

É importante ressaltar que, as informações de data/hora fornecidas ou retornadas pela API do Portal consideram o padrão ISO 8601, onde é possível definir além da data/hora, o timezone referente a esta informação. Exemplo:

2023-03-01T08:00:00+00:00: Indica o dia 01 de Março de 2023 ás 08 horas da manha no timezone UTC;
2023-03-01T05:00:00-03:00: Indica o dia 01 de Março de 2023 ás 05 horas da manha no timezone America/Sao_Paulo.

No caso dos endpoints de histórico, caso não fornecido um timezone em específico no filtro de período dos registros, as informações de data/hora fornecidas e retornadas irão considerar o timezone em UTC. Caso contrário, o Portal irá considerar o timezone informado no período da consulta(e também irá retornar os eventuais registros encontrados considerando este timezone).

Abaixo estão listados os exemplos para os endpoints de obtenção dos registros do Histórico de Dados, Alarmes e Eventos de Sistema.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"050e09a4-23dc-4062-a44c-936e71770ab7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"27219dee-7d6a-45a4-8546-6dbd054645c0"}}],"_postman_id":"80ade89e-1969-42d5-9d18-4426f1508456"},{"name":"Comandos em Dados e Alarmes","item":[{"name":"Escrita de Valor em Dado (usando ID)","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r","pm.test(\"Response body exists and not contain errors\", function () {\r"," pm.response.to.not.be.error;\r"," pm.response.to.be.withBody;\r","});\r","\r","if (pm.response.json()) {\r"," pm.collectionVariables.set('command_data_write_id', pm.response.json().id)\r","}"],"type":"text/javascript","id":"3c4ef2e6-a044-449b-8fcb-24d30b90d11d"}}],"id":"b88e06ab-1171-448b-b781-261459d5f755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"parameters\": {\r\n \t\"data_configuration_id\": (data_id),\r\n \t\"writing_value\": 99.99\r\n }\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/","description":"

Este endpoint é responsável por enviar um comando de escrita em um determinado Dado.

Para Conectores que utilizam o protocolo MQTT, um comando de escrita significa que o valor informado será publicado no tópico associado ao Dado do comando.
A resposta da requisição neste caso, já indicará se a publicação foi realizada com sucesso ou não.

Já para Conectores que utilizam o protocolo MODBUS/SCP-HI, um comando de escrita significa que o valor informado será escrito na variável do equipamento remoto de acordo com o endereço configurado no Dado associado ao comando.

A resposta da requisição neste caso, indica apenas se o comando de escrita foi criado com sucesso ou não. O seu processamento, dependerá de alguns fatores, como por exemplo, o status de conexão do Conector com o Portal.

Por este motivo, é importante ou obter o ID do comando retornado e utilizar este ID no endpoint que verifica o status de execução do comando de escrita ou utilizar o endpoint de \"Listagem de Estado de Dados\" e filtrar pelo ID do Dado associado ao comando.

Conteúdo da requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
command_type_id	Inteiro	Identificador do comando solicitado. No caso da escrita em Dado, será sempre o valor 1 (indicando que é um evento associado ao recurso de escrita de valor de Dado).
parameters > data_configuration_id	Inteiro	Identificador do Dado (ID) no Portal. Este ID é único e distinto para cada Dado.
parameters > writing_value	Inteiro / Float / String	Valor que será escrito no Dado.

","urlObject":{"path":["commands",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"673e0dcf-375a-4398-8531-71769d2bdc69","name":"Escrita de Valor em Dado (usando ID)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"parameters\": {\r\n \t\"data_configuration_id\": 999,\r\n \t\"writing_value\": 99.99\r\n }\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 17:04:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"422"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9999,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 999,\n \"writing_value\": 99.99\n },\n \"user\": {\n \"id\": 99,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-03T17:04:59.610877+00:00\",\n \"processed_datetime\": null,\n \"command_state\": {\n \"id\": 1,\n \"name\": \"AGUARDANDO\"\n },\n \"command_result\": null,\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 999,\n \"alarm_id\": null,\n \"value\": \"99.99\"\n}"}],"_postman_id":"b88e06ab-1171-448b-b781-261459d5f755"},{"name":"Escrita de Valor em Dado (usando referência)","event":[{"listen":"test","script":{"id":"3c4ef2e6-a044-449b-8fcb-24d30b90d11d","exec":["pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r","pm.test(\"Response body exists and not contain errors\", function () {\r"," pm.response.to.not.be.error;\r"," pm.response.to.be.withBody;\r","});\r","\r","if (pm.response.json()) {\r"," pm.collectionVariables.set('command_data_write_id', pm.response.json().id)\r","}"],"type":"text/javascript"}}],"id":"a67183ed-489b-4831-a2b1-e96da9937ce6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"connector_reference_id\": \"8292fd7f\",\r\n \"device_reference_id\": \"8a92fd7f\",\r\n \"parameters\": {\r\n \t\"data_reference_id\": \"6079cb5g\",\r\n \t\"writing_value\": 99.99\r\n }\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/","description":"

Mesma funcionalidade do endpoint anterior, porém utilizando a referência ao invés do ID.

Conteúdo da requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
command_type_id	Inteiro	Identificador do comando solicitado. No caso da escrita em Dado, será sempre o valor 1 (indicando que é um evento associado ao recurso de escrita de valor de Dado).
connector_reference_id	String	Referência do Conector (hash) no Portal. Este hash é único e distinto para cada Conector.
device_reference_id	String	Referência do Dispositivo (hash) no Portal. Este hash é único e distinto para cada Dispositivo.
parameters > data_reference_id	String	Referência do Dado (hash) no Portal. Este hash é distinto dentro de cada Dispositivo.
parameters > writing_value	Inteiro / Float / String	Valor que será escrito no Dado.

","urlObject":{"path":["commands",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"9f33a529-1a39-4c25-9507-e7be29c30f9a","name":"Escrita de Valor em Dado (usando referência)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"connector_reference_id\": \"8292fd7f\",\r\n \"device_reference_id\": \"8a92fd7f\",\r\n \"parameters\": {\r\n \t\"data_reference_id\": \"6079cb5g\",\r\n \t\"writing_value\": 99.99\r\n }\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 17:04:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"422"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9999,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 999,\n \"data_reference_id\": \"6079cb5g\",\n \"writing_value\": 99.99\n },\n \"user\": {\n \"id\": 99,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-03T17:04:59.610877+00:00\",\n \"processed_datetime\": null,\n \"command_state\": {\n \"id\": 1,\n \"name\": \"AGUARDANDO\"\n },\n \"command_result\": null,\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 999,\n \"alarm_id\": null,\n \"value\": \"99.99\"\n}"}],"_postman_id":"a67183ed-489b-4831-a2b1-e96da9937ce6"},{"name":"Múltipla Escrita de Valores em Dados (usando ID)","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r","pm.test(\"Response body exists and not contain errors\", function () {\r"," pm.response.to.not.be.error;\r"," pm.response.to.be.withBody;\r","});"],"type":"text/javascript","id":"4ece4df0-56f3-4504-956c-191607c71330"}}],"id":"22ac8a89-4b60-494f-8667-6e120a588454","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"parameters\": [\r\n {\r\n \t\"data_configuration_id\": (data_id),\r\n \t\"writing_value\": 99.99\r\n },\r\n {\r\n \t\"data_configuration_id\": {{another_data_id}},\r\n \t\"writing_value\": 88.88\r\n }\r\n ]\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/","description":"

Este endpoint tem o objetivo de realizar múltiplos comandos de escrita de dados em uma mesma requisição. Para mais informações sobre escrita em dados, consulte o exemplo de endpoint anterior.

Conteúdo da requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
command_type_id	Inteiro	Identificador do comando solicitado. No caso da escrita em Dado, será sempre o valor 1 (indicando que é um evento associado ao recurso de escrita de valor de Dado).
parameters > lista > item da lista > data_configuration_id	Inteiro	Identificador do Dado (ID) no Portal. Este ID é único e distinto para cada Dado.
parameters > lista > item da lista > writing_value	Inteiro / Float / String	Valor que será escrito no Dado.

","urlObject":{"path":["commands",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"be29e90d-dac0-413c-b257-e4f9d2c73fa8","name":"Múltipla Escrita de Valores em Dados (usando ID)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"parameters\": [\r\n {\r\n \t\"data_configuration_id\": 999,\r\n \t\"writing_value\": 99.99\r\n },\r\n {\r\n \t\"data_configuration_id\": 888,\r\n \t\"writing_value\": 88.88\r\n }\r\n ]\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 17:04:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"422"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 9999,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 999,\n \"writing_value\": 99.99\n },\n \"user\": {\n \"id\": 99,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-03T17:04:59.610877+00:00\",\n \"processed_datetime\": null,\n \"command_state\": {\n \"id\": 1,\n \"name\": \"AGUARDANDO\"\n },\n \"command_result\": null,\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 999,\n \"alarm_id\": null,\n \"value\": \"99.99\"\n },\n {\n \"id\": 8888,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 888,\n \"writing_value\": 88.88\n },\n \"user\": {\n \"id\": 99,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-03T17:04:59.610877+00:00\",\n \"processed_datetime\": null,\n \"command_state\": {\n \"id\": 1,\n \"name\": \"AGUARDANDO\"\n },\n \"command_result\": null,\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 888,\n \"alarm_id\": null,\n \"value\": \"88.88\"\n }\n]"}],"_postman_id":"22ac8a89-4b60-494f-8667-6e120a588454"},{"name":"Múltipla Escrita de Valores em Dados (usando referência)","event":[{"listen":"test","script":{"id":"4ece4df0-56f3-4504-956c-191607c71330","exec":["pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r","pm.test(\"Response body exists and not contain errors\", function () {\r"," pm.response.to.not.be.error;\r"," pm.response.to.be.withBody;\r","});"],"type":"text/javascript"}}],"id":"976df358-3f19-4236-b302-f02c70dd0224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"connector_reference_id\": \"8292fd7f\",\r\n \"device_reference_id\": \"8a92fd7f\",\r\n \"parameters\": [\r\n {\r\n \t\"data_reference_id\": \"6079cb5g\",\r\n \t\"writing_value\": 99.99\r\n },\r\n {\r\n \t\"data_reference_id\": \"d21nk89e\",\r\n \t\"writing_value\": 99.99\r\n }\r\n ]\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/","description":"

Mesma funcionalidade do endpoint anterior, porém utilizando a referência ao invés do ID.

Conteúdo da requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
command_type_id	Inteiro	Identificador do comando solicitado. No caso da escrita em Dado, será sempre o valor 1 (indicando que é um evento associado ao recurso de escrita de valor de Dado).
connector_reference_id	String	Referência do Conector (hash) no Portal. Este hash é único e distinto para cada Conector.
device_reference_id	String	Referência do Dispositivo (hash) no Portal. Este hash é único e distinto para cada Dispositivo.
parameters > lista > item da lista > data_reference_id	String	Referência do Dado (hash) no Portal. Este hash é distinto dentro de cada Dispositivo.
parameters > lista > item da lista > writing_value	Inteiro / Float / String	Valor que será escrito no Dado.

","urlObject":{"path":["commands",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"6853d82b-3b58-45a7-8c02-4bcf41c57c74","name":"Múltipla Escrita de Valores em Dados (usando referência)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 1,\r\n \"connector_reference_id\": \"8292fd7f\",\r\n \"device_reference_id\": \"8a92fd7f\",\r\n \"parameters\": [\r\n {\r\n \t\"data_reference_id\": \"6079cb5g\",\r\n \t\"writing_value\": 99.99\r\n },\r\n {\r\n \"data_reference_id\": \"85ab126f\",\r\n \t\"writing_value\": 88.88\r\n }\r\n ]\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 May 2023 17:04:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"422"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 9999,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 999,\n \"data_reference_id\": \"6079cb5g\",\n \"writing_value\": 99.99\n },\n \"user\": {\n \"id\": 99,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-03T17:04:59.610877+00:00\",\n \"processed_datetime\": null,\n \"command_state\": {\n \"id\": 1,\n \"name\": \"AGUARDANDO\"\n },\n \"command_result\": null,\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 999,\n \"alarm_id\": null,\n \"value\": \"99.99\"\n },\n {\n \"id\": 8888,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 888,\n \"data_reference_id\": \"85ab126f\",\n \"writing_value\": 88.88\n },\n \"user\": {\n \"id\": 99,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-03T17:04:59.610877+00:00\",\n \"processed_datetime\": null,\n \"command_state\": {\n \"id\": 1,\n \"name\": \"AGUARDANDO\"\n },\n \"command_result\": null,\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 888,\n \"alarm_id\": null,\n \"value\": \"88.88\"\n }\n]"}],"_postman_id":"976df358-3f19-4236-b302-f02c70dd0224"},{"name":"Consultando o status de execução de um Comando de Escrita","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(201);\r","});"],"type":"text/javascript","id":"b1ba8593-a453-422c-a07d-2537c87df707"}}],"id":"5eb8e584-2209-424a-bf5b-ad89abe0584b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/(command_data_write_id)/","description":"

Este endpoint é responsável por informar o status de execução de um determinado comando de escrita em um Dado.

Uma outra forma de obter o status de execução de um ou mais comandos de escrita é utilizar o endpoint de \"Listagem de Estado de Dados\" e filtrar pelo(s) ID(s) do(s) Dado(s) associado(s) ao(s) comando(s).

Vale ressaltar aqui que, mesmo que um comando de escrita seja realizado com sucesso, não significa que o equipamento remoto assumirá de fato o valor da escrita.

Isso dependerá de como a variável que receberá o valor da escrita é tratado pelo equipamento remoto.

\n","urlObject":{"path":["commands","(command_data_write_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"b75730f2-7931-4aaa-a771-bdcd504cef71","name":"Consultando o status de execução de um Comando de Escrita","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/(command_data_write_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 04 May 2023 19:37:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"461"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 999999,\n \"command_type\": {\n \"id\": 1,\n \"name\": \"Escrita em Dado\"\n },\n \"parameters\": {\n \"data_configuration_id\": 999\n },\n \"user\": {\n \"id\": 999,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-04T18:51:10.850574+00:00\",\n \"processed_datetime\": \"2023-05-04T18:51:10.746217+00:00\",\n \"command_state\": {\n \"id\": 6,\n \"name\": \"PROCESSADO\"\n },\n \"command_result\": {\n \"id\": 7,\n \"name\": \"RC_SUCCESS\"\n },\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": 999,\n \"value\": \"99.99\"\n}"}],"_postman_id":"5eb8e584-2209-424a-bf5b-ad89abe0584b"},{"name":"Reconhecimento de Alarme","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r","pm.test(\"Response body exists and not contain errors\", function () {\r"," pm.response.to.not.be.error;\r"," pm.response.to.be.withBody;\r","});\r","\r","if (pm.response.json()) {\r"," pm.collectionVariables.set('command_data_write_id', pm.response.json().id)\r","}"],"type":"text/javascript","id":"72e3287a-8ab0-46cf-bc11-7e6d0b6d87e1"}}],"id":"abd5f15f-c82a-4e2f-853b-8f8cce42a535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 2,\r\n \"parameters\": {\r\n \t\"alarm_configuration_id\": (alarm_id)\r\n }\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/","description":"

Este endpoint é responsável por enviar um comando de reconhecimento de um Alarme.

Alguns Alarmes podem ser configurados para que seja necessário que um usuário reconheça o evento de ocorrência do alarme. Isso significa que o Alarme só estará apto a voltar ao estado de \"Normal\" caso o usuário o reconheça(mesmo que o Alarme já não esteja mais ativo).

Conteúdo da requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
command_type_id	Inteiro	Identificador do comando solicitado. No caso do reconhecimento de alarme, será sempre o valor 2 (indicando que é um evento associado ao recurso de reconhecimento de Alarme).
parameters > alarm_configuration_id	Inteiro	Identificador do Alarme (ID) no Portal. Este ID é único e distinto para cada Alarme.

","urlObject":{"path":["commands",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"c8c26a06-d108-41e2-b6df-ef03a2879085","name":"Reconhecimento de Alarme","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"command_type_id\": 2,\r\n \"parameters\": {\r\n \t\"alarm_configuration_id\": 99999\r\n }\r\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/commands/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 04 May 2023 18:51:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"461"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9999,\n \"command_type\": {\n \"id\": 2,\n \"name\": \"Reconhecimento de Alarme\"\n },\n \"parameters\": {\n \"alarm_configuration_id\": 99999\n },\n \"user\": {\n \"id\": 999,\n \"email\": \"email@email.com\"\n },\n \"created_datetime\": \"2023-05-04T18:51:10.850574+00:00\",\n \"processed_datetime\": \"2023-05-04T18:51:10.746217+00:00\",\n \"command_state\": {\n \"id\": 6,\n \"name\": \"PROCESSADO\"\n },\n \"command_result\": {\n \"id\": 7,\n \"name\": \"RC_SUCCESS\"\n },\n \"portal_data\": null,\n \"user_data\": null,\n \"data_id\": null,\n \"alarm_id\": 99999,\n \"value\": null\n}"}],"_postman_id":"abd5f15f-c82a-4e2f-853b-8f8cce42a535"}],"id":"f107cfaf-dbc3-46a6-a461-49039424dd48","description":"

Atualmente, o usuário pode realizar alguns comandos através da API em seus Conectores cadastrados no Portal, como por exemplo, realizar a escrita de um valor em um Dado(que será impactado no equipamento remoto) ou reconhecer o evento de ocorrência de um alarme.

\n","_postman_id":"f107cfaf-dbc3-46a6-a461-49039424dd48"},{"name":"Conectores","item":[{"name":"Listagem de Conectores","event":[{"listen":"test","script":{"id":"cb8a8c5f-3d0d-4ae2-bb46-6e4469d99da0","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('connector_id'));"],"type":"text/javascript"}}],"id":"5d97aa21-1b09-498d-8421-51b83747209a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/connectors/?contract_id=(contract_id)&ids=98,99","description":"

Este endpoint é responsável por obter uma lista de informações de Conectores conforme os filtros definidos na requisição. Para cada Conector, é retornado um JSON com suas informações de configuração, estado, etc.

\n","urlObject":{"path":["connectors",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID da Área de Processo

\n","type":"text/plain"},"key":"process_area_id","value":"(process_area_id)"},{"description":{"content":"

IDs dos Conectores separados por vírgula. Ex: ids=98,99

\n","type":"text/plain"},"key":"ids","value":"98,99"},{"disabled":true,"description":{"content":"

Referências dos Conectores separados por vírgula. Ex: reference_ids=8292fd7f,b71hf53u

\n","type":"text/plain"},"key":"reference_ids","value":"8292fd7f,b71hf53u"},{"disabled":true,"description":{"content":"

Nome do Conector

\n","type":"text/plain"},"key":"name","value":"(connector_name)"},{"disabled":true,"description":{"content":"

Nome de Área de Processo

\n","type":"text/plain"},"key":"process_area_name","value":"(process_area_name)"},{"disabled":true,"description":{"content":"

Filtra por Conectores com o estado de habilitado ou não

\n","type":"text/plain"},"key":"enabled","value":"false"},{"disabled":true,"description":{"content":"

Filtra apenas por Conectores de Modelo ou não

\n","type":"text/plain"},"key":"base_model","value":"false"},{"disabled":true,"description":{"content":"

Filtra o recurso por marcadores que foram definidos no seu cadastro. Múltiplos valores devem ser separador por vírgula.

\n","type":"text/plain"},"key":"tags","value":"(nomeDoMarcador1),(nomeDoMarcador2)"}],"variable":[]}},"response":[{"id":"e8311dec-83f6-4790-9bed-298915dd46ac","name":"Listagem de Conectores","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/connectors/?contract_id=10&ids=98,99","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["connectors",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"process_area_id","value":"9","description":"ID da Área de Processo","disabled":true},{"key":"ids","value":"98,99","description":"IDs dos Conectores separados por vírgula. Ex: ids=98,99"},{"key":"name","value":"CONECTOR DE DEMONSTRAÇÃO","description":"Nome do Conector","disabled":true},{"key":"process_area_name","value":"Área de Processo Padrão","description":"Nome da Área de Processo","disabled":true},{"key":"base_model","value":"false","description":"Filtra apenas por Conectores de Modelo ou não","disabled":true},{"key":"enabled","value":"false","description":"Filtra apenas por Conectores de Modelo ou não","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 18:21:47 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"1188"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99,\n \"etag\": \"\\\"eeXXX1ba8ba1d5972ea3cbc5f01f42df\\\"\",\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"street\": \"Rua Armando Sales de Oliveira\",\n \"state\": \"São Paulo\",\n \"district\": \"\",\n \"extrainfo\": \"\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"number\": \"455\",\n \"latlng\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 3,\n \"name\": \"MODBUS TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": true,\n \"optimizes_frames\": true,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"user_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 30,\n \"screen_id\": null,\n \"reference_id\": \"7af6d288\",\n \"mqtt_topic_prefix\": \"0d315bb5\",\n \"mqtt_disconnect_time\": 0,\n \"mqtt_payload_format_id\": 1\n },\n ...\n]"}],"_postman_id":"5d97aa21-1b09-498d-8421-51b83747209a"},{"name":"Listagem de Estado de Conectores","event":[{"listen":"test","script":{"id":"a81ca843-5e43-41ea-8bcd-5ba5e08c1439","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('connector_id'));"],"type":"text/javascript"}}],"id":"5e8d449e-f503-4541-a4fa-554f0764426d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/connectors/?contract_id=(contract_id)&ids=98,99&only_state=true","description":"

Este endpoint é responsável por obter informações de estado de um Conector, como por exemplo, o status de conexão com o Portal ou se o mesmo possui um alarme ativo.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome do Campo	Tipo de Valor	Descrição
id	Inteiro	Identificador do Conector(ID) no Portal. Este ID é único e distinto para cada Conector.
enabled	Booleano	Indica se o Conector esta habilitado ou não no Portal
has_active_alarm	Booleano	Indica se o Conector possui algum Alarme ativo
is_connected	Booleano	Indica se o Conector está conectado(online) com o Portal ou não

","urlObject":{"path":["connectors",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"description":{"content":"

IDs dos Conectores separados por vírgula. Ex: ids=98,99

\n","type":"text/plain"},"key":"ids","value":"98,99"},{"description":{"content":"

Somente informações de Estado do Conector

\n","type":"text/plain"},"key":"only_state","value":"true"},{"disabled":true,"description":{"content":"

Referências dos Conectores separados por vírgula. Ex: reference_ids=8292fd7f,b71hf53u

\n","type":"text/plain"},"key":"reference_ids","value":"8292fd7f,b71hf53u"}],"variable":[]}},"response":[{"id":"4e4edb08-9a89-4754-b965-d9baa08189c6","name":"Listagem de Estado de Conectores","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/connectors/?contract_id=10&ids=98,99&only_state=true","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["connectors",""],"query":[{"key":"contract_id","value":"10"},{"key":"ids","value":"98,99"},{"key":"only_state","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 18:22:53 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"75"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99,\n \"enabled\": true,\n \"is_connected\": false,\n \"has_active_alarms\": false\n },\n ...\n]"}],"_postman_id":"5e8d449e-f503-4541-a4fa-554f0764426d"},{"name":"Detalhes de um Conector","event":[{"listen":"test","script":{"exec":["pm.collectionVariables.set('connector_id', pm.response.json().id)\r","pm.collectionVariables.set('connector_etag', pm.response.json().etag)"],"type":"text/javascript","id":"8ace82a3-0911-482b-b3af-47374fa0c37f"}}],"id":"4d92138a-4712-4660-83b2-de440e250d4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/connectors/(connector_id)/","description":"

Este endpoint é responsável por obter as informações de um Conector em especifico.

Diferente dos endpoints que listam informações de vários recursos, aqui é retornando um único objeto JSON de representação do Conector caso o mesmo seja encontrado na base de dados e o usuário da requisição tenha acesso ao mesmo.

\n","urlObject":{"path":["connectors","(connector_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"65f08c05-f549-4031-8c86-0c282b923826","name":"Detalhe de Conector","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/connectors/(connector_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Mar 2022 12:01:44 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"eac84e01a24f2661f0083095c50b6d11\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"1196"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 3114,\n \"etag\": \"\\\"eac84e01a24f2661f0083095c50b6d11\\\"\",\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Armando Sales de Oliveira\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 696,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 3,\n \"name\": \"MODBUS-TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": true,\n \"optimizes_frames\": true,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"user_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 30,\n \"screen_id\": null,\n \"reference_id\": \"1df7c592\",\n \"mqtt_topic_prefix\": \"eb30fd76\",\n \"mqtt_disconnect_time\": 0,\n \"mqtt_payload_format_id\": 1\n}"}],"_postman_id":"4d92138a-4712-4660-83b2-de440e250d4c"}],"id":"5bba5c60-ccfb-4694-85aa-dd8be6c55c8e","description":"

Um Conector é a entidade que representa um equipamento ou software remoto responsável por abrir a conexão com o Portal de Telemetria e viabilizar um canal de comunicação para troca de informações e agrupa as demais entidades hierárquicas: Dispositivo, Dado e Alarme.

Saiba mais sobre Conectores no Manual do Portal de Telemetria.

\n","_postman_id":"5bba5c60-ccfb-4694-85aa-dd8be6c55c8e"},{"name":"Dispositivos","item":[{"name":"Listagem de Dispositivos","event":[{"listen":"test","script":{"id":"0d83a7c6-0c59-4c64-ba37-72a93f7c510c","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('device_id'));"],"type":"text/javascript"}}],"id":"6f8b699e-d3bf-4d2f-85ea-82c71cc132a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/?connector_id=(connector_id)&contract_id=(contract_id)&ids=998,999","description":"

Este endpoint é responsável por obter uma lista de informações de Dispositivos conforme os filtros definidos na requisição. Para cada Dispositivo, é retornado um JSON com suas informações de configuração, estado, etc.

\n","urlObject":{"path":["devices",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"description":{"content":"

IDs dos Dispositivos separados por vírgula. Ex: ids=998,999

\n","type":"text/plain"},"key":"ids","value":"998,999"},{"disabled":true,"description":{"content":"

Referências dos Dispositivos separados por vírgula. Ex: reference_ids=7181ec6e,a60ie42v

\n","type":"text/plain"},"key":"reference_ids","value":"8a92fd7f,a60ie42v"},{"disabled":true,"description":{"content":"

Nome do Dispositivo

\n","type":"text/plain"},"key":"name","value":"(device_name)"},{"disabled":true,"description":{"content":"

Nome do Conector

\n","type":"text/plain"},"key":"connector_name","value":"(connector_name)"},{"disabled":true,"description":{"content":"

Nome da Área de Processo

\n","type":"text/plain"},"key":"process_area_name","value":"(process_area_name)"},{"disabled":true,"description":{"content":"

Filtra o recurso por marcadores que foram definidos no seu cadastro. Múltiplos valores devem ser separador por vírgula.

\n","type":"text/plain"},"key":"tags","value":"(nomeDoMarcador1),(nomeDoMarcador2)"}],"variable":[]}},"response":[{"id":"18309e3f-dbe7-45f8-9103-81ff55b8e16a","name":"Listagem de Dispositivo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/?contract_id=10&ids=998,999","protocol":"https","host":["api","telemetria","hitecnologia","com","br"],"path":["rest","v1","devices",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"ids","value":"998,999","description":"IDs dos Dispositivos separados por vírgula. Ex: ids=998,999"},{"key":"name","value":"DISPOSITIVO DE DEMOSTRAÇÃO","description":"Nome do Dispositivo","disabled":true},{"key":"connector_name","value":"CONECTOR DE DEMONSTRAÇÃO","description":"Nome do Conector","disabled":true},{"key":"process_area_name","value":"Área de Processo Padrão","description":"Nome da Área de Processo","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 12:01:02 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"2031"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 999,\n \"etag\": \"\\\"ee7bb9XXX43d6018beeafef1581689c4\\\"\",\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 2,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campina\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Teste\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 3,\n \"name\": \"MODBUS TCP\",\n \"is_mqtt_protocol\": false\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": false,\n \"optimizes_frames\": false,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 30,\n \"screen_id\": null,\n \"reference_id\": \"b5b9efb6\",\n \"mqtt_topic_prefix\": \"5c780a04\",\n \"mqtt_disconnect_time\": 0,\n \"mqtt_payload_format_id\": 1\n },\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": true,\n \"local_storage_enabled\": true,\n \"local_storage_version\": {\n \"id\": 2,\n \"name\": \"V2\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"America/Sao_Paulo\",\n \"portal_data\": {},\n \"user_data\": {},\n \"reference_id\": \"8292fd7f\"\n },\n ...\n]"}],"_postman_id":"6f8b699e-d3bf-4d2f-85ea-82c71cc132a2"},{"name":"Listagem de Dispositivos - Sem hierarquia de outros recursos","event":[{"listen":"test","script":{"id":"bd48a1f5-3911-4a7f-ade0-b6fa709e853f","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('device_id'));\r","pm.expect(jsonData[0].connector_id).to.eql(pm.collectionVariables.get('connector_id'));"],"type":"text/javascript"}}],"id":"f02108f3-dced-4910-9264-2e9dd3ae954c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/?contract_id=(contract_id)&ids=998,999&hierarchy=false","description":"

Este endpoint é o mesmo apresentado acima(que lista as informações de um Dispositivo), porém, passando o parâmetro hierarchy=false.

A diferença aqui é que o objeto JSON retornado para cada Dispositivo é mais simplificado, pois não traz todas as informações dos recursos de sua hierarquia(neste caso, do Conector e Contrato que está associado).

Desse modo, tem-se um retorno mais eficiente e enxuto das informações de cada Dispositivo.

\n","urlObject":{"path":["devices",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"description":{"content":"

IDs dos Dispositivos separados por vírgula. Ex: ids=998,999

\n","type":"text/plain"},"key":"ids","value":"998,999"},{"description":{"content":"

Incluir informações da Hierarquia do Dispositivo(Conector)

\n","type":"text/plain"},"key":"hierarchy","value":"false"},{"disabled":true,"description":{"content":"

Referências dos Dispositivos separados por vírgula. Ex: reference_ids=7181ec6e,a60ie42v

\n","type":"text/plain"},"key":"reference_ids","value":"8a92fd7f,a60ie42v"}],"variable":[]}},"response":[{"id":"bc16dffe-a3dc-43cf-8d12-b8eca79db633","name":"Listagem Sem Hierarquia de Dispositivo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/?contract_id=10&ids=998,999&hierarchy=false","protocol":"https","host":["api","telemetria","hitecnologia","com","br"],"path":["rest","v1","devices",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"ids","value":"998,999","description":"IDs dos Dispositivos separados por vírgula. Ex: ids=998,999"},{"key":"hierarchy","value":"false","description":"Incluir informações da Hierarquia do Dispositivo(Conector)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 12:03:09 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"782"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 999,\n \"etag\": \"\\\"ee7bb9aXXX3d6018beeafef1581689c4\\\"\",\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 2,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector_id\": 99,\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": true,\n \"local_storage_enabled\": true,\n \"local_storage_version\": {\n \"id\": 2,\n \"name\": \"V2\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"America/Sao_Paulo\",\n \"portal_data\": {},\n \"user_data\": {},\n \"reference_id\": \"8292fd7f\"\n }\n]"}],"_postman_id":"f02108f3-dced-4910-9264-2e9dd3ae954c"},{"name":"Listagem de Estado de Dispositivo","event":[{"listen":"test","script":{"id":"6132b53f-e317-4a06-b637-ab0534797d53","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('device_id'));"],"type":"text/javascript"}}],"id":"135cf4d7-887c-4103-956e-63ee4a85faae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/?contract_id=(contract_id)&ids=998,999&only_state=true","description":"

Este endpoint é responsável por obter informações de estado de um Dispositivo, como por exemplo, o status de conexão com o Portal ou se o mesmo possui um alarme ativo.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome do Campo	Tipo de Valor	Descrição
id	Inteiro	Identificador do Dispositivo(ID) no Portal. Este ID é único e distinto para cada Dispositivo.
enabled	Booleano	Indica se o Dispositivo esta habilitado ou não no Portal
has_active_alarm	Booleano	Indica se o Dispositivo possui algum Alarme ativo
is_connected	Booleano	Indica se o Dispositivo está conectado(online) com o Portal ou não

","urlObject":{"path":["devices",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"description":{"content":"

IDs dos Dispositivos separados por vírgula. Ex: ids=998,999

\n","type":"text/plain"},"key":"ids","value":"998,999"},{"description":{"content":"

Somente informações de Estado do Dispositivo

\n","type":"text/plain"},"key":"only_state","value":"true"},{"disabled":true,"description":{"content":"

Referências dos Dispositivos separados por vírgula. Ex: reference_ids=7181ec6e,a60ie42v

\n","type":"text/plain"},"key":"reference_ids","value":"8a92fd7f,a60ie42v"}],"variable":[]}},"response":[{"id":"487afbf6-0cab-47d9-bb55-ab616439cfe0","name":"Listagem de Estado de Dispositivos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/?contract_id=10&ids=998,999&only_state=true","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["devices",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"ids","value":"998,999","description":"IDs dos Dispositivos separados por vírgula. Ex: ids=998,999"},{"key":"only_state","value":"true","description":"Somente informações de Estado do Dispositivo"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 12:02:31 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"75"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 999,\n \"enabled\": true,\n \"is_connected\": false,\n \"has_active_alarms\": false\n },\n ...\n]"}],"_postman_id":"135cf4d7-887c-4103-956e-63ee4a85faae"},{"name":"Detalhes de um Dispositivo","event":[{"listen":"test","script":{"exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData.process_area.id).to.eql(pm.collectionVariables.get('process_area_id'));\r","pm.expect(jsonData.connector.id).to.eql(pm.collectionVariables.get('connector_id'));"],"type":"text/javascript","id":"8e0895cb-916e-4e27-9851-0211979a6252"}}],"id":"c79a2168-e343-453f-b7ef-31c59f45e16b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/(device_id)/","description":"

Este endpoint é responsável por obter as informações de um Dispositivo em especifico.

Diferente dos endpoints que listam informações de vários recursos, aqui é retornando um único objeto JSON de representação do Dispositivo caso o mesmo seja encontrado na base de dados e o usuário da requisição tenha acesso ao mesmo.

\n","urlObject":{"path":["devices","(device_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"6360d6d2-e7d9-422f-873b-b6e6c62a83ab","name":"Detalhe do Dispositivo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/devices/(device_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 13:25:47 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"ee7bb9a3a43d6018beeafef1581689c4\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"2029"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 999,\n \"etag\": \"\\\"ee7bb9a3a43d6018beeafef1581689c4\\\"\",\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 2,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Conector Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Teste\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 2,\n \"name\": \"MODBUS TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": false,\n \"optimizes_frames\": false,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 30,\n \"screen_id\": null,\n \"reference_id\": \"b5b9efb6\",\n \"mqtt_topic_prefix\": \"5c780a04\",\n \"mqtt_disconnect_time\": 0,\n \"mqtt_payload_format_id\": 1\n },\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": true,\n \"local_storage_enabled\": true,\n \"local_storage_version\": {\n \"id\": 2,\n \"name\": \"V2\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"America/Sao_Paulo\",\n \"portal_data\": {},\n \"user_data\": {},\n \"reference_id\": \"8292fd7f\"\n}"}],"_postman_id":"c79a2168-e343-453f-b7ef-31c59f45e16b"}],"id":"a555968e-9f62-4850-a02f-526f780cca68","description":"

Um Dispositivo é a entidade que possui os Dados a serem coletados pelo Portal de Telemetria através da conexão com o Conector associado ao mesmo e agrupa as demais entidades hierárquicas: Dado e Alarme.

Saiba mais sobre Dispositivos no Manual do Portal de Telemetria.

\n","_postman_id":"a555968e-9f62-4850-a02f-526f780cca68"},{"name":"Dados","item":[{"name":"Listagem de Dados","event":[{"listen":"test","script":{"id":"4577f6b8-ab65-436a-b458-069efe6d6341","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('data_id'));"],"type":"text/javascript"}}],"id":"cd3a362b-a0e5-4f37-8a7d-11e026c1ed83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/?contract_id=(contract_id)&ids=9998,9999","description":"

Este endpoint é responsável por obter uma lista de informações de Dados conforme os filtros definidos na requisição. Para cada Dado, é retornado um JSON com suas informações de configuração, estado, etc.

\n","urlObject":{"path":["data",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"description":{"content":"

IDs dos Dados separados por vírgula. Ex: ids=9998,9999

\n","type":"text/plain"},"key":"ids","value":"9998,9999"},{"disabled":true,"description":{"content":"

Referências dos Dados separados por vírgula. Ex: reference_ids=6079cb5g,d21nk89e

\n","type":"text/plain"},"key":"reference_ids","value":"6079cb5g,d21nk89e"},{"disabled":true,"description":{"content":"

Nome do Dado

\n","type":"text/plain"},"key":"name","value":"(data_name)"},{"disabled":true,"description":{"content":"

Nome do Conector

\n","type":"text/plain"},"key":"connector_name","value":"(connector_name)"},{"disabled":true,"description":{"content":"

Nome do Dispositivo

\n","type":"text/plain"},"key":"device_name","value":"(device_name)"},{"disabled":true,"description":{"content":"

Filtra por Dados de um Conector de Modelo

\n","type":"text/plain"},"key":"base_model","value":"true"},{"disabled":true,"description":{"content":"

Modo de leitura e escrita do dado. Valores possíveis: 0 - Apenas leitura / 1 - Leitura e escrita / 2 - Apenas Escrita

\n","type":"text/plain"},"key":"read_write_mode","value":"0"},{"disabled":true,"description":{"content":"

Filtra o recurso por marcadores que foram definidos no seu cadastro. Múltiplos valores devem ser separador por vírgula.

\n","type":"text/plain"},"key":"tags","value":"(nomeDoMarcador1),(nomeDoMarcador2)"}],"variable":[]}},"response":[{"id":"6e2aa50d-c965-45b4-8459-485f77300c4c","name":"Listagem de Dados","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/?contract_id=10&ids=9998,9999","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["data",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"ids","value":"9998,9999","description":"IDs dos Dados separados por vírgula. Ex: ids=9998,9999"},{"key":"base_model","value":"true","description":"Filtra por Dados de um Conector de Modelo","disabled":true},{"key":"name","value":"DADO DE DEMONSTRAÇÃO","description":"Nome do Dado","disabled":true},{"key":"device_name","value":"DISPOSITIVO DE DEMONSTRAÇÃO","description":"Nome do Dispositivo","disabled":true},{"key":"connector_name","value":"CONECTOR DE DEMONSTRAÇÃO","description":"Nome do Conector","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 14:04:28 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"3324"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 9999,\n \"etag\": \"\\\"5cc2428dad6550c61949f96ec2b62e36\\\"\",\n \"name\": \"Dado Teste\",\n \"label\": null,\n \"description\": \"Descrição Dado Teste\",\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Proceso Teste\",\n \"description\": \"Descrição Área de Proceso Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"device\": {\n \"id\": 99,\n \"etag\": null,\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 9,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Proceso Teste\",\n \"description\": \"Descrição Área de Proceso Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Teste\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Proceso Teste\",\n \"description\": \"Descrição Área de Proceso Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 2,\n \"name\": \"MODBUS TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": false,\n \"optimizes_frames\": false,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 30,\n \"screen_id\": null,\n \"reference_id\": \"b5b9efb6\",\n \"mqtt_topic_prefix\": \"5c780a04\",\n \"mqtt_disconnect_time\": 0\n },\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": false,\n \"local_storage_enabled\": false,\n \"local_storage_version\": {\n \"id\": 1,\n \"name\": \"V1\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"UTC\",\n \"portal_data\": {},\n \"reference_id\": \"8292fd7f\"\n },\n \"memory_type\": {\n \"id\": 15,\n \"name\": \"Holding Register\"\n },\n \"source_value\": {\n \"id\": 1,\n \"name\": \"Endereço do dado\"\n },\n \"enabled\": true,\n \"allowed_mapping_value\": true,\n \"history_enabled\": false,\n \"data_history_type_id\": 1,\n \"read_only\": true,\n \"read_write_mode\": 0,\n \"value_format_type\": {\n \"id\": 3,\n \"name\": \"2 casas decimais\"\n },\n \"custom_format\": null,\n \"update_value_mode_after_writing\": {\n \"id\": 1,\n \"name\": \"Aguarda ciclo de leitura ou evento de atualização de valor\"\n },\n \"unity_label\": \"°C\",\n \"memory_address\": 1001,\n \"local_storage_identity_number\": 500,\n \"minimum_value\": null,\n \"maximum_value\": null,\n \"calculation_type\": {\n \"id\": 1,\n \"name\": \"Fator multiplicação\"\n },\n \"calculation_param_a\": \"-1.75\",\n \"calculation_param_b\": \"2.37\",\n \"calculation_param_c\": \"3.982\",\n \"calculation_param_d\": \"-4\",\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"text_list\": null,\n \"pending_command\": false,\n \"pending_commands\": [],\n \"pending_mapping_write\": null,\n \"mqtt_qos\": 0,\n \"mqtt_retain\": false,\n \"portal_data\": {},\n \"current_value\": null,\n \"reference_id\": \"fa661fc6\"\n },\n ...\n]"}],"_postman_id":"cd3a362b-a0e5-4f37-8a7d-11e026c1ed83"},{"name":"Listagem de Dados - Sem hierarquia de recursos","event":[{"listen":"test","script":{"id":"f41b54f5-94b2-49ce-8bd0-872054404f52","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('data_id'));\r","pm.expect(jsonData[0].device_id).to.eql(pm.collectionVariables.get('device_id'));\r","pm.expect(jsonData[0].connector_id).to.eql(pm.collectionVariables.get('connector_id'));"],"type":"text/javascript"}}],"id":"e869ea2f-0a57-4742-b209-1d1e46bd5dec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/?contract_id=(contract_id)&ids=9998,9999&hierarchy=false","description":"

Este endpoint é o mesmo apresentado acima(que lista as informações de Dados), porém, passando o parâmetro hierarchy=false.

A diferença aqui é que o objeto JSON retornado para cada Dado é mais simplificado, pois não traz todas as informações dos recursos de sua hierarquia(neste caso, do Dispositivo, Conector e Contrato que está associado).

Desse modo, tem-se um retorno mais eficiente e enxuto das informações de cada Dado.

\n","urlObject":{"path":["data",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"description":{"content":"

IDs dos Dados separados por vírgula. Ex: data_ids=9998,9999

\n","type":"text/plain"},"key":"ids","value":"9998,9999"},{"description":{"content":"

Incluir informações da Hierarquia do Dado(Dispositivo e Conector)

\n","type":"text/plain"},"key":"hierarchy","value":"false"},{"disabled":true,"description":{"content":"

Referências dos Dados separados por vírgula. Ex: reference_ids=6079cb5g,d21nk89e

\n","type":"text/plain"},"key":"reference_ids","value":"6079cb5g,d21nk89e"}],"variable":[]}},"response":[{"id":"1c2c2ad1-80a6-4335-a4dc-5ef719a2f891","name":"Listagem de Dados sem Hierarquia","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/?contract_id=10&ids=9998,9999&hierarchy=false","protocol":"https","host":["api","telemetria","hitecnologia","com","br"],"path":["rest","v1","data",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"ids","value":"9998,9999","description":"IDs dos Dados separados por vírgula. Ex: ids=9998,9999"},{"key":"hierarchy","value":"false","description":"Incluir informações da Hierarquia do Dado(Dispositivo e Conector)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 14:39:25 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"1376"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 9999,\n \"etag\": \"\\\"5cc2428dad6550c61949f96ec2b62e36\\\"\",\n \"name\": \"Dado Teste\",\n \"label\": null,\n \"description\": \"Descrição Dado Teste\",\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo\",\n \"description\": \"Descrição Área de Processo\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"device_id\": 99,\n \"connector_id\": 99,\n \"memory_type\": {\n \"id\": 15,\n \"name\": \"Holding Register\"\n },\n \"source_value\": {\n \"id\": 1,\n \"name\": \"Endereço do dado\"\n },\n \"enabled\": true,\n \"allowed_mapping_value\": true,\n \"history_enabled\": false,\n \"data_history_type_id\": 1,\n \"read_only\": true,\n \"read_write_mode\": 0,\n \"value_format_type\": {\n \"id\": 3,\n \"name\": \"2 casas decimais\"\n },\n \"custom_format\": null,\n \"update_value_mode_after_writing\": {\n \"id\": 1,\n \"name\": \"Aguarda ciclo de leitura ou evento de atualização de valor\"\n },\n \"unity_label\": \"°C\",\n \"memory_address\": 1001,\n \"local_storage_identity_number\": 500,\n \"minimum_value\": null,\n \"maximum_value\": null,\n \"calculation_type\": {\n \"id\": 1,\n \"name\": \"Fator multiplicação\"\n },\n \"calculation_param_a\": \"-1.75\",\n \"calculation_param_b\": \"2.37\",\n \"calculation_param_c\": \"3.982\",\n \"calculation_param_d\": \"-4\",\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"text_list\": null,\n \"pending_command\": false,\n \"pending_commands\": [],\n \"pending_mapping_write\": null,\n \"mqtt_qos\": 0,\n \"mqtt_retain\": false,\n \"portal_data\": {},\n \"current_value\": null,\n \"reference_id\": \"fa661fc6\"\n }\n]"}],"_postman_id":"e869ea2f-0a57-4742-b209-1d1e46bd5dec"},{"name":"Obter o valor corrente de Dado(s)","event":[{"listen":"test","script":{"id":"62fbfddb-598c-4622-b22f-a5bd850cc66f","exec":[""],"type":"text/javascript"}}],"id":"3fc86564-86f1-47b2-ad87-7cffc9b616cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data_current_value/?contract_id=(contract_id)&data_ids=9998,9999","description":"

Este endpoint é responsável por obter o valor corrente (atual) de um ou mais Dados conforme os filtros fornecidos na requisição no Portal.

O valor corrente de um Dado diz respeito ao valor mais recente coletado pelo Portal para este Dado no equipamento remoto ou ao valor enviado pelo equipamento ao Portal.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome do Campo	Tipo de Valor	Descrição
data_id	Inteiro	Identificador do Dado (ID) no Portal. Este ID é único e distinto para cada Dado.
date_time	Data/Hora	Data/hora (no formato ISO 8601) do valor.
value	String	Valor corrente do Dado.

","urlObject":{"path":["data_current_value",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"description":{"content":"

IDs dos Dados separados por vírgula. Ex: data_ids=9998,9999

\n","type":"text/plain"},"key":"data_ids","value":"9998,9999"},{"disabled":true,"description":{"content":"

Referências dos Dados separados por vírgula. Ex: reference_ids=6079cb5g,d21nk89e

\n","type":"text/plain"},"key":"reference_ids","value":"6079cb5g,d21nk89e"}],"variable":[]}},"response":[{"id":"50d3eba0-15ee-45e3-9add-48ab454aac9f","name":"Obter o valor corrente de Dado(s)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/data_current_value/?contract_id=10&data_ids=9998,9999","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["data_current_value",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"data_ids","value":"9998,9999","description":"IDs dos Dados separados por vírgula. Ex: data_ids=9998,9999"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 14:09:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"137027"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"data_id\": \"9998\",\n \"date_time\": \"2023-03-01T08:05:46.272977+00:00\",\n \"value\": \"30.50000\"\n },\n {\n \"data_id\": \"9999\",\n \"date_time\": \"2023-03-01T08:05:46.272977+00:00\",\n \"value\": \"27.75000\"\n },\n ...\n]"}],"_postman_id":"3fc86564-86f1-47b2-ad87-7cffc9b616cf"},{"name":"Listagem de Estado de Dados","event":[{"listen":"test","script":{"id":"9ee6f06d-eada-4729-8420-04ca35bdb0c9","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('data_id'));"],"type":"text/javascript"}}],"id":"2815d776-0507-4215-9be1-315510e77d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/?contract_id=(contract_id)&ids=9998,9999&only_state=true","description":"

Este endpoint é responsável por obter informações de estado de um Dado, como por exemplo, o status de execução de comandos de escrita ou se o mesmo possui um alarme ativo.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome do Campo	Tipo de Valor	Descrição
id	Inteiro	Identificador do Dado (ID) no Portal. Este ID é único e distinto para cada Dado.
enabled	Booleano	Indica se o Dado esta habilitado ou não no Portal.
has_active_alarms	Booleano	Indica se o Dado possui algum Alarme ativo.
pending_commands	JSON	Objeto que lista os eventuais comandos de Escrita pendentes de execução para o Dado. Caso a lista esteja vazia, significa que não há Comandos de Escrita pendentes.
pending_commands > id	Inteiro	Identificador do Comando de Escrita
pending_commands > command_state_id	Inteiro	Idendificador do estado de execução do comando, onde: 1 = Aguardando 5 = Processando 6 = Processado 7 = Cancelado
pending_commands > writing_value	String	Valor da Escrita
pending_commands > processed_datetime	Data/hora	Data/hora de processamento(execução) do Comando de Escrita no equipamento remoto.

","urlObject":{"path":["data",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"description":{"content":"

IDs dos Dados separados por vírgula. Ex: data_ids=9998,9999

\n","type":"text/plain"},"key":"ids","value":"9998,9999"},{"description":{"content":"

Somente informações de Estado do Dado

\n","type":"text/plain"},"key":"only_state","value":"true"},{"disabled":true,"description":{"content":"

Referências dos Dados separados por vírgula. Ex: reference_ids=6079cb5g,d21nk89e

\n","type":"text/plain"},"key":"reference_ids","value":"6079cb5g,d21nk89e"}],"variable":[]}},"response":[{"id":"44cbe515-7c77-4365-bfae-ee6c556945ad","name":"Listagem de Estado de Dados","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/?contract_id=10&ids=9998,9999&only_state=true","protocol":"https","host":["api","telemetria","hitecnologia","com","br"],"path":["rest","v1","data",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"ids","value":"9998,9999","description":"IDs dos Dados separados por vírgula. Ex: ids=9998,9999"},{"key":"only_state","value":"true","description":"Apenas informações de Estado do Dado"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 14:38:56 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"106"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 9999,\n \"enabled\": true,\n \"has_active_alarms\": false,\n \"pending_commands\": [\n {\n \"id\": 100,\n \"command_state_id\": 1,\n \"writing_value\": \"1\",\n \"created_datetime\": \"2023-03-01T11:38:48.490161+00:00\",\n \"processed_datetime\": null\n }\n ],\n \"pending_mapping_write\": null\n }\n]"}],"_postman_id":"2815d776-0507-4215-9be1-315510e77d93"},{"name":"Detalhes de um Dado","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","if (pm.response.json()) {\r"," pm.collectionVariables.set('data_id', pm.response.json().id)\r"," pm.collectionVariables.set('data_etag', pm.response.json().etag)\r","}\r","\r"," pm.test(\"Check response value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.pending_command).to.eql(false);\r"," pm.expect(jsonData.process_area.id).to.eql(pm.collectionVariables.get('process_area_id'));\r"," pm.expect(jsonData.device.connector.id).to.eql(pm.collectionVariables.get('connector_id'));\r"," pm.expect(jsonData.device.id).to.eql(pm.collectionVariables.get('device_id'));\r"," });"],"type":"text/javascript","id":"06f5aa73-61c1-436e-b9e2-452affb6d2f5"}}],"id":"1a1e986f-3ddd-4d45-a3e3-85eb1d6c3379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/(data_id)/","description":"

Este endpoint é responsável por obter as informações de um Dado em especifico.

Diferente dos endpoints que listam informações de vários recursos, aqui é retornando um único objeto JSON de representação do Dado caso o mesmo seja encontrado na base de dados e o usuário da requisição tenha acesso ao mesmo.

\n","urlObject":{"path":["data","(data_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"e0471517-fed6-436e-9f0c-eac8bd5e980d","name":"Detalhe de Dado","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/data/(data_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 16:12:19 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"7942d6aa124828b5bddb7abb9d32657f\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"3323"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 99,\n \"etag\": \"\\\"5cc2428dad6550c61949f96ec2b62e36\\\"\",\n \"name\": \"Dado Teste\",\n \"label\": null,\n \"description\": \"Descrição Dado Teste\",\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Proceso Teste\",\n \"description\": \"Descrição Área de Proceso Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"device\": {\n \"id\": 99,\n \"etag\": null,\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 9,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Proceso Teste\",\n \"description\": \"Descrição Área de Proceso Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Teste\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 999,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Proceso Teste\",\n \"description\": \"Descrição Área de Proceso Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 2,\n \"name\": \"MODBUS TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": false,\n \"optimizes_frames\": false,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 30,\n \"screen_id\": null,\n \"reference_id\": \"b5b9efb6\",\n \"mqtt_topic_prefix\": \"5c780a04\",\n \"mqtt_disconnect_time\": 0,\n \"mqtt_payload_format_id\": 1\n },\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": false,\n \"local_storage_enabled\": false,\n \"local_storage_version\": {\n \"id\": 1,\n \"name\": \"V1\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"UTC\",\n \"portal_data\": {},\n \"reference_id\": \"8292fd7f\"\n },\n \"memory_type\": {\n \"id\": 15,\n \"name\": \"Holding Register\"\n },\n \"source_value\": {\n \"id\": 1,\n \"name\": \"Endereço do dado\"\n },\n \"enabled\": true,\n \"allowed_mapping_value\": true,\n \"history_enabled\": false,\n \"data_history_type_id\": 1,\n \"read_only\": true,\n \"read_write_mode\": 0,\n \"value_format_type\": {\n \"id\": 3,\n \"name\": \"2 casas decimais\"\n },\n \"custom_format\": null,\n \"update_value_mode_after_writing\": {\n \"id\": 1,\n \"name\": \"Aguarda ciclo de leitura ou evento de atualização de valor\"\n },\n \"unity_label\": \"°C\",\n \"memory_address\": 1001,\n \"local_storage_identity_number\": 500,\n \"minimum_value\": null,\n \"maximum_value\": null,\n \"calculation_type\": {\n \"id\": 1,\n \"name\": \"Fator multiplicação\"\n },\n \"calculation_param_a\": \"-1.75\",\n \"calculation_param_b\": \"2.37\",\n \"calculation_param_c\": \"3.982\",\n \"calculation_param_d\": \"-4\",\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"text_list\": null,\n \"pending_command\": false,\n \"pending_commands\": [],\n \"pending_mapping_write\": null,\n \"mqtt_qos\": 0,\n \"mqtt_retain\": false,\n \"portal_data\": {},\n \"current_value\": null,\n \"reference_id\": \"fa661fc6\"\n}"}],"_postman_id":"1a1e986f-3ddd-4d45-a3e3-85eb1d6c3379"}],"id":"72f2b6ac-3eb6-4f1a-82c3-7c28a1f6ab45","description":"

O Dado é a entidade que é responsável pela leitura e armazenamento de informações no Dispositivo. Dados podem ter Alarmes ou não, dependendo da necessidade.

Saiba mais sobre Dados no Manual do Portal de Telemetria.

\n","_postman_id":"72f2b6ac-3eb6-4f1a-82c3-7c28a1f6ab45"},{"name":"Alarmes","item":[{"name":"Listagem de Alarmes","event":[{"listen":"test","script":{"id":"5bbc7375-63a8-4c87-96fc-68eb866954c9","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('alarm_id'));"],"type":"text/javascript"}}],"id":"9a34ff20-92fa-41a6-beca-2fe3ddb04ef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/?contract_id=(contract_id)&ids=99998,99999","description":"

Este endpoint é responsável por obter uma lista de informações de Alarmes conforme os filtros definidos na requisição. Para cada Alarme, é retornado um JSON com suas informações de configuração, estado, etc.

\n","urlObject":{"path":["alarms",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"disabled":true,"description":{"content":"

ID do Dado

\n","type":"text/plain"},"key":"data_id","value":"(data_id)"},{"description":{"content":"

IDs dos Alarmes separados por vírgula. Ex: ids=99998,99999

\n","type":"text/plain"},"key":"ids","value":"99998,99999"},{"disabled":true,"description":{"content":"

Referências dos Alarmes separados por vírgula. Ex: reference_ids=1b90fd7f,r814p7ac

\n","type":"text/plain"},"key":"reference_ids","value":"1b90fd7f,r814p7ac"},{"disabled":true,"description":{"content":"

Filtra por Alarmes configurados para exigir reconhecimento

\n","type":"text/plain"},"key":"acknowledgment_enabled","value":"true"},{"disabled":true,"key":"base_model","value":"false"},{"disabled":true,"description":{"content":"

Filtra o recurso por marcadores que foram definidos no seu cadastro. Múltiplos valores devem ser separador por vírgula.

\n","type":"text/plain"},"key":"tags","value":"(nomeDoMarcador1),(nomeDoMarcador2)"}],"variable":[]}},"response":[{"id":"168fa828-09c8-44f4-9364-aae3e8b20f8a","name":"Listagem de Alarmes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/?contract_id=10&ids=99998,99999","protocol":"https","host":["api","telemetria","hitecnologia","com","br"],"path":["rest","v1","alarms",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"data_id","value":"9999","description":"ID do Dado","disabled":true},{"key":"ids","value":"99998,99999","description":"IDs dos Alarmes separados por vírgula. Ex: ids=99998, 99999"},{"key":"acknowledgment_enabled","value":"true","description":"Filtra por Alarmes configurados para exigir reconhecimento","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Mar 2022 18:52:06 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"4177"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99999,\n \"etag\": \"\\\"dff38052fba56b9173ba6d535388efaa\\\"\",\n \"name\": \"Alarme Teste\",\n \"description\": \"Descrição Alarme Teste\",\n \"process_area\": {\n \"id\": 999,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"data\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Dado Teste\",\n \"label\": null,\n \"description\": \"Descrição Dado Teste\",\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"device\": {\n \"id\": 99,\n \"etag\": null,\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 9,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Teste\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 2,\n \"name\": \"MODBUS TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": false,\n \"optimizes_frames\": false,\n \"last_activity_at\": null,\n \"portal_data\": {\"default_notifications\": {\"emails\": [\"teste@teste.com\"], \"telegrams\": [\"99999999999\"]}},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 60,\n \"screen_id\": null,\n \"reference_id\": \"b5b9efb6\",\n \"mqtt_topic_prefix\": \"5c780a04\",\n \"mqtt_disconnect_time\": 0\n },\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": false,\n \"local_storage_enabled\": false,\n \"local_storage_version\": {\n \"id\": 1,\n \"name\": \"V1\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"UTC\",\n \"portal_data\": {},\n \"reference_id\": \"8292fd7f\"\n },\n \"memory_type\": {\n \"id\": 15,\n \"name\": \"Holding Register\"\n },\n \"source_value\": {\n \"id\": 1,\n \"name\": \"Endereço do dado\"\n },\n \"enabled\": true,\n \"allowed_mapping_value\": true,\n \"history_enabled\": false,\n \"data_history_type_id\": 1,\n \"read_only\": true,\n \"read_write_mode\": 0,\n \"value_format_type\": {\n \"id\": 3,\n \"name\": \"2 casas decimais\"\n },\n \"custom_format\": null,\n \"update_value_mode_after_writing\": {\n \"id\": 1,\n \"name\": \"Aguarda ciclo de leitura ou evento de atualização de valor\"\n },\n \"unity_label\": \"°C\",\n \"memory_address\": 1001,\n \"local_storage_identity_number\": 500,\n \"minimum_value\": null,\n \"maximum_value\": null,\n \"calculation_type\": {\n \"id\": 1,\n \"name\": \"Fator multiplicação\"\n },\n \"calculation_param_a\": \"10\",\n \"calculation_param_b\": null,\n \"calculation_param_c\": null,\n \"calculation_param_d\": null,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"text_list\": null,\n \"pending_command\": false,\n \"pending_commands\": [],\n \"pending_mapping_write\": null,\n \"mqtt_qos\": 0,\n \"mqtt_retain\": false,\n \"portal_data\": {},\n \"current_value\": null,\n \"reference_id\": \"fa661fc6\"\n },\n \"alarm_trigger_condition\": {\n \"id\": 1,\n \"name\": \"Igualdade\"\n },\n \"limit\": 10,\n \"level\": \"LL\",\n \"enabled\": true,\n \"acknowledgment_enabled\": true,\n \"alarm_current_state\": {\n \"alarm_state\": {\n \"id\": 1,\n \"number\": 0,\n \"name\": \"NORMAL\"\n },\n \"datetime_last_transition\": null,\n \"datetime_last_activation\": null,\n \"datetime_last_acknowledgment\": null,\n \"state\": false,\n \"acknowledgment_state\": false,\n \"pending_command\": false,\n \"pending_commands\": []\n },\n \"notification_enabled\": true,\n \"history_enabled\": true,\n \"portal_data\": {},\n \"reference_id\": \"8ddbec14\"\n },\n ...\n]"}],"_postman_id":"9a34ff20-92fa-41a6-beca-2fe3ddb04ef1"},{"name":"Listagem de Alarmes - Sem hierarquia de recursos","event":[{"listen":"test","script":{"id":"99f00038-a950-4364-946a-ad64066a86e3","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('alarm_id'));\r","pm.expect(jsonData[0].data_id).to.eql(pm.collectionVariables.get('data_id'));\r","pm.expect(jsonData[0].device_id).to.eql(pm.collectionVariables.get('device_id'));\r","pm.expect(jsonData[0].connector_id).to.eql(pm.collectionVariables.get('connector_id'));"],"type":"text/javascript"}}],"id":"6b058beb-23b1-4a73-96b1-2fae24e187f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/?contract_id=(contract_id)&ids=99998,99999&hierarchy=false","description":"

Este endpoint é o mesmo apresentado acima(que lista as informações de Alarmes), porém, passando o parâmetro hierarchy=false.

A diferença aqui é que o objeto JSON retornado para cada Alarme é mais simplificado, pois não traz todas as informações dos recursos de sua hierarquia(neste caso, do Dado, Dispositivo, Conector e Contrato que está associado).

Desse modo, tem-se um retorno mais eficiente e enxuto das informações de cada Alarme.

\n","urlObject":{"path":["alarms",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"disabled":true,"description":{"content":"

ID do Dado

\n","type":"text/plain"},"key":"data_id","value":"(data_id)"},{"description":{"content":"

IDs dos Alarmes separados por vírgula. Ex: ids=99998,99999

\n","type":"text/plain"},"key":"ids","value":"99998,99999"},{"description":{"content":"

Incluir informações da Hierarquia do Alarme(Dado, Dispositivo e Conector)

\n","type":"text/plain"},"key":"hierarchy","value":"false"},{"disabled":true,"description":{"content":"

Filtra por Alarmes configurados para exigir reconhecimento

\n","type":"text/plain"},"key":"acknowledgment_enabled","value":"true"},{"disabled":true,"description":{"content":"

Referências dos Alarmes separados por vírgula. Ex: reference_ids=1b90fd7f,r814p7ac

\n","type":"text/plain"},"key":"reference_ids","value":"1b90fd7f,r814p7ac"}],"variable":[]}},"response":[{"id":"d5a18465-496d-4be6-b9dc-d875a423e42b","name":"Listagem de Alarmes sem Hierarquia","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/?contract_id=10&ids=99998,99999&hierarchy=false","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["alarms",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"data_id","value":"9999","description":"ID do Dado","disabled":true},{"key":"ids","value":"99998,99999","description":"IDs dos Alarmes separados por vírgula. Ex: ids=99998,99999"},{"key":"hierarchy","value":"false","description":"Incluir informações da Hierarquia do Alarme(Dado, Dispositivo e Conector)"},{"key":"acknowledgment_enabled","value":"true","description":"Filtra por Alarmes configurados para exigir reconhecimento","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Mar 2022 13:51:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"992"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99999,\n \"etag\": \"\\\"e692ed4a4f236bb8b2142e653e752fe3\\\"\",\n \"name\": \"Alarme Teste\",\n \"description\": \"Descrição Alarme Teste\",\n \"process_area\": {\n \"id\": 999,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"data_id\": 9999,\n \"device_id\": 999,\n \"connector_id\": 99,\n \"alarm_trigger_condition\": {\n \"id\": 1,\n \"name\": \"Igualdade\"\n },\n \"limit\": 10,\n \"level\": \"LL\",\n \"enabled\": true,\n \"acknowledgment_enabled\": true,\n \"alarm_current_state\": {\n \"alarm_state\": {\n \"id\": 1,\n \"number\": 0,\n \"name\": \"NORMAL\"\n },\n \"datetime_last_transition\": null,\n \"datetime_last_activation\": null,\n \"datetime_last_acknowledgment\": null,\n \"state\": false,\n \"acknowledgment_state\": false,\n \"pending_command\": false,\n \"pending_commands\": []\n },\n \"notification_enabled\": true,\n \"history_enabled\": true,\n \"portal_data\": {},\n \"user_data\": {},\n \"reference_id\": \"c96287ab\"\n }\n]"}],"_postman_id":"6b058beb-23b1-4a73-96b1-2fae24e187f9"},{"name":"Listagem de Estado de Alarmes","event":[{"listen":"test","script":{"id":"6972bef0-b06c-496f-91ea-6422a9095b14","exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData[0].id).to.eql(pm.collectionVariables.get('alarm_id'));"],"type":"text/javascript"}}],"id":"56f9bf39-7200-4016-8208-abae6a5f4da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/?contract_id=(contract_id)&ids=99998,99999&only_state=true","description":"

Este endpoint é responsável por obter informações de estado de um Alarme, como por exemplo, se o mesmo está ativo ou não.

Resposta

Em cada registro, é possível verificar as seguintes informações no JSON de resposta da requisição neste endpoint:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome do Campo	Tipo de Valor	Descrição
id	Inteiro	Identificador do Alarme(ID) no Portal. Este ID é único e distinto para cada Alarme.
is_active	Booleano	Indica se o Alarme está ativo(alarmado) ou não.
alarm_state_id	Booleano	Indica o seguintes estados para o Alarme: 1= Normal 2= Ativo e não reconhecido 3= Ativo e reconhecido 4= Normal e não reconhecido
last_transition_at	Data/hora	Indica a Data/hora da última transição do Alarme(de normal para ativo e de ativo para normal).
data_value	String	Valor atual do Dado associado ao Alarme.

","urlObject":{"path":["alarms",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"},{"disabled":true,"description":{"content":"

ID do Conector

\n","type":"text/plain"},"key":"connector_id","value":"(connector_id)"},{"disabled":true,"description":{"content":"

ID do Dispositivo

\n","type":"text/plain"},"key":"device_id","value":"(device_id)"},{"disabled":true,"description":{"content":"

ID do Dado

\n","type":"text/plain"},"key":"data_id","value":"(data_id)"},{"description":{"content":"

IDs dos Alarmes separados por vírgula. Ex: ids=99998,99999

\n","type":"text/plain"},"key":"ids","value":"99998,99999"},{"description":{"content":"

Somente informações de Estado do Alarme

\n","type":"text/plain"},"key":"only_state","value":"true"},{"disabled":true,"description":{"content":"

Filtra por Alarmes configurados para exigir reconhecimento

\n","type":"text/plain"},"key":"acknowledgment_enabled","value":"true"},{"disabled":true,"description":{"content":"

Referências dos Alarmes separados por vírgula. Ex: reference_ids=1b90fd7f,r814p7ac

\n","type":"text/plain"},"key":"reference_ids","value":"1b90fd7f,r814p7ac"}],"variable":[]}},"response":[{"id":"b5dc3149-d7a2-4370-8eb0-9850193693c8","name":"Listagem de Estado de Alarmes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/?contract_id=10&data_id=9999&ids=99998,99999&only_state=true","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["alarms",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"},{"key":"connector_id","value":"99","description":"ID do Conector","disabled":true},{"key":"device_id","value":"999","description":"ID do Dispositivo","disabled":true},{"key":"data_id","value":"9999","description":"ID do Dado"},{"key":"ids","value":"99998,99999","description":"IDs dos Alarmes separados por vírgula. Ex: ids=99998,99999"},{"key":"only_state","value":"true","description":"Somente informações de Estado do Alarme"},{"key":"acknowledgment_enabled","value":"true","description":"Filtra por Alarmes configurados para exigir reconhecimento","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Mar 2022 13:51:11 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"94"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99999,\n \"is_active\": false,\n \"alarm_state_id\": 1,\n \"data_value\": null,\n \"last_transition_at\": null\n }\n]"}],"_postman_id":"56f9bf39-7200-4016-8208-abae6a5f4da4"},{"name":"Detalhes de um Alarme","event":[{"listen":"test","script":{"exec":["var jsonData = pm.response.json();\r","pm.expect(jsonData.alarm_current_state.pending_command).to.eql(false);\r","pm.expect(jsonData.process_area.id).to.eql(pm.collectionVariables.get('process_area_id'));\r","pm.expect(jsonData.data.device.connector.id).to.eql(pm.collectionVariables.get('connector_id'));\r","pm.expect(jsonData.data.device.id).to.eql(pm.collectionVariables.get('device_id'));\r","pm.expect(jsonData.data.id).to.eql(pm.collectionVariables.get('data_id'));"],"type":"text/javascript","id":"8558224c-2d46-44d7-9d73-0d6b2f6aa934"}}],"id":"407cb594-cedb-40ed-881c-75962da6e654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/(alarm_id)/","description":"

Este endpoint é responsável por obter as informações de um Alarme em especifico.

Diferente dos endpoints que listam informações de vários recursos, aqui é retornando um único objeto JSON de representação do Alarme caso o mesmo seja encontrado na base de dados e o usuário da requisição tenha acesso ao mesmo.

\n","urlObject":{"path":["alarms","(alarm_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"a7181d92-50ed-464c-8f2a-0af92e099910","name":"Detalhe do Alarme","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/alarms/(alarm_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Mar 2022 14:17:48 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"e692ed4a4f236bb8b2142e653e752fe3\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"4204"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 99999,\n \"etag\": \"\\\"e692ed4a4f236bb8b2142e653e752fe3\\\"\",\n \"name\": \"Alarme Teste\",\n \"description\": \"Alarme Teste\",\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"data\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Dado Teste\",\n \"label\": null,\n \"description\": \"Descrição Dado Teste\",\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"device\": {\n \"id\": 99,\n \"etag\": null,\n \"contract_id\": 10,\n \"name\": \"Dispositivo Teste\",\n \"description\": \"Descrição Dispositivo Teste\",\n \"enabled\": true,\n \"device_address\": 2,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 999,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"inherits_parent_process_area\": false,\n \"connector\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Conector Teste\",\n \"description\": \"Descrição Conector Teste\",\n \"enabled\": true,\n \"notification_enabled\": true,\n \"location_name\": \"Localização Teste\",\n \"location_address\": {\n \"city\": \"Campinas\",\n \"state\": \"São Paulo\",\n \"latlng\": \"\",\n \"number\": \"455\",\n \"street\": \"Rua Teste\",\n \"country\": \"Brasil\",\n \"zipcode\": \"130500000\",\n \"district\": \"\",\n \"extrainfo\": \"\"\n },\n \"contract_id\": 10,\n \"process_area\": {\n \"id\": 99,\n \"etag\": null,\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 10,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n \"connector_type\": {\n \"id\": 16,\n \"name\": \"NEON G5\"\n },\n \"protocol\": {\n \"id\": 1,\n \"name\": \"MODBUS TCP\"\n },\n \"serial_number\": \"101.99999\",\n \"secondary_serial_number\": null,\n \"timezone\": \"America/Sao_Paulo\",\n \"connector_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"updates_datetime\": true,\n \"optimizes_frames\": true,\n \"last_activity_at\": null,\n \"portal_data\": {},\n \"base_model\": false,\n \"base_model_id\": null,\n \"pooling_interval\": 38,\n \"screen_id\": null,\n \"reference_id\": \"27880d82\",\n \"mqtt_topic_prefix\": \"9b62366c\",\n \"mqtt_disconnect_time\": 0,\n \"mqtt_payload_format_id\": 1\n },\n \"device_status\": {\n \"id\": 2,\n \"number\": 2,\n \"name\": \"Desconectado\"\n },\n \"is_connected\": false,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"is_hi_device\": true,\n \"local_storage_enabled\": true,\n \"local_storage_version\": {\n \"id\": 2,\n \"name\": \"V2\"\n },\n \"local_storage_initial_address\": 1000,\n \"local_storage_timezone\": \"America/Sao_Paulo\",\n \"portal_data\": {},\n \"reference_id\": \"5edcc907\"\n },\n \"memory_type\": {\n \"id\": 15,\n \"name\": \"Holding Register\"\n },\n \"source_value\": {\n \"id\": 1,\n \"name\": \"Endereço do dado\"\n },\n \"enabled\": true,\n \"allowed_mapping_value\": true,\n \"history_enabled\": false,\n \"data_history_type_id\": 1,\n \"read_only\": true,\n \"read_write_mode\": 0,\n \"value_format_type\": {\n \"id\": 3,\n \"name\": \"2 casas decimais\"\n },\n \"custom_format\": null,\n \"update_value_mode_after_writing\": {\n \"id\": 1,\n \"name\": \"Aguarda ciclo de leitura ou evento de atualização de valor\"\n },\n \"unity_label\": \"°C\",\n \"memory_address\": 1001,\n \"local_storage_identity_number\": 500,\n \"minimum_value\": null,\n \"maximum_value\": null,\n \"calculation_type\": {\n \"id\": 1,\n \"name\": \"Fator multiplicação\"\n },\n \"calculation_param_a\": \"10\",\n \"calculation_param_b\": null,\n \"calculation_param_c\": null,\n \"calculation_param_d\": null,\n \"number_active_alarms\": 0,\n \"has_active_alarms\": false,\n \"text_list\": null,\n \"pending_command\": false,\n \"pending_commands\": [],\n \"pending_mapping_write\": null,\n \"mqtt_qos\": 0,\n \"mqtt_retain\": false,\n \"portal_data\": {},\n \"user_data\": {},\n \"current_value\": null,\n \"reference_id\": \"5c4ee109\"\n },\n \"alarm_trigger_condition\": {\n \"id\": 1,\n \"name\": \"Igualdade\"\n },\n \"limit\": 10,\n \"level\": \"LL\",\n \"enabled\": true,\n \"acknowledgment_enabled\": true,\n \"alarm_current_state\": {\n \"alarm_state\": {\n \"id\": 1,\n \"number\": 0,\n \"name\": \"NORMAL\"\n },\n \"datetime_last_transition\": null,\n \"datetime_last_activation\": null,\n \"datetime_last_acknowledgment\": null,\n \"state\": false,\n \"acknowledgment_state\": false,\n \"pending_command\": false,\n \"pending_commands\": []\n },\n \"notification_enabled\": true,\n \"history_enabled\": true,\n \"portal_data\": {},\n \"user_data\": {},\n \"reference_id\": \"c96287ab\"\n}"}],"_postman_id":"407cb594-cedb-40ed-881c-75962da6e654"}],"id":"f930d471-858c-4382-93f5-de5d0abdbfa6","description":"

Alarme é a entidade responsável por definir uma condição de anomalia no contexto do Portal de Telemetria considerando o valor de um Dado(para que então seja gerado um evento de alerta no Portal).

Saiba mais sobre Alarmes no Manual do Portal de Telemetria.

\n","_postman_id":"f930d471-858c-4382-93f5-de5d0abdbfa6"},{"name":"Gerência de Usuários e Controle de Acesso","item":[{"name":"Realizar Login e Obter Token","event":[{"listen":"test","script":{"exec":["pm.collectionVariables.set('user_token', pm.response.json().token)\r","pm.collectionVariables.set('user_id', pm.response.json().id)\r","pm.collectionVariables.set('contract_id', pm.response.json().is_member_contracts[0].id)"],"type":"text/javascript","id":"224c166e-c419-4432-beee-0afc3870d081"}}],"id":"f188a970-6d3c-4e81-a466-33f505559624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"email@email.com\",\r\n \"password\": \"(senhaembase64)\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login/","description":"

Valida as credenciais de acesso ao Portal de Telemetria (usuário/e-mail e senha) e retorna a token para ser utilizada no cabeçalho das próximas requisições conforme padrão abaixo:

\n
Authorization: Bearer valordatoken
\n

Requer renovação pelo endpoint https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login_refresh/ sempre que exceder a data de expiração da token.

Atenção: A senha deve sempre ser informada já codificada em base 64.

\n","urlObject":{"path":["auth","login",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"d177062f-6834-4e1f-bd1e-e32feeba043b","name":"Realizar Login e Obter Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"teste@hitecnologia.com.br\",\r\n \"password\": \"senhaembase64\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 16:41:15 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"9260"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"token\": \"eyJ0XXXYYYZZZ1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6InN1cG9ydGVAaGl0ZWNub2xvZ2lhLmNvbS5iciIsImlhdCI6MTY0NzM1MDIzOXXXYYYZZZoxNjQ3MzY0NjM5LCJqdGkiOiJkYWU3YjEwZS1hYWU1LTRmODMtYTJlNS1hNTZlNDRjMDllN2IiLXXXYYYZZZlkIjozNSwib3JpZ19pYXQiOjE2NDczNTAyMzl9.MgktPVHnZ-kZviTReCczXILo_nK-9qXXXYYYZZZQ2P4\",\n \"expiration_at\": \"2022-03-15T17:17:19+00:00\",\n \"refresh_expiration_at\": \"2022-03-16T13:17:19+00:00\",\n \"id\": 99,\n \"etag\": \"\\\"e7dfeaa133da3e903c67ceadc32498b3\\\"\",\n \"email\": \"teste@hitecnologia.com.br\",\n \"first_name\": \"Teste\",\n \"last_name\": \"Sobrenome Teste\",\n \"is_active\": true,\n \"is_public_access\": false,\n \"last_login\": \"2022-01-28T18:45:24.286316+00:00\",\n \"date_joined\": \"2020-04-15T18:32:50+00:00\",\n \"user_profile\": {\n \"id\": 99,\n \"daily_summary\": true,\n \"email_notifications\": true,\n \"requires_password_change\": false,\n \"blocks_password_change\": false,\n \"contract\": {\n \"id\": 99,\n \"owner_id\": 999,\n \"name\": \"teste\",\n \"description\": \"teste\"\n },\n \"portal_data\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"datetimeFormat\": \"L LTS\",\n \"refreshInterval\": 30000,\n \"defaultDashboardTab\": \"station-report\"\n },\n \"user_data\": null\n },\n \"is_member_contracts\": [\n {\n \"id\": 99,\n \"owner_id\": 99,\n \"name\": \"Contrato Teste A\",\n \"description\": \"Descrição Contrato Teste A\"\n },\n {\n \"id\": 999,\n \"owner_id\": 999,\n \"name\": \"Contrato Teste B\",\n \"description\": \"Descrição Contrato Teste B\"\n }\n ],\n \"allowed_permissions\": [\n {\n \"contract_id\": 99,\n \"process_areas\": [\n {\n \"id\": 999,\n ...\n }\n ]\n },\n {\n \"contract_id\": 99,\n \"process_areas\": [\n {\n \"id\": 999,\n ...\n }\n ]\n }\n ]\n}"}],"_postman_id":"f188a970-6d3c-4e81-a466-33f505559624"},{"name":"Atualizar Token","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"f5f239ad-0f46-40c2-a5ce-1ecde8a96521"}}],"id":"32bfbaef-2332-461a-9087-17e87fba17dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"(user_token)\"\n}"},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login_refresh/","description":"

Atualiza o token de autenticação do usuário, retornando datas de vencimento novas para expiration_at e refresh_expiration_at.

\n","urlObject":{"path":["auth","login_refresh",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"6b2e58a7-d8a3-4e1e-93a7-4c345599ced5","name":"Atualizar Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer tokendousuario","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/login_refresh/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 16:13:28 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"464"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtXXXYYYZZZG9ydGVAaGl0ZWNub2xvZ2lhLmNvbS5iciIsImlhdCI6MTY0NzM1XXXYYYZZZXhwIjoxNjQ3MzY2ODM3LCJqdGkiOiI2ZDNjMGEwYXXXYYYZZZQ0MTgtOTk3NC1hZTNiZDBXXXYYYZZZLCJ1c2VyX2lkIjozNSwib3JpZ19pYXQiOjE2NDczNTI0MzcsIm9XXXYYYZZZIjoiZGFlN2IxMGUtYWFlNS00ZjgzLWEyZTUtXXXYYYZZZzA5ZTdiIn0.8LO7vXXXYYYZZZnl5246wWZdXVDUbCnQ7QybEsjA2FA\",\n \"expiration_at\": \"2022-03-15T17:53:57+00:00\",\n \"refresh_expiration_at\": \"2022-03-16T13:53:57+00:00\"\n}"}],"_postman_id":"32bfbaef-2332-461a-9087-17e87fba17dd"},{"name":"Realizar Logout","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"391bc66a-9605-44c6-94f6-c5778920b223"}}],"id":"725164d1-ce1b-4966-a546-005413212ee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer (user_token)"}],"body":{"mode":"raw","raw":""},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/logout/","description":"

Realiza a invalidação de um token e sua desconexão do Portal de Telemetria.

\n","urlObject":{"path":["auth","logout",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"2b9f94d5-840a-4199-b2ad-909a829c4a46","name":"Realizar Logout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer tokendousuario"}],"body":{"mode":"raw","raw":""},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/logout/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 16:15:00 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"301"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGXXXYYYZZZ1NiJ9.eyJ1c2VybmFtZSI6InN1cG9ydGVAXXXYYYZZZ2xvZ2lhLmNvbS5iciIsImlXXXYYYZZZM2MDc1OCwiZXhwIjoxNjQ3Mzc1MTXXXYYYZZZiOiIwZDJlMzQzZi1lY2XXXYYYZZZtOTVmMS04OTMwYThlZXXXYYYZZZJ1c2VyX2lkIjozNSwib3JpZ19pYXQiOjE2NDcXXXYYYZZZ.1CvaZcMGnX-0eS8kYxh9XXXYYYZZZ2IHZtfuIy9e3dI\"\n}"}],"_postman_id":"725164d1-ce1b-4966-a546-005413212ee8"},{"name":"Listagem de Usuários","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"fb907d9a-fcc7-4b3f-8cf1-59887e522eb9"}}],"id":"c1e2c005-4ab0-4652-95f0-d10dc32e1166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/users/?contract_id=(contract_id)","description":"

Retorna uma lista detalhada dos usuários conforme a permissão do usuário que fez a requisição.

\n","urlObject":{"path":["auth","users",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"}],"variable":[]}},"response":[{"id":"692e5b59-ad29-40a7-aa30-ebfe8243461f","name":"Listagem de Usuários","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer tokendousuario","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/users/?contract_id=10","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["auth","users",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 16:26:12 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"82993"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99,\n \"etag\": \"\\\"50XXXYYYZZZ4bdf3ad451924a915ac9f\\\"\",\n \"email\": \"teste@hitecnologia.com.br\",\n \"first_name\": \"Nome do Usuário Teste\",\n \"last_name\": \"Sobrenome do Usuário Teste\",\n \"is_active\": true,\n \"is_public_access\": false,\n \"last_login\": \"2021-08-05T16:13:04.100112+00:00\",\n \"date_joined\": \"2021-07-26T18:59:04+00:00\",\n \"user_profile\": {\n \"id\": 99,\n \"daily_summary\": false,\n \"email_notifications\": false,\n \"requires_password_change\": false,\n \"blocks_password_change\": false,\n \"contract\": {\n \"id\": 99,\n \"owner_id\": 999,\n \"name\": \"Contrato Teste\",\n \"description\": \"Descrição Contrato Teste\"\n },\n \"portal_data\": null,\n \"user_data\": null\n },\n \"is_member_contracts\": [\n {\n \"id\": 99,\n \"owner_id\": 999,\n \"name\": \"Contrato Teste\",\n \"description\": \"Descrição Contrato Teste\"\n }\n ],\n \"allowed_permissions\": [\n {\n \"contract_id\": 99,\n \"process_areas\": [\n ...\n ]\n }\n ]\n },\n ...\n]"}],"_postman_id":"c1e2c005-4ab0-4652-95f0-d10dc32e1166"},{"name":"Detalhe de Usuário","event":[{"listen":"test","script":{"exec":["pm.collectionVariables.set('user_etag', pm.response.json().etag)"],"type":"text/javascript","id":"a645004f-5fad-40c8-9ad1-1d220a15ad30"}}],"id":"1c0a5929-7d28-43fb-8716-5addff4f4f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/users/(user_id)/","description":"

Detalhes do usuário.

\n","urlObject":{"path":["auth","users","(user_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"116883b3-7e56-497b-ba7e-86c0997860f0","name":"Detalhe de Usuário","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer tokendousuario","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/auth/users/(user_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 16:28:08 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"2f39f28f75ef742c0c9f0864c10348ee\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"11368"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 99,\n \"etag\": \"\\\"e7dfXXXYYYZZZe903c67ceadc32498b3\\\"\",\n \"email\": \"teste@hitecnologia.com.br\",\n \"first_name\": \"Nome do Usuário Teste\",\n \"last_name\": \"Sobrenome do Usuário Teste\",\n \"is_active\": true,\n \"is_public_access\": false,\n \"last_login\": \"2022-03-15T14:06:29.617484+00:00\",\n \"date_joined\": \"2020-04-15T18:32:50+00:00\",\n \"user_profile\": {\n \"id\": 999,\n \"daily_summary\": true,\n \"email_notifications\": true,\n \"requires_password_change\": false,\n \"blocks_password_change\": false,\n \"contract\": {\n \"id\": 99,\n \"owner_id\": 999,\n \"name\": \"Contrato Teste\",\n \"description\": \"Descrição Contrato Teste\"\n },\n \"portal_data\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"datetimeFormat\": \"L LTS\",\n \"refreshInterval\": 30000,\n \"defaultDashboardTab\": \"station-report\"\n },\n \"user_data\": null\n },\n \"is_member_contracts\": [\n {\n \"id\": 99,\n \"owner_id\": 999,\n \"name\": \"Contrato Teste\",\n \"description\": \"Descrição Contrato Teste\"\n },\n ...\n ],\n \"allowed_permissions\": [\n ...\n ]\n}"}],"_postman_id":"1c0a5929-7d28-43fb-8716-5addff4f4f17"},{"name":"Listagem de Áreas de Processo","id":"2543a971-c0f3-46a8-9f2c-13220b501d0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/process_areas/?contract_id=(contract_id)","description":"

Retorna uma lista detalhada das Áreas de Processo conforme a permissão do usuário que fez a requisição.

\n","urlObject":{"path":["process_areas",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"}],"variable":[]}},"response":[{"id":"1aa37b0c-9486-4798-ad78-6161b6afa90c","name":"Listagem de Áreas de Processo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/process_areas/?contract_id=10","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["process_areas",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 17:25:53 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"2707"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99,\n \"etag\": \"\\\"dfae6XXXac9a1dfb86749ad9b0e10b86\\\"\",\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 99,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n },\n ...\n]"}],"_postman_id":"2543a971-c0f3-46a8-9f2c-13220b501d0f"},{"name":"Detalhe de Área de Processo","event":[{"listen":"test","script":{"exec":["pm.collectionVariables.set('process_area_id', pm.response.json().id)\r","pm.collectionVariables.set('process_area_etag', pm.response.json().etag)"],"type":"text/javascript","id":"0d86ea55-e5a0-48b3-91bc-808b542a4e1d"}}],"id":"a4f215fe-7f89-4b30-9603-fd22ca94e762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/process_areas/(process_area_id)/","description":"

Detalhes da Área de Processo.

\n","urlObject":{"path":["process_areas","(process_area_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"disabled":true,"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"}],"variable":[]}},"response":[{"id":"7a3133b1-685b-4359-8613-9613caf95d28","name":"Detalhe de Área de Processo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/process_areas/(process_area_id)/","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["process_areas","(process_area_id)",""],"query":[{"key":"contract_id","value":"0","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 17:36:15 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"e96b25b29341456d5f4872e5e9fc8209\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"208"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 99,\n \"etag\": \"\\\"e96b2XXx341456d5f4872e5e9fc8209\\\"\",\n \"name\": \"Área de Processo Teste\",\n \"description\": \"Descrição Área de Processo Teste\",\n \"contract_id\": 99,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true\n}"}],"_postman_id":"a4f215fe-7f89-4b30-9603-fd22ca94e762"},{"name":"Listagem de Grupos de Usuário","id":"8cf120f7-068b-4dc8-be2c-629e45a9abbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/user_groups/?contract_id=(contract_id)","description":"

Retorna uma lista detalhada dos Grupos de Usuário conforme a permissão do usuário que fez a requisição.

\n","urlObject":{"path":["user_groups",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[{"description":{"content":"

ID do Contrato

\n","type":"text/plain"},"key":"contract_id","value":"(contract_id)"}],"variable":[]}},"response":[{"id":"97b71358-d6eb-42ce-b8c6-598f5e582a15","name":"Listagem de Grupos de Usuário","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":{"raw":"https://api.telemetria.hitecnologia.com.br/rest/v1/user_groups/?contract_id=10","host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"path":["user_groups",""],"query":[{"key":"contract_id","value":"10","description":"ID do Contrato"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 17:48:27 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"10487"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 99,\n \"etag\": \"\\\"bd8a6738XXX39fa7e92cb47e629bab01\\\"\",\n \"name\": \"Grupo de Usuário Teste\",\n \"description\": \"Descrição Grupo de Usuário Teste\",\n \"contract_id\": 99,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": false,\n \"portal_permissions\": [\n {\n \"id\": 99,\n \"name\": \"EQUIPAMENTO-ACESSO\"\n },\n ...\n ],\n \"blocked_permissions\": [\n {\n \"id\": 999,\n \"name\": \"LISTA DE TEXTO - CADASTRO\"\n },\n ...\n ]\n },\n ...\n]"}],"_postman_id":"8cf120f7-068b-4dc8-be2c-629e45a9abbe"},{"name":"Detalhe de Grupo de Usuário","event":[{"listen":"test","script":{"exec":["pm.collectionVariables.set('user_group_id', pm.response.json().id)\r","pm.collectionVariables.set('user_group_etag', pm.response.json().etag)"],"type":"text/javascript","id":"97216be2-6fed-408a-9782-b29ddbe9922d"}}],"id":"eaa74ef3-7a15-403e-83df-cfa2a35232b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/user_groups/(user_group_id)/","description":"

Retorna uma lista detalhada dos Grupos de Usuário conforme a permissão do usuário que fez a requisição.

\n","urlObject":{"path":["user_groups","(user_group_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"cb9307a2-d01d-4342-a581-e69533e3fe5e","name":"Detalhe de Grupo de Usuário","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer (user_token)","type":"text"}],"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/user_groups/(user_group_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Mar 2022 17:58:35 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"5b4acfb66e1dc4daef415024371ccf49\""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 99,\n \"etag\": \"\\\"5b4XXXb66e1dc4daef415024371ccf49\\\"\",\n \"name\": \"Grupo de Usuário Teste\",\n \"description\": \"Descrição Grupo de Usuário Teste\",\n \"contract_id\": 999,\n \"is_system\": false,\n \"is_default\": false,\n \"allowed_remove\": true,\n \"portal_permissions\": [\n {\n \"id\": 99,\n \"name\": \"EQUIPAMENTO-CADASTRO\"\n },\n ...\n ],\n \"blocked_permissions\": []\n}"}],"_postman_id":"eaa74ef3-7a15-403e-83df-cfa2a35232b5"},{"name":"Ativar/Desativar Usuário","event":[{"listen":"test","script":{"exec":["pm.collectionVariables.set('user_etag', pm.response.json().etag)"],"type":"text/javascript","packages":{},"requests":{},"id":"cde28c57-d4ba-43e4-b73d-312afd79e253"}}],"id":"07bee563-e263-4848-987c-48ac3e75da2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"If-Match","value":"(user_etag)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"is_active\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/contracts/(contract_id)/member_users/(user_id)/","description":"

Ativa ou desativa o acesso de um usuário dentro do sistema.

Um usuário desativado não consegue realizar o login.

Conteúdo da requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atributo	Tipo	Descrição
is_active	Booleano	Define a ativação do acesso do usuário. O valor `true` ativa o acesso do usuário e o valor `false` desativa.

Atenção! Este endpoint utiliza um código chamado ETAG para controle e segurança na alteração de recursos. Para obter o ETAG necessário para esta requisição, primeiro realize a requisição de \"Detalhe de Usuário\" e armazene o valor retornado no campo \"etag\" (por exemplo, \"56a709eb72ff3ab2c293ef5c848af755\", incluindo as aspas). Esse valor deve ser preenchido no cabeçalho (header) desta requisição como valor para a chave If-Match.

\n","urlObject":{"path":["contracts","(contract_id)","member_users","(user_id)",""],"host":["https://api.telemetria.hitecnologia.com.br/rest/v1"],"query":[],"variable":[]}},"response":[{"id":"f99fabf4-023d-4001-84ae-20644c1507b4","name":"Ativar/Desativar Usuário","originalRequest":{"method":"PATCH","header":[{"key":"If-Match","value":"(user_etag)","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"is_active\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.telemetria.hitecnologia.com.br/rest/v1/contracts/(contract_id)/member_users/(user_id)/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 11 Dec 2025 19:31:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.9"},{"key":"Content-Type","value":"application/json"},{"key":"ETag","value":"\"8488d918265a65537432ffb989a09540\""},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PATCH, DELETE"},{"key":"Permissions-Policy","value":"geolocation=(), microphone=(), camera=(), payment=(), usb=(), magnetometer=(), gyroscope=(), accelerometer=()"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"2501"},{"key":"Content-Security-Policy","value":"frame-src 'self' https://www.google.com; base-uri 'self'; img-src 'self' data:; default-src 'self'; object-src 'none'; script-src 'self' https://www.google.com https://www.gstatic.com; form-action 'self'; font-src 'self' https://use.fontawesome.com https://use.typekit.net data: https://fonts.googleapis.com https://fonts.gstatic.com; connect-src 'self'; style-src 'self' https://use.fontawesome.com; frame-ancestors 'none'"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9999,\n \"etag\": \"\\\"8488d918265a65537432ffb989a09540\\\"\",\n \"email\": \"email@email.com\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"is_active\": false,\n ...\n}"}],"_postman_id":"07bee563-e263-4848-987c-48ac3e75da2c"}],"id":"35acb4b5-46f1-4f65-bb48-9dd4ef7ead07","description":"

Os usuários são entidades criadas pelo dono do Contrato no Portal de Telemetria ou por usuários de sistema. Os endpoints a seguir descrevem algumas das atividades possíveis de serem feitas com essa entidade.

Atenção: conforme citado na introdução desta documentação, o Portal utiliza dois métodos de autenticação: Autenticação básica(Basic Authentication) ou via tokens JWT(JSON Web Tokens). Caso se deseje utilizar a autenticação básica(fornecendo o usuário e senha em todas as requisições), não é necessário utilizar os endpoints abaixo que lidam com a autenticação de usuário e manutenção de seu login.

\n","_postman_id":"35acb4b5-46f1-4f65-bb48-9dd4ef7ead07"}],"event":[{"listen":"prerequest","script":{"id":"3547815f-e0b1-46d2-8095-c672bc1d0236","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a003e50-e147-427f-8ec4-22b1ee766ac8","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.telemetria.hitecnologia.com.br/rest/","type":"string"},{"key":"rest_version","value":"v1","type":"string"},{"key":"username","value":"email@email.com","type":"string"},{"key":"password","value":"(senhaembase64)","type":"string"},{"key":"user_token","value":"(user_token)","type":"string"},{"key":"user_id","value":"(user_id)"},{"key":"user_etag","value":"(user_etag)"},{"key":"contract_id","value":"(contract_id)"},{"key":"process_area_id","value":"(process_area_id)"},{"key":"process_area_etag","value":"(process_area_etag)"},{"key":"user_group_id","value":"(user_group_id)"},{"key":"user_group_etag","value":"(user_group_etag)"},{"key":"connector_id","value":"(connector_id)"},{"key":"connector_etag","value":"(connector_etag)"},{"key":"device_id","value":"(device_id)"},{"key":"device_etag","value":"(device_etag)"},{"key":"data_id","value":"(data_id)"},{"key":"data_etag","value":"(data_etag)"},{"key":"device_duplicated_id","value":"(device_duplicated_id)"},{"key":"device_duplicated_etag","value":"(device_duplicated_etag)"},{"key":"alarm_id","value":"(alarm_id)"},{"key":"alarm_etag","value":"(alarm_etag)"},{"key":"data_duplicated_id","value":"(data_duplicated_id)"},{"key":"data_duplicated_etag","value":"(data_duplicated_etag)"},{"key":"alarm_duplicated_id","value":"(alarm_duplicated_id)"},{"key":"alarm_duplicated_etag","value":"(alarm_duplicated_etag)"},{"key":"command_data_write_id","value":"(command_data_write_id)"},{"key":"reference_id","value":"8a92fd7f"},{"key":"data_reference_id","value":"6079cb5g"},{"key":"data_reference_id_2","value":"d21nk89e"},{"key":"data_reference_id_1","value":"6079cb5g"},{"key":"data_id_1","value":"9998"},{"key":"data_id_2","value":"9999"},{"key":"device_reference_id_1","value":"8a92fd7f"},{"key":"device_reference_id_2","value":"a60ie42v"},{"key":"device_id_1","value":"998"},{"key":"device_id_2","value":"999"},{"key":"rconnector_reference_id_1","value":"8292fd7f"},{"key":"connector_reference_id_1","value":"8292fd7f"},{"key":"connector_reference_id_2","value":"b71hf53u"},{"key":"connector_id_1","value":"98"},{"key":"connector_id_2","value":"99"},{"key":"alarm_reference_id_1","value":"1b90fd7f"},{"key":"alarm_reference_id_2","value":"r814p7ac"},{"key":"alarm_id_1","value":"99998"},{"key":"alarm_id_2","value":"99999"},{"key":"system_event_id","value":"(system_event_id)"},{"key":"system_sub_event_id","value":"(system_sub_event_id)"}]}