Branding Service API Data Structures
Branding
JSON Example
{
"contactUsLink": "string",
"backgroundColor": "string",
"copyright": "string",
"tenantName": "string",
"companyLogo": "string",
"companyName": "string",
"useSharedSettings": "boolean",
"global": "boolean",
"id": "string",
"textColor": "string",
"productName": "string",
"disclaimer": "string"
}
string
contactUsLink
Optional
contactUsLink
string
backgroundColor
Optional
backgroundColor
string
copyright
Optional
copyright
string
tenantName
Required
tenantName
string
companyLogo
Optional
companyLogo
string
companyName
Optional
companyName
boolean
useSharedSettings
Optional
useSharedSettings
boolean
global
Optional
global
string As uuid As uuid
id
Optional
id
string
textColor
Optional
textColor
string
productName
Optional
productName
string
disclaimer
Optional
disclaimer
MessageBoard
JSON Example
{
"passUserId": "boolean",
"customMessage": "string",
"url": "string"
}
boolean
passUserId
Optional
passUserId
string
customMessage
Optional
customMessage
string
url
Optional
url
Parameter To
Returned By
MsgBoardUrlWhiteListEntry
JSON Example
{
"id": "string",
"url": "string",
"tenant": "string"
}
string As uuid As uuid
id
Optional
id
string
url
Optional
url
string
tenant
Required
tenant
PageMsgBoardUrlWhiteListEntry
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"id": "string",
"url": "string",
"tenant": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
RestEntity
JSON Example
{
"setLocation": "boolean",
"httpStatus": "string"
}
boolean
setLocation
Optional
setLocation
string
httpStatus
Optional
httpStatus
object
httpHeaders
Optional
httpHeaders
object
body
Optional
body
Sort
This data structure has no properties.
Node: apidepo-liferay-dxp-v1-be-w-1:8080: