QUINCE API. Проєкти

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

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

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

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

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

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

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

{
  "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 елементів.

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

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

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

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

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

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

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

Видалення, архівування та відновлення проєктів

Проєкти входять до довідників з уніфікованим контрактом видалення й відновлення (/api/v2/project/markasdelete і /api/v2/project/restore, той самий контракт і для папок проєктів). Повний опис формату запиту, відповіді та кодів відмов - у розділі Видалення, архівування та відновлення довідників. Проєкт за замовчуванням (IsDefault: true) видалити не можна - відмова з кодом DEFAULT_ITEM; непорожню папку - з кодом FOLDER_NOT_EMPTY.

Папки проєктів

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

Метод повертає тільки папки проєктів. Фільтр filter.ParentFolder працює за загальним правилом з розділу Папки довідників.

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

Поля відповіді

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

{
  "filter": {
    "ParentFolder": null
  },
  "page": 1
}