Reservation Service API Data Structures
Alert
JSON Example
{
"referenceResourceId": "string",
"alertPercentLevel": "integer"
}string
referenceResourceId
Optional
referenceResourceId
integer As int32 As int32
alertPercentLevel
Optional
alertPercentLevel
AlertPolicy
JSON Example
{
"alerts": [
{
"referenceResourceId": "string",
"alertPercentLevel": "integer"
}
],
"recipients": [
"string"
],
"frequencyReminder": "integer",
"emailBgMgr": "boolean",
"enabled": "boolean"
}array of string
recipients
Optional
recipients
integer As int32 As int32
frequencyReminder
Optional
frequencyReminder
boolean
emailBgMgr
Optional
emailBgMgr
boolean
enabled
Optional
enabled
BoolCommonExpression
This data structure has no properties.
CommonExpression
This data structure has no properties.
EntitySimpleProperty
JSON Example
{
"propertyName": "string"
}string
propertyName
Optional
propertyName
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
OdataQueryInfo
JSON Example
{
"expand": [
{
"propertyName": "string"
}
],
"select": [
{
"propertyName": "string"
}
],
"top": "integer",
"skipToken": "string",
"inlineCount": "string",
"orderBy": [
{
"direction": "string"
}
],
"skip": "integer",
"rawFilter": "string",
"rawOrderBy": "string"
}integer As int32 As int32
top
Optional
top
string
skipToken
Optional
skipToken
object
customOptions
Optional
customOptions
string
inlineCount
Optional
inlineCount
integer As int32 As int32
skip
Optional
skip
string
rawFilter
Optional
rawFilter
string
rawOrderBy
Optional
rawOrderBy
OrderByExpression
JSON Example
{
"direction": "string"
}string
direction
Optional
direction
Page
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{}
],
"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
array of object
content
Optional
content
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
PageAndSortRequest
JSON Example
{
"pageNumber": "integer",
"offset": "integer",
"pageSize": "integer",
"queryInfo": {
"expand": [
{
"propertyName": "string"
}
],
"select": [
{
"propertyName": "string"
}
],
"top": "integer",
"skipToken": "string",
"inlineCount": "string",
"orderBy": [
{
"direction": "string"
}
],
"skip": "integer",
"rawFilter": "string",
"rawOrderBy": "string"
}
}integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
offset
Optional
offset
integer As int32 As int32
pageSize
Optional
pageSize
PageReservation
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"alertPolicy": {
"alerts": [
{
"referenceResourceId": "string",
"alertPercentLevel": "integer"
}
],
"recipients": [
"string"
],
"frequencyReminder": "integer",
"emailBgMgr": "boolean",
"enabled": "boolean"
},
"reservationTypeId": "string",
"reservationPolicyId": "string",
"priority": "integer",
"version": "integer",
"enabled": "boolean",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"lastUpdated": "string",
"subTenantId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"id": "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
PageReservationInfo
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"reservationTypeRef": {
"id": "string",
"label": "string"
},
"name": "string",
"tenantId": "string",
"subTenantRef": {
"id": "string",
"label": "string"
},
"id": "string",
"priority": "integer",
"enabled": "boolean",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"reservationPolicyRef": {
"id": "string",
"label": "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
PageSubtenant
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"subtenantRoles": [
{
"name": "string",
"principalId": [
{
"domain": "string",
"name": "string"
}
],
"id": "string",
"scopeRoleRef": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"tenant": "string",
"extensionData": {
"entries": [
{
"key": "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
PageTenant
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"defaultTenant": "boolean",
"password": "string",
"urlName": "string",
"contactEmail": "string",
"name": "string",
"description": "string",
"id": "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
ProviderPreferences
JSON Example
{
"preferences": {
"entries": [
{
"key": "string"
}
]
},
"serviceTypeId": "string",
"id": "string"
}string
serviceTypeId
Optional
serviceTypeId
string As uuid As uuid
id
Optional
id
Reservation
JSON Example
{
"alertPolicy": {
"alerts": [
{
"referenceResourceId": "string",
"alertPercentLevel": "integer"
}
],
"recipients": [
"string"
],
"frequencyReminder": "integer",
"emailBgMgr": "boolean",
"enabled": "boolean"
},
"reservationTypeId": "string",
"reservationPolicyId": "string",
"priority": "integer",
"version": "integer",
"enabled": "boolean",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"lastUpdated": "string",
"subTenantId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"id": "string"
}string
reservationTypeId
Optional
reservationTypeId
string
reservationPolicyId
Optional
reservationPolicyId
integer As int32 As int32
priority
Optional
priority
integer As int64 As int64
version
Optional
version
boolean
enabled
Optional
enabled
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string
subTenantId
Optional
subTenantId
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
tenantId
Optional
tenantId
string
id
Optional
id
Property Of
ReservationInfo
JSON Example
{
"reservationTypeRef": {
"id": "string",
"label": "string"
},
"name": "string",
"tenantId": "string",
"subTenantRef": {
"id": "string",
"label": "string"
},
"id": "string",
"priority": "integer",
"enabled": "boolean",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"reservationPolicyRef": {
"id": "string",
"label": "string"
}
}string
name
Optional
name
string
tenantId
Optional
tenantId
string
id
Optional
id
integer As int32 As int32
priority
Optional
priority
boolean
enabled
Optional
enabled
Sort
This data structure has no properties.
importRequest
JSON Example
{
"classId": "string",
"data": [
"string"
],
"mimeType": "string",
"inDryRunMode": "boolean",
"resolutionMode": "string"
}string
classId
Optional
classId
array of string
data
Required
data
string
mimeType
Optional
mimeType
boolean
inDryRunMode
Optional
inDryRunMode
string
resolutionMode
Optional
resolutionMode
labelledReference
JSON Example
{
"id": "string",
"label": "string"
}string
id
Optional
id
string
label
Optional
label
literal
Wraps a value such that values of different types can be treated generically.
This data structure has no properties.
literalMap
Equivalent of java.util.Map
JSON Example
{
"entries": [
{
"key": "string"
}
]
}
operationError
JSON Example
{
"errorMessage": "string",
"errorCode": "integer"
}string
errorMessage
Optional
errorMessage
integer As int32 As int32
errorCode
Optional
errorCode
operationResult
JSON Example
{
"operationErrors": [
{
"errorMessage": "string",
"errorCode": "integer"
}
],
"operationStatus": "string",
"contentId": "string",
"contentTypeId": "string",
"messages": [
"string"
],
"contentName": "string"
}string
operationStatus
Optional
operationStatus
string
contentId
Optional
contentId
string
contentTypeId
Optional
contentTypeId
array of string
messages
Optional
messages
string
contentName
Optional
contentName
principalId
JSON Example
{
"domain": "string",
"name": "string"
}string
domain
Optional
domain
string
name
Optional
name
subtenant
JSON Example
{
"subtenantRoles": [
{
"name": "string",
"principalId": [
{
"domain": "string",
"name": "string"
}
],
"id": "string",
"scopeRoleRef": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"tenant": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
string
tenant
Optional
tenant
subtenantRole
JSON Example
{
"name": "string",
"principalId": [
{
"domain": "string",
"name": "string"
}
],
"id": "string",
"scopeRoleRef": "string"
}string
name
Optional
name
string
id
Optional
id
string
scopeRoleRef
Optional
scopeRoleRef
tenant
JSON Example
{
"defaultTenant": "boolean",
"password": "string",
"urlName": "string",
"contactEmail": "string",
"name": "string",
"description": "string",
"id": "string"
}boolean
defaultTenant
Optional
defaultTenant
string
password
Optional
password
string
urlName
Optional
urlName
string
contactEmail
Optional
contactEmail
string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
timeSpan
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
JSON Example
{
"unit": "string",
"amount": "integer"
}string
unit
Optional
The unit of measure for the time span. e.g: days.
integer As int64 As int64
amount
Optional
The amount for the time span.
Node: apidepo-liferay-dxp-v1-be-w-0:8080: