Ресурсы API

Публичный интерфейс для интеграции сторонних сервисов и автоматизации взаимодействия с данными системы

API Reference

Документация по маршрутам IICD в формате, с которым удобно работать

Слева быстрый переход по разделам и endpoint'ам, справа подробная спецификация каждого маршрута с параметрами, кодами ответа и примерами тел запросов и ответов.

Сводка

Всего маршрутов

103

Публичных Bearer API

Разделов

1 маршрут

API-ключи

Управление ключами доступа организации для внешних интеграций.

List of organization API keys (create/revoke - separate POSTs)

List of organization API keys (create/revoke - separate POSTs).

API-ключиСессия пользователяResponse: application/json

Request

GET

/api/v1/api_keys

Responses

200 OK

Successful Response

Коды ошибок

422

Validation Error

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
prefix	Type: string
scopes	Type: array[string]
scopes[]	Type: string
expires_at	Type: —
is_active	Type: boolean
last_used_at	Type: —

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "prefix": "string",
    "scopes": ["string"],
    "expires_at": "2026-04-27T12:00:00",
    "is_active": true,
    "last_used_at": "2026-04-27T12:00:00"
  }
]

12 маршрутов

Рейтинги и сравнения

Сводные рейтинги, сравнительные показатели и аналитика эффективности.

Эффективность сотрудника на выбранном оборудовании

Эффективность сотрудника на выбранном оборудовании.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/equipment-employee-efficiency

Query parameters

Name	Description
equipment_id*	Type: string<uuid> Equipment ID
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/equipment-employee-efficiency?equipment_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
employees	Type: array[EquipmentEmployeeEfficiencyItem]
employees[].place	Type: integer
employees[].employee	Type: string
employees[].shifts	Type: integer
employees[].hours	Type: number
employees[].efficiency	Type: integer

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

{
  "employees": [
    {
      "place": 0,
      "employee": "string",
      "shifts": 0,
      "hours": 0.0,
      "efficiency": 0
    }
  ]
}

Статистика смен по оборудованию

Статистика смен по оборудованию.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/equipment-shift-statistics

Query parameters

Name	Description
equipment_id*	Type: string<uuid> Equipment ID
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/equipment-shift-statistics?equipment_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
total	Type: integer
worked	Type: integer
remaining	Type: integer

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

{
  "total": 0,
  "worked": 0,
  "remaining": 0
}

Топ оборудования по моточасам/наработке

Топ оборудования по моточасам/наработке.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/top/equipments

Query parameters

Name	Description
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period
workshop_id	Type: string<uuid> Workshop ID for filtration

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/top/equipments?time_finish=example&time_start=2026-04-28T00%3A00%3A00&workshop_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
	Type: object Дополнительные поля (ключи произвольные)

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

[
  {}
]

Топ участков по отработанным часам

Топ участков по отработанным часам.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/top/units

Query parameters

Name	Description
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period
workshop_id	Type: string<uuid> Workshop ID for filtration

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/top/units?time_finish=example&time_start=2026-04-28T00%3A00%3A00&workshop_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
place	Type: integer
unit	Type: string
shifts	Type: integer
work	Type: integer

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

[
  {
    "place": 0,
    "unit": "string",
    "shifts": 0,
    "work": 0
  }
]

Топ пользователей по стажу

Топ пользователей по стажу.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/top/users

Query parameters

Name	Description
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period
workshop_id	Type: string<uuid> Workshop ID for filtration
min_shifts	Type: integer Minimum number of shifts for filtering

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/top/users?min_shifts=0&time_finish=example&time_start=2026-04-28T00%3A00%3A00&workshop_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
place	Type: integer
user	Type: string
shifts	Type: integer
work	Type: integer

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

[
  {
    "place": 0,
    "user": "string",
    "shifts": 0,
    "work": 0
  }
]

Топ цехов по отработанным часам

Топ цехов по отработанным часам.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/top/workshops

Query parameters

Name	Description
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period
workshop_id	Type: string<uuid> Workshop ID for filtration

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/top/workshops?time_finish=example&time_start=2026-04-28T00%3A00%3A00&workshop_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
place	Type: integer
equipment	Type: string
shifts	Type: integer
details	Type: integer

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

[
  {
    "place": 0,
    "equipment": "string",
    "shifts": 0,
    "details": 0
  }
]

Расширенная статистика участка: сравнение текущего и предыдущего периодов

Расширенная статистика участка: сравнение текущего и предыдущего периодов.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/unit-comparison-stats

Query parameters

Name	Description
unit_id*	Type: string<uuid> Department ID
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/unit-comparison-stats?time_finish=example&time_start=2026-04-28T00%3A00%3A00&unit_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
current_period	Type: object
previous_period	Type: object
comparison	Type: object

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

{
  "current_period": {},
  "previous_period": {},
  "comparison": {}
}

Оборудование на участке: смены, моточасы, эффективность

Оборудование на участке: смены, моточасы, эффективность.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/unit-equipment

Query parameters

Name	Description
unit_id	Type: string<uuid> Department ID
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/unit-equipment?time_finish=example&time_start=2026-04-28T00%3A00%3A00&unit_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
name	Type: string
id	Type: string<uuid>
shifts	Type: integer
motohours	Type: number
nowork	Type: integer
efficiency	Type: number

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

[
  {
    "name": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "shifts": 0,
    "motohours": 0.0,
    "nowork": 0,
    "efficiency": 0.0
  }
]

Сводка по участку: смены и часы

Сводка по участку: смены и часы.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/unit-statistics

Query parameters

Name	Description
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period
unit_id*	Type: string<uuid> Department ID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/unit-statistics?time_finish=example&time_start=2026-04-28T00%3A00%3A00&unit_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
shifts	Type: integer
hours	Type: integer
is_up_hours	Type: boolean
is_up_shifts	Type: boolean
is_up	Type: —

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

{
  "shifts": 0,
  "hours": 0,
  "is_up_hours": true,
  "is_up_shifts": true,
  "is_up": true
}

Эффективность оборудования по пользователю

Эффективность оборудования по пользователю.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/user-equipment-efficiency

