QUINCEFIN
Відкрити меню

QUINCE API. Проєкти

Список методів

МетодОпис
/api/v2/project/listОтримання списку проєктів
/api/v2/project/loadОтримання одного проєкту за Id
/api/v2/project/addСтворення проєктів
/api/v2/project/updateОновлення проєктів

Отримання списку проєктів

Назва методу: /api/v2/project/list

Повертає список проєктів. Для навігації використовується номер сторінки page. Якщо розмір сторінки не перевизначений системними налаштуваннями, API повертає до 100 елементів.

Параметри запиту

ПолеТипОпис
filterobjectФільтр проєктів. Поля фільтра працюють з логікою AND.
filter.IdintegerІдентифікатор проєкту.
filter.NamestringПошук за назвою проєкту. Пошук виконується як входження рядка без урахування регістру.
filter.UsedInOrganizerbooleanОзнака використання проєкту в органайзері.
filter.ArchivebooleanОзнака повернення архівних проєктів. Передається в API як Void.
filter.VoidbooleanАльтернативне поле для архівності.
filter.MobileAppbooleanЯкщо true, API використовує збільшений ліміт вибірки.
pageintegerНомер сторінки. Якщо не передати, використовується перша сторінка.

Основні поля відповіді

ПолеОпис
IdІдентифікатор проєкту.
NameНазва проєкту.
FullNameПовна назва з урахуванням ієрархії.
TaskPrefixПрефікс номерів задач у проєкті.
ColorКолір проєкту.
ParentFolderІдентифікатор батьківського проєкту або папки.
ParentFolderNameНазва батьківського проєкту або папки.
PartnerІдентифікатор партнера, пов’язаного з проєктом.
PartnerNameНазва партнера.
MemoПримітка.
IsDefaultОзнака проєкту за замовчуванням.
UsedInOrganizerОзнака використання проєкту в органайзері.
VoidОзнака архівного запису.
DateCreatedДата створення.
DateModifiedДата останнього редагування.

Приклад запиту

{
  "filter": {
    "Name": "Впровадження",
    "UsedInOrganizer": true,
    "Archive": false
  },
  "page": 1
}

Отримання одного проєкту

Назва методу: /api/v2/project/load

Повертає один проєкт за Id. Ідентифікатор можна передати напряму в тілі запиту або в filter.Id.

Приклад запиту

{
  "Id": 120
}

Якщо Id не передати, API поверне помилку Execution terminated. "Id" is required.

Створення та оновлення проєктів

Назва методу створення: /api/v2/project/add

Назва методу оновлення: /api/v2/project/update

Методи додають або оновлюють проєкти пакетами. Якщо системний ліміт пакета не перевизначений, максимальний розмір пакета - 100 елементів.

Параметри запиту

ПолеТипОпис
arrayarrayМасив проєктів. Обов’язковий.
array[].IdintegerІдентифікатор проєкту. Обов’язковий для /api/v2/project/update.
array[].NamestringНазва проєкту. Обов’язкова для створення та оновлення.
array[].TaskPrefixstringПрефікс номерів задач у проєкті. Якщо проєкт використовується в органайзері й префікс не передати, система сформує його автоматично з назви.
array[].ColorstringКолір проєкту.
array[].ParentFolderintegerІдентифікатор батьківського проєкту або папки.
array[].ParentintegerАльтернативна назва поля для ParentFolder.
array[].PartnerintegerІдентифікатор партнера, пов’язаного з проєктом.
array[].MemostringПримітка.
array[].IsDefaultbooleanОзнака проєкту за замовчуванням.
array[].UsedInOrganizerbooleanОзнака використання проєкту в органайзері. Для створення за замовчуванням використовується true.
array[].VoidbooleanОзнака архівного запису.

Приклад створення

{
  "array": [
    {
      "Name": "Впровадження CRM",
      "TaskPrefix": "CRM",
      "Color": "#2F80ED",
      "UsedInOrganizer": true,
      "Memo": "Проєкт для задач команди впровадження"
    }
  ]
}

Приклад оновлення

{
  "array": [
    {
      "Id": 120,
      "Name": "Впровадження CRM",
      "Color": "#27AE60",
      "Void": false
    }
  ]
}

Формат відповіді для add і update

ПолеОпис
successОзнака успішного виконання.
data[].IdІдентифікатор створеного або оновленого проєкту.
data[].TempIdТимчасовий номер елемента в пакеті, який дає змогу зіставити відповідь із запитом.

Якщо array не передати або передати не масив, API поверне success: false і текст помилки Not valid format or empty array.