Bitcop Web API

Получение списка задач

Данный метод позволяет получить список задач.

GET /tasks

Входные параметры:

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

GET /api/v1/tasks

Структура ответа:

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Задача 1",
      "parent": null,
      "group": {
        "id": 1,
        "name": "Группа 1"
      },
      "taskNumber": null,
      "archived": false,
      "changedOn": "20171124T110630"
    },
    {
      "id": 2,
      "name": "Задача 2",
      "parent": {
        "id": 1,
        "name": "Задача 1"
      },
      "group": {
        "id": 1,
        "name": "Группа 1"
      },
      "taskNumber": null,
      "archived": false,
      "changedOn": "20171125T163255"
    }
  ]
}

Описание полей ответа:

Получение активности работы сотрудников по задачам

Данный метод позволяет получить активность работы сотрудников по задачам.

GET /tasks/activity

Входные параметры:

Пример запроса (группировка по сотрудникам):

GET /api/v1/tasks/activity?begin=20170920T070000&end=20170921&group=user

Структура ответа:

{
  "status": "success",
  "data": [
    {
      "user": {
        "id": 6,
        "name": "Смирнова Татьяна"
      },
      "tasks": [
        {
          "task": {
            "id": 2,
            "name": "Задача 2"
          },
          "periods": [
            [
              "20180418T091122",
              "20180418T130330"
            ],
            [
              "20180418T140532",
              "20180418T180234"
            ]
          ],
          "totalTime": 28150
        }
      ],
      "totalTime": 28150
    }
  ]
}

Пример запроса (группировка по задачам):

GET /api/v1/tasks/activity?begin=20170920T070000&end=20170921&group=task

Структура ответа:

{
  "status": "success",
  "data": [
    {
      "task": {
        "id": 2,
        "name": "Задача 2"
      },
      "users": [
        {
          "user": {
            "id": 6,
            "name": "Смирнова Татьяна"
          },
          "totalTime": 28150
        }
      ],
      "totalTime": 28150
    }
  ]
}

Создать задачу

Данный метод позволяет создать новую задачу.

POST /tasks
JSON:
{
  "name":"Название задачи"
}

Входные параметры:

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

POST /api/v1/tasks
JSON:
{
  "name":"Задача 1",
  "members":"1,2,3"
}

Структура ответа:

{
  "status": "success",
  "data": {
    "id": 1,
    "name": "Задача 1",
    "parent": null,
    "group": null,
    "taskNumber": null,
    "archived": false,
    "changedOn": "20171124T110630"
  }
}

Описание полей ответа:

Создать подзадачу

Данный метод позволяет создать подзадачу.

POST /tasks/{id}
JSON:
{
  "name":"Название подзадачи"
}

Входные параметры:

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

POST /api/v1/tasks/1
JSON:
{
  "name":"Задача 2"
}

Структура ответа:

{
  "status": "success",
  "data": {
    "id": 2,
    "name": "Задача 2",
    "parent": {
      "id": 1,
      "name": "Задача 1"
    },
    "group": null,
    "taskNumber": null,
    "archived": false,
    "changedOn": "20171125T163255"
  }
}

Описание полей ответа:

Редактировать задачу

Данный метод позволяет редактировать задачу.

PUT /tasks/{id}
JSON:
{
  "name":"Новое название задачи"
}

Входные параметры:

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

PUT /api/v1/tasks/1
JSON:
{
  "name":"Новое название задачи"
}

Структура ответа:

{
  "status": "success",
  "data": {
    "id": 1,
    "name": "Новое название задачи",
    "parent": null,
    "group": null,
    "taskNumber": null,
    "archived": false,
    "changedOn": "20171125T163255"
  }
}

Описание полей ответа:

Получение списка задач из группы

Данный метод позволяет получить список задач только из определенной группы.

GET /taskgroups/{id}/tasks

Входные параметры:

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