Query parameters

Name	Description
user_id*	Type: string<uuid> User ID
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/user-equipment-efficiency?time_finish=example&time_start=2026-04-28T00%3A00%3A00&user_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
equipments	Type: array[UserEquipmentEfficiencyItem]
equipments[].place	Type: integer
equipments[].equipment	Type: string
equipments[].shifts	Type: integer
equipments[].hours	Type: number
equipments[].efficiency	Type: integer

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

{
  "equipments": [
    {
      "place": 0,
      "equipment": "string",
      "shifts": 0,
      "hours": 0.0,
      "efficiency": 0
    }
  ]
}

Статистика смен пользователя

Статистика смен пользователя.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/user-shift-statistics

Query parameters

Name	Description
user_id*	Type: string<uuid> User ID
time_start*	Type: string Start date of the period
time_finish*	Type: string End date of the period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/user-shift-statistics?time_finish=example&time_start=2026-04-28T00%3A00%3A00&user_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
total	Type: integer
worked	Type: integer
remaining	Type: integer

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

{
  "total": 0,
  "worked": 0,
  "remaining": 0
}

Статистика цеха: сотрудники, оборудование, эффективность

Статистика цеха: сотрудники, оборудование, эффективность.

Рейтинги и сравненияBearer API keyResponse: application/json

Request

GET

/api/v1/public/ratings/workshop-statistics

Query parameters

Name	Description
workshop_id	Type: string<uuid> Workshop ID for filtration

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/ratings/workshop-statistics?workshop_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
name	Type: string
id	Type: string<uuid>
user	Type: string
users	Type: integer
equipments	Type: integer
work	Type: integer
nowork	Type: integer
efficiency	Type: integer

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

[
  {
    "name": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user": "string",
    "users": 0,
    "equipments": 0,
    "work": 0,
    "nowork": 0,
    "efficiency": 0
  }
]

4 маршрута

Смены

Сменные интервалы, текущие смены и аналитика по сотрудникам и оборудованию.

Список смен с фильтрами (даты, сотрудник, цех и т. д.)

Список смен с фильтрами (даты, сотрудник, цех и т. д.).

СменыBearer API keyResponse: application/json

Request

GET

/api/v1/public/shifts

Query parameters

Name	Description
equipment_id	Type: —
limit	Type: integer
offset	Type: integer
user_id	Type: —
working_time_id	Type: —
time_start	Type: —
time_finish	Type: —
team_id	Type: —
is_holiday	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/shifts?equipment_id=example&is_holiday=example&limit=0&offset=0&team_id=example&time_finish=example&time_start=example&user_id=example&working_time_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "team": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "created_at": "2026-04-27T12:00:00",
      "updated_at": "2026-04-27T12:00:00",
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "email": "string",
        "avatar": "string",
        "phone": "string",
        "is_superuser": true,
        "is_active": true,
        "position": {
          "id": null,
          "name": null
        },
        "role": {
          "id": null,
          "type": null
        }
      },
      "users": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "full_name": "string",
          "email": "string",
          "avatar": null,
          "phone": null,
          "is_superuser": true,
          "is_active": true,
          "position": null,
          "role": null
        }
      ],
      "subscription": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "plan": "string",
        "end_date": "string"
      }
    },
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "full_name": "string",
      "email": "string",
      "avatar": "string",
      "phone": "string",
      "is_superuser": true,
      "is_active": true,
      "position": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "role": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      }
    },
    "equipments": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "equipment_type": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string"
        },
        "sensors": [],
        "is_chpu": true,
        "is_favorite": true,
        "unit": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "description": null,
          "workshop": null,
          "user": null
        }
      }
    ],
    "working_time": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "short_name": "string",
      "when_start": "string",
      "when_end": "string",
      "color_type": "string",
      "icon_type": 0,
      "is_holiday": true
    },
    "assignment": "string",
    "datetime_start": "2026-04-27T12:00:00",
    "datetime_finish": "2026-04-27T12:00:00"
  }
]

Смена по id (полная схема)

Смена по id (полная схема).

СменыBearer API keyResponse: application/json

Request

GET

/api/v1/public/shifts/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/shifts/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
team	Type: —
user	Type: —
equipments	Type: —
working_time	Type: —
assignment	Type: —
datetime_start	Type: —
datetime_finish	Type: —

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "team": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "created_at": "2026-04-27T12:00:00",
    "updated_at": "2026-04-27T12:00:00",
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "full_name": "string",
      "email": "string",
      "avatar": "string",
      "phone": "string",
      "is_superuser": true,
      "is_active": true,
      "position": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "role": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      }
    },
    "users": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "email": "string",
        "avatar": "string",
        "phone": "string",
        "is_superuser": true,
        "is_active": true,
        "position": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "role": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string"
        }
      }
    ],
    "subscription": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "plan": "string",
      "end_date": "string"
    }
  },
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "full_name": "string",
    "email": "string",
    "avatar": "string",
    "phone": "string",
    "is_superuser": true,
    "is_active": true,
    "position": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "role": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string"
    }
  },
  "equipments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "equipment_type": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      },
      "sensors": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "sensor_type": {
            "id": null,
            "type": null
          },
          "byte_order": {
            "id": null,
            "type": null
          },
          "data_type": {
            "id": null,
            "type": null
          },
          "metric_type": {
            "id": null,
            "type": null,
            "units_of_measurement": null,
            "output_min": null,
            "output_max": null
          },
          "register_address": 0,
          "sensor_box": {
            "id": null,
            "name": null,
            "slave_address": null,
            "timeout": null,
            "interval": null,
            "ip_address": null
          },
          "low_threshold_value": 0.0,
          "high_threshold_value": 0.0,
          "pre_work_threshold_value": 0.0,
          "status": null
        }
      ],
      "is_chpu": true,
      "is_favorite": true,
      "unit": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "workshop": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "description": null,
          "user": null
        },
        "user": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "full_name": "string",
          "email": "string"
        }
      }
    }
  ],
  "working_time": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "short_name": "string",
    "when_start": "string",
    "when_end": "string",
    "color_type": "string",
    "icon_type": 0,
    "is_holiday": true
  },
  "assignment": "string",
  "datetime_start": "2026-04-27T12:00:00",
  "datetime_finish": "2026-04-27T12:00:00"
}

Текущая смена для указанного оборудования

Текущая смена для указанного оборудования.

СменыBearer API keyResponse: application/json

Request

GET

/api/v1/public/shifts/equipments/{equipment_id}/shifts/current

Path parameters

Name	Description
equipment_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/shifts/equipments/3fa85f64-5717-4562-b3fc-2c963f66afa6/shifts/current" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Аналитика смен конкретного пользователя (user_id в пути; даты в query)

Аналитика смен конкретного пользователя (user_id в пути; даты в query).

СменыBearer API keyResponse: application/json

Request

GET

/api/v1/public/shifts/users/{user_id}/shifts/analytics

Path parameters

Name	Description
user_id*	Type: string<uuid>

Query parameters

Name	Description
date_start*	Type: string
date_finish*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/shifts/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/shifts/analytics?date_finish=2026-04-28&date_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

3 маршрута

Статистика

Статистические срезы по оборудованию, участкам и цехам.

Статистика Work/NoWork/NoCon: вчера, 7 и 30 дней

Статистика Work/NoWork/NoCon: вчера, 7 и 30 дней.

СтатистикаBearer API keyResponse: application/json

Request

GET

/api/v1/public/statistics/equipment/{equipment_id}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/statistics/equipment/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
yesterday	Type: StatisticPeriodData Statistics data for period
yesterday.work	Type: number
yesterday.nowork	Type: number
yesterday.nocon	Type: number
last_week	Type: StatisticPeriodData Statistics data for period
last_week.work	Type: number
last_week.nowork	Type: number
last_week.nocon	Type: number
last_month	Type: StatisticPeriodData Statistics data for period
last_month.work	Type: number
last_month.nowork	Type: number
last_month.nocon	Type: number

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

{
  "yesterday": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  },
  "last_week": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  },
  "last_month": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  }
}

Та же логика, агрегированная по участку целиком

Та же логика, агрегированная по участку целиком.

СтатистикаBearer API keyResponse: application/json

Request

GET

/api/v1/public/statistics/unit/{unit_id}

Path parameters

Name	Description
unit_id*	Type: string<uuid> Department UUID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/statistics/unit/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
yesterday	Type: StatisticPeriodData Statistics data for period
yesterday.work	Type: number
yesterday.nowork	Type: number
yesterday.nocon	Type: number
last_week	Type: StatisticPeriodData Statistics data for period
last_week.work	Type: number
last_week.nowork	Type: number
last_week.nocon	Type: number
last_month	Type: StatisticPeriodData Statistics data for period
last_month.work	Type: number
last_month.nowork	Type: number
last_month.nocon	Type: number

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

{
  "yesterday": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  },
  "last_week": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  },
  "last_month": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  }
}

Статистика цеха в едином формате (описание — в OpenAPI)

Статистика цеха в едином формате (описание — в OpenAPI).

СтатистикаBearer API keyResponse: application/json

Request

GET

/api/v1/public/statistics/workshop/{workshop_id}

Path parameters

Name	Description
workshop_id*	Type: string<uuid> Workshop UUID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/statistics/workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
yesterday	Type: StatisticPeriodData Statistics data for period
yesterday.work	Type: number
yesterday.nowork	Type: number
yesterday.nocon	Type: number
last_week	Type: StatisticPeriodData Statistics data for period
last_week.work	Type: number
last_week.nowork	Type: number
last_week.nocon	Type: number
last_month	Type: StatisticPeriodData Statistics data for period
last_month.work	Type: number
last_month.nowork	Type: number
last_month.nocon	Type: number

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

{
  "yesterday": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  },
  "last_week": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  },
  "last_month": {
    "work": 0.0,
    "nowork": 0.0,
    "nocon": 0.0
  }
}

3 маршрута

Оборудование

Справочники оборудования, типов и связанных сущностей.

Список оборудования организации (фильтры в query — по OpenAPI)

Список оборудования организации (фильтры в query — по OpenAPI).

ОборудованиеBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipments

Query parameters

Name	Description
equipment_type_id	Type: — Equipment type UUID
unit_id	Type: — Department UUID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipments?equipment_type_id=example&unit_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "equipment_type": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string"
    },
    "sensors": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sensor_type": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string"
        },
        "byte_order": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string"
        },
        "data_type": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string"
        },
        "metric_type": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string",
          "units_of_measurement": "string",
          "output_min": 0.0,
          "output_max": 0.0
        },
        "register_address": 0,
        "sensor_box": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "slave_address": 0,
          "timeout": "string",
          "interval": "string",
          "ip_address": "string"
        },
        "low_threshold_value": 0.0,
        "high_threshold_value": 0.0,
        "pre_work_threshold_value": 0.0,
        "status": "string"
      }
    ],
    "is_chpu": true,
    "is_favorite": true,
    "unit": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "workshop": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "user": {
          "id": null,
          "first_name": null,
          "last_name": null,
          "middle_name": null,
          "full_name": null,
          "phone": null,
          "email": null
        }
      },
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "email": "string"
      }
    }
  }
]

Карточка оборудования по id

Карточка оборудования по id.

ОборудованиеBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipments/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipments/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "equipment_type": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  },
  "sensors": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sensor_type": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      },
      "byte_order": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      },
      "data_type": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      },
      "metric_type": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string",
        "units_of_measurement": "string",
        "output_min": 0.0,
        "output_max": 0.0
      },
      "register_address": 0,
      "sensor_box": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "slave_address": 0,
        "timeout": "string",
        "interval": "string",
        "ip_address": "string"
      },
      "low_threshold_value": 0.0,
      "high_threshold_value": 0.0,
      "pre_work_threshold_value": 0.0,
      "status": "string"
    }
  ],
  "is_chpu": true,
  "is_favorite": true,
  "unit": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "workshop": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "phone": null,
        "email": "string"
      }
    },
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "full_name": "string",
      "email": "string"
    }
  }
}

Публичный список оборудования указанной организации

Публичный список оборудования указанной организации.

ОборудованиеBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipments/public/organization/{organization_id}

Path parameters

Name	Description
organization_id*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipments/public/organization/example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

2 маршрута

Материалы

Материалы, категории и транзакции движения материалов.

Список материалов: фильтры по цеху, оборудованию, интервалу времени

Список материалов: фильтры по цеху, оборудованию, интервалу времени.

МатериалыBearer API keyResponse: application/json

Request

GET

/api/v1/public/materials

Query parameters

Name	Description
workshop_id	Type: — Filter by workshop
equipment_id	Type: — Filter by equipment (materials from transactions)
time_start	Type: — Beginning of the period
time_finish	Type: — End of period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/materials?equipment_id=example&time_finish=example&time_start=example&workshop_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —
unit	Type: —
category	Type: —
quantity	Type: number
spent_month	Type: number
spent_total	Type: number

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "unit": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "workshop": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "user": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "full_name": "string",
          "phone": null,
          "email": "string"
        }
      },
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "email": "string"
      }
    },
    "category": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string"
    },
    "quantity": 0.0,
    "spent_month": 0.0,
    "spent_total": 0.0
  }
]

Материал по id

Материал по id.

МатериалыBearer API keyResponse: application/json

Request

GET

/api/v1/public/materials/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/materials/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —
unit	Type: —
category	Type: —
quantity	Type: number
spent_month	Type: number
spent_total	Type: number

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "unit": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "workshop": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "phone": "string",
        "email": "string"
      }
    },
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "full_name": "string",
      "email": "string"
    }
  },
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string"
  },
  "quantity": 0.0,
  "spent_month": 0.0,
  "spent_total": 0.0
}

10 маршрутов

Цеха и участки

Структура производственных подразделений и их агрегированные показатели.

Список участков

Список участков.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/units

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/units" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —
workshop	Type: —
user	Type: —

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "workshop": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "phone": "string",
        "email": "string"
      }
    },
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "full_name": "string",
      "email": "string"
    }
  }
]

Участок по id

Участок по id.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/units/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/units/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Счётчики: станки, люди, работа оборудования на участке

Счётчики: станки, люди, работа оборудования на участке.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/units/{unit_id}/count

Path parameters

Name	Description
unit_id*	Type: string<uuid>

Query parameters

Name	Description
influx_client	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/units/3fa85f64-5717-4562-b3fc-2c963f66afa6/count?influx_client=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Участки, входящие в цех

Участки, входящие в цех.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/units/workshop/{workshop_id}

Path parameters

Name	Description
workshop_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/units/workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Список цехов

Список цехов.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/workshops

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/workshops" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —
user	Type: —

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "full_name": "string",
      "phone": "string",
      "email": "string"
    }
  }
]

Цех по id

Цех по id.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/workshops/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/workshops/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Сравнение показателей цеха: текущий и предыдущий периоды

Сравнение показателей цеха: текущий и предыдущий периоды.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/workshops/{workshop_id}/comparison-stats

Path parameters

Name	Description
workshop_id*	Type: string<uuid>

Query parameters

Name	Description
time_start*	Type: string
time_finish*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/workshops/3fa85f64-5717-4562-b3fc-2c963f66afa6/comparison-stats?time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Число участков, станков, сотрудников в цеху

Число участков, станков, сотрудников в цеху.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/workshops/{workshop_id}/count

Path parameters

Name	Description
workshop_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/workshops/3fa85f64-5717-4562-b3fc-2c963f66afa6/count" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Цех со списком участков

Цех со списком участков.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/workshops/{workshop_id}/units

Path parameters

Name	Description
workshop_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/workshops/3fa85f64-5717-4562-b3fc-2c963f66afa6/units" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Все цеха с вложенными участками (units) предприятия

Все цеха с вложенными участками (units) предприятия.

Цеха и участкиBearer API keyResponse: application/json

Request

GET

/api/v1/public/workshops/all/units

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/workshops/all/units" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

14 маршрутов

Пользователи и подписки

Персональные рейтинги, подписки и связанные пользовательские данные.

Подписка/уведомления пользователя (по user_id)

Подписка/уведомления пользователя (по user_id).

Пользователи и подпискиBearer API keyResponse: application/json

Request

GET

/api/v1/public/subscriptions/by_user/{user_id}

Path parameters

Name	Description
user_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/subscriptions/by_user/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Эффективность по оборудованию пользователя (user_id в пути)

Эффективность по оборудованию пользователя (user_id в пути).

Пользователи и подпискиBearer API keyResponse: application/json

Request

GET

/api/v1/public/users/{user_id}/equipments-efficiency

Path parameters

Name	Description
user_id*	Type: string<uuid>

Query parameters

Name	Description
time_start*	Type: string
time_finish*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/equipments-efficiency?time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
object	Type: object Дополнительные поля (ключи произвольные)

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

{}

Рейтинг пользователя (user_id в пути)

Рейтинг пользователя (user_id в пути).

Пользователи и подпискиBearer API keyResponse: application/json

Request

GET

/api/v1/public/users/{user_id}/rating

Path parameters

Name	Description
user_id*	Type: string<uuid>

Query parameters

Name	Description
time_start*	Type: string
time_finish*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/rating?time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
object	Type: object Дополнительные поля (ключи произвольные)

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

{}

Суточные агрегаты рейтинга пользователя (user_id в пути)

Суточные агрегаты рейтинга пользователя (user_id в пути).

Пользователи и подпискиBearer API keyResponse: application/json

Request

GET

/api/v1/public/users/{user_id}/rating/day_count

Path parameters

Name	Description
user_id*	Type: string<uuid>

Query parameters

Name	Description
time_start*	Type: string
time_finish*	Type: string
equipment_id	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/rating/day_count?equipment_id=example&time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
	Type: —

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

[]

Список пользователей текущей организации

Список пользователей текущей организации.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user

Query parameters

