Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 kirill
|
7a50001f0b |
+680
@@ -0,0 +1,680 @@
|
|||||||
|
openapi: 3.0.3
|
||||||
|
|
||||||
|
info:
|
||||||
|
title: HRBox API
|
||||||
|
version: 1.0.0
|
||||||
|
description: |
|
||||||
|
API для чтения подразделений, трудоустройств и пользователей.
|
||||||
|
|
||||||
|
Все методы требуют авторизованную сессию HRBox и соответствующее право доступа.
|
||||||
|
Ответ содержит массив `data` и метаданные пагинации `_meta`.
|
||||||
|
|
||||||
|
servers:
|
||||||
|
- url: /api
|
||||||
|
|
||||||
|
tags:
|
||||||
|
- name: department
|
||||||
|
description: Подразделения организационной структуры
|
||||||
|
- name: employment
|
||||||
|
description: Трудоустройства пользователей
|
||||||
|
- name: user
|
||||||
|
description: Пользователи
|
||||||
|
|
||||||
|
paths:
|
||||||
|
/department:
|
||||||
|
get:
|
||||||
|
tags: [department]
|
||||||
|
summary: Получить список подразделений
|
||||||
|
operationId: getDepartments
|
||||||
|
description: Возвращает активные подразделения и организации.
|
||||||
|
x-permissions:
|
||||||
|
- show-structure-page
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Page'
|
||||||
|
- $ref: '#/components/parameters/PerPage'
|
||||||
|
- $ref: '#/components/parameters/Sort'
|
||||||
|
- $ref: '#/components/parameters/Fields'
|
||||||
|
- $ref: '#/components/parameters/Expand'
|
||||||
|
- name: id
|
||||||
|
in: query
|
||||||
|
description: ID подразделений через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: name
|
||||||
|
in: query
|
||||||
|
description: Поиск по названию
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: parent_id
|
||||||
|
in: query
|
||||||
|
description: ID родительского подразделения
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: chief_id
|
||||||
|
in: query
|
||||||
|
description: ID руководителя
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: is_organization
|
||||||
|
in: query
|
||||||
|
description: Признак организации
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: is_null_parent_id
|
||||||
|
in: query
|
||||||
|
description: Только корневые подразделения
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: status_id
|
||||||
|
in: query
|
||||||
|
description: Статусы подразделений через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: integer
|
||||||
|
- name: chief_only
|
||||||
|
in: query
|
||||||
|
description: Только подразделения текущего руководителя
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: for_boss
|
||||||
|
in: query
|
||||||
|
description: Только управляемые текущим пользователем поддеревья
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Список подразделений
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/components/schemas/PaginatedResponse'
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Department'
|
||||||
|
'401':
|
||||||
|
$ref: '#/components/responses/Unauthorized'
|
||||||
|
'403':
|
||||||
|
$ref: '#/components/responses/Forbidden'
|
||||||
|
|
||||||
|
/employment:
|
||||||
|
get:
|
||||||
|
tags: [employment]
|
||||||
|
summary: Получить список трудоустройств
|
||||||
|
operationId: getEmployments
|
||||||
|
x-permissions:
|
||||||
|
- user-edit
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Page'
|
||||||
|
- $ref: '#/components/parameters/PerPage'
|
||||||
|
- $ref: '#/components/parameters/Sort'
|
||||||
|
- $ref: '#/components/parameters/Fields'
|
||||||
|
- $ref: '#/components/parameters/Expand'
|
||||||
|
- name: id
|
||||||
|
in: query
|
||||||
|
description: ID трудоустройства
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: user_id
|
||||||
|
in: query
|
||||||
|
description: ID пользователя
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: department_id
|
||||||
|
in: query
|
||||||
|
description: ID подразделения; учитывается его поддерево
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: chief_id
|
||||||
|
in: query
|
||||||
|
description: ID трудоустройства руководителя
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: position
|
||||||
|
in: query
|
||||||
|
description: Поиск по должности
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: is_main
|
||||||
|
in: query
|
||||||
|
description: Только основное трудоустройство
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: status_id
|
||||||
|
in: query
|
||||||
|
description: Статус трудоустройства
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
- name: org_num
|
||||||
|
in: query
|
||||||
|
description: Табельные номера через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
- name: created_at
|
||||||
|
in: query
|
||||||
|
description: Дата или диапазон дат создания в формате `from|to`
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: first_name
|
||||||
|
in: query
|
||||||
|
description: Поиск по имени
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: last_name
|
||||||
|
in: query
|
||||||
|
description: Поиск по фамилии
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: name
|
||||||
|
in: query
|
||||||
|
description: Поиск по имени и фамилии пользователя
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: employment_date
|
||||||
|
in: query
|
||||||
|
description: Дата трудоустройства
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
- name: fired_date
|
||||||
|
in: query
|
||||||
|
description: Дата увольнения
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
- name: origin_id
|
||||||
|
in: query
|
||||||
|
description: Внешние ID через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
- name: origin_organization_id
|
||||||
|
in: query
|
||||||
|
description: Внешний ID организации
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: reg_status_id
|
||||||
|
in: query
|
||||||
|
description: Регистрационные статусы пользователей через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: integer
|
||||||
|
- name: user_list_key
|
||||||
|
in: query
|
||||||
|
description: Ключ сохранённого списка пользователей
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: chief_only
|
||||||
|
in: query
|
||||||
|
description: Текущий пользователь и его прямые подчинённые
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: chief_only_all
|
||||||
|
in: query
|
||||||
|
description: Текущий пользователь и все его подчинённые
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: multipleEmployment
|
||||||
|
in: query
|
||||||
|
description: Фильтр по наличию нескольких трудоустройств
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: searchInAllSubDepartments
|
||||||
|
in: query
|
||||||
|
description: Искать во всех вложенных подразделениях
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Список трудоустройств
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/components/schemas/PaginatedResponse'
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Employment'
|
||||||
|
'401':
|
||||||
|
$ref: '#/components/responses/Unauthorized'
|
||||||
|
'403':
|
||||||
|
$ref: '#/components/responses/Forbidden'
|
||||||
|
|
||||||
|
/user:
|
||||||
|
get:
|
||||||
|
tags: [user]
|
||||||
|
summary: Получить список пользователей
|
||||||
|
operationId: getUsers
|
||||||
|
x-permissions:
|
||||||
|
anyOf:
|
||||||
|
- user-list
|
||||||
|
- show-user-page
|
||||||
|
- user-invite
|
||||||
|
- authenticated user with reports
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Page'
|
||||||
|
- $ref: '#/components/parameters/PerPage'
|
||||||
|
- $ref: '#/components/parameters/Sort'
|
||||||
|
- $ref: '#/components/parameters/Fields'
|
||||||
|
- $ref: '#/components/parameters/Expand'
|
||||||
|
- name: searchQuery
|
||||||
|
in: query
|
||||||
|
description: Сквозной полнотекстовый поиск пользователей
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: q
|
||||||
|
in: query
|
||||||
|
description: Поиск по имени
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: id
|
||||||
|
in: query
|
||||||
|
description: ID пользователей через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: not_id
|
||||||
|
in: query
|
||||||
|
description: Исключить пользователя по ID
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: email
|
||||||
|
in: query
|
||||||
|
description: Поиск по электронной почте
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: phone_auth
|
||||||
|
in: query
|
||||||
|
description: Поиск по телефону авторизации
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: name
|
||||||
|
in: query
|
||||||
|
description: Поиск по имени, фамилии и отчеству
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: first_name
|
||||||
|
in: query
|
||||||
|
description: Поиск по имени
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: middle_name
|
||||||
|
in: query
|
||||||
|
description: Поиск по отчеству
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: last_name
|
||||||
|
in: query
|
||||||
|
description: Поиск по фамилии
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: department_id
|
||||||
|
in: query
|
||||||
|
description: ID подразделения; учитывается его поддерево
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: chief_id
|
||||||
|
in: query
|
||||||
|
description: ID руководителя
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: position
|
||||||
|
in: query
|
||||||
|
description: Поиск по должности
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: is_external
|
||||||
|
in: query
|
||||||
|
description: Признак внешнего пользователя
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: reg_status_id
|
||||||
|
in: query
|
||||||
|
description: Регистрационные статусы через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: integer
|
||||||
|
- name: gender_id
|
||||||
|
in: query
|
||||||
|
description: Пол пользователя; несколько значений через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: integer
|
||||||
|
- name: duty_id
|
||||||
|
in: query
|
||||||
|
description: ID внутренней услуги
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: birthday_date
|
||||||
|
in: query
|
||||||
|
description: Дата или диапазон дат рождения
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: created_at
|
||||||
|
in: query
|
||||||
|
description: Дата или диапазон дат создания в формате `from|to`
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: updated_at
|
||||||
|
in: query
|
||||||
|
description: Дата или диапазон дат изменения
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: employment_date
|
||||||
|
in: query
|
||||||
|
description: Дата или диапазон дат трудоустройства
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: is_boss
|
||||||
|
in: query
|
||||||
|
description: Признак руководителя
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: group_id
|
||||||
|
in: query
|
||||||
|
description: ID группы пользователей
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: status
|
||||||
|
in: query
|
||||||
|
description: ID персональных статусов через запятую
|
||||||
|
style: form
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: survey_id
|
||||||
|
in: query
|
||||||
|
description: ID опроса
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: survey_360_matrix_is_approved
|
||||||
|
in: query
|
||||||
|
description: Статус согласования матрицы 360
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: company
|
||||||
|
in: query
|
||||||
|
description: Поиск по компании
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: spec_id
|
||||||
|
in: query
|
||||||
|
description: ID профессиональной области
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: chief_only
|
||||||
|
in: query
|
||||||
|
description: Текущий пользователь и его прямые подчинённые
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: chief_only_all
|
||||||
|
in: query
|
||||||
|
description: Текущий пользователь и все его подчинённые
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: user_list_key
|
||||||
|
in: query
|
||||||
|
description: Ключ сохранённого списка пользователей
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
- name: withoutEmployment
|
||||||
|
in: query
|
||||||
|
description: Только пользователи без трудоустройств
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: searchInAllSubDepartments
|
||||||
|
in: query
|
||||||
|
description: Искать во всех вложенных подразделениях
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Список пользователей
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/components/schemas/PaginatedResponse'
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/User'
|
||||||
|
'401':
|
||||||
|
$ref: '#/components/responses/Unauthorized'
|
||||||
|
'403':
|
||||||
|
$ref: '#/components/responses/Forbidden'
|
||||||
|
|
||||||
|
components:
|
||||||
|
parameters:
|
||||||
|
Page:
|
||||||
|
name: page
|
||||||
|
in: query
|
||||||
|
description: Номер страницы, начиная с 1
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
minimum: 1
|
||||||
|
default: 1
|
||||||
|
PerPage:
|
||||||
|
name: per-page
|
||||||
|
in: query
|
||||||
|
description: Количество элементов на странице
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
minimum: 1
|
||||||
|
default: 20
|
||||||
|
Sort:
|
||||||
|
name: sort
|
||||||
|
in: query
|
||||||
|
description: Поля сортировки через запятую; префикс `-` задаёт сортировку по убыванию
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
Fields:
|
||||||
|
name: fields
|
||||||
|
in: query
|
||||||
|
description: Возвращаемые поля через запятую
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
Expand:
|
||||||
|
name: expand
|
||||||
|
in: query
|
||||||
|
description: Дополнительные связанные данные через запятую
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
|
||||||
|
responses:
|
||||||
|
Unauthorized:
|
||||||
|
description: Пользователь не авторизован
|
||||||
|
Forbidden:
|
||||||
|
description: Недостаточно прав
|
||||||
|
|
||||||
|
schemas:
|
||||||
|
PaginatedResponse:
|
||||||
|
type: object
|
||||||
|
required: [data, _meta]
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items: {}
|
||||||
|
_meta:
|
||||||
|
$ref: '#/components/schemas/PaginationMeta'
|
||||||
|
|
||||||
|
PaginationMeta:
|
||||||
|
type: object
|
||||||
|
required: [totalCount, pageCount, currentPage, perPage]
|
||||||
|
properties:
|
||||||
|
totalCount:
|
||||||
|
type: integer
|
||||||
|
example: 42
|
||||||
|
pageCount:
|
||||||
|
type: integer
|
||||||
|
example: 3
|
||||||
|
currentPage:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
perPage:
|
||||||
|
type: integer
|
||||||
|
example: 20
|
||||||
|
|
||||||
|
Department:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
parent_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
nullable: true
|
||||||
|
chief_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
nullable: true
|
||||||
|
is_organization:
|
||||||
|
type: boolean
|
||||||
|
status_id:
|
||||||
|
type: integer
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
|
||||||
|
Employment:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
user_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
department_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
nullable: true
|
||||||
|
chief_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
nullable: true
|
||||||
|
position:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
is_main:
|
||||||
|
type: boolean
|
||||||
|
employment_date:
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
nullable: true
|
||||||
|
fired_date:
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
nullable: true
|
||||||
|
status_id:
|
||||||
|
type: integer
|
||||||
|
org_num:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
|
||||||
|
User:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
first_name:
|
||||||
|
type: string
|
||||||
|
middle_name:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
last_name:
|
||||||
|
type: string
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
birthday_date:
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
nullable: true
|
||||||
|
reg_status_id:
|
||||||
|
type: integer
|
||||||
|
gender_id:
|
||||||
|
type: integer
|
||||||
|
nullable: true
|
||||||
|
city_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
nullable: true
|
||||||
|
company:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
is_external:
|
||||||
|
type: boolean
|
||||||
|
photo_file_id:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
nullable: true
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
-407
@@ -79,12 +79,6 @@ tags:
|
|||||||
description: Methods for admin oversight of personal API tokens. Requires "api-tokens-admin" permission.
|
description: Methods for admin oversight of personal API tokens. Requires "api-tokens-admin" permission.
|
||||||
- name: admin-employment
|
- name: admin-employment
|
||||||
description: Methods for administrative read-only access to employee employments, including external identifiers used by integrations. Requires "user-edit" permission.
|
description: Methods for administrative read-only access to employee employments, including external identifiers used by integrations. Requires "user-edit" permission.
|
||||||
- name: library
|
|
||||||
description: Корпоративная библиотека (книги). Требуется право `book-access`.
|
|
||||||
- name: admin-library-category
|
|
||||||
description: |
|
|
||||||
Редактор каталога библиотеки: дерево категорий и книг (H-1267). Требуется
|
|
||||||
право `book-manager`.
|
|
||||||
|
|
||||||
paths:
|
paths:
|
||||||
/mobile/bind/{id}/{token}:
|
/mobile/bind/{id}/{token}:
|
||||||
@@ -8270,312 +8264,6 @@ paths:
|
|||||||
Запись не найдена. Включает случаи обращения к записям,
|
Запись не найдена. Включает случаи обращения к записям,
|
||||||
принадлежащим другим тенантам.
|
принадлежащим другим тенантам.
|
||||||
|
|
||||||
|
|
||||||
/library/catalog:
|
|
||||||
get:
|
|
||||||
tags: [library]
|
|
||||||
summary: Каталог библиотеки (категории и книги)
|
|
||||||
description: |
|
|
||||||
Клиентский каталог библиотеки (H-1267). Контракт идентичен /article/category:
|
|
||||||
без параметров — корень каталога, с id/hash_id — содержимое категории.
|
|
||||||
Видимость категорий и книг по группам пользователей применяется автоматически.
|
|
||||||
operationId: libraryCatalog
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
parameters:
|
|
||||||
- name: id
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
description: ID категории (пусто — корень каталога)
|
|
||||||
schema: { type: string, format: uuid }
|
|
||||||
- name: hash_id
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
description: Хэш категории, альтернатива id
|
|
||||||
schema: { type: string }
|
|
||||||
- name: q
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
description: Поиск по названию, автору и серии книги
|
|
||||||
schema: { type: string }
|
|
||||||
- name: tags
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
description: ID тегов через запятую
|
|
||||||
schema: { type: string }
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Содержимое категории или результаты поиска
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
category:
|
|
||||||
description: Текущая категория (null для корня)
|
|
||||||
nullable: true
|
|
||||||
allOf:
|
|
||||||
- $ref: '#/components/schemas/libraryCatalogCategory'
|
|
||||||
categories:
|
|
||||||
type: array
|
|
||||||
description: Подкатегории текущей категории
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogCategory'
|
|
||||||
items:
|
|
||||||
type: array
|
|
||||||
description: Книги текущей категории
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogBook'
|
|
||||||
tags:
|
|
||||||
type: array
|
|
||||||
description: Теги, доступные в текущей категории
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/tag'
|
|
||||||
breadcrumbs:
|
|
||||||
type: array
|
|
||||||
description: Хлебные крошки (пусто для корня)
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
id: { type: string, format: uuid }
|
|
||||||
label: { type: string }
|
|
||||||
url: { type: string }
|
|
||||||
q:
|
|
||||||
type: string
|
|
||||||
nullable: true
|
|
||||||
description: Поисковый запрос
|
|
||||||
400: { description: Некорректный id категории }
|
|
||||||
404: { description: Категория не найдена }
|
|
||||||
401: { description: Unauthorized request }
|
|
||||||
403: { description: Unauthorized request }
|
|
||||||
|
|
||||||
/admin/library-category/items:
|
|
||||||
get:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Дерево каталога (один уровень)
|
|
||||||
description: |
|
|
||||||
Узлы одного уровня дерева для редактора каталога. Без id — корень,
|
|
||||||
с id категории — её дети. Дети категорий грузятся лениво повторным
|
|
||||||
запросом. У категорий в data есть children_count.
|
|
||||||
operationId: adminLibraryCategoryItems
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
parameters:
|
|
||||||
- name: id
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
description: ID категории (item_id узла, не узла дерева)
|
|
||||||
schema: { type: string, format: uuid }
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Массив узлов дерева
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogTreeNode'
|
|
||||||
403: { description: Нет права book-manager }
|
|
||||||
|
|
||||||
/admin/library-category/create:
|
|
||||||
post:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Создать категорию
|
|
||||||
operationId: adminLibraryCategoryCreate
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required: [name]
|
|
||||||
properties:
|
|
||||||
name: { type: string }
|
|
||||||
parent_id:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
nullable: true
|
|
||||||
description: ID родительского узла дерева (null — корень)
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Результат (errors при ошибке валидации)
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogEditorResult'
|
|
||||||
403: { description: Нет права book-manager }
|
|
||||||
|
|
||||||
/admin/library-category/update:
|
|
||||||
put:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Обновить узел дерева (категорию или книгу)
|
|
||||||
description: |
|
|
||||||
id — идентификатор УЗЛА дерева (key из items). Для категории принимает
|
|
||||||
name/description/status_id/thumb_style_id/content_style_id/tags_id/
|
|
||||||
userGroupsVisibleId/userGroupsHiddenId/image; для книги — title и другие
|
|
||||||
поля книги. tags_id — строка с ID через запятую. image — объект {id, fid}
|
|
||||||
(fid обязателен для построения URL картинки категории; image: null — не менять).
|
|
||||||
Узлы чужих каталогов недоступны (404).
|
|
||||||
operationId: adminLibraryCategoryUpdate
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
parameters:
|
|
||||||
- name: id
|
|
||||||
in: query
|
|
||||||
required: true
|
|
||||||
schema: { type: string, format: uuid }
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Результат
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogEditorResult'
|
|
||||||
400: { description: Некорректный uuid }
|
|
||||||
404: { description: Узел не найден или принадлежит другому каталогу }
|
|
||||||
|
|
||||||
/admin/library-category/delete:
|
|
||||||
delete:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Удалить узел дерева
|
|
||||||
description: |
|
|
||||||
Категория удаляется вместе с поддеревом; для книги удаляется только узел
|
|
||||||
(книга остаётся в библиотеке). id — идентификатор узла дерева.
|
|
||||||
operationId: adminLibraryCategoryDelete
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
parameters:
|
|
||||||
- name: id
|
|
||||||
in: query
|
|
||||||
required: true
|
|
||||||
schema: { type: string, format: uuid }
|
|
||||||
responses:
|
|
||||||
200: { description: Удалено (true) }
|
|
||||||
400: { description: Некорректный uuid }
|
|
||||||
404: { description: Узел не найден или принадлежит другому каталогу }
|
|
||||||
|
|
||||||
/admin/library-category/update-tree:
|
|
||||||
post:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Перенести узел в другую категорию
|
|
||||||
operationId: adminLibraryCategoryUpdateTree
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required: [childId]
|
|
||||||
properties:
|
|
||||||
childId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
description: ID переносимого узла дерева
|
|
||||||
parentId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
nullable: true
|
|
||||||
description: ID узла целевой категории (null — в корень)
|
|
||||||
responses:
|
|
||||||
200: { description: Перенесено }
|
|
||||||
400: { description: Не передан childId }
|
|
||||||
404: { description: Узел не найден, либо родитель — не категория }
|
|
||||||
500: { description: Перенос не выполнен }
|
|
||||||
|
|
||||||
/admin/library-category/sort:
|
|
||||||
post:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Сохранить порядок узлов
|
|
||||||
description: Карта «ID узла дерева → порядковый номер». Чужие узлы игнорируются.
|
|
||||||
operationId: adminLibraryCategorySort
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required: [sort]
|
|
||||||
properties:
|
|
||||||
sort:
|
|
||||||
type: object
|
|
||||||
additionalProperties: { type: integer }
|
|
||||||
responses:
|
|
||||||
200: { description: Сохранено }
|
|
||||||
400: { description: sort — не объект }
|
|
||||||
|
|
||||||
/admin/library-category/create-item:
|
|
||||||
post:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Добавить книгу в категорию
|
|
||||||
description: |
|
|
||||||
entity_id принудительно Entity::Book (375) — подменить нельзя. Дубликаты
|
|
||||||
по (parent_id, item_id) не создаются.
|
|
||||||
operationId: adminLibraryCategoryCreateItem
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required: [item_id]
|
|
||||||
properties:
|
|
||||||
item_id:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
description: ID книги
|
|
||||||
parent_id:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
nullable: true
|
|
||||||
description: ID узла категории (null — корень)
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Результат
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogEditorResult'
|
|
||||||
404: { description: Родитель не найден или не категория }
|
|
||||||
|
|
||||||
/admin/library-category/create-items:
|
|
||||||
post:
|
|
||||||
tags: [admin-library-category]
|
|
||||||
summary: Добавить несколько книг (мультивыбор)
|
|
||||||
description: Транзакционно; при ошибке валидации любого элемента — полный откат.
|
|
||||||
operationId: adminLibraryCategoryCreateItems
|
|
||||||
security:
|
|
||||||
- SessionAuth: [ ]
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
required: [item_id]
|
|
||||||
properties:
|
|
||||||
item_id: { type: string, format: uuid }
|
|
||||||
parent_id:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
nullable: true
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Результат (data — массив созданных узлов)
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/libraryCatalogEditorResult'
|
|
||||||
|
|
||||||
components:
|
components:
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
SessionAuth:
|
SessionAuth:
|
||||||
@@ -9187,101 +8875,6 @@ components:
|
|||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/tag'
|
$ref: '#/components/schemas/tag'
|
||||||
|
|
||||||
libraryCatalogCategory:
|
|
||||||
type: object
|
|
||||||
description: Категория каталога библиотеки
|
|
||||||
properties:
|
|
||||||
id: { type: string, format: uuid }
|
|
||||||
name: { type: string }
|
|
||||||
title: { type: string }
|
|
||||||
description: { type: string, nullable: true }
|
|
||||||
hash_id: { type: string }
|
|
||||||
url: { type: string }
|
|
||||||
status_id:
|
|
||||||
type: integer
|
|
||||||
description: 1 - Active, 2 - Disabled
|
|
||||||
thumb_style_id:
|
|
||||||
type: integer
|
|
||||||
description: Превью 1 - картинка и текст, 2 - только текст, 3 - только картинка
|
|
||||||
content_style_id:
|
|
||||||
type: integer
|
|
||||||
description: Вид содержимого 1 - плитка, 2 - список
|
|
||||||
thumbUrl: { type: string }
|
|
||||||
imageUrl: { type: string }
|
|
||||||
iconUrl: { type: string }
|
|
||||||
tags:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/tag'
|
|
||||||
|
|
||||||
libraryCatalogBook:
|
|
||||||
type: object
|
|
||||||
description: Книга в каталоге библиотеки (состав полей карточки книги)
|
|
||||||
properties:
|
|
||||||
id: { type: string, format: uuid }
|
|
||||||
entity_id: { type: integer, example: 375 }
|
|
||||||
entityId: { type: integer, example: 375 }
|
|
||||||
name: { type: string, description: Совпадает с title }
|
|
||||||
title: { type: string }
|
|
||||||
description: { type: string, nullable: true }
|
|
||||||
url: { type: string }
|
|
||||||
status_id:
|
|
||||||
type: integer
|
|
||||||
description: 1 - В библиотеке, 2 - На руках, 3 - Удалена
|
|
||||||
statusName: { type: string }
|
|
||||||
author: { type: string, nullable: true }
|
|
||||||
series: { type: string, nullable: true }
|
|
||||||
publishing_house: { type: string, nullable: true }
|
|
||||||
year_issue: { type: integer, nullable: true }
|
|
||||||
page_quantity: { type: integer, nullable: true }
|
|
||||||
read_quantity: { type: integer, nullable: true }
|
|
||||||
is_print: { type: boolean, description: Есть бумажная версия }
|
|
||||||
thumbUrl: { type: string, description: Обложка (или плейсхолдер) }
|
|
||||||
thumbMiniCubeUrl: { type: string }
|
|
||||||
tags:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/tag'
|
|
||||||
countLike: { type: integer }
|
|
||||||
isLikeUser: { type: boolean }
|
|
||||||
isFavoriteUser: { type: boolean }
|
|
||||||
isOnHandUser: { type: boolean, description: Книга сейчас на руках }
|
|
||||||
|
|
||||||
libraryCatalogTreeNode:
|
|
||||||
type: object
|
|
||||||
description: Узел дерева редактора каталога библиотеки
|
|
||||||
properties:
|
|
||||||
key:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
description: ID узла дерева (hr_category_tree_item)
|
|
||||||
title: { type: string }
|
|
||||||
folder: { type: boolean, description: true — категория }
|
|
||||||
lazy: { type: boolean, description: Дети грузятся отдельным запросом }
|
|
||||||
children:
|
|
||||||
type: array
|
|
||||||
nullable: true
|
|
||||||
description: null — не загружены (лениво)
|
|
||||||
items: { type: object }
|
|
||||||
data:
|
|
||||||
type: object
|
|
||||||
description: |
|
|
||||||
treeData сущности. Для категории — поля libraryCatalogCategory плюс item_id,
|
|
||||||
children_count, userGroupsVisible/Hidden, organization_id, isTenantSynced.
|
|
||||||
Для книги — поля libraryCatalogBook плюс item_id.
|
|
||||||
|
|
||||||
libraryCatalogEditorResult:
|
|
||||||
type: object
|
|
||||||
description: Единый формат ответа редактора каталога
|
|
||||||
properties:
|
|
||||||
success: { type: boolean }
|
|
||||||
data:
|
|
||||||
nullable: true
|
|
||||||
description: Созданный/обновлённый узел (или массив узлов для create-items)
|
|
||||||
errors:
|
|
||||||
nullable: true
|
|
||||||
description: Ошибки валидации (null при успехе)
|
|
||||||
|
|
||||||
calendarEventType:
|
calendarEventType:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Reference in New Issue
Block a user