IPAM Service API Data Structures
{
"providerEndpointId": "string",
"name": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
providerEndpointId
name
description
externalId
id
{
"alternateWINS": "string",
"preferredWINS": "string",
"primaryDNS": "string",
"dnsSearchSuffixes": "string",
"dnsSuffix": "string",
"name": "string",
"description": "string",
"secondaryDNS": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
alternateWINS
preferredWINS
primaryDNS
dnsSearchSuffixes
dnsSuffix
name
description
secondaryDNS
id
{
"propertyName": "string"
}
propertyName
{
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
name
description
id
{
"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"
}
start
description
subnetPrefixLength
externalId
providerEndpointURI
addressSpaceId
ipVersion
providerEndpointId
name
end
id
gateway
{
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
name
description
id
providerEndpointId
requestDetails
requestState
providerEndpointId
requestDetails
requestState
{
"rel": "string",
"href": "string"
}
rel
href
{
"key": "string"
}
key
{
"expand": [
{
"propertyName": "string"
}
],
"select": [
{
"propertyName": "string"
}
],
"top": "integer",
"skipToken": "string",
"inlineCount": "string",
"orderBy": [
{
"direction": "string"
}
],
"skip": "integer",
"rawFilter": "string",
"rawOrderBy": "string"
}
top
skipToken
customOptions
inlineCount
skip
rawFilter
rawOrderBy
{
"direction": "string"
}
direction
{
"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"
}
}
pageNumber
offset
pageSize
{
"number": "integer",
"size": "integer",
"offset": "integer",
"totalPages": "integer",
"totalElements": "integer"
}
number
size
offset
totalPages
totalElements
{
"name": "string",
"description": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
{
"statusCode": "string"
}
headers
body
statusCode
{
"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"
}
]
}
}
}
lastUpdated
createdDate
requestType
providerCorrelationRequestId
tenantId
originalCallbackServiceId
id
version
{
"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"
}
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
{
"metadata": {
"number": "integer",
"size": "integer",
"offset": "integer",
"totalPages": "integer",
"totalElements": "integer"
},
"links": [
{
"rel": "string",
"href": "string"
}
],
"content": [
{}
]
}
content
Represents a Routine run correlation
{
"correlationType": "string",
"correlationId": "string"
}
correlationType
correlationId
Represents a Routine run result
{
"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"
}
requestedBy
requestId
runDetails
runStatus
createDate
completeDate
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.