Что такое справочники
Справочники (directories) — управляемые списки значений, используемые в карточках сущностей: отрасли клиентов (client industries), поддерживаемые форматы файлов и другие системные списки.
Отрасли клиентов
Отрасль клиента (retail, IT, медицина...) помогает группировать заказчиков и настраивать специализации исполнителей (Услуги и специализации).
Управление отраслями через API:
| Действие | Метод |
|---|---|
| Все отрасли | GET /api/integration/v1/clientIndustry |
| Одна отрасль | GET /api/integration/v1/clientIndustry/{id} |
| Добавить | POST /api/integration/v1/clientIndustry/{name} |
| Переименовать | PUT /api/integration/v1/clientIndustry/{id} |
| Удалить | DELETE /api/integration/v1/clientIndustry/{id} |
Форматы файлов
GET /api/integration/v1/directory/formats — форматы разбора, поддерживаемые аккаунтом (см. Форматы файлов).
Прочие справочники
GET /api/integration/v1/directory — получение указанного справочника по имени. Доступные имена уточняйте в Справочнике API или Swagger: app.plaia.ru/api/methods.
Практика
Справочники лучше задать до массового заведения клиентов и проектов: заполненные отрасли упростят фильтрацию и отчёты.