GET /api/v1/taskgroups/2/tasks

Структура ответа:

{
  "status": "success",
  "data": [
    {
      "id": 3,
      "name": "Задача 3",
      "parent": null,
      "group": {
        "id": 2,
        "name": "Группа 2"
      },
      "taskNumber": null,
      "archived": false,
      "changedOn": "20171126T162353"
    }
  ]
}

Описание полей ответа:

Создать задачу в группе

Данный метод позволяет создать новую задачу в определенной группе.

POST /taskgroups/{id}/tasks
JSON:
{
  "name":"Название задачи"
}

Входные параметры:

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

POST /api/v1/taskgroups/2/tasks
JSON:
{
  "name":"Задача 3"
}

Структура ответа:

{
  "status": "success",
  "data": {
    "id": 1,
    "name": "Задача 3",
    "parent": null,
    "group": {
      "id": 2,
      "name": "Группа 2"
    },
    "taskNumber": null,
    "archived": false,
    "changedOn": "20171126T162353"
  }
}

Описание полей ответа:

Архивировать задачу

Данный метод позволяет перенести задачу в архив. Вы можете перенести задачу в архив вместо удаления. Задача, перенесенная в архив, не будет отображаться в списке задач для трекинга. Вы в любое время можете восстановить задачу из архива.

POST /tasks/{id}/archive

Входные параметры:

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

POST /api/v1/tasks/1/archive

Структура ответа:

{
  "status": "success"
}

Разархивировать задачу

Данный метод позволяет восстановить задачу из архива.

POST /tasks/{id}/archive

Входные параметры:

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

POST /api/v1/tasks/1/unarchive

Структура ответа:

{
  "status": "success"
}

Получение списка групп задач

Данный метод позволяет получить список групп задач.

GET /taskgroups

Входные параметры:

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

GET /api/v1/taskgroups

Структура ответа:

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Группа 1",
      "parent": null,
      "groupNumber": null,
      "archived": false,
      "changedOn": "20171123T143142"
    }
  ]
}

Описание полей ответа:

Создать группу задач

Данный метод позволяет создать новую группу задач.

POST /taskgroups
JSON:
{
  "name":"Название группы"
 }
 

Входные параметры:

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

POST /api/v1/taskgroups
JSON:
{
  "name":"Группа 1"
 }

Структура ответа:

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Группа 1",
      "parent": null,
      "groupNumber": null,
      "archived": false,
      "changedOn": "20171123T143142"
    }
  ]
}

Описание полей ответа:

Создать подгруппу задач

Данный метод позволяет создать подгруппу задач.

POST /taskgroups/{id}
JSON:
{
  "name":"Группа 2"
 }
 

Входные параметры:

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

POST /api/v1/taskgroups/1
JSON:
{
  "name":"Группа 2"
 }

Структура ответа:

{
  "status": "success",
  "data": {
    "id": 2,
    "name": "Группа 2",
    "parent": {
      "id": 1,
      "name": "Группа 1"
    },
    "groupNumber": null,
    "changedOn": "20171126T133141"
  }
}

Описание полей ответа:

Архивировать группу задач

Данный метод позволяет перенести группу в архив. Вы можете перенести группу в архив вместо удаления. Группа, перенесенная в архив, не будет отображаться в списке задач для трекинга. Вы в любое время можете восстановить группу из архива. При архивировании группы будут перенесеты в архив все задачи в этой группе.

POST /taskgroups/{id}/archive

Входные параметры:

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

POST /api/v1/taskgroups/1/archive

Структура ответа:

{
  "status": "success"
}

Разархивировать группу задач

Данный метод позволяет восстановить группу из архива. При восстановлении группы из архива будут восстановлены все задачи в этой группе.

POST /taskgroups/{id}/unarchive

Входные параметры:

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

POST /api/v1/taskgroups/1/unarchive

Структура ответа:

{
  "status": "success"
}