API Rest do Portal de Telemetria

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

v0

list

GET /rest/v0/

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v0 list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v0", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v0", "list"]
result = client.action(schema, action)

v1

list

GET /rest/v1/

View associada a página principal da API REST V1

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "list"]
result = client.action(schema, action)

alarms > list

GET /rest/v1/alarms/

Obtém a lista de alarmes do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`name`	Texto com o nome do alarme.
`ids`	Valores inteiros separados por virgula com os identificadores dos alarmes.
`connector_id`	Valor inteiro com o identificador do conector associado ao alarme.
`connector_name`	Texto com o nome do conector associado ao alarme.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao alarme.
`device_name`	Texto com o nome do dispositivo associado ao alarme.
`data_id`	Valor inteiro com o identificador do dado associado ao alarme.
`data_ids`	Valores inteiros separados por virgula com os identificadores dos dados.
`data_name`	Texto com o nome do dado associado ao alarme.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao alarme.
`process_area_name`	Texto com o nome da área de processo associada ao alarme.
`contract_id`	Valor inteiro com o identificador do contrato associado ao alarme.
`enabled`	Valor booleano de identificação do estado de habilitação do recurso no sistema.
`base_model`	Valor booleano de identificação se o recurso é de modelo.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name alarm_trigger_condition_name limit level alarm_state_name datetime_last_transition datetime_last_activation datetime_last_acknowledgment state acknowledgment_state process_area_name data_name device_name connector_name data_current_value data_current_value_date_time Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms list -p name=... -p ids=... -p connector_id=... -p connector_name=... -p device_id=... -p device_name=... -p data_id=... -p data_ids=... -p data_name=... -p process_area_id=... -p process_area_name=... -p contract_id=... -p enabled=... -p base_model=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > list"]
var params = {
    name: ...,
    ids: ...,
    connector_id: ...,
    connector_name: ...,
    device_id: ...,
    device_name: ...,
    data_id: ...,
    data_ids: ...,
    data_name: ...,
    process_area_id: ...,
    process_area_name: ...,
    contract_id: ...,
    enabled: ...,
    base_model: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > list"]
params = {
    "name": ...,
    "ids": ...,
    "connector_id": ...,
    "connector_name": ...,
    "device_id": ...,
    "device_name": ...,
    "data_id": ...,
    "data_ids": ...,
    "data_name": ...,
    "process_area_id": ...,
    "process_area_name": ...,
    "contract_id": ...,
    "enabled": ...,
    "base_model": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

alarms > create

POST /rest/v1/alarms/

Cria um alarme no sistema.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do alarme.
`description`	Valor texto com a descrição do alarme
`data_id` required	Valor inteiro com o identificador do dado associado ao alarme.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao alarme.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao alarme deve ser herdada do dado.
`alarm_trigger_condition_id` required	Valor inteiro com o identificador da condição de disparo do alarme.
`limit`	Valor real de limite para ativação do alarme.
`enabled`	Valor booleano que indica se o alarme está habilitado no sistema.
`acknowledgment_enabled`	Valor booleano que indica se o reconhecimento está habilitado para o alarme.
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms create -p name=... -p description=... -p data_id=... -p process_area_id=... -p inherits_parent_process_area=... -p alarm_trigger_condition_id=... -p limit=... -p unity_label=... -p enabled=... -p acknowledgment_enabled=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > create"]
var params = {
    name: ...,
    description: ...,
    data_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    alarm_trigger_condition_id: ...,
    limit: ...,
    unity_label: ...,
    enabled: ...,
    acknowledgment_enabled: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > create"]
params = {
    "name": ...,
    "description": ...,
    "data_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "alarm_trigger_condition_id": ...,
    "limit": ...,
    "unity_label": ...,
    "enabled": ...,
    "acknowledgment_enabled": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

alarms > partial_update

PATCH /rest/v1/alarms/

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > partial_update"]
result = client.action(schema, action)

alarms > read

GET /rest/v1/alarms/{id}/

Obtém os detalhes de configuração de um determinado alarme.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do alarme.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

alarms > partial_update_0

PATCH /rest/v1/alarms/{id}/

Atualiza as informações de configuração de um alarme.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do alarme.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name`	Valor texto com o nome do alarme.
`description`	Valor texto com a descrição do alarme
`data_id`	Valor inteiro com o identificador do dado associado ao alarme.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao alarme.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao alarme deve ser herdada do dado.
`alarm_trigger_condition_id`	Valor inteiro com o identificador da condição de disparo do alarme.
`limit`	Valor real de limite para ativação do alarme.
`enabled`	Valor booleano que indica se o alarme está habilitado no sistema.
`acknowledgment_enabled`	Valor booleano que indica se o reconhecimento está habilitado para o alarme.
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms partial_update_0 -p id=... -p If-Match=... -p name=... -p description=... -p data_id=... -p process_area_id=... -p inherits_parent_process_area=... -p alarm_trigger_condition_id=... -p limit=... -p unity_label=... -p enabled=... -p acknowledgment_enabled=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > partial_update_0"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    data_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    alarm_trigger_condition_id: ...,
    limit: ...,
    unity_label: ...,
    enabled: ...,
    acknowledgment_enabled: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > partial_update_0"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "data_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "alarm_trigger_condition_id": ...,
    "limit": ...,
    "unity_label": ...,
    "enabled": ...,
    "acknowledgment_enabled": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

alarms > delete

DELETE /rest/v1/alarms/{id}/

Remove um determinado alarme da base de alarmes.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do alarme.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

alarms > clear_history > create

POST /rest/v1/alarms/{id}/clear_history/

Remove os registros de históricos de um alarme do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do alarme a serem removidos os registros do(s) histórico(s).

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`history_type` required	Valor texto com o tipo do histórico a serem removidos os registros. Valor para cada tipo: alarms ou all: histórico de alarmes;
`reason` required	Valor texto com a descrição do motivo para remoção dos registros do(s) histórico(s). Este registro poderá ser consultado posteriormente no histórico de eventos do sistema.
`cutting_datetime`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de corte para remoção de registros do(s) histórico(s). Ou seja, todos os registros iguais ou anteriores a data/hora fornecida serão removidos. Caso não seja fornecido este parâmetro, todos os registros serão removidos do(s) histórico(s) para o recurso selecionado.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms clear_history create -p id=... -p history_type=... -p reason=... -p cutting_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > clear_history > create"]
var params = {
    id: ...,
    history_type: ...,
    reason: ...,
    cutting_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > clear_history > create"]
params = {
    "id": ...,
    "history_type": ...,
    "reason": ...,
    "cutting_datetime": ...,
}
result = client.action(schema, action, params=params)

alarms > duplicate > create

POST /rest/v1/alarms/{id}/duplicate/

Duplica o cadastro de um alarme no Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do alarme a ser duplicado.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do alarme utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do alarme.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do alarme.
`description`	Valor texto com a descrição do alarme
`data_id`	Valor inteiro com o identificador do dado associado ao alarme.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao alarme.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao alarme deve ser herdada do dado.
`alarm_trigger_condition_id`	Valor inteiro com o identificador da condição de disparo do alarme.
`limit`	Valor real de limite para ativação do alarme.
`enabled`	Valor booleano que indica se o alarme está habilitado no sistema.
`acknowledgment_enabled`	Valor booleano que indica se o reconhecimento está habilitado para o alarme.
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.
`data`	Dado relativo ao comando.
`alarm`	Alarme relativo ao comando.
`value`	Valor relativo ao comando.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms duplicate create -p id=... -p If-Match=... -p name=... -p description=... -p data_id=... -p process_area_id=... -p inherits_parent_process_area=... -p alarm_trigger_condition_id=... -p limit=... -p unity_label=... -p enabled=... -p acknowledgment_enabled=... -p portal_data=... -p user_data=... -p data=... -p alarm=... -p value=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms > duplicate > create"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    data_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    alarm_trigger_condition_id: ...,
    limit: ...,
    unity_label: ...,
    enabled: ...,
    acknowledgment_enabled: ...,
    portal_data: ...,
    user_data: ...,
    data: ...,
    alarm: ...,
    value: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms > duplicate > create"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "data_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "alarm_trigger_condition_id": ...,
    "limit": ...,
    "unity_label": ...,
    "enabled": ...,
    "acknowledgment_enabled": ...,
    "portal_data": ...,
    "user_data": ...,
    "data": ...,
    "alarm": ...,
    "value": ...,
}
result = client.action(schema, action, params=params)

alarms_history > list

GET /rest/v1/alarms_history/

Obtém a lista do histórico de eventos dos alarmes do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`connector_id`	Valor inteiro com o identificador do conector associado ao alarme do histórico.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao alarme do histórico.
`data_id`	Valor inteiro com o identificador do dado associado ao alarme do histórico.
`alarm_id`	Valor inteiro com o identificador do alarme associado ao histórico.
`alarm_ids`	Valores inteiros com os identificadores dos alarmes associados ao histórico.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao alarme do histórico.
`contract_id`	Valor inteiro com o identificador do contrato associado ao alarme do histórico.
`start`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-01 08:00:00) de início para recuperação de registros no histórico.
`end`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de fim para recuperação de registros no histórico.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: date_time_event date_time_alarm_activate alarm_trigger_condition alarm_limit alarm_level alarm_value alarm_state_name system_event_name system_sub_event_name alarm_name data_name user_email Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 alarms_history list -p connector_id=... -p device_id=... -p data_id=... -p alarm_id=... -p alarm_ids=... -p process_area_id=... -p contract_id=... -p start=... -p end=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "alarms_history > list"]
var params = {
    connector_id: ...,
    device_id: ...,
    data_id: ...,
    alarm_id: ...,
    alarm_ids: ...,
    process_area_id: ...,
    contract_id: ...,
    start: ...,
    end: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "alarms_history > list"]
params = {
    "connector_id": ...,
    "device_id": ...,
    "data_id": ...,
    "alarm_id": ...,
    "alarm_ids": ...,
    "process_area_id": ...,
    "contract_id": ...,
    "start": ...,
    "end": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

POST /rest/v1/auth/login/

Recebe um conjunto de credenciais do usuário e retorna um token no formato JWT (JSON Web Token) ou recebe um JWT via o cabeçalho da requisição e retorna as informações do usuário associado o token. O token gerado tem validade de 4 HORAS e pode ser renovado por até 1 DIA através do endpoint de refresh

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`Authorization`	Deve ser fornecido um JSON Web Token(JWT) válido para o login em que se deseja obter as informações do usuário associado ao token. Utilize essa alternativa em relação ao login via credenciais do usuário.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`email` required	Valor texto com o endereço de e-mail do usuário.
`password` required	Valor texto codificado em Base64 contendo a senha do usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth login create -p Authorization=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > login > create"]
var params = {
    Authorization: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > login > create"]
params = {
    "Authorization": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

auth > login_refresh > create

POST /rest/v1/auth/login_refresh/

Recebe um token no formato JWT (JSON Web Token) e retorna um novo token atualizado.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`token` required	JSON Web Token(JWT) válido para o login em que se deseja atualizar a data de expiração do token.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth login_refresh create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > login_refresh > create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > login_refresh > create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

auth > logout > create

POST /rest/v1/auth/logout/

Recebe um token no formato JWT (JSON Web Token) associado ao usuário que se deseja realizar o logout.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`token` required	JSON Web Token(JWT) válido para o login que se deseja realizar o logout.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth logout create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > logout > create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > logout > create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

auth > password_change > create

POST /rest/v1/auth/password_change/

Realiza a troca de senha de um usuário do Portal de Telemetria.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`old_password` required	Valor texto codificado em Base64 contendo a senha atual do usuário.
`new_password1` required	Valor texto codificado em Base64 contendo a nova senha do usuário.
`new_password2` required	Valor texto codificado em Base64 contendo a confirmação da nova senha do usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth password_change create -p old_password=... -p new_password1=... -p new_password2=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > password_change > create"]
var params = {
    old_password: ...,
    new_password1: ...,
    new_password2: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > password_change > create"]
params = {
    "old_password": ...,
    "new_password1": ...,
    "new_password2": ...,
}
result = client.action(schema, action, params=params)

auth > users > list

GET /rest/v1/auth/users/

Obtém a lista de usuários do Portal de Telemetria.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`contract_id`	Valor inteiro com o identificador do contrato associado aos usuários.
`contract_ids`	Lista contendo os valores inteiros de identificação dos usuários.
`email`	Valor texto com o endereço de email do usuário.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id email first_name last_name is_active last_login date_joined Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth users list -p contract_id=... -p contract_ids=... -p email=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > users > list"]
var params = {
    contract_id: ...,
    contract_ids: ...,
    email: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > users > list"]
params = {
    "contract_id": ...,
    "contract_ids": ...,
    "email": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

auth > users > read

GET /rest/v1/auth/users/{id}/

Obtém os detalhes de configuração de um usuário.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth users read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > users > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > users > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

auth > users > partial_update

PATCH /rest/v1/auth/users/{id}/

Atualiza as informações de configuração de um determinado usuário.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do usuário.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`first_name`	Valor texto com o nome do usuário.
`last_name`	Valor texto com o sobrenome do usuário.
`user_profile`	Objeto JSON com a definição de informações de profile do usuário.
`associated_permissions`	Objeto JSON com as definições das informações de permissões do usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 auth users partial_update -p id=... -p If-Match=... -p first_name=... -p last_name=... -p user_profile=... -p associated_permissions=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "auth > users > partial_update"]
var params = {
    id: ...,
    If-Match: ...,
    first_name: ...,
    last_name: ...,
    user_profile: ...,
    associated_permissions: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "auth > users > partial_update"]
params = {
    "id": ...,
    "If-Match": ...,
    "first_name": ...,
    "last_name": ...,
    "user_profile": ...,
    "associated_permissions": ...,
}
result = client.action(schema, action, params=params)

commands > list

GET /rest/v1/commands/

Obtém a lista de comandos sobre recursos do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`command_type_id`	Valor inteiro com o identificador do do tipo associado ao comando.
`data_id`	Valor inteiro com o identificador do do dado associado ao comando.
`alarm_id`	Valor inteiro com o identificador do do alarme associado ao comando.
`command_state_id`	Valor inteiro com o identificador do do estado associado ao comando.
`command_result_id`	Valor inteiro com o identificador do do resultado associado ao comando.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 commands list -p command_type_id=... -p data_id=... -p alarm_id=... -p command_state_id=... -p command_result_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "commands > list"]
var params = {
    command_type_id: ...,
    data_id: ...,
    alarm_id: ...,
    command_state_id: ...,
    command_result_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "commands > list"]
params = {
    "command_type_id": ...,
    "data_id": ...,
    "alarm_id": ...,
    "command_state_id": ...,
    "command_result_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

commands > create

POST /rest/v1/commands/

Cria um comando sobre recursos do sistema.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`command_type_id` required	Valor inteiro com o identificador do tipo de commando.
`parameters` required	Objeto JSON com a definição dos parâmetros do comando de acordo com seu tipo.
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 commands create -p command_type_id=... -p parameters=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "commands > create"]
var params = {
    command_type_id: ...,
    parameters: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "commands > create"]
params = {
    "command_type_id": ...,
    "parameters": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

commands > read

GET /rest/v1/commands/{id}/

Obtém os detalhes de configuração de um comando,

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do comando.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 commands read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "commands > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "commands > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

commands > partial_update

PATCH /rest/v1/commands/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do comando.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 commands partial_update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "commands > partial_update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "commands > partial_update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

commands > delete

DELETE /rest/v1/commands/{id}/

Remove um determinado comando da base de dados.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do comando.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 commands delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "commands > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "commands > delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

connectors > list

GET /rest/v1/connectors/

Obtém a lista de conectores do Portal de Telemetria.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`name`	Texto com o nome do conector.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao conector.
`process_area_name`	Texto com o nome da área de processo associada ao conector.
`contract_id`	Valor inteiro com o identificador do contrato associado ao conector.
`enabled`	Valor booleano de identificação do estado de habilitação do recurso no sistema.
`base_model`	Valor booleano de identificação se o recurso é de modelo.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name location enabled serial_number connector_status_name number_active_alarms process_area_name Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors list -p name=... -p process_area_id=... -p process_area_name=... -p contract_id=... -p enabled=... -p base_model=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > list"]
var params = {
    name: ...,
    process_area_id: ...,
    process_area_name: ...,
    contract_id: ...,
    enabled: ...,
    base_model: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > list"]
params = {
    "name": ...,
    "process_area_id": ...,
    "process_area_name": ...,
    "contract_id": ...,
    "enabled": ...,
    "base_model": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

connectors > create

POST /rest/v1/connectors/

Cria um conector no Portal de Telemetria.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do conector.
`description`	Valor texto com a descrição do conector.
`connector_type_id` required	Valor inteiro com o identificador do tipo de conector associado ao conector.
`protocol_id`	Valor inteiro com o identificador do protocolo de comunicação associado ao conector.
`contract_id` required	Valor inteiro com o identificador do contrato associado ao conector.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao conector.
`enabled`	Valor booleano que indica se o conector está habilitado no Portal de Telemetria.
`location_name` required	Valor texto com o nome da localização geográfica do conector.
`location_address`	Objeto JSON com a definição de dados da localização geográfica do conector.
`serial_number` required	Valor texto com a identificação do número de série do conector.
`timezone`	Valor texto com a identificação do timezone associado ao conector.
`updates_datetime`	Valor booleano que indica se o Portal de Telemetria deve atualizar a data/hora do conector.
`optimizes_frames`	Valor booleano que indica se o Portal de Telemetria deve otimizar os frames de comunicação com o conector.
`pooling_interval`	Valor inteiro com a taxa de atualização(em segundos) dos valores de dados associados ao conector. O valor mínimo é de 30 segundos.
`base_model`	Valor booleano que indica se o conector é de modelo(para outros conectores).
`base_model_id`	Valor inteiro com o identificador do conector de modelo associado ao conector.
`apply_changes_to_instances`	Valor booleano que indica se as alterações realizadas no recurso de modelo devem ser aplicadas nos recursos associados(instâncias). Este atributo não é persistido em base de dados.
`portal_data`	Objeto JSON com a definição de dados customizados pelo Portal de Telemetria.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors create -p name=... -p description=... -p connector_type_id=... -p protocol_id=... -p contract_id=... -p process_area_id=... -p enabled=... -p location_name=... -p location_address=... -p serial_number=... -p timezone=... -p updates_datetime=... -p optimizes_frames=... -p pooling_interval=... -p base_model=... -p base_model_id=... -p apply_changes_to_instances=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > create"]
var params = {
    name: ...,
    description: ...,
    connector_type_id: ...,
    protocol_id: ...,
    contract_id: ...,
    process_area_id: ...,
    enabled: ...,
    location_name: ...,
    location_address: ...,
    serial_number: ...,
    timezone: ...,
    updates_datetime: ...,
    optimizes_frames: ...,
    pooling_interval: ...,
    base_model: ...,
    base_model_id: ...,
    apply_changes_to_instances: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > create"]
params = {
    "name": ...,
    "description": ...,
    "connector_type_id": ...,
    "protocol_id": ...,
    "contract_id": ...,
    "process_area_id": ...,
    "enabled": ...,
    "location_name": ...,
    "location_address": ...,
    "serial_number": ...,
    "timezone": ...,
    "updates_datetime": ...,
    "optimizes_frames": ...,
    "pooling_interval": ...,
    "base_model": ...,
    "base_model_id": ...,
    "apply_changes_to_instances": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

connectors > partial_update

PATCH /rest/v1/connectors/

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > partial_update"]
result = client.action(schema, action)

connectors > read

GET /rest/v1/connectors/{id}/

Obtém os detalhes de configuração de um determinado conector.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do conector.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

connectors > partial_update_0

PATCH /rest/v1/connectors/{id}/

Atualiza as informações de configuração de um conector.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do conector.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name`	Valor texto com o nome do conector.
`description`	Valor texto com a descrição do conector.
`connector_type_id`	Valor inteiro com o identificador do tipo de conector associado ao conector.
`protocol_id`	Valor inteiro com o identificador do protocolo de comunicação associado ao conector.
`contract_id`	Valor inteiro com o identificador do contrato associado ao conector.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao conector.
`enabled`	Valor booleano que indica se o conector está habilitado no Portal de Telemetria.
`location_name`	Valor texto com o nome da localização geográfica do conector.
`location_address`	Objeto JSON com a definição de dados da localização geográfica do conector.
`serial_number`	Valor texto com a identificação do número de série do conector.
`timezone`	Valor texto com a identificação do timezone associado ao conector.
`updates_datetime`	Valor booleano que indica se o Portal de Telemetria deve atualizar a data/hora do conector.
`optimizes_frames`	Valor booleano que indica se o Portal de Telemetria deve otimizar os frames de comunicação com o conector.
`pooling_interval`	Valor inteiro com a taxa de atualização(em segundos) dos valores de dados associados ao conector. O valor mínimo é de 30 segundos.
`base_model`	Valor booleano que indica se o conector é de modelo(para outros conectores).
`base_model_id`	Valor inteiro com o identificador do conector de modelo associado ao conector.
`apply_changes_to_instances`	Valor booleano que indica se as alterações realizadas no recurso de modelo devem ser aplicadas nos recursos associados(instâncias). Este atributo não é persistido em base de dados.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors partial_update_0 -p id=... -p If-Match=... -p name=... -p description=... -p connector_type_id=... -p protocol_id=... -p contract_id=... -p process_area_id=... -p enabled=... -p location_name=... -p location_address=... -p serial_number=... -p timezone=... -p updates_datetime=... -p optimizes_frames=... -p pooling_interval=... -p base_model=... -p base_model_id=... -p apply_changes_to_instances=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > partial_update_0"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    connector_type_id: ...,
    protocol_id: ...,
    contract_id: ...,
    process_area_id: ...,
    enabled: ...,
    location_name: ...,
    location_address: ...,
    serial_number: ...,
    timezone: ...,
    updates_datetime: ...,
    optimizes_frames: ...,
    pooling_interval: ...,
    base_model: ...,
    base_model_id: ...,
    apply_changes_to_instances: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > partial_update_0"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "connector_type_id": ...,
    "protocol_id": ...,
    "contract_id": ...,
    "process_area_id": ...,
    "enabled": ...,
    "location_name": ...,
    "location_address": ...,
    "serial_number": ...,
    "timezone": ...,
    "updates_datetime": ...,
    "optimizes_frames": ...,
    "pooling_interval": ...,
    "base_model": ...,
    "base_model_id": ...,
    "apply_changes_to_instances": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

connectors > delete

DELETE /rest/v1/connectors/{id}/

Remove um determinado conector do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do conector.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

connectors > clear_history > create

POST /rest/v1/connectors/{id}/clear_history/

Remove os registros de históricos de um conector do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do conector a serem removidos os registros do(s) histórico(s).

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`history_type` required	Valor texto com o tipo do histórico a serem removidos os registros. Valor para cada tipo: data: histórico de dados; alarms: histórico de alarmes; all: ambos os históricos.
`reason` required	Valor texto com a descrição do motivo para remoção dos registros do(s) histórico(s). Este registro poderá ser consultado posteriormente no histórico de eventos do sistema.
`cutting_datetime`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de corte para remoção de registros do(s) histórico(s). Ou seja, todos os registros iguais ou anteriores a data/hora fornecida serão removidos. Caso não seja fornecido este parâmetro, todos os registros serão removidos do(s) histórico(s) para o recurso selecionado.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors clear_history create -p id=... -p history_type=... -p reason=... -p cutting_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > clear_history > create"]
var params = {
    id: ...,
    history_type: ...,
    reason: ...,
    cutting_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > clear_history > create"]
params = {
    "id": ...,
    "history_type": ...,
    "reason": ...,
    "cutting_datetime": ...,
}
result = client.action(schema, action, params=params)

connectors > duplicate > create

POST /rest/v1/connectors/{id}/duplicate/

Duplica o cadastro de um conector no Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do conector a ser duplicado.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do conector utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do conector.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do novo conector.
`description`	Valor texto com a descrição do conector.
`serial_number` required	Valor texto com a identificação do número de série do novo conector.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao conector.
`enabled`	Valor booleano que indica se o conector está habilitado no Portal de Telemetria.
`location_name`	Valor texto com o nome da localização geográfica do conector.
`location_address`	Objeto JSON com a definição de dados da localização geográfica do conector.
`timezone`	Valor texto com a identificação do timezone associado ao conector.
`contract_id`	Valor inteiro com o identificador do contrato associado ao conector.
`pooling_interval`	Valor inteiro com a taxa de atualização(em segundos) dos valores de dados associados ao conector. O valor mínimo é de 30 segundos.
`base_model`	Valor booleano que indica se o conector é de modelo(para outros conectores).
`base_model_id`	Valor inteiro com o identificador do conector de modelo associado ao conector.
`portal_data`	Objeto JSON com a definição de dados customizados pelo Portal de Telemetria.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 connectors duplicate create -p id=... -p If-Match=... -p name=... -p description=... -p serial_number=... -p process_area_id=... -p enabled=... -p location_name=... -p location_address=... -p timezone=... -p contract_id=... -p pooling_interval=... -p base_model=... -p base_model_id=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "connectors > duplicate > create"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    serial_number: ...,
    process_area_id: ...,
    enabled: ...,
    location_name: ...,
    location_address: ...,
    timezone: ...,
    contract_id: ...,
    pooling_interval: ...,
    base_model: ...,
    base_model_id: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "connectors > duplicate > create"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "serial_number": ...,
    "process_area_id": ...,
    "enabled": ...,
    "location_name": ...,
    "location_address": ...,
    "timezone": ...,
    "contract_id": ...,
    "pooling_interval": ...,
    "base_model": ...,
    "base_model_id": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

contracts > member_users > read

GET /rest/v1/contracts/{contract_id}/member_users/{id}/

Obtém os detalhes de configuração de um determinado membro de um contrato.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contract_id` required	Valor inteiro com o identificador do contrato.
`id` required	Valor inteiro com o identificador do usuário membro.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 contracts member_users read -p contract_id=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "contracts > member_users > read"]
var params = {
    contract_id: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "contracts > member_users > read"]
params = {
    "contract_id": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

contracts > member_users > partial_update

PATCH /rest/v1/contracts/{contract_id}/member_users/{id}/

Atualiza as informações de configuração de um determinado membro de um contrato.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contract_id` required	Valor inteiro com o identificador do contrato.
`id` required	Valor inteiro com o identificador do usuário membro.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`associated_permissions`	Objeto JSON com as definições das informações de permissões do usuário.
`first_name`	Valor texto com o nome do usuário(membro).
`last_name`	Valor texto com o sobrenome do usuário(membro).
`password1`	Valor texto codificado em Base64 contendo a senha do usuário(membro).
`password2`	Valor texto codificado em Base64 contendo a confirmação da senha do usuário(membro).
`requires_password_change`	Valor booleano para indicação de que o usuário(membro) deve alterar a sua senha.
`reason_password_change`	Valor texto para motivo que usuário(membro) deve alterar a sua senha.
`blocks_password_change`	Valor booleano para indicação de que o usuário(membro) poderá alterar a sua senha.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 contracts member_users partial_update -p contract_id=... -p id=... -p If-Match=... -p associated_permissions=... -p first_name=... -p last_name=... -p password1=... -p password2=... -p requires_password_change=... -p reason_password_change=... -p blocks_password_change=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "contracts > member_users > partial_update"]
var params = {
    contract_id: ...,
    id: ...,
    If-Match: ...,
    associated_permissions: ...,
    first_name: ...,
    last_name: ...,
    password1: ...,
    password2: ...,
    requires_password_change: ...,
    reason_password_change: ...,
    blocks_password_change: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "contracts > member_users > partial_update"]
params = {
    "contract_id": ...,
    "id": ...,
    "If-Match": ...,
    "associated_permissions": ...,
    "first_name": ...,
    "last_name": ...,
    "password1": ...,
    "password2": ...,
    "requires_password_change": ...,
    "reason_password_change": ...,
    "blocks_password_change": ...,
}
result = client.action(schema, action, params=params)

contracts > member_users > delete

DELETE /rest/v1/contracts/{contract_id}/member_users/{id}/

Remove um determinado membro de um contrato.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contract_id` required	Valor inteiro com o identificador do contrato.
`id` required	Valor inteiro com o identificador do usuário membro.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 contracts member_users delete -p contract_id=... -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "contracts > member_users > delete"]
var params = {
    contract_id: ...,
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "contracts > member_users > delete"]
params = {
    "contract_id": ...,
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

contracts > member_users > list

GET /rest/v1/contracts/{id}/member_users/

Obtém as listas de membros de um contrato do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contract_id` required	Valor inteiro com o identificador do contrato.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`email`	Valor texto com o endereço de email do membro do contrato.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id email first_name last_name is_active last_login date_joined Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-email
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 contracts member_users list -p contract_id=... -p email=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "contracts > member_users > list"]
var params = {
    contract_id: ...,
    email: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "contracts > member_users > list"]
params = {
    "contract_id": ...,
    "email": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

contracts > member_users > create

POST /rest/v1/contracts/{id}/member_users/

Associa um usuário como membro de um contrato no Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contract_id` required	Valor inteiro com o identificador do contrato.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`email` required	Valor texto com o endereço de e-mail do usuário a ser associado como membro do contrato. Caso o usuário já exista, o mesmo será adicionado como membro do contrato. Caso não, o atributo create_user será verifica para sedeterminar se um usuário deve ser criado para o endereço de e-mail fornecido
`create_user`	Valor booleano para indicação de criação de um usuário associado ao endereço de e-mail fornecido caso não exista um usuário associado ao e-mail. Após a criação do usuário, este será associado como membro do contrato.
`first_name`	Valor texto com o nome do usuário(válido somente se o atributo create_user for fornecido com o valor true).
`last_name`	Valor texto com o sobrenome do usuário(válido somente se o atributo create_user for fornecido com o valor true).
`password1`	Valor texto codificado em Base64 contendo a senha do usuário(válido somente se o atributo create_user for fornecido com o valor true).
`password2`	Valor texto codificado em Base64 contendo a confirmação da senha do usuário(válido somente se o atributo create_user for fornecido com o valor true).
`requires_password_change`	Valor booleano para indicação de que o usuário(membro) deve alterar a sua senha(válido somente se o atributo create_user for fornecido com o valor true).
`reason_password_change`	Valor texto para indicação do motivo que usuário(membro) deve alterar a sua senha(válido somente se o atributo create_user for fornecido com o valor true).
`blocks_password_change`	Valor booleano para indicação de que o usuário(membro) não poderá trocar a sua senha (válido somente se o atributo create_user for fornecido com o valor true).
`associated_permissions`	Objeto JSON com as definições das informações de permissões do usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 contracts member_users create -p contract_id=... -p email=... -p create_user=... -p first_name=... -p last_name=... -p password1=... -p password2=... -p requires_password_change=... -p reason_password_change=... -p blocks_password_change=... -p associated_permissions=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "contracts > member_users > create"]
var params = {
    contract_id: ...,
    email: ...,
    create_user: ...,
    first_name: ...,
    last_name: ...,
    password1: ...,
    password2: ...,
    requires_password_change: ...,
    reason_password_change: ...,
    blocks_password_change: ...,
    associated_permissions: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "contracts > member_users > create"]
params = {
    "contract_id": ...,
    "email": ...,
    "create_user": ...,
    "first_name": ...,
    "last_name": ...,
    "password1": ...,
    "password2": ...,
    "requires_password_change": ...,
    "reason_password_change": ...,
    "blocks_password_change": ...,
    "associated_permissions": ...,
}
result = client.action(schema, action, params=params)

data > list

GET /rest/v1/data/

Obtém a lista de dados do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`name`	Texto com o nome do dado.
`ids`	Valores inteiros separados por virgula com os identificadores dos dados.
`connector_id`	Valor inteiro com o identificador do conector associado ao dado.
`connector_name`	Texto com o nome do conector associado ao dado.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao dado.
`device_name`	Texto com o nome do dispositivo associado ao dado.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado.
`process_area_name`	Texto com o nome da área de processo associada ao dado.
`contract_id`	Valor inteiro com o identificador do contrato associado ao dado.
`enabled`	Valor booleano de identificação do estado de habilitação do recurso no sistema.
`base_model`	Valor booleano de identificação se o recurso é de modelo.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name unity_label process_area_name number_active_alarms device_name connector_name current_value current_value_date_time Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data list -p name=... -p ids=... -p connector_id=... -p connector_name=... -p device_id=... -p device_name=... -p process_area_id=... -p process_area_name=... -p contract_id=... -p enabled=... -p base_model=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > list"]
var params = {
    name: ...,
    ids: ...,
    connector_id: ...,
    connector_name: ...,
    device_id: ...,
    device_name: ...,
    process_area_id: ...,
    process_area_name: ...,
    contract_id: ...,
    enabled: ...,
    base_model: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > list"]
params = {
    "name": ...,
    "ids": ...,
    "connector_id": ...,
    "connector_name": ...,
    "device_id": ...,
    "device_name": ...,
    "process_area_id": ...,
    "process_area_name": ...,
    "contract_id": ...,
    "enabled": ...,
    "base_model": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

data > create

POST /rest/v1/data/

Cria um dado no sistema.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do dado.
`description`	Valor texto com a descrição do dado.
`device_id` required	Valor inteiro com o identificador do dispositivo associado ao dado.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao dado deve ser herdada do dispositivo.
`memory_type_id` required	Valor inteiro com o identificador do tipo de memória associado ao dado.
`memory_address`	Valor inteiro com o endereço do dado.
`unity_label`	Valor texto com a unidade de engenharia associado ao dado.
`value_format_type_id`	Valor inteiro com identificador do tipo de formatação do valor do dado.
`update_value_mode_after_writing_id`	Valor inteiro com identificador do modo de atualização do valor do dado após um comando de escrita.
`read_only`	Valor booleano que indica se o dado é desomente leitura.
`enabled`	Valor booleano que indica se o dado está habilitado no sistema.
`history_enabled`	Valor booleano que indica se o valor do dado de ser historiado pelo sistema.
`source_value_id` required	Valor inteiro com o identificador da fonte de coleta do valor do dado.
`local_storage_identity_number`	Valor inteiro com o identificador da posição do dado no buffer da base local decoleta de dados.
`calculation_type_id`	Valor inteiro com o identificador do tipo de cálculo associado ao dado.
`calculation_param_a`	Valor texto associado ao primeiro parâmetro do tipo de cálculo.
`calculation_param_b`	Valor texto associado ao segundo parâmetro do tipo de cálculo.
`calculation_param_c`	Valor texto associado ao terceiro parâmetro do tipo de cálculo.
`calculation_param_d`	Valor texto associado ao quarto parâmetro do tipo de cálculo.
`text_list_id`	Valor inteiro com o identificador do da lista de texto associado ao dado.
`minimum_value`	Valor real mínimo permitido para o dado(para que o portal possa validar a atualização/coleta do valor do dado)
`maximum_value`	Valor real máximo permitido para o dado(para que o portal possa validar a atualização/coleta do valor do dado)
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data create -p name=... -p description=... -p device_id=... -p process_area_id=... -p inherits_parent_process_area=... -p memory_type_id=... -p memory_address=... -p unity_label=... -p value_format_type_id=... -p update_value_mode_after_writing_id=... -p read_only=... -p enabled=... -p history_enabled=... -p source_value_id=... -p local_storage_identity_number=... -p calculation_type_id=... -p calculation_param_a=... -p calculation_param_b=... -p calculation_param_c=... -p calculation_param_d=... -p text_list_id=... -p minimum_value=... -p maximum_value=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > create"]
var params = {
    name: ...,
    description: ...,
    device_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    memory_type_id: ...,
    memory_address: ...,
    unity_label: ...,
    value_format_type_id: ...,
    update_value_mode_after_writing_id: ...,
    read_only: ...,
    enabled: ...,
    history_enabled: ...,
    source_value_id: ...,
    local_storage_identity_number: ...,
    calculation_type_id: ...,
    calculation_param_a: ...,
    calculation_param_b: ...,
    calculation_param_c: ...,
    calculation_param_d: ...,
    text_list_id: ...,
    minimum_value: ...,
    maximum_value: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > create"]
params = {
    "name": ...,
    "description": ...,
    "device_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "memory_type_id": ...,
    "memory_address": ...,
    "unity_label": ...,
    "value_format_type_id": ...,
    "update_value_mode_after_writing_id": ...,
    "read_only": ...,
    "enabled": ...,
    "history_enabled": ...,
    "source_value_id": ...,
    "local_storage_identity_number": ...,
    "calculation_type_id": ...,
    "calculation_param_a": ...,
    "calculation_param_b": ...,
    "calculation_param_c": ...,
    "calculation_param_d": ...,
    "text_list_id": ...,
    "minimum_value": ...,
    "maximum_value": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

data > partial_update

PATCH /rest/v1/data/

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > partial_update"]
result = client.action(schema, action)

data > read

GET /rest/v1/data/{id}/

Obtém os detalhes de configuração de um determinado dado.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dado.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

data > partial_update_0

PATCH /rest/v1/data/{id}/

Atualiza as informações de configuração de um dado.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dado.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name`	Valor texto com o nome do dado.
`description`	Valor texto com a descrição do dado.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao dado.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao dado deve ser herdada do dispositivo.
`memory_type_id`	Valor inteiro com o identificador do tipo de memória associado ao dado.
`memory_address`	Valor inteiro com o endereço do dado.
`unity_label`	Valor texto com a unidade de engenharia associado ao dado.
`value_format_type_id`	Valor inteiro com identificador do tipo de formatação do valor do dado.
`update_value_mode_after_writing_id`	Valor inteiro com identificador do modo de atualização do valor do dado após um comando de escrita.
`read_only`	Valor booleano que indica se o dado é desomente leitura.
`enabled`	Valor booleano que indica se o dado está habilitado no sistema.
`history_enabled`	Valor booleano que indica se o valor do dado de ser historiado pelo sistema.
`source_value_id`	Valor inteiro com o identificador da fonte de coleta do valor do dado.
`local_storage_identity_number`	Valor inteiro com o identificador da posição do dado no buffer da base local decoleta de dados.
`calculation_type_id`	Valor inteiro com o identificador do tipo de cálculo associado ao dado.
`calculation_param_a`	Valor texto associado ao primeiro parâmetro do tipo de cálculo.
`calculation_param_b`	Valor texto associado ao segundo parâmetro do tipo de cálculo.
`calculation_param_c`	Valor texto associado ao terceiro parâmetro do tipo de cálculo.
`calculation_param_d`	Valor texto associado ao quarto parâmetro do tipo de cálculo.
`text_list_id`	Valor inteiro com o identificador do da lista de texto associado ao dado.
`minimum_value`	Valor real mínimo permitido para o dado(para que o portal possa validar a atualização/coleta do valor do dado)
`maximum_value`	Valor real máximo permitido para o dado(para que o portal possa validar a atualização/coleta do valor do dado)
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data partial_update_0 -p id=... -p If-Match=... -p name=... -p description=... -p device_id=... -p process_area_id=... -p inherits_parent_process_area=... -p memory_type_id=... -p memory_address=... -p unity_label=... -p value_format_type_id=... -p update_value_mode_after_writing_id=... -p read_only=... -p enabled=... -p history_enabled=... -p source_value_id=... -p local_storage_identity_number=... -p calculation_type_id=... -p calculation_param_a=... -p calculation_param_b=... -p calculation_param_c=... -p calculation_param_d=... -p text_list_id=... -p minimum_value=... -p maximum_value=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > partial_update_0"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    device_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    memory_type_id: ...,
    memory_address: ...,
    unity_label: ...,
    value_format_type_id: ...,
    update_value_mode_after_writing_id: ...,
    read_only: ...,
    enabled: ...,
    history_enabled: ...,
    source_value_id: ...,
    local_storage_identity_number: ...,
    calculation_type_id: ...,
    calculation_param_a: ...,
    calculation_param_b: ...,
    calculation_param_c: ...,
    calculation_param_d: ...,
    text_list_id: ...,
    minimum_value: ...,
    maximum_value: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > partial_update_0"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "device_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "memory_type_id": ...,
    "memory_address": ...,
    "unity_label": ...,
    "value_format_type_id": ...,
    "update_value_mode_after_writing_id": ...,
    "read_only": ...,
    "enabled": ...,
    "history_enabled": ...,
    "source_value_id": ...,
    "local_storage_identity_number": ...,
    "calculation_type_id": ...,
    "calculation_param_a": ...,
    "calculation_param_b": ...,
    "calculation_param_c": ...,
    "calculation_param_d": ...,
    "text_list_id": ...,
    "minimum_value": ...,
    "maximum_value": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

data > delete

DELETE /rest/v1/data/{id}/

Remove um determinado dado da base de dados.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dado.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

data > clear_history > create

POST /rest/v1/data/{id}/clear_history/

Remove os registros de históricos de um dado do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dado a serem removidos os registros do(s) histórico(s).

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`history_type` required	Valor texto com o tipo do histórico a serem removidos os registros. Valor para cada tipo: data: histórico de dados; alarms: histórico de alarmes; all: ambos os históricos.
`reason` required	Valor texto com a descrição do motivo para remoção dos registros do(s) histórico(s). Este registro poderá ser consultado posteriormente no histórico de eventos do sistema.
`cutting_datetime`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de corte para remoção de registros do(s) histórico(s). Ou seja, todos os registros iguais ou anteriores a data/hora fornecida serão removidos. Caso não seja fornecido este parâmetro, todos os registros serão removidos do(s) histórico(s) para o recurso selecionado.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data clear_history create -p id=... -p history_type=... -p reason=... -p cutting_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > clear_history > create"]
var params = {
    id: ...,
    history_type: ...,
    reason: ...,
    cutting_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > clear_history > create"]
params = {
    "id": ...,
    "history_type": ...,
    "reason": ...,
    "cutting_datetime": ...,
}
result = client.action(schema, action, params=params)

data > duplicate > create

POST /rest/v1/data/{id}/duplicate/

Duplica o cadastro de um dado no Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dado a ser duplicado.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do dado utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do dado.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do dado.
`description`	Valor texto com a descrição do dado.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao dado.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao dado deve ser herdada do dispositivo.
`memory_type_id` required	Valor inteiro com o identificador do tipo de memória associado ao dado.
`memory_address`	Valor inteiro com o endereço do dado.
`unity_label`	Valor texto com a unidade de engenharia associado ao dado.
`value_format_type_id`	Valor inteiro com identificador do tipo de formatação do valor do dado.
`update_value_mode_after_writing_id`	Valor inteiro com identificador do modo de atualização do valor do dado após um comando de escrita.
`read_only`	Valor booleano que indica se o dado é desomente leitura.
`enabled`	Valor booleano que indica se o dado está habilitado no sistema.
`history_enabled`	Valor booleano que indica se o valor do dado de ser historiado pelo sistema.
`source_value_id` required	Valor inteiro com o identificador da fonte de coleta do valor do dado.
`local_storage_identity_number`	Valor inteiro com o identificador da posição do dado no buffer da base local decoleta de dados.
`calculation_type_id`	Valor inteiro com o identificador do tipo de cálculo associado ao dado.
`calculation_param_a`	Valor texto associado ao primeiro parâmetro do tipo de cálculo.
`calculation_param_b`	Valor texto associado ao segundo parâmetro do tipo de cálculo.
`calculation_param_c`	Valor texto associado ao terceiro parâmetro do tipo de cálculo.
`calculation_param_d`	Valor texto associado ao quarto parâmetro do tipo de cálculo.
`text_list_id`	Valor inteiro com o identificador do da lista de texto associado ao dado.
`minimum_value`	Valor real mínimo permitido para o dado(para que o portal possa validar a atualização/coleta do valor do dado)
`maximum_value`	Valor real máximo permitido para o dado(para que o portal possa validar a atualização/coleta do valor do dado)
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data duplicate create -p id=... -p If-Match=... -p name=... -p description=... -p device_id=... -p process_area_id=... -p inherits_parent_process_area=... -p memory_type_id=... -p memory_address=... -p unity_label=... -p value_format_type_id=... -p update_value_mode_after_writing_id=... -p read_only=... -p enabled=... -p history_enabled=... -p source_value_id=... -p local_storage_identity_number=... -p calculation_type_id=... -p calculation_param_a=... -p calculation_param_b=... -p calculation_param_c=... -p calculation_param_d=... -p text_list_id=... -p minimum_value=... -p maximum_value=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data > duplicate > create"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    device_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    memory_type_id: ...,
    memory_address: ...,
    unity_label: ...,
    value_format_type_id: ...,
    update_value_mode_after_writing_id: ...,
    read_only: ...,
    enabled: ...,
    history_enabled: ...,
    source_value_id: ...,
    local_storage_identity_number: ...,
    calculation_type_id: ...,
    calculation_param_a: ...,
    calculation_param_b: ...,
    calculation_param_c: ...,
    calculation_param_d: ...,
    text_list_id: ...,
    minimum_value: ...,
    maximum_value: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data > duplicate > create"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "device_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "memory_type_id": ...,
    "memory_address": ...,
    "unity_label": ...,
    "value_format_type_id": ...,
    "update_value_mode_after_writing_id": ...,
    "read_only": ...,
    "enabled": ...,
    "history_enabled": ...,
    "source_value_id": ...,
    "local_storage_identity_number": ...,
    "calculation_type_id": ...,
    "calculation_param_a": ...,
    "calculation_param_b": ...,
    "calculation_param_c": ...,
    "calculation_param_d": ...,
    "text_list_id": ...,
    "minimum_value": ...,
    "maximum_value": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

data_current_value > list

GET /rest/v1/data_current_value/

Obtém o valor corrente de dados do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`connector_id`	Valor inteiro com o identificador do conector associado ao dado do histórico.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao dado do histórico.
`data_id`	Valor inteiro com o identificador do dado associado ao histórico.
`data_ids`	Valores inteiros com os identificadores dos dados associados ao histórico.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado do histórico.
`contract_id`	Valor inteiro com o identificador do contrato associado ao dado do histórico.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: date_time value data_id Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data_current_value list -p connector_id=... -p device_id=... -p data_id=... -p data_ids=... -p process_area_id=... -p contract_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data_current_value > list"]
var params = {
    connector_id: ...,
    device_id: ...,
    data_id: ...,
    data_ids: ...,
    process_area_id: ...,
    contract_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data_current_value > list"]
params = {
    "connector_id": ...,
    "device_id": ...,
    "data_id": ...,
    "data_ids": ...,
    "process_area_id": ...,
    "contract_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

data_current_value > create

POST /rest/v1/data_current_value/

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data_current_value create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data_current_value > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data_current_value > create"]
result = client.action(schema, action)

data_history > list

GET /rest/v1/data_history/

Obtém a lista do histórico de valores dos dados do sistema. Caso não fornecido um período, serão retornados dados das ÚLTIMAS 24 HORAS. O período MÁXIMO para consulta no histórico é de 1 MÊS.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`connector_id`	Valor inteiro com o identificador do conector associado ao dado do histórico.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao dado do histórico.
`data_id`	Valor inteiro com o identificador do dado associado ao histórico.
`data_ids`	Valores inteiros com os identificadores dos dados associados ao histórico.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado do histórico.
`contract_id`	Valor inteiro com o identificador do contrato associado ao dado do histórico.
`start`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-01 08:00:00) de início para recuperação de registros no histórico.
`end`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de fim para recuperação de registros no histórico.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: date_time value data_id Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 data_history list -p connector_id=... -p device_id=... -p data_id=... -p data_ids=... -p process_area_id=... -p contract_id=... -p start=... -p end=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "data_history > list"]
var params = {
    connector_id: ...,
    device_id: ...,
    data_id: ...,
    data_ids: ...,
    process_area_id: ...,
    contract_id: ...,
    start: ...,
    end: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "data_history > list"]
params = {
    "connector_id": ...,
    "device_id": ...,
    "data_id": ...,
    "data_ids": ...,
    "process_area_id": ...,
    "contract_id": ...,
    "start": ...,
    "end": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

devices > list

GET /rest/v1/devices/

Obtém a lista de dispositivos.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`name`	Texto com o nome do dispositivo.
`connector_id`	Valor inteiro com o identificador do conector associado ao dispositivo.
`connector_name`	Texto com o nome do conector associado ao dispositivo.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dispositivo.
`process_area_name`	Texto com o nome da área de processo associada ao dispositivo.
`contract_id`	Valor inteiro com o identificador do contrato associado ao dispositivo.
`enabled`	Valor booleano de identificação do estado de habilitação do recurso no sistema.
`base_model`	Valor booleano de identificação se o recurso é de modelo.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name device_status_name device_address number_active_alarms connector_id connector_name connector_status_name connector_location connector_serial_number process_area_name Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices list -p name=... -p connector_id=... -p connector_name=... -p process_area_id=... -p process_area_name=... -p contract_id=... -p enabled=... -p base_model=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > list"]
var params = {
    name: ...,
    connector_id: ...,
    connector_name: ...,
    process_area_id: ...,
    process_area_name: ...,
    contract_id: ...,
    enabled: ...,
    base_model: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > list"]
params = {
    "name": ...,
    "connector_id": ...,
    "connector_name": ...,
    "process_area_id": ...,
    "process_area_name": ...,
    "contract_id": ...,
    "enabled": ...,
    "base_model": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

devices > create

POST /rest/v1/devices/

Cria um dispositivo.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do dispositivo.
`description`	Valor texto com a descrição do dispositivo.
`connector_id` required	Valor inteiro com o identificador do conector associado ao dispositivo.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dispositivo.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao dispositivo deve ser herdada do conector.
`device_address` required	Valor inteiro com o endereço do dispositivo
`is_hi_device`	Valor booleano que indica se o dispositivo é de fabricação da HI Tecnologia.
`local_storage_enabled`	Valor booleano que indica se a coleta de dados da base local está habilitada.
`local_storage_version_id`	Valor inteiro com a identificação da versão da estrutura da base local de coleta de dados.
`local_storage_initial_address`	Valor inteiro do endereço de início da base local de coleta de dados.
`local_storage_timezone`	Valor texto com a identificação do timezone associado aos registros da base local de coleta de dados.
`portal_data`	Objeto JSON com a definição de dados customizados pelo Portal de Telemetria.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices create -p name=... -p description=... -p connector_id=... -p process_area_id=... -p inherits_parent_process_area=... -p device_address=... -p is_hi_device=... -p local_storage_enabled=... -p local_storage_version_id=... -p local_storage_initial_address=... -p local_storage_timezone=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > create"]
var params = {
    name: ...,
    description: ...,
    connector_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    device_address: ...,
    is_hi_device: ...,
    local_storage_enabled: ...,
    local_storage_version_id: ...,
    local_storage_initial_address: ...,
    local_storage_timezone: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > create"]
params = {
    "name": ...,
    "description": ...,
    "connector_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "device_address": ...,
    "is_hi_device": ...,
    "local_storage_enabled": ...,
    "local_storage_version_id": ...,
    "local_storage_initial_address": ...,
    "local_storage_timezone": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

devices > partial_update

PATCH /rest/v1/devices/

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > partial_update"]
result = client.action(schema, action)

devices > read

GET /rest/v1/devices/{id}/

Obtém os detalhes de configuração de um determinado dispositivo.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dispositivo.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

devices > partial_update_0

PATCH /rest/v1/devices/{id}/

Atualiza as informações de configuração de um dispositivo.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dispositivo.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name`	Valor texto com o nome do dispositivo.
`description`	Valor texto com a descrição do dispositivo.
`connector_id`	Valor inteiro com o identificador do conector associado ao dispositivo.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dispositivo.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao dispositivo deve ser herdada do conector.
`device_address`	Valor inteiro com o endereço do dispositivo
`is_hi_device`	Valor booleano que indica se o dispositivo é de fabricação da HI Tecnologia.
`local_storage_enabled`	Valor booleano que indica se a coleta de dados da base local está habilitada.
`local_storage_version_id`	Valor inteiro com a identificação da versão da estrutura da base local de coleta de dados.
`local_storage_initial_address`	Valor inteiro do endereço de início da base local de coleta de dados.
`local_storage_timezone`	Valor texto com a identificação do timezone associado aos registros da base local de coleta de dados.
`portal_data`	Objeto JSON com a definição de dados customizados pelo Portal de Telemetria.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices partial_update_0 -p id=... -p If-Match=... -p name=... -p description=... -p connector_id=... -p process_area_id=... -p inherits_parent_process_area=... -p device_address=... -p is_hi_device=... -p local_storage_enabled=... -p local_storage_version_id=... -p local_storage_initial_address=... -p local_storage_timezone=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > partial_update_0"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    connector_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    device_address: ...,
    is_hi_device: ...,
    local_storage_enabled: ...,
    local_storage_version_id: ...,
    local_storage_initial_address: ...,
    local_storage_timezone: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > partial_update_0"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "connector_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "device_address": ...,
    "is_hi_device": ...,
    "local_storage_enabled": ...,
    "local_storage_version_id": ...,
    "local_storage_initial_address": ...,
    "local_storage_timezone": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

devices > delete

DELETE /rest/v1/devices/{id}/

Remove um determinado dispositivo da base de dados.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dispositivo.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

devices > clear_history > create

POST /rest/v1/devices/{id}/clear_history/

Remove os registros de históricos de um dispositivo do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do dispositivo a serem removidos os registros do(s) histórico(s).

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`history_type` required	Valor texto com o tipo do histórico a serem removidos os registros. Valor para cada tipo: data: histórico de dados; alarms: histórico de alarmes; all: ambos os históricos.
`reason` required	Valor texto com a descrição do motivo para remoção dos registros do(s) histórico(s). Este registro poderá ser consultado posteriormente no histórico de eventos do sistema.
`cutting_datetime`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de corte para remoção de registros do(s) histórico(s). Ou seja, todos os registros iguais ou anteriores a data/hora fornecida serão removidos. Caso não seja fornecido este parâmetro, todos os registros serão removidos do(s) histórico(s) para o recurso selecionado.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices clear_history create -p id=... -p history_type=... -p reason=... -p cutting_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > clear_history > create"]
var params = {
    id: ...,
    history_type: ...,
    reason: ...,
    cutting_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > clear_history > create"]
params = {
    "id": ...,
    "history_type": ...,
    "reason": ...,
    "cutting_datetime": ...,
}
result = client.action(schema, action, params=params)

devices > duplicate > create

POST /rest/v1/devices/{id}/duplicate/

Duplica o cadastro de um dispositivo no Portal de Telemetria.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do dispositivo utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do dispositivo.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do dispositivo.
`description`	Valor texto com a descrição do dispositivo.
`connector_id`	Valor inteiro com o identificador do conector associado ao dispositivo.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dispositivo.
`inherits_parent_process_area`	Valor booleano que indica se a área de processo associada ao dispositivo deve ser herdada do conector.
`device_address` required	Valor inteiro com o endereço do dispositivo
`is_hi_device`	Valor booleano que indica se o dispositivo é de fabricação da HI Tecnologia.
`local_storage_enabled`	Valor booleano que indica se a coleta de dados da base local está habilitada.
`local_storage_version_id`	Valor inteiro com a identificação da versão da estrutura da base local de coleta de dados.
`local_storage_initial_address`	Valor inteiro do endereço de início da base local de coleta de dados.
`local_storage_timezone`	Valor texto com a identificação do timezone associado aos registros da base local de coleta de dados.
`portal_data`	Objeto JSON com a definição de dados customizados pelo Portal de Telemetria.
`user_data`	Objeto JSON com a definição de dados customizados pelo usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 devices duplicate create -p If-Match=... -p name=... -p description=... -p connector_id=... -p process_area_id=... -p inherits_parent_process_area=... -p device_address=... -p is_hi_device=... -p local_storage_enabled=... -p local_storage_version_id=... -p local_storage_initial_address=... -p local_storage_timezone=... -p portal_data=... -p user_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "devices > duplicate > create"]
var params = {
    If-Match: ...,
    name: ...,
    description: ...,
    connector_id: ...,
    process_area_id: ...,
    inherits_parent_process_area: ...,
    device_address: ...,
    is_hi_device: ...,
    local_storage_enabled: ...,
    local_storage_version_id: ...,
    local_storage_initial_address: ...,
    local_storage_timezone: ...,
    portal_data: ...,
    user_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "devices > duplicate > create"]
params = {
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "connector_id": ...,
    "process_area_id": ...,
    "inherits_parent_process_area": ...,
    "device_address": ...,
    "is_hi_device": ...,
    "local_storage_enabled": ...,
    "local_storage_version_id": ...,
    "local_storage_initial_address": ...,
    "local_storage_timezone": ...,
    "portal_data": ...,
    "user_data": ...,
}
result = client.action(schema, action, params=params)

machines > read

GET /rest/v1/machines/{id}/

Obtém os detalhes de configuração de uma determinada área de processo.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da área de processo.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 machines read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "machines > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "machines > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

machines > partial_update

PATCH /rest/v1/machines/{id}/

Atualiza as informações de configuração de uma determinada área de processo.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da área de processo.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`identity_name`	Valor texto com o nome da área de processo.
`description`	Valor texto com a descrição da área de processo.
`contract_id`	Valor inteiro com o identificador do contrato associado a área de processo.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 machines partial_update -p id=... -p If-Match=... -p identity_name=... -p description=... -p contract_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "machines > partial_update"]
var params = {
    id: ...,
    If-Match: ...,
    identity_name: ...,
    description: ...,
    contract_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "machines > partial_update"]
params = {
    "id": ...,
    "If-Match": ...,
    "identity_name": ...,
    "description": ...,
    "contract_id": ...,
}
result = client.action(schema, action, params=params)

machines > delete

DELETE /rest/v1/machines/{id}/

Remove uma determinada área de processo do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da área de processo.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 machines delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "machines > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "machines > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

process_areas > list

GET /rest/v1/process_areas/

Obtém a lista de áreas de processo do Portal de Telemetria.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`contract_id`	Valor inteiro com o identificador do contrato associado a área de processo.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name description Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 process_areas list -p contract_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "process_areas > list"]
var params = {
    contract_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "process_areas > list"]
params = {
    "contract_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

process_areas > create

POST /rest/v1/process_areas/

Cria uma área de processo no Portal de Telemetria.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome da área de processo.
`description`	Valor texto com a descrição da área de processo.
`contract_id` required	Valor inteiro com o identificador do contrato associado a área de processo.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 process_areas create -p name=... -p description=... -p contract_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "process_areas > create"]
var params = {
    name: ...,
    description: ...,
    contract_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "process_areas > create"]
params = {
    "name": ...,
    "description": ...,
    "contract_id": ...,
}
result = client.action(schema, action, params=params)

process_areas > read

GET /rest/v1/process_areas/{id}/

Obtém os detalhes de configuração de uma determinada área de processo.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da área de processo.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 process_areas read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "process_areas > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "process_areas > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

process_areas > partial_update

PATCH /rest/v1/process_areas/{id}/

Atualiza as informações de configuração de uma determinada área de processo.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da área de processo.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`identity_name`	Valor texto com o nome da área de processo.
`description`	Valor texto com a descrição da área de processo.
`contract_id`	Valor inteiro com o identificador do contrato associado a área de processo.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 process_areas partial_update -p id=... -p If-Match=... -p identity_name=... -p description=... -p contract_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "process_areas > partial_update"]
var params = {
    id: ...,
    If-Match: ...,
    identity_name: ...,
    description: ...,
    contract_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "process_areas > partial_update"]
params = {
    "id": ...,
    "If-Match": ...,
    "identity_name": ...,
    "description": ...,
    "contract_id": ...,
}
result = client.action(schema, action, params=params)

process_areas > delete

DELETE /rest/v1/process_areas/{id}/

Remove uma determinada área de processo do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da área de processo.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 process_areas delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "process_areas > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "process_areas > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

remote_access_tokens > list

GET /rest/v1/remote_access_tokens/

Obtém a lista de tokens para acesso remoto ao conector.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`connector_id`	Valor inteiro com o identificador do conector associado ao token.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id token type connector_name enabled status Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-token
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 remote_access_tokens list -p connector_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "remote_access_tokens > list"]
var params = {
    connector_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "remote_access_tokens > list"]
params = {
    "connector_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

remote_access_tokens > create

POST /rest/v1/remote_access_tokens/

Cria um token para acesso remoto ao conector.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`remote_access_token_type_id` required	Valor inteiro com o identificador do tipo de token.
`connector_id` required	Valor inteiro com o identificador do conector associado ao token.
`enabled`	Valor booleano que indica se o token está habilitado no sistema.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 remote_access_tokens create -p remote_access_token_type_id=... -p connector_id=... -p enabled=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "remote_access_tokens > create"]
var params = {
    remote_access_token_type_id: ...,
    connector_id: ...,
    enabled: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "remote_access_tokens > create"]
params = {
    "remote_access_token_type_id": ...,
    "connector_id": ...,
    "enabled": ...,
}
result = client.action(schema, action, params=params)

remote_access_tokens > read

GET /rest/v1/remote_access_tokens/{id}/

Obtém os detalhes de configuração de um determinado token.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do token.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 remote_access_tokens read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "remote_access_tokens > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "remote_access_tokens > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

remote_access_tokens > partial_update

PATCH /rest/v1/remote_access_tokens/{id}/

Atualiza as informações de configuração de um token.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do token.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`remote_access_token_type_id`	Valor inteiro com o identificador do tipo de token.
`connector_id`	Valor inteiro com o identificador do conector associado ao token.
`enabled`	Valor booleano que indica se o token está habilitado no sistema.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 remote_access_tokens partial_update -p id=... -p If-Match=... -p remote_access_token_type_id=... -p connector_id=... -p enabled=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "remote_access_tokens > partial_update"]
var params = {
    id: ...,
    If-Match: ...,
    remote_access_token_type_id: ...,
    connector_id: ...,
    enabled: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "remote_access_tokens > partial_update"]
params = {
    "id": ...,
    "If-Match": ...,
    "remote_access_token_type_id": ...,
    "connector_id": ...,
    "enabled": ...,
}
result = client.action(schema, action, params=params)

remote_access_tokens > delete

DELETE /rest/v1/remote_access_tokens/{id}/

Remove um determinado token da base de dados.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do token.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 remote_access_tokens delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "remote_access_tokens > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "remote_access_tokens > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

system_history > list

GET /rest/v1/system_history/

Obtém a lista do histórico de eventos do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`contract_id` required	Valor inteiro com o identificador do contrato associado ao histórico.
`connector_id`	Valor inteiro com o identificador do conector associado ao histórico.
`data_id`	Valor inteiro com o identificador do dado associado ao histórico.
`system_event_id`	Valor inteiro com o identificador do evento de sistema associado ao histórico.
`system_sub_event_id`	Valor inteiro com o identificador do sub-evento de sistema associado ao histórico.
`start`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-01 08:00:00) de início para recuperação de registros no histórico.
`end`	Valor texto com a definição de data/hora(no formato ISO8601, exemplo: 2020-12-31 23:59:59) de fim para recuperação de registros no histórico.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id date_time_event message details system_event_name system_sub_event_name connector_name data_name user_email Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-data_name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 system_history list -p contract_id=... -p connector_id=... -p data_id=... -p system_event_id=... -p system_sub_event_id=... -p start=... -p end=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "system_history > list"]
var params = {
    contract_id: ...,
    connector_id: ...,
    data_id: ...,
    system_event_id: ...,
    system_sub_event_id: ...,
    start: ...,
    end: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "system_history > list"]
params = {
    "contract_id": ...,
    "connector_id": ...,
    "data_id": ...,
    "system_event_id": ...,
    "system_sub_event_id": ...,
    "start": ...,
    "end": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

tags > list

GET /rest/v1/tags/

Obtém o valor corrente de dados do sistema.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`connector_id`	Valor inteiro com o identificador do conector associado ao dado do histórico.
`device_id`	Valor inteiro com o identificador do dispositivo associado ao dado do histórico.
`data_id`	Valor inteiro com o identificador do dado associado ao histórico.
`data_ids`	Valores inteiros com os identificadores dos dados associados ao histórico.
`process_area_id`	Valor inteiro com o identificador da área de processo associada ao dado do histórico.
`contract_id`	Valor inteiro com o identificador do contrato associado ao dado do histórico.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: date_time value data_id Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 tags list -p connector_id=... -p device_id=... -p data_id=... -p data_ids=... -p process_area_id=... -p contract_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "tags > list"]
var params = {
    connector_id: ...,
    device_id: ...,
    data_id: ...,
    data_ids: ...,
    process_area_id: ...,
    contract_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "tags > list"]
params = {
    "connector_id": ...,
    "device_id": ...,
    "data_id": ...,
    "data_ids": ...,
    "process_area_id": ...,
    "contract_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

text_lists > list

GET /rest/v1/text_lists/

Obtém as listas de textos do Portal de Telemetria.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`contract_id`	Valor inteiro com o identificador do contrato associado a lista de texto.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name description Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 text_lists list -p contract_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "text_lists > list"]
var params = {
    contract_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "text_lists > list"]
params = {
    "contract_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

text_lists > create

POST /rest/v1/text_lists/

Cria uma lista de texto no Portal de Telemetria.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome da lista de texto.
`description`	Valor texto com a descrição da lista detexto.
`contract_id` required	Valor inteiro com o identificador do contrato associado a lista de texto.
`default_item`	Objeto JSON com a definição do item padrão da lista de texto.
`items` required	Objeto JSON com a definição dos itens da lista de texto.
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 text_lists create -p name=... -p description=... -p contract_id=... -p default_item=... -p items=... -p portal_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "text_lists > create"]
var params = {
    name: ...,
    description: ...,
    contract_id: ...,
    default_item: ...,
    items: ...,
    portal_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "text_lists > create"]
params = {
    "name": ...,
    "description": ...,
    "contract_id": ...,
    "default_item": ...,
    "items": ...,
    "portal_data": ...,
}
result = client.action(schema, action, params=params)

text_lists > read

GET /rest/v1/text_lists/{id}/

Obtém os detalhes de configuração de uma determinada lista de texto.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da lista de texto.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 text_lists read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "text_lists > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "text_lists > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

text_lists > partial_update

PATCH /rest/v1/text_lists/{id}/

Atualiza as informações de configuração de uma determinada lista de texto.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da lista de texto.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name`	Valor texto com o nome da lista de texto.
`description`	Valor texto com a descrição da lista detexto.
`contract_id`	Valor inteiro com o identificador do contrato associado a lista de texto.
`default_item`	Objeto JSON com a definição do item padrão da lista de texto.
`items`	Objeto JSON com a definição dos itens da lista de texto.
`portal_data`	Objeto JSON com a definição de dados customizados pelo sistema.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 text_lists partial_update -p id=... -p If-Match=... -p name=... -p description=... -p contract_id=... -p default_item=... -p items=... -p portal_data=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "text_lists > partial_update"]
var params = {
    id: ...,
    If-Match: ...,
    name: ...,
    description: ...,
    contract_id: ...,
    default_item: ...,
    items: ...,
    portal_data: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "text_lists > partial_update"]
params = {
    "id": ...,
    "If-Match": ...,
    "name": ...,
    "description": ...,
    "contract_id": ...,
    "default_item": ...,
    "items": ...,
    "portal_data": ...,
}
result = client.action(schema, action, params=params)

text_lists > delete

DELETE /rest/v1/text_lists/{id}/

Remove uma determinada lista de texto do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador da lista de texto.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 text_lists delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "text_lists > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "text_lists > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)

user_groups > list

GET /rest/v1/user_groups/

Obtém a lista de grupos de usuários do Portal de Telemetria.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`contract_id`	Valor inteiro com o identificador do contrato associado ao grupo de usuários.
`ordering`	Valor texto que define quais campos do recurso(separados por ",") devem ser utilizados para ordenação da coleção. Campos possíveis: id name description Utilize "-" antes do nome do campo para ordenação decrescente, exemplo: /ordering=-name
`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".
`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 "offset".
`max_results`	Valor inteiro com o número máximo de registros que devem ser retornados na coleção.
`page_token`	Valor texto com a identificação da página de registros a serem retornados na coleção. Deve ser utilizado em conjunto com "max_results".

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 user_groups list -p contract_id=... -p ordering=... -p page_size=... -p page=... -p limit=... -p offset=... -p max_results=... -p page_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "user_groups > list"]
var params = {
    contract_id: ...,
    ordering: ...,
    page_size: ...,
    page: ...,
    limit: ...,
    offset: ...,
    max_results: ...,
    page_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "user_groups > list"]
params = {
    "contract_id": ...,
    "ordering": ...,
    "page_size": ...,
    "page": ...,
    "limit": ...,
    "offset": ...,
    "max_results": ...,
    "page_token": ...,
}
result = client.action(schema, action, params=params)

user_groups > create

POST /rest/v1/user_groups/

Cria um grupo de usuários no Portal de Telemetria.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`name` required	Valor texto com o nome do grupo de usuário.
`description`	Valor texto com a descrição do grupo de usuário.
`contract_id` required	Valor inteiro com o identificador do contrato associado ao grupo de usuário.
`portal_permissions_ids`	Lista com os valores inteiros de identificação das permissões do portal associadas ao grupo de usuários.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 user_groups create -p name=... -p description=... -p contract_id=... -p portal_permissions_ids=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "user_groups > create"]
var params = {
    name: ...,
    description: ...,
    contract_id: ...,
    portal_permissions_ids: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "user_groups > create"]
params = {
    "name": ...,
    "description": ...,
    "contract_id": ...,
    "portal_permissions_ids": ...,
}
result = client.action(schema, action, params=params)

user_groups > read

GET /rest/v1/user_groups/{id}/

Obtém os detalhes de configuração de um determinado grupo de usuário.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do grupo de usuário.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 user_groups read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "user_groups > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "user_groups > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

user_groups > partial_update

PATCH /rest/v1/user_groups/{id}/

Atualiza as informações de configuração de um determinado grupo de usuário.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do grupo de usuário.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

Request Body

The request body should be "application/json" encoded, and should contain a single item.

Parameter	Description
`identity_name`	Valor texto com o nome do grupo de usuário
`description`	Valor texto com a descrição do grupo de usuário
`contract_id`	Valor inteiro com o identificador do contrato associado ao grupo de usuário.
`portal_permissions_ids`	Lista com os valores inteiros de identificação das permissões do portal associadas ao grupo de usuários.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 user_groups partial_update -p id=... -p If-Match=... -p identity_name=... -p description=... -p contract_id=... -p portal_permissions_ids=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "user_groups > partial_update"]
var params = {
    id: ...,
    If-Match: ...,
    identity_name: ...,
    description: ...,
    contract_id: ...,
    portal_permissions_ids: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "user_groups > partial_update"]
params = {
    "id": ...,
    "If-Match": ...,
    "identity_name": ...,
    "description": ...,
    "contract_id": ...,
    "portal_permissions_ids": ...,
}
result = client.action(schema, action, params=params)

user_groups > delete

DELETE /rest/v1/user_groups/{id}/

Remove uma determinado grupo de usuário do Portal de Telemetria.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	Valor inteiro com o identificador do grupo de usuário.

Header Parameters

The following parameters should be included as HTTP headers.

Parameter	Description
`If-Match` required	Valor do ETAG de representação do recurso utilizado na operação. O valor do ETAG pode ser obtido na requisição via GET do recurso.

# Load the schema document
$ coreapi get http://api.telemetria.techfilter.com.br/rest/docs/

# Interact with the API endpoint
$ coreapi action v1 user_groups delete -p id=... -p If-Match=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "user_groups > delete"]
var params = {
    id: ...,
    If-Match: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.telemetria.techfilter.com.br/rest/docs/")

# Interact with the API endpoint
action = ["v1", "user_groups > delete"]
params = {
    "id": ...,
    "If-Match": ...,
}
result = client.action(schema, action, params=params)