Reclamation Service API Data Structures
BoolCommonExpression
This data structure has no properties.
CertificateInfo
JSON Example
{
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
}string As date-time As date-time
notValidBefore
Optional
notValidBefore
boolean
identityCertificateExists
Optional
identityCertificateExists
string
issuerName
Optional
issuerName
string As date-time As date-time
notValidAfter
Optional
notValidAfter
string
thumbprint
Optional
thumbprint
string
principalName
Optional
principalName
CommonExpression
This data structure has no properties.
EntitySimpleProperty
JSON Example
{
"propertyName": "string"
}string
propertyName
Optional
propertyName
Health
JSON Example
{
"opsAlertDetails": [
{
"name": "string",
"criticality": "string",
"updatedOn": "string",
"createdOn": "string",
"status": "string"
}
],
"alertsDetails": [
"string"
],
"status": "string"
}array of string
alertsDetails
Optional
alertsDetails
string
status
Optional
status
InlinebooleanLiteral1
Wraps a boolean value.
This data structure has no properties.
boolean
value
Optional
The boolean value.
InlinebooleanLiteral1
Wraps a boolean value.
This data structure has no properties.
boolean
value
Optional
The boolean value.
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
ManagementEndpointDetails
JSON Example
{
"password": "string",
"endpointUrl": "string",
"tenant": "string",
"username": "string"
}string
password
Required
password
string
endpointUrl
Required
endpointUrl
string
tenant
Required
tenant
string
username
Required
username
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
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
ReclamationDetails
JSON Example
{
"assignedDate": "string",
"resourceId": "string",
"requestReason": "string",
"waitBeforeForcingLeasePeriod": "integer",
"currentLeaseExpiryDate": "string",
"workItemId": "string",
"userComments": "string",
"machineName": "string",
"iaasMachineId": "string",
"requestor": "string",
"ownerName": "string",
"dailyCost": "number",
"newLeasePeriod": "integer",
"id": "integer",
"state": "string",
"requireAdditionalNotification": "boolean",
"currencyCode": "string",
"tenant": "string"
}string As date-time As date-time
assignedDate
Required
assignedDate
string
resourceId
Optional
resourceId
string
requestReason
Required
requestReason
integer As int32 As int32
waitBeforeForcingLeasePeriod
Required
waitBeforeForcingLeasePeriod
string As date-time As date-time
currentLeaseExpiryDate
Optional
currentLeaseExpiryDate
string
workItemId
Optional
workItemId
string
userComments
Optional
userComments
string
machineName
Required
machineName
string
iaasMachineId
Optional
iaasMachineId
string
requestor
Required
requestor
string
ownerName
Required
ownerName
number As double As double
dailyCost
Required
dailyCost
integer As int32 As int32
newLeasePeriod
Required
newLeasePeriod
integer As int64 As int64
id
Optional
id
string
state
Required
state
boolean
requireAdditionalNotification
Required
requireAdditionalNotification
string
currencyCode
Optional
currencyCode
string
tenant
Required
tenant
Sort
This data structure has no properties.
StatMetric
JSON Example
{
"statName": "string",
"value": "number"
}string
statName
Optional
statName
number As double As double
value
Optional
value
booleanLiteral
AllOf
JSON Example
{
"value": "boolean"
}
deploymentopsresource
JSON Example
{
"vcopsResourceUuid": "string",
"strings": [
{
"propertyName": "string",
"value": "string"
}
],
"stats": [
{
"statName": "string",
"value": "number"
}
],
"deploymentCafeUuid": "string",
"health": {
"opsAlertDetails": [
{
"name": "string",
"criticality": "string",
"updatedOn": "string",
"createdOn": "string",
"status": "string"
}
],
"alertsDetails": [
"string"
],
"status": "string"
},
"deploymentName": "string",
"deploymentUuid": "string"
}string
vcopsResourceUuid
Optional
vcopsResourceUuid
string
deploymentCafeUuid
Optional
deploymentCafeUuid
string
deploymentName
Optional
deploymentName
string
deploymentUuid
Optional
deploymentUuid
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"
}
]
}
metricfilter
JSON Example
{
"stat": "string",
"value": "number",
"operation": "string"
}string
stat
Optional
stat
number As double As double
value
Optional
value
string
operation
Optional
operation
metricsQuery
JSON Example
{
"stringFilters": [
{
"value": "string",
"key": "string"
}
],
"statFilters": [
{
"stat": "string",
"value": "number",
"operation": "string"
}
],
"toExpirationDate": "string",
"fromExpirationDate": "string"
}string As date-time As date-time
toExpirationDate
Optional
toExpirationDate
string As date-time As date-time
fromExpirationDate
Optional
fromExpirationDate
stringProperty
JSON Example
{
"propertyName": "string",
"value": "string"
}string
propertyName
Optional
propertyName
string
value
Optional
value
stringfilter
JSON Example
{
"value": "string",
"key": "string"
}string
value
Optional
value
string
key
Optional
key
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.
timelineStatMetricsQuery
JSON Example
{
"fromDate": "string",
"statKeyName": "string",
"toDate": "string",
"vraResourceID": "string"
}string As date-time As date-time
fromDate
Optional
fromDate
string
statKeyName
Optional
statKeyName
string As date-time As date-time
toDate
Optional
toDate
string
vraResourceID
Optional
vraResourceID
timelinemetricsresource
JSON Example
{
"fromDate": "string",
"vraResourceUuid": "string",
"strings": [
{
"propertyName": "string",
"value": "string"
}
],
"toDate": "string",
"health": {
"opsAlertDetails": [
{
"name": "string",
"criticality": "string",
"updatedOn": "string",
"createdOn": "string",
"status": "string"
}
],
"alertsDetails": [
"string"
],
"status": "string"
},
"vcopsUuid": "string"
}string As date-time As date-time
fromDate
Optional
fromDate
string
vraResourceUuid
Optional
vraResourceUuid
object
stats
Optional
stats
string As date-time As date-time
toDate
Optional
toDate
string
vcopsUuid
Optional
vcopsUuid
timelinestatmetric
JSON Example
{
"vCOPsMetricKey": "string",
"statName": "string",
"statData": [
{
"timestamp": "integer"
}
]
}string
vCOPsMetricKey
Optional
vCOPsMetricKey
string
statName
Optional
statName
timelinestatnode
JSON Example
{
"timestamp": "integer"
}object
value
Optional
value
integer As int64 As int64
timestamp
Optional
timestamp
vcopsalert
JSON Example
{
"name": "string",
"criticality": "string",
"updatedOn": "string",
"createdOn": "string",
"status": "string"
}string
name
Optional
name
string
criticality
Optional
criticality
string As date-time As date-time
updatedOn
Optional
updatedOn
string As date-time As date-time
createdOn
Optional
createdOn
string
status
Optional
status
vmresource
JSON Example
{
"pendingRequest": "boolean",
"strings": [
{
"propertyName": "string",
"value": "string"
}
],
"moref": "string",
"stats": [
{
"statName": "string",
"value": "number"
}
],
"dailyCost": "number",
"serverGuid": "string",
"health": {
"opsAlertDetails": [
{
"name": "string",
"criticality": "string",
"updatedOn": "string",
"createdOn": "string",
"status": "string"
}
],
"alertsDetails": [
"string"
],
"status": "string"
},
"vcopsUuid": "string",
"iaasUuid": "string",
"expirationDate": "string"
}boolean
pendingRequest
Optional
pendingRequest
string
moref
Optional
moref
number As double As double
dailyCost
Optional
dailyCost
string
serverGuid
Optional
serverGuid
string
vcopsUuid
Optional
vcopsUuid
string
iaasUuid
Optional
iaasUuid
string As date-time As date-time
expirationDate
Optional
expirationDate
workItemCallbackAction
JSON Example
{
"targetId": "string",
"workItemTypeId": "string",
"formData": {
"entries": [
{
"key": "string"
}
]
},
"workItemId": "string",
"assignee": "string",
"completeActionId": "string",
"completedDate": "string"
}string
targetId
Optional
targetId
string
workItemTypeId
Optional
workItemTypeId
string
workItemId
Optional
workItemId
string
assignee
Optional
assignee
string
completeActionId
Optional
completeActionId
string As date-time As date-time
completedDate
Optional
completedDate
Node: apidepo-liferay-dxp-v1-be-w-1:8080: