WORKSECTION

Проекты

Получение списка проектов через API: get_projects

Пример get_projects запроса

 https://your-domain.com/api/admin/v2/?action=get_projects&hash=HASH 
Возвращает наименования проектов, их уникальный ID, статусы (archive, active, pending), основную команду и ссылкой на проект.

Параметры:
  • user_from и user_to содержат данные о авторе и руководителе проекта
  • max_time и max_money (если указаны) содержат информацию о плановых затратах проекта
  • Параметр tags (если указано) содержит данные о статусе и метках проекта
В этом запросе параметр page не требуется

Необязательные параметры:
  • &filter=archive (active, pending) — возвращает данные проектов в указанном статусе
  • &extra=users — возвращает массив данных об участниках и их id

Пример JSON ответа 

"status": "ok",
"data":[
  {
    "id": "PROJECT_ID",
    "name": "PROJECT_NAME",
    "page": "/project/PROJECT_ID/",
    "status": "active",
    "company": "COMPANY_NAME",
    "user_from": {
        "id": "USER_ID",
        "email": "USER_EMAIL",
        "name": "USER_NAME"
        },         
    "user_to": {    
        "id": "USER_ID",         
        "email": "USER_EMAIL",             
        "name": "USER_NAME"
        }, 
"date_added": "YYYY-MM-DD HH:II",
    "date_end": "YYYY-MM-DD", "max_time": "50", "max_money": "100" }, { "id": "PROJECT_ID", "name":"PROJECT_NAME", "page": "/project/PROJECT_ID/", "status": "archive", "company": "COMPANY_NAME", "user_from": { "id": "USER_ID", "email": "USER_EMAIL", "name": "USER_NAME" }, "user_to": { "id": "USER_ID", "email": "USER_EMAIL", "name": "USER_NAME" },
"date_added": "YYYY-MM-DD HH:II",
"date_start": "YYYY-MM-DD",
    "date_end": "YYYY-MM-DD",
    "date_closed": "YYYY-MM-DD HH:II",
"tags": {
        "TAG_ID": "TAG_NAME"
    }
} ] }

Создание проекта через API: post_project

Пример post_project запроса

https://your-domain.com/api/admin/v2/?action=post_project&
email_user_from=USER_EMAIL&email_manager=USER_EMAIL&email_user_to=
USER_EMAIL&members=USER_EMAIL,USER_EMAIL&title=TASK_NAME&text=
TASK_TEXT&company=COMPANY&datestart=DD.MM.YYYYY&
dateend=DD.MM.YYYYY&hash=HASH
В данном запросе можно добавлять файлы, параметр page не требуется

Обязательные параметры:
  • email_user_from — email автора проекта
  • email_manager — email руководителя проекта
  • email_user_to — email ответственного сотрудника по умолчанию в задачах (ANY для «любой сотрудник», NOONE для «без ответственного»)
  • title – наименование проекта
  • members= — список email участников проекта разделенных запятой

Необязательные параметры:
  • text – описание проекта 
  • company – основная команда проекта
  • date_start – дата, когда проект должен стартовать в формате DD.MM.YYYY
  • date_end – дата, когда проект должен быть завершен в формате DD.MM.YYYY
  • max_time – плановые затраты времени
  • max_money – плановые затраты денег 

При успешном выполнении запроса, ответ будет содержать статус Ok и передаваемые данные

{
    "status": "ok",
    "data": {
        "id": "PROJECT_ID",
        "name": "PROJECT_NAME",
        "page": "/project/PROJECT_ID/",
        "status": "active",
        "company": "COMPANY_NAME",
        "user_from": {
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": {
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "text": "PROJECT_TEXT",
        "date_added": "YYYY-MM-DD HH:II",
        "date_start": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD",
        "max_time": 100,
        "max_money": 500
    }
}

Архивирование проекта через API: close_project

Пример close_project запроса

https://your-domain.com/api/admin/v2/?action=close_project&
page=/project/PROJECT_ID/&hash=HASH
Архивирует указанный проект

При успешном выполнении запроса, ответ будет содержать статус Ок
 
{
"status": "ok"
}

Активация проекта API: activate_project

Пример activate_project запроса 

https://your-domain.com/api/admin/v2/?action=activate_project&
page=/project/PROJECT_ID/&hash=HASH
Активирует указанный проект

При успешном выполнении запроса, ответ будет содержать статус Ок

{
"status": "ok"
}

Редактирование проекта через API: update_project

Пример update_project запроса

https://your-domain.com/api/admin/v2/?action=update_project&
page=/project=ID_PROJECT/&email_user_to=USER_EMAIL&
title=PROJECT_NAME&datestart=DD.MM.YYYY&dateend=DD.MM.YYYY&hash=HASH
 Параметр Page должен совпадать с URL проекта

Обязательные параметры:
  • page – адрес проекта 

Необязательные параметры:
  • email_user_to — email ответственного сотрудника по умолчанию в новых задачах проекта (ANY для «любой сотрудник», NOONE для "без ответственного"
  • email_manager - email руководителя проекта
  • title – наименование проекта
  • date_start – дата старта проекта в формате DD.MM.YYYY
  • date_end – дата завершения проекта в формате DD.MM.YYYY 

При успешном выполнении, ответ содержит статус ok и данные
 
{
    "status": "ok",
    "data": {
        "id": "PROJECT_ID",
        "name": "PROJECT_NAME",
        "page": "/project/PROJECT_ID/",
        "status": "active",
        "company": "COMPANY",
        "user_from": {
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": {
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "text": "PROJECT_TEXT",
        "date_added": "YYYY-MM-DD HH:II",
        "date_start": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD",
        "max_time": 100,
        "max_money": 500
    }
}

Получение списка наименований команд/папок проектов через API: get_project_groups

Пример get_project_groups запроса

https://your-domain.com/api/admin/v2/?action=get_project_groups&hash=HASH
Возвращает данные с названиями команд/папок, их id и тип.

В этом запросе параметр page не требуется 

Пример JSON ответа

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "folder"
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 0
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 1
        }
    ]
}
В ответе указанный тип:
  • "type": "folder" – папка для проектов, создана участником аккаунта
  • "type": "company", "client": 0 – Моя команда
  • "type": "company", "client": 1 – Команда-Клиент

Создание папки для проектов через API: add_project_group

Пример add_project_group запроса

https://your-domain.com/api/admin/v2/?action=add_project_group&
title=PROJECT_GROUP&hash=HASH
Проверяет на возможное существование такой папки, и создает новую, если необходимо.

В этом запросе параметр page не требуется.

Обязательные параметры:
  • title – название папки для проектов

При успешном выполнении, ответ будет содержать статус ok и данные

{
    "status": "ok",
    "data": {
        "id": "PROJECT_GROUP_ID",
        "title": "PROJECT_GROUP",
        "type": "folder"
    }
}

Получение данных проекта через API: get_project

Пример get_project запроса

https://your-domain.com/api/admin/v2/?action=get_project&page=
/project/PROJECT_ID/&hash=HASH
Возвращает наименование проекта, его уникальный ID, статус (archive, active, pending), основную команду и ссылку на проект.

Параметры:
  • user_from и user_to — содержат данные о авторе и руководителе проекта
  • max_time и max_money — (если указаны) содержат информацию о плановых затратах проекта
  • tags — (если указано) содержит данные о статусе и метках проекта
  • users — содержит массив данных об участниках проекта и их id 
  • company — содержит данные о принадлежности проекта
  • text — содержит описание проекта (если есть)  

Параметры дат:
  • date_added — дата и время создания проекта
  • date_closed — дата и время закрытия проекта
  • date_start — дата, когда проект должен стартовать (если указано) 
  • date_end — дата, когда проект должен быть закрыт (если указано) 

Пример JSON ответа 

{
    "status": "ok",
    "data": {
        "id": "PROJECT_ID",
        "name": "PROJECT_NAME",
        "page": "/project/PROJECT_ID/",
        "status": "active",
        "company": "COMPANY_NAME",
        "user_from": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "text": "PROJECT_TEXT",
        "date_added": "YYYY-MM-DD HH:II",
        "date_start": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD",
        "max_time": 100,
        "max_money": 500,
        "users": [
            {
                "id": "USER_ID", "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            {
                "id": "USER_ID", "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            { "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            { "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            }
        ]
    }
}

Добавление людей в команду проекта через API: add_project_members

Пример add_project_members запроса

https://your-domain.com/api/admin/v2/?action=add_project_members&page=
/project/PROJECT_ID/&members=USER_EMAIL_1,USER_EMAIL_2&hash=HASH
Добавляет людей в команду проекта

Обязательные параметры:
  • page – проект
  • members – email добавляемых людей, через запятую

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

{
"status": "ok"
}
esc
или
Распечатать