Команды

Описание структуры JSON-объекта, описывающего команду

Поле Тип Описание
id String Уникальный ID команды
alias String Псевдоним команды
title String Название команды
description String Описание команды
ownerAlias String Псевдоним владельца команды
avatar String Ссылка на аватар команды
selectorTitle String Селектор названия команды
private Boolean Приватная команда(true) или публичная(false)
selectorId String Селектор ID
isDeleted Boolean Команда удалена true или нет false
selectorOwnerAlias String Селектор псевдонима владельца команды
hexColor String Код цвета
selectorAlias String Псевдоним селектора команды
selectorColor String Цвет селектора
selectorHash String Хэш селектора

Метод для получения списка команд

GET /team

Запрос возвращает массив публичных команд, есть возможность настройки количества отображаемых объектов на странице

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "teamList": [
            {
                "id": "aeed70f9-aaaa-aaaa-aaaa-9086a22a65a7",
                "alias": "test",
                "title": "test",
                "description": "description",
                "ownerAlias": "user2",
                "avatar": "https://gitflic.ru/upload/img/8dd2e03e-aaaa-aaaa-aaaa-dbdd98ff4b0f.jpg",
                "private": false,
                "selectorTitle": "test",
                "selectorId": "aeed70f9-aaaa-aaaa-aaaa-9086a22a65a7",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            },
            {
                "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "alias": "gitflic",
                "title": "gitflic",
                "description": "description",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
                "private": false,
                "selectorTitle": "gitflic",
                "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод получения команд активного пользователя

GET /team/my

Запрос возвращает массив команд активного пользователя, есть возможность настройки количества отображаемых объектов на странице

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
    {
    "_embedded": {
        "teamList": [
            {
                "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "alias": "gitflic",
                "title": "gitflic",
                "description": "description",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
                "private": false,
                "selectorTitle": "gitflic",
                "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод получения команд с участием пользователя

GET /team/shared

Запрос возвращает массив команд с участием пользователя, есть возможность настройки количества отображаемых объектов на странице

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "teamList": [
            {
                "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "alias": "gitflic",
                "title": "gitflic",
                "description": "description",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
                "private": false,
                "selectorTitle": "gitflic",
                "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения команды по псевдониму

GET /team/{teamAlias}

Запрос возвращает команду

Переменная пути запроса Тип Описание
teamAlias String Псевдоним команды

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
            {
                "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "alias": "gitflic",
                "title": "gitflic",
                "description": "description",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
                "private": false,
                "selectorTitle": "gitflic",
                "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            }


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для создания команды

POST /team

Запрос создает и возвращает команду

Request

Поддерживаемый формат json

Структура тела POST-запроса:

Параметр Описание
title Название команды
isPrivate Приватная команда или нет. Принимает true или false
alias Псевдоним команды
ownerAlias Псевдоним владельца команды
ownerAliasType Тип владельца компании. Принимает USER или COMPANY
description Описание команды

Пример JSON объекта

{
    "title": "team",
    "isPrivate": "true",
    "alias": "team",
    "ownerAlias": "alias",
    "ownerAliasType": "USER",
    "description": "description"
}

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
        {
            "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
            "alias": "team",
            "title": "team",
            "description": "description",
            "ownerAlias": "alias",
            "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
            "private": true,
            "selectorTitle": "team",
            "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
            "selectorOwnerAlias": null,
            "selectorAlias": null,
            "selectorColor": null,
            "selectorHash": null
        }


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для переноса команды

POST /team/transfer

Запрос передает команду и возвращает информацию о ней

Обратите внимание, что для передачи команды другому пользователю, он должен быть администратором команды. Передача компании возможно только в том случае, если текущий владелец команды является владельцем компании.

Request

Поддерживаемый формат json

Структура тела POST-запроса:

Параметр Описание
teamAlias Псевдоним команды, которую необходимо передать
ownerAlias Псевдоним нового владельца команды

Пример JSON объекта

{
    "ownerAlias" : "alias",
    "teamAlias" : "team"
}

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
        {
            "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
            "alias": "team",
            "title": "team",
            "description": "description",
            "ownerAlias": "alias",
            "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
            "private": true,
            "selectorTitle": "team",
            "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
            "selectorOwnerAlias": null,
            "selectorAlias": null,
            "selectorColor": null,
            "selectorHash": null
        }


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод добавления пользователя в команду

POST /team/{teamAlias}/member/invite

Запрос добавляет пользователя в команду с указанной ролью

Переменная пути запроса Тип Описание
teamAlias String Псевдоним команды, в которую необходимо добавить пользователя

Request

Поддерживаемый формат json

Структура тела POST-запроса:

Параметр Описание
userAlias Псевдоним пользователя, который будет добавлен в команду
role Роль, с которой будет добавлен пользователь. Возможные значения: GUEST - гость, REPORTER - докладчик, DEVELOPER - разработчик и ADMIN - администратор 
{
    "userAlias" : "user",
    "role" : "ADMIN"
}

Responses

STATUS 200 - Пользователю отправлено приглашение в команду.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод изменения роли пользователя в команде

PUT /team/{teamAlias}/member/role

Запрос изменяет роль пользователя в команде

Переменная пути запроса Тип Описание
teamAlias String Псевдоним команды, в которой необходимо изменить роль пользователя

Request

Поддерживаемый формат json

Структура тела POST-запроса:

Параметр Описание
userAlias Псевдоним пользователя, роль которого будет изменена в команде
role Измененная роль пользователя. Возможные значения: GUEST - гость, REPORTER - докладчик, DEVELOPER - разработчик и ADMIN - администратор 
{
    "userAlias" : "user",
    "role" : "ADMIN"
}

Responses

STATUS 200 - Изменена роль пользователя.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод удаления пользователя из команды

DELETE /team/{teamAlias}/member/{userAlias}

Запрос удаляет пользователя из команды

Переменная пути запроса Тип Описание
teamAlias String Псевдоним команды, из которой необходимо удалить пользователя
userAlias String Псевдоним пользователя, которого необходимо удалить из команды

Responses

STATUS 200 - Пользователь удален из команды.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Навигация