WORKSECTION

Мітки

Отримання списку наборів статусів/міток через API: get_tag_groups

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

https://your—domain.com/api/admin/v2/?action=get_tag_groups&hash=HASH
Повертає дані по наборах статусів/міток
У цьому запиті параметр page не потрібен

Повертає наступні дані по наборах статусів/міток:
  • id — унікальний номер набору
  • title — назва набору
  • type — показує, що це набір статусів status або міток label
  • access — видимість міток певного набору (статуси завжди видимі та мають значення public)
    public — доступний всім командам (у тому числі клієнтським)
    private — доступний тільки для внутрішніх команд компанії

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
"status": "ok",
"data": [
{
"title": "GROUP_NAME_1",
"id": GROUP_ID,
"type": "status",
"access": "public"
},
{
"title": "GROUP_NAME_2",
"id": GROUP_ID,
"type": "label",
"access": "public"
}, { "title": "GROUP_NAME_3", "id": GROUP_ID,
"type": "label", "access": "private" } ]
}

Отримання списку статусів та міток через API: get_tags

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

https://your—domain.com/api/admin/v2/?action=get_tags&hash=HASH
Повертає дані по всіх статусах та мітках з прив'язкою до набору
У цьому запиті параметр page не потрібен

Необов'язкові параметри:
  • group — повертає дані одного вибраного набору. Можна вказувати назву набору або його ID (можна отримати через цей же метод у масиві group, який повертається, або через метод get_tag_groups)

Повертаються наступні дані:
  • id — унікальний номер статусу/мітки
  • title — назва статусу/мітки
  • group — інформація щодо групи статусів/міток (значення параметрів описані в методі get_tag_groups)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
"status": "ok",
"data": [
{
"title": "LABEL_NAME",
"id": "LABEL_ID",
"group": {
"title": "GROUP_NAME",
"id": GROUP_ID,
"type": "label",
"access": "public"
} }, {
"title": "STATUS_NAME",
"id": "STATUS_ID",
"group": {
"title": "GROUP_NAME",
"id": GROUP_ID,
"type": "status",
"access": "public"
}
}
]
}

Створення групи для статусів та міток через API: add_tag_groups

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

https://your—domain.com/api/admin/v2/?action=add_tag_groups&
title=GROUP_NAME_1,GROUP_NAME_2&type=label&access=public&hash=HASH
Перевіряє на можливе існування групи статусів/міток, і створює нову, якщо необхідно
У цьому запиті параметр page не потрібен

Обов'язкові параметри:
  • type — набір статусів status або міток label
  • access — видимість міток певного набору (статуси завжди видимі та мають значення public)
    • public — доступний усім командам (у тому числі клієнтським)
      private — доступний тільки для внутрішніх команд компанії
  • title — назви груп міток/статусів, розділених комою

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "title": "GROUP_NAME_1",
            "id": GROUP_ID,
            "type": "label",
            "access": "public"
        },
        {
            "title": "GROUP_NAME_2",
            "id": GROUP_ID,
            "type": "status",
            "access": "public"
        }
    ]
}

Створення статусів та міток через API: add_tags

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

https://your—domain.com/api/admin/v2/?action=add_tags&
title=LABEL_NAME_1,LABEL_NAME_2&group=GROUP_ID&hash=HASH
Перевіряє на можливе існування статусів/міток, і створює нові, якщо необхідно
У цьому запиті параметр page не потрібен

Обов'язкові параметри:
  • group — назва або ID набору, в якому необхідно створити статуси/мітки (ID набору можна отримати через метод get_tag_groups)
  • title — назви статусів або міток, розділених комою

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "title": "LABEL_NAME_1",
            "id": LABEL_ID
        },
        {
            "title": "LABEL_NAME_2",
            "id": LABEL_ID
        }
    ]
}

Встановлення/зняття статусів та міток задачам через API: update_tags

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

https://your—domain.com/api/admin/v2/?action=update_tags&
page=/project/PROJECT_ID/TASK_ID/&plus=Tag1,Tag2&minus=Tag3,
Tag4&hash=HASH
Встановлення нових і знаття старих статусів або міток завдань
Статуси та мітки можна вказувати за їх назвами (повний збіг) або ID (можна отримати через метод get_tags)

Обов'язкові параметри:

Необов'язкові параметри:
  • plus — список статусів/міток, розділених комою, які будуть встановлені
  • minus — список статусів/міток, розділених комою, які будуть зняті

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Отримання списку всіх проектних статусів та міток через API: get_project_tags

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

https://your—domain.com/api/admin/v2/?action=get_project_tags&hash=HASH
Повертає дані по всіх проектних статусах/мітках з прив'язкою до набору
У цьому запиті параметр page не потрібен

Повертаються наступні дані:
  • id — унікальний номер проектного статусу/мітки
  • title — назва проектного статусу/мітки
  • group — інформація про групу проектних статусів/міток (значення параметрів аналогічні описаним у методі get_tag_groups)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{ "status": "ok",
    "data": [
        {
           "title": "PROJECT_STATUS_NAME_1",
            "id": "PROJECT_STATUS_ID",
            "group": {          
"title": "PROJECT_GROUP_NAME",
              "id": "PROJECT_GROUP_ID",
             "type": "status",
             "access": "public"
            }, {
            "title": "_PROJECT_LABEL_NAME_2",
            "id": "PROJECT_LABEL_ID",
            "group": {             
"title": "PROJECT_GROUP_NAME",
             "id": "PROJECT_GROUP_ID",
             "type": "label",
             "access": "public"
            }
        ]
}

Створення проектних статусів та міток через API: add_project_tags

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

https://your—domain.com/api/admin/v2/?action=add_project_tags&title=
PROJECT_LABEL_NAME_1,PROJECT_LABEL_NAME_2&group=PROJECT_GROUP_ID&hash=HASH
Перевіряє на можливе існування проектних статусів/міток, і створює нові, якщо необхідно
У цьому запиті параметр page не потрібен

Обов'язкові параметри:
  • group — назва або ID набору, в якому необхідно створити проектні статуси/мітки
  • title — назви статусів або міток, розділених комою

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

"status": "ok",
"data": [
   { "title": "PROJECT_LABEL_NAME_1", "id": PROJECT_LABEL_ID },
   { "title": "PROJECT_LABEL_NAME_2", "id": PROJECT_LABEL_ID }
]
}

Встановлення/зняття статусів та міток проектам через API: update_project_tags

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

https://your—domain.com/api/admin/v2/?action=update_project_tags& page=/project/PROJECT_ID/&plus=Tag1,Tag2&minus=Tag3,Tag4&hash=HASH
Установка нових і зняття старих статусів або міток проекту
Статуси та мітки можна вказувати за їх назвами (повний збіг) або ID (можна отримати через метод get_project_tags)

Обов'язкові параметри:
Необов'язкові параметри:
  • plus — список статусів/міток, розділених комою, які будуть встановлені проекту
  • minus — список статусів/міток, розділених комою, які будуть зняті з проекту

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok",
}
esc
или
Роздрукувати