Полная документация API для управления проектами в Blue - создание, обновление, удаление и запрос проектов
Обзор
Проекты являются основной организационной единицей в Blue. Они содержат списки, задачи, пользовательские поля, автоматизации и все другие данные, связанные с работой. Проекты принадлежат компаниям и имеют свои собственные системы разрешений, шаблоны и конфигурации.
Доступные операции
Основные операции с проектами
Операция | Описание | Ссылка |
---|---|---|
Create Project | Создать новый проект или из шаблона | View Details → |
List Projects | Запрос и фильтрация проектов | View Details → |
Delete Project | Удалить проект навсегда | View Details → |
Archive Project | Архивировать/разархивировать проекты | View Details → |
Rename Project | Обновить название проекта и слаг | View Details → |
Copy Project | Дублировать существующий проект | View Details → |
Компоненты проекта
Компонент | Описание | Ссылка |
---|---|---|
Lists | Управление списками задач в проектах | View Details → |
Templates | Работа с шаблонами проектов | View Details → |
Activity | Отслеживание активности и изменений проекта | View Details → |
Ключевые концепции
Структура проекта
- Проекты принадлежат компаниям
- Каждый проект может иметь несколько списков
- Списки содержат задачи
- Проекты поддерживают пользовательские поля, теги и автоматизации
Модель разрешений
Проекты имеют многоуровневую систему разрешений:
Уровень | Разрешения |
---|---|
OWNER | Full control, can delete project |
ADMIN | Manage project settings, users, and content |
MEMBER | Create and edit content |
CLIENT | Limited edit access |
VIEW_ONLY | Read-only access |
COMMENT_ONLY | Can only comment |
Категории проектов
Проекты могут быть классифицированы для лучшей организации:
- CRM
- КРОСС-ФУНКЦИОНАЛЬНЫЙ
- УСПЕХ КЛИЕНТА
- ДИЗАЙН
- ИНЖЕНЕРИЯ
- ОБЩИЙ (по умолчанию)
- ЧЕЛОВЕЧЕСКИЕ РЕСУРСЫ
- ИТ
- МАРКЕТИНГ
- ОПЕРАЦИИ
- ЛИЧНЫЙ
- ЗАКУПКИ
- ПРОДУКТ
- ПРОДАЖИ
Общие шаблоны
Создание базового проекта
mutation CreateProject {
createProject(input: {
name: "Q1 Marketing Campaign"
companyId: "company-123"
category: MARKETING
}) {
id
name
slug
}
}
Запрос проектов с фильтрами
query GetProjects {
projectList(
filter: {
companyIds: ["company-123"]
isArchived: false
categories: [MARKETING, SALES]
}
sort: [{ field: updatedAt, direction: DESC }]
take: 20
) {
items {
id
name
category
todosCount
todosDoneCount
}
pageInfo {
hasNextPage
total
}
}
}
Примечание: Запрос
projectList
является рекомендуемым подходом для запроса проектов. Существует устаревший запросprojects
, который не следует использовать для новых реализаций.
Управление списками проектов
# Get all lists in a project
query GetProjectLists {
todoLists(projectId: "project-123") {
id
title
position
todosCount
}
}
# Create a new list
mutation CreateList {
createTodoList(input: {
projectId: "project-123"
title: "To Do"
position: 1.0
}) {
id
title
}
}
Лучшие практики
-
Именование проектов
- Используйте четкие, описательные названия
- Избегайте специальных символов, которые могут повлиять на слаги
- Держите названия менее 50 символов
-
Управление разрешениями
- Начинайте с минимальных разрешений
- Используйте роль CLIENT для внешних заинтересованных сторон
- Регулярно проверяйте доступ к проектам
-
Организация
- Используйте категории для группировки схожих проектов
- Архивируйте завершенные проекты вместо удаления
- Используйте шаблоны для повторяющихся типов проектов
-
Производительность
- Используйте пагинацию для больших списков проектов
- Фильтруйте по статусу активных/архивированных
- Ограничьте количество списков на проект (макс. 50)
Обработка ошибок
Распространенные ошибки, с которыми вы можете столкнуться:
Код ошибки | Описание | Решение |
---|---|---|
PROJECT_NOT_FOUND |
Проект не существует или нет доступа | Verify project ID and permissions |
COMPANY_NOT_FOUND |
Компания не существует | Check company ID |
FORBIDDEN |
Недостаточно разрешений | Ensure proper role level |
BAD_USER_INPUT |
Ошибка валидации (например, слишком длинное имя) | Check input validation requirements |
Связанные ресурсы
- API записей - Управление задачами/записями в проектах
- API пользовательских полей - Добавление пользовательских полей в проекты
- API автоматизаций - Настройка автоматизаций проектов
- API пользователей - Управление пользователями проекта и разрешениями