Запрос GetPoints

PointData / GetPoints

Конечная точка: POST /point-data/get-points

Запрос GetPoints возвращает массив точек записанных данных по индикатору. Каждая точка представляет собой пару «время»-«значение».

Ответ приходит в формате Unix Epoch Time (количество секунд, начиная с 1970 года).

Различие между входным и выходным форматами даты объясняется тем, что Web Api представляет собой обертку над сервисом gRPC, который используется для внутренних нужд и работает с датами в формате Unix Epoch Time.

На вход принимаются следующие параметры:

ПараметрТипНазначение
fromDatedatetimeДата и время начала периода в формате ISO 8601 (YYYY-MM-DDTHH:mm:ss.msZ)
toDatedatetimeДата и время конца периода в формате ISO 8601 (YYYY-MM-DDTHH:mm:ss.msZ)
groupstringГруппа показателей, первая составляющая часть типа данных (например, «bio»)
classstringКласс показателей, вторая составляющая часть типа данных (например, «mental»)
kindsstring[]Массив из видов показателей, третьих составляющих частей типа данных (например, «Stress_10_avg», «Concentration_10_avg» и так далее)
usersJSONМассив пользователей в виде JSON-объектов
tenantIdintegerИдентификатор приложения или внешнего каталога пользователей. Используется в том случае, если у стороннего разработчика собственные идентификаторы пользователей. По умолчанию, используются пользователи Платформы, зарегистрированные на Паспорте, в этом случае TenantId = 0. Для создания нового каталога пользователей, обратитесь в техническую поддержку Платформы.
userIdintegerИдентификатор пользователя в данном каталоге (Tenant). По умолчанию (если TenantId = 0), идентификатор пользователя в Паспорте Платформы.

Если у пользователя, чей access_token используется для установления соединения, нет прав доступа к данным пользователя, указанного в UserIds, то пакеты данных по нему приходить не будут.

Пример запроса:

{
  "class": "mental",
  "group": "bio",
  "kinds": [
    "Stress_10_avg"
  ],
  "users": [
    {
      "tenantId": 0,
      "userId": 12
    }
  ],
  "fromDate": "2023-03-27T11:29:58.032Z",
  "toDate": "2023-03-27T11:42:58.032Z"
}

Пример ответа:

[
  {
    "userId": 12,
    "tenantId": 0,
    "time": {
      "seconds": 1679902200,
      "nanos": 0
    },
    "group": "bio",
    "class": "mental",
    "kind": "Stress_10_avg",
    "value": 5.903648357020284
  },
  {
    "userId": 12,
    "tenantId": 0,
    "time": {
      "seconds": 1679907600,
      "nanos": 0
    },
    "group": "bio",
    "class": "mental",
    "kind": "Stress_10_avg",
    "value": 5.830482776041706
  },
  {
    "userId": 12,
    "tenantId": 0,
    "time": {
      "seconds": 1679902800,
      "nanos": 0
    },
    "group": "bio",
    "class": "mental",
    "kind": "Stress_10_avg",
    "value": 6.012120235665303
  }
]