Name	Description
role_id	Type: — Filter by role
unit_id	Type: — Filter by unit ID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user?role_id=example&unit_id=example" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "full_name": "string",
    "email": "string",
    "avatar": "string",
    "phone": "string",
    "is_superuser": true,
    "is_active": true,
    "position": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "role": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string"
    }
  }
]

Пользователь по id

Пользователь по id.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
first_name	Type: string
last_name	Type: string
middle_name	Type: string
full_name	Type: string
email	Type: string
avatar	Type: —
phone	Type: —
is_superuser	Type: boolean
is_active	Type: boolean
position	Type: —
role	Type: —
subscription	Type: —
unit	Type: —
time_zone	Type: string
language	Type: string

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "full_name": "string",
  "email": "string",
  "avatar": "string",
  "phone": "string",
  "is_superuser": true,
  "is_active": true,
  "position": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "role": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  }
}

Проверка JWT-аутентификации пользователя

Проверка JWT-аутентификации пользователя.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/auth/jwt

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/auth/jwt" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Проверка текущей пользовательской сессии

Проверка текущей пользовательской сессии.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/check

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/check" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
first_name	Type: string
last_name	Type: string
middle_name	Type: string
full_name	Type: string
email	Type: string
avatar	Type: —
phone	Type: —
is_superuser	Type: boolean
is_active	Type: boolean
position	Type: —
role	Type: —
subscription	Type: —
unit	Type: —
time_zone	Type: string
language	Type: string

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "full_name": "string",
  "email": "string",
  "avatar": "string",
  "phone": "string",
  "is_superuser": true,
  "is_active": true,
  "position": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "role": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  }
}

Профиль текущего пользователя

Профиль текущего пользователя.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/current_user

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/current_user" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Фото текущего пользователя

Фото текущего пользователя.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/current_user/photo

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/current_user/photo" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Параметры подключения InfluxDB для текущей организации

Параметры подключения InfluxDB для текущей организации.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/get_influx_connection_params

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/get_influx_connection_params" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Данные приглашения пользователя

Данные приглашения пользователя.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/invite

Query parameters

Name	Description
token*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/invite?token=example" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Статус подтверждения пользователя по id

Статус подтверждения пользователя по id.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/is_verified/{user_id}

Path parameters

Name	Description
user_id*	Type: string<uuid> User UUID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/is_verified/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: boolean См. схему ответа в OpenAPI

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

true

Список доступных языков интерфейса

Список доступных языков интерфейса.

Пользователи и подпискиCookie или BearerResponse: application/json

Request

GET

/api/v1/user/languages

Request example

curl -sS "https://public.api.iicd.ru/api/v1/user/languages" \
  -H "Authorization: Bearer ${API_KEY}"
# Альтернатива без Bearer: cookie Cookie_PV_data — см. PUBLIC_API_SPEC.md §0.

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
	Type: object Дополнительные поля (ключи произвольные)

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

[
  {}
]

54 маршрута

Прочее

Остальные ресурсы API, не попавшие в тематические разделы.

Список комментариев с фильтрацией (типовой список для сущности комментария)

Список комментариев с фильтрацией (типовой список для сущности комментария).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/comments

Query parameters

Name	Description
equipment_id	Type: —
user_id	Type: —
shift_id	Type: —
is_pinned	Type: —
time_start	Type: —
time_finish	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/comments?equipment_id=example&is_pinned=example&shift_id=example&time_finish=example&time_start=example&user_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "text": "string",
    "made_at": "2026-04-27T12:00:00",
    "is_pinned": true
  }
]

Комментарий по идентификатору

Комментарий по идентификатору.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/comments/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
text	Type: string
made_at	Type: string<date-time>
is_pinned	Type: boolean

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "text": "string",
  "made_at": "2026-04-27T12:00:00",
  "is_pinned": true
}

События простоев с необязательным workshop_id и прочими фильтрами

События простоев с необязательным workshop_id и прочими фильтрами.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/effective-downtime-events

Query parameters

Name	Description
workshop_id	Type: — Workshop UUID for filtering

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/effective-downtime-events?workshop_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "is_deleted": true
  }
]

Событие эффективного простоя по id

Событие эффективного простоя по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/effective-downtime-events/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/effective-downtime-events/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
is_deleted	Type: boolean

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "is_deleted": true
}

Эффективный простой: при shift_id — по смене; другие комбинации со shift_id запрещены

Эффективный простой: при shift_id — по смене; другие комбинации со shift_id запрещены.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/effective-downtimes

Query parameters

Name	Description
equipment_id	Type: —
shift_id	Type: —
event_id	Type: —
user_id	Type: —
team_id	Type: —
workshop_id	Type: —
unit_id	Type: —
time_start	Type: —
time_finish	Type: —
check_finished	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/effective-downtimes?check_finished=example&equipment_id=example&event_id=example&shift_id=example&team_id=example&time_finish=example&time_start=example&unit_id=example&user_id=example&workshop_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Запись эффективного простоя по id

Запись эффективного простоя по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/effective-downtimes/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/effective-downtimes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Агрегированная эффективность по смене

Агрегированная эффективность по смене.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/efficiency/shift

Query parameters

Name	Description
user_id	Type: — User UUID
time_start*	Type: string Start time
time_finish*	Type: string End time
equipment_id	Type: — UUID of filtering equipment

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/efficiency/shift?equipment_id=example&time_finish=example&time_start=2026-04-28T00%3A00%3A00&user_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Показатели эффективности оборудования

Показатели эффективности оборудования.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipment-efficiency

Query parameters

Name	Description
time_start*	Type: string
time_finish*	Type: string
equipment_id	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipment-efficiency?equipment_id=example&time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
object	Type: object Дополнительные поля (ключи произвольные)

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

{}

Справочник типов оборудования

Справочник типов оборудования.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipment-types

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipment-types" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  }
]

Тип оборудования по id

Тип оборудования по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipment-types/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipment-types/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
type	Type: string

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "string"
}

Набор рейтингов по единицам оборудования

Набор рейтингов по единицам оборудования.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/equipments-ratings

Query parameters

