Примечание: Эта функция была введена в GitLab 8.12.
API для трансляционных сообщений доступен только администраторам. Все запросы от гостей будут отвечать кодом 401 Unauthorized
, а все запросы от обычных пользователей — кодом 403 Forbidden
.
GET /broadcast_messages
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/broadcast_messages
Пример ответа:
[
{
"message":"Пример трансляционного сообщения",
"starts_at":"2016-08-24T23:21:16.078Z",
"ends_at":"2016-08-26T23:21:16.080Z",
"color":"#E75E40",
"font":"#FFFFFF",
"id":1,
"active": false
}
]
GET /broadcast_messages/:id
Атрибут | Тип | Обязательный | Описание |
---|---|---|---|
id |
integer | да | ID трансляционного сообщения |
message |
string | да | Сообщение для отображения |
starts_at |
datetime | нет | Время начала (по умолчанию текущее время) |
ends_at |
datetime | нет | Время окончания (по умолчанию через час от текущего времени) |
color |
string | нет | Шестнадцатеричный код цвета фона |
font |
string | нет | Шестнадцатеричный код цвета шрифта |
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/broadcast_messages/1
Пример ответа:
{
"message":"Выполняется развертывание",
"starts_at":"2016-08-24T23:21:16.078Z",
"ends_at":"2016-08-26T23:21:16.080Z",
"color":"#cecece",
"font":"#FFFFFF",
"id":1,
"active":false
}
```## Создание трансляционного сообщения
POST /broadcast_messages
| Атрибут | Тип | Обязательный | Описание |
| ----------- | -------- | -------- | ---------------------------------------------------- |
| `message` | string | да | Сообщение для отображения |
| `starts_at` | datetime | нет | Время начала (по умолчанию текущее время) |
| `ends_at` | datetime | нет | Время окончания (по умолчанию через час от текущего времени) |
| `color` | string | нет | Шестнадцатеричный код цвета фона |
| `font` | string | нет | Шестнадцатеричный код цвета шрифта |
```bash
curl --data "message=Выполняется развертывание&color=#cecece" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/broadcast_messages
Пример ответа:
{
"message":"Развертывание в процессе",
"starts_at":"2016-08-26T00:41:35.060Z",
"ends_at":"2016-08-26T01:41:35.060Z",
"color":"#cecece",
"font":"#FFFFFF",
"id":1,
"active": true
}
PUT /broadcast_messages/:id
Атрибут | Тип | Обязательный | Описание |
---|---|---|---|
id |
integer | да | ID сообщения рассылки |
message |
string | нет | Сообщение для отображения |
starts_at |
datetime | нет | Время начала |
ends_at |
datetime | нет | Время окончания |
color |
string | нет | Шестнадцатеричный код цвета фона |
font |
string | нет | Шестнадцатеричный код цвета шрифта |
curl --request PUT --data "message=Обновить сообщение&color=#000" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/broadcast_messages/1
```Пример ответа:
```json
{
"message": "Обновить сообщение",
"starts_at": "2016-08-26T00:41:35.060Z",
"ends_at": "2016-08-26T01:41:35.060Z",
"color": "#000",
"font": "#FFFFFF",
"id": 1,
"active": true
}
DELETE /broadcast_messages/:id
Атрибут | Тип | Обязательный | Описание |
---|---|---|---|
id |
integer (целое число) | да | ID сообщения рассылки |
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/broadcast_messages/1
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )