Welcome Message
This chapter focuses on service for the welcome message of Squash TM.
Get welcome message
A GET to /welcome-message returns the welcome message.
HTTP request
GET /api/rest/latest/welcome-message HTTP/1.1
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 68
{
"_type" : "welcome-message",
"message" : "<h1>Bienvenue<h1>"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
the type of the entity |
|
|
the welcome message of Squash TM |
Modify welcome message
A PATCH to /welcome-message modifies the welcome message.
HTTP request
PATCH /api/rest/latest/welcome-message HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 37
Host: localhost:8080
{
"message" : "<h1>Bienvenue<h1>"
}Request fields
| Path | Type | Description |
|---|---|---|
|
|
the welcome message of Squash TM (mandatory) |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 68
{
"_type" : "welcome-message",
"message" : "<h1>Bienvenue<h1>"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
the type of the entity |
|
|
the welcome message of Squash TM |