IPAM Service API Data Structures
AddressSpace
JSON Example
{
"providerEndpointId": "string",
"name": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
providerEndpointId
Required
providerEndpointId
string
name
Optional
name
string
description
Optional
description
string
externalId
Required
externalId
string
id
Optional
id
BoolCommonExpression
This data structure has no properties.
CommonExpression
This data structure has no properties.
DNSInfo
JSON Example
{
"alternateWINS": "string",
"preferredWINS": "string",
"primaryDNS": "string",
"dnsSearchSuffixes": "string",
"dnsSuffix": "string",
"name": "string",
"description": "string",
"secondaryDNS": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
alternateWINS
Optional
alternateWINS
string
preferredWINS
Optional
preferredWINS
string
primaryDNS
Optional
primaryDNS
string
dnsSearchSuffixes
Optional
dnsSearchSuffixes
string
dnsSuffix
Optional
dnsSuffix
string
name
Optional
name
string
description
Optional
description
string
secondaryDNS
Optional
secondaryDNS
string
id
Optional
id
EntitySimpleProperty
JSON Example
{
"propertyName": "string"
}string
propertyName
Optional
propertyName
IPAMObject
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
IPRange
JSON Example
{
"start": "string",
"description": "string",
"subnetPrefixLength": "integer",
"externalId": "string",
"dnsInfo": {
"alternateWINS": "string",
"preferredWINS": "string",
"primaryDNS": "string",
"dnsSearchSuffixes": "string",
"dnsSuffix": "string",
"name": "string",
"description": "string",
"secondaryDNS": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
},
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"providerEndpointURI": "string",
"addressSpaceId": "string",
"ipVersion": "string",
"providerEndpointId": "string",
"name": "string",
"end": "string",
"id": "string",
"gateway": "string"
}string
start
Optional
start
string
description
Optional
description
integer As int32 As int32
subnetPrefixLength
Optional
subnetPrefixLength
string
externalId
Optional
externalId
string
providerEndpointURI
Optional
providerEndpointURI
string
addressSpaceId
Optional
addressSpaceId
string
ipVersion
Optional
ipVersion
string
providerEndpointId
Required
providerEndpointId
string
name
Optional
name
string
end
Optional
end
string
id
Optional
id
string
gateway
Optional
gateway
IPRangeOperation
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
InlineResourceInfo1
This data structure has no properties.
InlineipamRequestStatus1
This data structure has no properties.
string
providerEndpointId
Optional
providerEndpointId
string
requestDetails
Optional
requestDetails
string
requestState
Required
requestState
InlineipamRequestStatus1
This data structure has no properties.
string
providerEndpointId
Optional
providerEndpointId
string
requestDetails
Optional
requestDetails
string
requestState
Required
requestState
Link
JSON Example
{
"rel": "string",
"href": "string"
}string
rel
Optional
rel
string
href
Optional
href
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
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
PageMetadata
JSON Example
{
"number": "integer",
"size": "integer",
"offset": "integer",
"totalPages": "integer",
"totalElements": "integer"
}integer As int64 As int64
number
Optional
number
integer As int64 As int64
size
Optional
size
integer As int64 As int64
offset
Optional
offset
integer As int64 As int64
totalPages
Optional
totalPages
integer As int64 As int64
totalElements
Optional
totalElements
ResourceInfo
AllOf
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
ResponseEntity
JSON Example
{
"statusCode": "string"
}object
headers
Optional
headers
object
body
Optional
body
string
statusCode
Optional
statusCode
Sort
This data structure has no properties.
ipamRequest
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"requestType": "string",
"providerCorrelationRequestId": "string",
"tenantId": "string",
"originalCallbackServiceId": "string",
"id": "string",
"version": "integer",
"requestInput": {
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
requestType
Required
requestType
string
providerCorrelationRequestId
Optional
providerCorrelationRequestId
string
tenantId
Optional
tenantId
string
originalCallbackServiceId
Optional
originalCallbackServiceId
string As uuid As uuid
id
Optional
id
integer As int64 As int64
version
Optional
version
ipamRequestStatus
AllOf
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"requestType": "string",
"providerCorrelationRequestId": "string",
"tenantId": "string",
"originalCallbackServiceId": "string",
"id": "string",
"version": "integer",
"requestInput": {
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
},
"providerEndpointId": "string",
"requestDetails": "string",
"requestPayload": {
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
},
"requestState": "string"
}
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"
}
]
}
pagedEntities
JSON Example
{
"metadata": {
"number": "integer",
"size": "integer",
"offset": "integer",
"totalPages": "integer",
"totalElements": "integer"
},
"links": [
{
"rel": "string",
"href": "string"
}
],
"content": [
{}
]
}array of object
content
Optional
content
routineRunCorrelation
Represents a Routine run correlation
JSON Example
{
"correlationType": "string",
"correlationId": "string"
}string
correlationType
Required
correlationType
string
correlationId
Required
correlationId
routineRunRunResult
Represents a Routine run result
JSON Example
{
"requestedBy": "string",
"correlation": {
"correlationType": "string",
"correlationId": "string"
},
"resultData": {
"entries": [
{
"key": "string"
}
]
},
"requestId": "string",
"runDetails": "string",
"resultHeader": {
"entries": [
{
"key": "string"
}
]
},
"runStatus": "string",
"createDate": "string",
"completeDate": "string"
}string
requestedBy
Optional
requestedBy
string
requestId
Optional
requestId
string
runDetails
Optional
runDetails
string
runStatus
Optional
runStatus
string As date-time As date-time
createDate
Optional
createDate
string As date-time As date-time
completeDate
Optional
completeDate
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-1:8080: