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
или
Распечатать