Banner Message

This chapter focuses on the message showing in a banner on top of all pages.

get Get banner message

A GET to /banner-message returns the banner message.

HTTP request

GET /api/rest/latest/banner-message HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 72

{
  "_type" : "banner-message",
  "message" : "<h1>Banner message<h1>"
}

Response fields

Path Type Description

_type

String

the type of the entity

message

String

the message to show on the banner

patch Modify banner message

A PATCH to /banner-message modifies the banner message.

HTTP request

PATCH /api/rest/latest/banner-message HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 42
Host: localhost:8080

{
  "message" : "<h1>Banner message<h1>"
}

Request fields

Path Type Description

message

String

the message to show on the banner. Set to empty string to hide the banner.

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 72

{
  "_type" : "banner-message",
  "message" : "<h1>Banner message<h1>"
}

Response fields

Path Type Description

_type

String

the type of the entity

message

String

the message to show on the banner. Set to empty string to hide the banner.