GitFlic API
Команды
Описание структуры JSON-объекта, описывающего команду
Поле | Тип | Описание |
---|---|---|
id |
string | Уникальный ID команды |
alias |
string | Алиас команды |
title |
string | Название команды |
description |
string | Описание команды |
ownerAlias |
string | Псевдоним владельца команды |
avatar |
string | Ссылка на аватар команды |
selectorTitle |
string | Селектор названия команды |
private |
boolean | Приватная команда(true) или публичная(false) |
selectorId |
string | Селектор ID |
selectorOwnerAlias |
string | Селектор псевдонима владельца команды |
selectorAlias |
string | Селектор псевдонима команды |
selectorColor |
string | Селектор цвета |
selectorHash |
string | Селектор хэша |
GET /team
Запрос возвращает массив команд, есть возможность настройки количества отображаемых объектов на странице
Запрос | Описание |
---|---|
GET /team |
Список публичных команд |
Responses
STATUS 200
- пример JSON:
{
"_embedded": {
"teamList": [
{
"id": "aeed70f9-274f-4403-8916-9086a22a65a7",
"alias": "test",
"title": "test",
"description": "",
"ownerAlias": "user2",
"avatar": "https://gitflic.ru/upload/img/8dd2e03e-5f91-4deb-8f0d-dbdd98ff4b0f.jpg",
"selectorTitle": "test",
"private": false,
"selectorId": "aeed70f9-274f-4403-8916-9086a22a65a7",
"selectorOwnerAlias": null,
"selectorAlias": null,
"selectorColor": null,
"selectorHash": null
},
{
"id": "2bee3ea6-dcc7-4ce5-9349-2d98d59e71f7",
"alias": "gitflic",
"title": "Гитфлиц",
"description": "",
"ownerAlias": "user1",
"avatar": "https://gitflic.ru/upload/img/065abe2c-b5cf-4c59-9cda-3ffebd3a4f28.jpg",
"selectorTitle": "Гитфлиц",
"private": false,
"selectorId": "2bee3ea6-dcc7-4ce5-9349-2d98d59e71f7",
"selectorOwnerAlias": null,
"selectorAlias": null,
"selectorColor": null,
"selectorHash": null
},
{
"id": "6cfe8d60-ca3b-4822-8b11-7e9fe331dc7a",
"alias": "komanda-2",
"title": "команда 2",
"description": "",
"ownerAlias": "user2",
"avatar": "https://gitflic.ru/upload/img/7dfbffd1-7466-412e-8d6b-e5f5085d728a.jpg",
"selectorTitle": "команда 2",
"private": false,
"selectorId": "6cfe8d60-ca3b-4822-8b11-7e9fe331dc7a",
"selectorOwnerAlias": null,
"selectorAlias": null,
"selectorColor": null,
"selectorHash": null
}
]
},
"page": {
"size": 10,
"totalElements": 3,
"totalPages": 1,
"number": 0
}
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
GET /team/my
Запрос возвращает массив команд, есть возможность настройки количества отображаемых объектов на странице
Запрос | Описание |
---|---|
GET /team/my |
Список личных команд |
Responses
STATUS 200
- пример JSON:
{
"_embedded": {
"teamList": [
{
"id": "2bee3ea6-dcc7-4ce5-9349-2d98d59e71f7",
"alias": "gitflic",
"title": "Гитфлик",
"description": "",
"ownerAlias": "dbi471",
"avatar": "https://gitflic.ru/upload/img/065abe2c-b5cf-4c59-9cda-3ffebd3a4f28.jpg",
"selectorTitle": "Гитфлик",
"private": false,
"selectorId": "2bee3ea6-dcc7-4ce5-9349-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
Запрос возвращает массив команд, есть возможность настройки количества отображаемых объектов на странице
Запрос | Описание |
---|---|
GET /team/shared |
Список команд с вашим участием |
Responses
STATUS 200
- пример JSON:
{
"_embedded": {
"teamList": [
{
"id": "d6117daa-d001-4a4d-b6c6-f196c3b1584b",
"alias": "pegasus",
"title": "pegasus",
"description": "Пегас ударом копыта о землю мог выбивать источники.",
"ownerAlias": "user1",
"avatar": "https://gitflic.ru/upload/img/7dfbffd1-7466-412e-8d6b-e5f5085d728a.jpg",
"selectorTitle": "pegasus",
"private": true,
"selectorId": "d6117daa-d001-4a4d-b6c6-f196c3b1584b",
"selectorOwnerAlias": null,
"selectorAlias": null,
"selectorColor": null,
"selectorHash": null
}
]
},
"page": {
"size": 10,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
GET /team/{teamAlias}
Запрос возвращает команду.
Запрос | Описание |
---|---|
GET team/{teamAlias} |
Получить информацию о команде по алиасу |
Переменная пути запроса | Тип | Описание |
---|---|---|
teamAlias |
String | Псевдоним пользователя |
Responses
STATUS 200
- пример JSON:
{
"id": "2bee3ea6-dcc7-4ce5-9349-2d98d59e71f7",
"alias": "gitflic",
"title": "Гитфлиц",
"description": "",
"ownerAlias": "user1",
"avatar": "https://gitflic.ru/upload/img/065abe2c-b5cf-4c59-9cda-3ffebd3a4f28.jpg",
"selectorTitle": "Гитфлиц",
"private": false,
"selectorId": "2bee3ea6-dcc7-4ce5-9349-2d98d59e71f7",
"selectorOwnerAlias": null,
"selectorAlias": null,
"selectorColor": null,
"selectorHash": null
}
STATUS 403
- Нет прав для доступа.
STATUS 404
- Данные по запросу не найдены.
В данной статье
Документация
- Общая информация
- Основные настройки
- Авторизация и регистрация
- Уведомления
- Создание README для профиля
- Введение
- Получение Access Token
- Пагинация
- Методы для проектов
- Методы для пользователей
- Методы для команд
- Методы для компаний
- Методы для проблем
- Методы для комментариев к проблемам
- Методы для коммитов
- Методы для релизов
- Методы для запросов на слияние
- Методы для веток
- Методы для вебхуков
- Методы для тегов