/Methods/CreateReportSubscription

<< Click to Display Table of Contents >>

Navigation:  API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > Доступ к архивам данных >

/Methods/CreateReportSubscription

Создает асинхронную подписку на генерацию отчёта. Внутри отчёта применяются сложные временнЫе и агрегационные функции (интеграл, среднее, минимум, максимум) на основе параметров, заданных для каждой колонки.

HTTP: POST /Methods/CreateReportSubscription

Запрос

{
  "sessionId": 1234,
  "timeout": 600000,
  "parameters": {
    "startTime": 1681285274000,
    "endTime": 1681285948000,
    "FormingMethod": 1,
    "IntervalUnit": 1,
    "resampleInterval": 1.0,
    "Layer": 0
  },
  "columns": [
    {
      "name": "ColumnName1",
      "parameters": {
        "Ref": "57161",
        "Attribute": 0,
        "Aggregation": {
          "Type": 1,
          "SubType": 0
        }
      }
    }
  ]
}

Поля запроса

Поле

Тип

Обязат.

По умолчанию

Описание

timeout

int64

Нет

600000

Таймаут (мс) на асинхронное получение данных.

parameters.startTime

int64/string

Да

 

Время начала отчёта (DT).

parameters.endTime

int64/string

Да

 

Время окончания отчёта (DT).

parameters.FormingMethod

int

Нет

0

Метод: 0 (OnChange), 1 (Periodic), 2 (Total).

parameters.IntervalUnit

int

Нет

0

Единица времени: -1 (Сырое), 0 (Сек), 1 (Мин), 2 (Час), 3 (День), 4 (Месяц).

parameters.resampleInterval

double

Нет

0.0

Размер интервала (в единицах IntervalUnit).

parameters.Deadband

double

Нет

0.0

Мёртвая зона (сек).

parameters.Layer

int

Нет

(авто)

Слой архива (0, 1, 2). По умолчанию вычисляется из длины интервала.

parameters.timestampKind

int

Нет

0

Тип возвращаемого времени (0=UTC, 1=Local, 2=Custom).

parameters.timestampOffset

int64

Нет

0

Смещение для Custom времени.

parameters.timestampFormat

string

Нет

""

Формат времени в строке. Если не задан, возвращается число.

columns

array

Да

 

Описания колонок отчёта.

columns[].name

string

Нет

""

Имя колонки.

columns[].parameters.Ref

string

Да

 

Идентификатор или путь узла (например, "57161" или "Node.Path").

columns[].parameters.Attribute

int

Нет

0

Что возвращать: 0 (Value), 1 (Time), 2 (Quality).

columns[].parameters.Aggregation.Type

int

Нет

 

Тип: 0 (Last), 1 (First), 2 (Integral), 3 (Avg), 5 (Max), 6 (Min), и т.д.

columns[].parameters.ProcessingParameter

double

Нет

0.0

Делитель для значения (на него будет разделён результат).

columns[].parameters.Quality

int

Нет

1031412

Битовая маска фильтрации качества.

Ответ

{
  "subscriptionId": 1,
  "serverTime": 1682503946407,
  "code": 0
}