Name	Description
time_start*	Type: string
time_finish*	Type: string

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/equipments-ratings?time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Список филиалов верхнего уровня

Список филиалов верхнего уровня.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/filials

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/filials" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string"
  }
]

Филиал по id

Филиал по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/filials/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Query parameters

Name	Description
user*	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/filials/3fa85f64-5717-4562-b3fc-2c963f66afa6?user=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string"
}

Категории материалов (дерево — поддерживается recursive_depth)

Категории материалов (дерево — поддерживается recursive_depth).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/material-categories

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/material-categories" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string"
  }
]

Категория материалов по id

Категория материалов по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/material-categories/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/material-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string"
}

Операции/движения по материалам с фильтрами

Операции/движения по материалам с фильтрами.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/material-transactions

Query parameters

Name	Description
workshop_id	Type: — Filter by workshop
equipment_id	Type: — Filter by equipment
user_id	Type: — Filter by user
time_start	Type: — Beginning of the period
time_finish	Type: — End of period

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/material-transactions?equipment_id=example&time_finish=example&time_start=example&user_id=example&workshop_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
material	Type: —
user	Type: —
transaction_type	Type: string
quantity	Type: number
transaction_datetime	Type: string

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "material": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "unit": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "workshop": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "description": null,
          "user": null
        },
        "user": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "full_name": "string",
          "email": "string"
        }
      },
      "category": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string"
      },
      "quantity": 0.0,
      "spent_month": 0.0,
      "spent_total": 0.0
    },
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "full_name": "string"
    },
    "transaction_type": "string",
    "quantity": 0.0,
    "transaction_datetime": "string"
  }
]

Транзакция материала по id

Транзакция материала по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/material-transactions/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/material-transactions/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
material	Type: —
user	Type: —
transaction_type	Type: string
quantity	Type: number
transaction_datetime	Type: string

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "material": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "unit": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "workshop": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "user": {
          "id": null,
          "first_name": null,
          "last_name": null,
          "middle_name": null,
          "full_name": null,
          "phone": null,
          "email": null
        }
      },
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "email": "string"
      }
    },
    "category": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string"
    },
    "quantity": 0.0,
    "spent_month": 0.0,
    "spent_total": 0.0
  },
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "full_name": "string"
  },
  "transaction_type": "string",
  "quantity": 0.0,
  "transaction_datetime": "string"
}

Отчёт: кто какой материал сколько и как расходовал

Отчёт: кто какой материал сколько и как расходовал.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/material-transactions/consumption_report

Query parameters

Name	Description
material_id	Type: —
user_id	Type: —
date_from	Type: —
date_to	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/material-transactions/consumption_report?date_from=example&date_to=example&material_id=example&user_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
total_quantity	Type: number
transactions_count	Type: integer
user	Type: —
material	Type: —

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

[
  {
    "total_quantity": 0.0,
    "transactions_count": 0,
    "user": {},
    "material": {}
  }
]

Список уведомлений пользователя/организации

Список уведомлений пользователя/организации.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/notifications

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/notifications" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "title": "string",
    "type": "string",
    "event_name": "string",
    "event_type": "string",
    "subject": {
      "id": "string",
      "value": "string"
    },
    "object": {
      "id": "string",
      "value": "string"
    },
    "created_by_user": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2026-04-27T12:00:00",
    "is_read": true
  }
]

Уведомление по id

Уведомление по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/notifications/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/notifications/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
title	Type: string
type	Type: string
event_name	Type: string
event_type	Type: string
subject	Type: —
object	Type: —
created_by_user	Type: string<uuid>
id	Type: string<uuid>
created_at	Type: —
is_read	Type: boolean

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

{
  "title": "string",
  "type": "string",
  "event_name": "string",
  "event_type": "string",
  "subject": {
    "id": "string",
    "value": "string"
  },
  "object": {
    "id": "string",
    "value": "string"
  },
  "created_by_user": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2026-04-27T12:00:00",
  "is_read": true
}

Текущая организация API-ключа

Текущая организация API-ключа.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/organizations/me

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/organizations/me" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
description	Type: —
avatar	Type: —
inn	Type: —
kpp	Type: —
is_configured	Type: boolean

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "avatar": "string",
  "inn": "string",
  "kpp": "string",
  "is_configured": true
}

Справочник должностей сотрудников

Справочник должностей сотрудников.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/positions

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/positions" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  }
]

Должность по id

Должность по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/positions/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/positions/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string"
}

Список сенсорных боксов

Список сенсорных боксов.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-boxes

Query parameters

Name	Description
sensor_box_model_type_id	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-boxes?sensor_box_model_type_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "slave_address": 0,
    "timeout": "string",
    "interval": "string",
    "ip_address": "string",
    "sensor_box_hash": "string",
    "sensor_box_model_type": {}
  }
]

Сенсорный бокс по id

Сенсорный бокс по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-boxes/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-boxes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
slave_address	Type: integer
timeout	Type: string
interval	Type: string
ip_address	Type: string
sensor_box_hash	Type: —
sensor_box_model_type	Type: —
sensors	Type: —

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "slave_address": 0,
  "timeout": "string",
  "interval": "string",
  "ip_address": "string",
  "sensor_box_hash": "string",
  "sensor_box_model_type": {}
}

Опорные точки для графика: одно оборудование, интервал

Опорные точки для графика: одно оборудование, интервал.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/chart/data/equipment/{equipment_id}/{time_start}/{time_stop}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/chart/data/equipment/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
date	Type: string
work	Type: number
nowork	Type: number
off	Type: number
number_of_shifts	Type: integer
efficiency	Type: number

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

[
  {
    "date": "string",
    "work": 0.0,
    "nowork": 0.0,
    "off": 0.0,
    "number_of_shifts": 0,
    "efficiency": 0.0
  }
]

Данные для графика в разрезе участка

Данные для графика в разрезе участка.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/chart/data/unit/{unit_id}/{time_start}/{time_stop}

Path parameters

Name	Description
unit_id*	Type: string<uuid> Department UUID
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/chart/data/unit/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
date	Type: string
work	Type: number
nowork	Type: number
off	Type: number
number_of_shifts	Type: integer
efficiency	Type: number

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

[
  {
    "date": "string",
    "work": 0.0,
    "nowork": 0.0,
    "off": 0.0,
    "number_of_shifts": 0,
    "efficiency": 0.0
  }
]

Данные для графика в контексте цеха

Данные для графика в контексте цеха.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/chart/data/workshop/{workshop_id}/{time_start}/{time_stop}

Path parameters

Name	Description
workshop_id*	Type: string<uuid> Workshop UUID
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/chart/data/workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
date	Type: string
work	Type: number
nowork	Type: number
off	Type: number
number_of_shifts	Type: integer
efficiency	Type: number

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

[
  {
    "date": "string",
    "work": 0.0,
    "nowork": 0.0,
    "off": 0.0,
    "number_of_shifts": 0,
    "efficiency": 0.0
  }
]

Моточасы оборудования за период (параметры — в query)

Моточасы оборудования за период (параметры — в query).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/motohours/{equipment_id}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Query parameters

Name	Description
time_start*	Type: string Start time in the format YYYY-MM-DDTHH:MM:SS
time_finish*	Type: string End time in the format YYYY-MM-DDTHH:MM:SS

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/motohours/3fa85f64-5717-4562-b3fc-2c963f66afa6?time_finish=example&time_start=2026-04-28T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Произвольный интервал, своя агрегация в query (read custom)

Произвольный интервал, своя агрегация в query (read custom).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/{equipment_id}/{time_start}/{time_stop}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Срез/агрегация за прошедший календарный месяц

Срез/агрегация за прошедший календарный месяц.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/{equipment_id}/lastmonth

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/3fa85f64-5717-4562-b3fc-2c963f66afa6/lastmonth" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Данные за текущие сутки

Данные за текущие сутки.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/{equipment_id}/today

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/3fa85f64-5717-4562-b3fc-2c963f66afa6/today" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Данные за вчера

Данные за вчера.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/{equipment_id}/yesterday

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/3fa85f64-5717-4562-b3fc-2c963f66afa6/yesterday" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Полная выгрузка/агрегация доступных данных датчиков по оборудованию (см. OpenAPI)

Полная выгрузка/агрегация доступных данных датчиков по оборудованию (см. OpenAPI).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/all/{equipment_id}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Query parameters

Name	Description
time_start	Type: string Начало периода (локальная часовая зона пользователя)
time_stop	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/all/3fa85f64-5717-4562-b3fc-2c963f66afa6?time_start=2025-01-01T00%3A00%3A00&time_stop=2025-01-02T00%3A00%3A00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Суточные агрегаты датчиков по оборудованию

Суточные агрегаты датчиков по оборудованию.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/day_by_day/{equipment_id}/{time_start}/{time_stop}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/day_by_day/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Суточные агрегаты по датчикам на участке

Суточные агрегаты по датчикам на участке.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/day_by_day/by_unit/{unit_id}/{time_start}/{time_stop}

Path parameters

Name	Description
unit_id*	Type: string<uuid> Unit UUID
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/day_by_day/by_unit/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Суточные показатели по цеху

Суточные показатели по цеху.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/day_by_day/by_workshop/{workshop_id}/{time_start}/{time_stop}

Path parameters

Name	Description
workshop_id*	Type: string<uuid> Department UUID
time_start*	Type: string Period start time (in UTC)
time_stop*	Type: string Period end time (in UTC)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/day_by_day/by_workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00Z/2025-01-02T00:00:00Z" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Почасовая детализация по оборудованию

Почасовая детализация по оборудованию.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/hour_by_hour/{equipment_id}/{time_start}/{time_stop}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/hour_by_hour/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Почасовая детализация по участку

Почасовая детализация по участку.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/hour_by_hour/by_unit/{unit_id}/{time_start}/{time_stop}

Path parameters

Name	Description
unit_id*	Type: string<uuid> Unit UUID
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/hour_by_hour/by_unit/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Почасовая детализация по цеху

Почасовая детализация по цеху.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/hour_by_hour/by_workshop/{workshop_id}/{time_start}/{time_stop}

Path parameters

Name	Description
workshop_id*	Type: string<uuid> Department UUID
time_start*	Type: string Period start time (in UTC)
time_stop*	Type: string Period end time (in UTC)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/hour_by_hour/by_workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00Z/2025-01-02T00:00:00Z" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Ряд с заданной длительностью бакета (секунды) в пути

Ряд с заданной длительностью бакета (секунды) в пути.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/timeseries_custom_aggregation/{equipment_id}/{time_start}/{time_stop}/{aggregation_seconds}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)
aggregation_seconds*	Type: number Aggregation in seconds

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/timeseries_custom_aggregation/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00/0" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Агрегированные ряды; при периоде < 1 ч — мелкая агрегация (2 с)

Агрегированные ряды; при периоде < 1 ч — мелкая агрегация (2 с).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/timeseries/{equipment_id}/{time_start}/{time_stop}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/timeseries/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Данные датчиков по участку

Данные датчиков по участку.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/unit/{unit_id}/{time_start}/{time_stop}

Path parameters

Name	Description
unit_id*	Type: string<uuid> Department UUID
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/unit/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Данные датчиков по цеху целиком

Данные датчиков по цеху целиком.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/read/workshop/{workshop_id}/{time_start}/{time_stop}

Path parameters

Name	Description
workshop_id*	Type: string<uuid> Workshop UUID
time_start*	Type: string Начало периода (локальная часовая зона пользователя)
time_stop*	Type: string Конец периода (локальная часовая зона пользователя)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/read/workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6/2025-01-01T00:00:00/2025-01-02T00:00:00" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Статистика по id оборудования (альтернативный маршрут)

Статистика по id оборудования (альтернативный маршрут).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/statistic_by_id/{equipment_id}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/statistic_by_id/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Сводная статистика Influx/датчиков по организации/контексту (см. схему)

Сводная статистика Influx/датчиков по организации/контексту (см. схему).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/statistic/all

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/statistic/all" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Статистика датчиков по единице оборудования

Статистика датчиков по единице оборудования.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/statistic/equipment/{equipment_id}

Path parameters

Name	Description
equipment_id*	Type: string<uuid> UUID оборудования (Hardware)

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/statistic/equipment/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Статистика по участку

Статистика по участку.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/statistic/unit/{unit_id}

Path parameters

Name	Description
unit_id*	Type: string<uuid> Department UUID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/statistic/unit/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Статистика в контексте цеха

Статистика в контексте цеха.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensor-data/statistic/workshop/{workshop_id}

Path parameters

Name	Description
workshop_id*	Type: string<uuid> Workshop UUID

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensor-data/statistic/workshop/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

{}

Список датчиков (логические датчики)

Список датчиков (логические датчики).

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensors

Query parameters

Name	Description
sensor_box_id	Type: —
equipment_id	Type: —

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensors?equipment_id=example&sensor_box_id=example" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
_(корень)_	Type: — См. схему ответа в OpenAPI

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sensor_type": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string"
    },
    "byte_order": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string"
    },
    "data_type": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string"
    },
    "metric_type": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "units_of_measurement": "string",
      "output_min": 0.0,
      "output_max": 0.0
    },
    "register_address": 0,
    "equipment": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "is_chpu": true
    },
    "sensor_box": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "slave_address": 0,
      "timeout": "string",
      "interval": "string",
      "ip_address": "string"
    },
    "low_threshold_value": 0.0,
    "high_threshold_value": 0.0,
    "pre_work_threshold_value": 0.0,
    "status": 0
  }
]

Датчик по id

Датчик по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/sensors/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/sensors/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
sensor_type	Type: —
byte_order	Type: —
data_type	Type: —
metric_type	Type: —
register_address	Type: integer
equipment	Type: —
sensor_box	Type: src__sensors__SensorSchemas__GetSensorBoxForSensorScheme
sensor_box.id	Type: string<uuid>
sensor_box.name	Type: string
sensor_box.slave_address	Type: integer
sensor_box.timeout	Type: string
sensor_box.interval	Type: string
sensor_box.ip_address	Type: string
low_threshold_value	Type: —
high_threshold_value	Type: —
pre_work_threshold_value	Type: —
status	Type: —
input_min	Type: —
input_max	Type: —

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sensor_type": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  },
  "byte_order": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  },
  "data_type": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string"
  },
  "metric_type": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "units_of_measurement": "string",
    "output_min": 0.0,
    "output_max": 0.0
  },
  "register_address": 0,
  "equipment": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "is_chpu": true
  },
  "sensor_box": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "slave_address": 0,
    "timeout": "string",
    "interval": "string",
    "ip_address": "string"
  },
  "low_threshold_value": 0.0,
  "high_threshold_value": 0.0,
  "pre_work_threshold_value": 0.0,
  "status": 0
}

Цепочка смен (сущность shift_chain) по id

Цепочка смен (сущность shift_chain) по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/shift-chains/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/shift-chains/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
shift_ids	Type: —
shifts	Type: —
descriptions	Type: —
date_start	Type: —
date_finish	Type: —
organization	Type: —

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shift_ids": [
    "string"
  ],
  "shifts": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "team": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "created_at": "2026-04-27T12:00:00",
        "updated_at": "2026-04-27T12:00:00",
        "user": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "full_name": "string",
          "email": "string",
          "avatar": null,
          "phone": null,
          "is_superuser": true,
          "is_active": true,
          "position": null,
          "role": null
        },
        "users": [
          {
            "id": null,
            "first_name": null,
            "last_name": null,
            "middle_name": null,
            "full_name": null,
            "email": null,
            "avatar": null,
            "phone": null,
            "is_superuser": null,
            "is_active": null,
            "position": null,
            "role": null
          }
        ],
        "subscription": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "plan": "string",
          "end_date": null
        }
      },
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "full_name": "string",
        "email": "string",
        "avatar": "string",
        "phone": "string",
        "is_superuser": true,
        "is_active": true,
        "position": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "role": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": "string"
        }
      },
      "equipments": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "description": "string",
          "equipment_type": {
            "id": null,
            "type": null
          },
          "sensors": [],
          "is_chpu": true,
          "is_favorite": true,
          "unit": {
            "id": null,
            "name": null,
            "description": null,
            "workshop": null,
            "user": null
          }
        }
      ],
      "working_time": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "short_name": "string",
        "when_start": "string",
        "when_end": "string",
        "color_type": "string",
        "icon_type": 0,
        "is_holiday": true
      },
      "assignment": "string",
      "datetime_start": "2026-04-27T12:00:00",
      "datetime_finish": "2026-04-27T12:00:00"
    }
  ],
  "descriptions": "string",
  "date_start": "string",
  "date_finish": "string",
  "organization": {}
}

Справочник рабочих интервалов/календаря

Справочник рабочих интервалов/календаря.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/working-times

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/working-times" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
short_name	Type: —
when_start	Type: string<time>
when_end	Type: string<time>
color_type	Type: string
icon_type	Type: integer
is_holiday	Type: boolean

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "short_name": "string",
    "when_start": "string",
    "when_end": "string",
    "color_type": "string",
    "icon_type": 0,
    "is_holiday": true
  }
]

Интервал рабочего времени по id

Интервал рабочего времени по id.

ПрочееBearer API keyResponse: application/json

Request

GET

/api/v1/public/working-times/{entity_id}

Path parameters

Name	Description
entity_id*	Type: string<uuid>

Request example

curl -sS "https://public.api.iicd.ru/api/v1/public/working-times/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer ${API_KEY}"

Responses

200 OK

Успешный ответ

Коды ошибок

422

Ошибка валидации

Body

application/json

Основные поля

Name	Description
id	Type: string<uuid>
name	Type: string
short_name	Type: —
when_start	Type: string<time>
when_end	Type: string<time>
color_type	Type: string
icon_type	Type: integer
is_holiday	Type: boolean

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "short_name": "string",
  "when_start": "string",
  "when_end": "string",
  "color_type": "string",
  "icon_type": 0,
  "is_holiday": true
}