Jump to

• Request
• Response

Get IPv4 Addresses by IP Subnet

get

/ipSubnet/IPV4/{id}/ipAddresses

Gets the IPv4 addresses that match the specified IP subnet ID.

Attribute selection is enabled for all first-level attributes.

Request

Path Parameters

• id(required): string
  The ID of the IP subnet.

Query Parameters

• depth: integer
  The depth of the expansion.

  Default Value: 0
• expand: string
  The additional details to include in the response.
• fields: string
  The fields to include in the response.
• limit: integer
  The number of items to return.

  Default Value: 200
• offset: integer
  The number of items to skip before starting to collect the result set.

  Default Value: 0
• sort: string
  The fields to sort.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The IPv4 addresses were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: IPV4Address
  An IPv4 address.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IPV4Address"
    }
}

Nested Schema : IPV4Address

An IPv4 address.

Match All

Show Source

• allOf IPAddress
  An IP address.
• object IPV4Address-allOf[1]

{
    "description":"An IPv4 address.",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPAddress"
        },
        {
            "type":"object",
            "properties":{
                "ipv4Address":{
                    "type":"string",
                    "description":"The IP address."
                }
            }
        }
    ]
}

Nested Schema : IPAddress

An IP address.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object IPAddress-allOf[1]

{
    "description":"An IP address.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "prefixLength":{
                    "type":"integer",
                    "description":"The number of bits in the prefix."
                },
                "macAddress":{
                    "type":"string",
                    "description":"The MAC address."
                },
                "macAddressType":{
                    "type":"string",
                    "description":"The type of MAC address."
                },
                "numericAddress":{
                    "type":"integer",
                    "readOnly":true
                },
                "ipAddressDomain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "parentSubnet":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/IPSubnet"
                        }
                    ],
                    "description":"The parent IP subnet of the IP address.",
                    "readOnly":true
                },
                "parentNetwork":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/IPNetwork"
                        }
                    ],
                    "description":"The parent IP network of the IP address.",
                    "readOnly":true
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : IPAddress-allOf[1]

Type: object

Show Source

• ipAddressDomain: NetworkAddressDomain
  A network address domain.
• macAddress: string
  The MAC address.
• macAddressType: string
  The type of MAC address.
• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• numericAddress: integer
  Read Only: true
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• parentNetwork: object parentNetwork
  Read Only: true

  The parent IP network of the IP address.
• parentSubnet: object parentSubnet
  Read Only: true

  The parent IP subnet of the IP address.
• prefixLength: integer
  The number of bits in the prefix.

{
    "type":"object",
    "properties":{
        "prefixLength":{
            "type":"integer",
            "description":"The number of bits in the prefix."
        },
        "macAddress":{
            "type":"string",
            "description":"The MAC address."
        },
        "macAddressType":{
            "type":"string",
            "description":"The type of MAC address."
        },
        "numericAddress":{
            "type":"integer",
            "readOnly":true
        },
        "ipAddressDomain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "parentSubnet":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/IPSubnet"
                }
            ],
            "description":"The parent IP subnet of the IP address.",
            "readOnly":true
        },
        "parentNetwork":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/IPNetwork"
                }
            ],
            "description":"The parent IP network of the IP address.",
            "readOnly":true
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

Nested Schema : IPV4Address-allOf[1]

Type: object

Show Source

• ipv4Address: string
  The IP address.

{
    "type":"object",
    "properties":{
        "ipv4Address":{
            "type":"string",
            "description":"The IP address."
        }
    }
}

Nested Schema : NetworkAddressDomain

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object NetworkAddressDomain-allOf[1]

{
    "description":"A network address domain.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the network address domain. It also indicates the ID of the domain."
                },
                "networkAddressType":{
                    "type":"string",
                    "description":"The type of network address, either IP Subnet or flow identifier."
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyRef

Type: object

A related party, which defines a party or party role linked to a specific entity.

Show Source

• @referredType: string
  Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'.
• href: string (uri)
  The URI for the related party.
• id: string
  The ID of the related party.
• name: string
  The name of the related party.
• role: string
  The role of the related party.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is 'Party'."
        }
    }
}

Nested Schema : parentNetwork

Type: object

Read Only: true

The parent IP network of the IP address.

Match All

Show Source

• allOf schema
  An IP network or IP subnet.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPNetwork"
        }
    ],
    "description":"The parent IP network of the IP address.",
    "readOnly":true
}

Nested Schema : parentSubnet

Type: object

Read Only: true

The parent IP subnet of the IP address.

Match All

Show Source

• allOf schema
  An IP subnet.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPSubnet"
        }
    ],
    "description":"The parent IP subnet of the IP address.",
    "readOnly":true
}

Nested Schema : NetworkAddressDomain-allOf[1]

Type: object

Show Source

• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• name: string
  The name of the network address domain. It also indicates the ID of the domain.
• networkAddressType: string
  The type of network address, either IP Subnet or flow identifier.
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the network address domain. It also indicates the ID of the domain."
        },
        "networkAddressType":{
            "type":"string",
            "description":"The type of network address, either IP Subnet or flow identifier."
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

Nested Schema : schema

An IP network or IP subnet.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"An IP network or IP subnet.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "ipAddress":{
                    "type":"string",
                    "description":"The network's starting IP address."
                },
                "prefixLength":{
                    "type":"integer",
                    "description":"The number of bits in the address that are in the network."
                },
                "isIPNetwork":{
                    "type":"boolean",
                    "description":"Whether it's an IP network (true) or IP subnet (false)."
                },
                "availableHostCount":{
                    "type":"integer",
                    "description":"The total number of usable hosts in the network.",
                    "readOnly":true
                },
                "numericLowerAddress":{
                    "type":"integer",
                    "description":"The numeric equivalent of the start IP address of the network.",
                    "readOnly":true
                },
                "numericUpperAddress":{
                    "type":"integer",
                    "description":"The numeric equivalent of the end IP address of the network.",
                    "readOnly":true
                },
                "allowHostAtSubnetBoundaries":{
                    "type":"boolean",
                    "description":"Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false)."
                },
                "ipAddressDomain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "ipv6AddressType":{
                    "type":"string",
                    "description":"The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST."
                },
                "ipAddressVersion":{
                    "type":"string",
                    "description":"The version of the IP network, either IPv4 or IPv6."
                },
                "prefix":{
                    "type":"string",
                    "description":"The prefix for the IP network.",
                    "readOnly":true
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• allowHostAtSubnetBoundaries: boolean
  Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false).
• availableHostCount: integer
  Read Only: true

  The total number of usable hosts in the network.
• ipAddress: string
  The network's starting IP address.
• ipAddressDomain: NetworkAddressDomain
  A network address domain.
• ipAddressVersion: string
  The version of the IP network, either IPv4 or IPv6.
• ipv6AddressType: string
  The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST.
• isIPNetwork: boolean
  Whether it's an IP network (true) or IP subnet (false).
• numericLowerAddress: integer
  Read Only: true

  The numeric equivalent of the start IP address of the network.
• numericUpperAddress: integer
  Read Only: true

  The numeric equivalent of the end IP address of the network.
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• prefix: string
  Read Only: true

  The prefix for the IP network.
• prefixLength: integer
  The number of bits in the address that are in the network.

{
    "type":"object",
    "properties":{
        "ipAddress":{
            "type":"string",
            "description":"The network's starting IP address."
        },
        "prefixLength":{
            "type":"integer",
            "description":"The number of bits in the address that are in the network."
        },
        "isIPNetwork":{
            "type":"boolean",
            "description":"Whether it's an IP network (true) or IP subnet (false)."
        },
        "availableHostCount":{
            "type":"integer",
            "description":"The total number of usable hosts in the network.",
            "readOnly":true
        },
        "numericLowerAddress":{
            "type":"integer",
            "description":"The numeric equivalent of the start IP address of the network.",
            "readOnly":true
        },
        "numericUpperAddress":{
            "type":"integer",
            "description":"The numeric equivalent of the end IP address of the network.",
            "readOnly":true
        },
        "allowHostAtSubnetBoundaries":{
            "type":"boolean",
            "description":"Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false)."
        },
        "ipAddressDomain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "ipv6AddressType":{
            "type":"string",
            "description":"The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST."
        },
        "ipAddressVersion":{
            "type":"string",
            "description":"The version of the IP network, either IPv4 or IPv6."
        },
        "prefix":{
            "type":"string",
            "description":"The prefix for the IP network.",
            "readOnly":true
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

Nested Schema : schema

An IP subnet.

Match All

Show Source

• allOf schema
  An IP network or IP subnet.
• object type

{
    "description":"An IP subnet.",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPNetwork"
        },
        {
            "type":"object",
            "properties":{
                "isSubnetPartitioned":{
                    "type":"boolean",
                    "description":"Whether the subnet has been partitioned (true) or not (false).",
                    "readOnly":true
                },
                "ipNetwork":{
                    "$ref":"#/components/schemas/IPNetwork"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "ipAddresses":{
                    "type":"string",
                    "format":"uri",
                    "description":"The list of IP addresses for the subnet.",
                    "readOnly":true
                },
                "partitionedSubnets":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IPSubnet"
                    },
                    "description":"The list of partitioned subnets.",
                    "readOnly":true
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• ipAddresses: string (uri)
  Read Only: true

  The list of IP addresses for the subnet.
• ipNetwork: schema
  An IP network or IP subnet.
• isSubnetPartitioned: boolean
  Read Only: true

  Whether the subnet has been partitioned (true) or not (false).
• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• partitionedSubnets: array partitionedSubnets
  Read Only: true

  The list of partitioned subnets.

{
    "type":"object",
    "properties":{
        "isSubnetPartitioned":{
            "type":"boolean",
            "description":"Whether the subnet has been partitioned (true) or not (false).",
            "readOnly":true
        },
        "ipNetwork":{
            "$ref":"#/components/schemas/IPNetwork"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "ipAddresses":{
            "type":"string",
            "format":"uri",
            "description":"The list of IP addresses for the subnet.",
            "readOnly":true
        },
        "partitionedSubnets":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IPSubnet"
            },
            "description":"The list of partitioned subnets.",
            "readOnly":true
        }
    }
}

Nested Schema : partitionedSubnets

Type: array

Read Only: true

The list of partitioned subnets.

Show Source

• Array of: schema
  An IP subnet.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IPSubnet"
    },
    "description":"The list of partitioned subnets.",
    "readOnly":true
}

206 Response

A range of IPv4 addresses were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: IPV4Address
  An IPv4 address.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IPV4Address"
    }
}

Nested Schema : IPV4Address

An IPv4 address.

Match All

Show Source

• allOf IPAddress
  An IP address.
• object IPV4Address-allOf[1]

{
    "description":"An IPv4 address.",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPAddress"
        },
        {
            "type":"object",
            "properties":{
                "ipv4Address":{
                    "type":"string",
                    "description":"The IP address."
                }
            }
        }
    ]
}

Nested Schema : IPAddress

An IP address.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object IPAddress-allOf[1]

{
    "description":"An IP address.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "prefixLength":{
                    "type":"integer",
                    "description":"The number of bits in the prefix."
                },
                "macAddress":{
                    "type":"string",
                    "description":"The MAC address."
                },
                "macAddressType":{
                    "type":"string",
                    "description":"The type of MAC address."
                },
                "numericAddress":{
                    "type":"integer",
                    "readOnly":true
                },
                "ipAddressDomain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "parentSubnet":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/IPSubnet"
                        }
                    ],
                    "description":"The parent IP subnet of the IP address.",
                    "readOnly":true
                },
                "parentNetwork":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/IPNetwork"
                        }
                    ],
                    "description":"The parent IP network of the IP address.",
                    "readOnly":true
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : IPAddress-allOf[1]

Type: object

Show Source

• ipAddressDomain: NetworkAddressDomain
  A network address domain.
• macAddress: string
  The MAC address.
• macAddressType: string
  The type of MAC address.
• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• numericAddress: integer
  Read Only: true
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• parentNetwork: object parentNetwork
  Read Only: true

  The parent IP network of the IP address.
• parentSubnet: object parentSubnet
  Read Only: true

  The parent IP subnet of the IP address.
• prefixLength: integer
  The number of bits in the prefix.

{
    "type":"object",
    "properties":{
        "prefixLength":{
            "type":"integer",
            "description":"The number of bits in the prefix."
        },
        "macAddress":{
            "type":"string",
            "description":"The MAC address."
        },
        "macAddressType":{
            "type":"string",
            "description":"The type of MAC address."
        },
        "numericAddress":{
            "type":"integer",
            "readOnly":true
        },
        "ipAddressDomain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "parentSubnet":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/IPSubnet"
                }
            ],
            "description":"The parent IP subnet of the IP address.",
            "readOnly":true
        },
        "parentNetwork":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/IPNetwork"
                }
            ],
            "description":"The parent IP network of the IP address.",
            "readOnly":true
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

Nested Schema : IPV4Address-allOf[1]

Type: object

Show Source

• ipv4Address: string
  The IP address.

{
    "type":"object",
    "properties":{
        "ipv4Address":{
            "type":"string",
            "description":"The IP address."
        }
    }
}

Nested Schema : NetworkAddressDomain

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object NetworkAddressDomain-allOf[1]

{
    "description":"A network address domain.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the network address domain. It also indicates the ID of the domain."
                },
                "networkAddressType":{
                    "type":"string",
                    "description":"The type of network address, either IP Subnet or flow identifier."
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyRef

Type: object

A related party, which defines a party or party role linked to a specific entity.

Show Source

• @referredType: string
  Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'.
• href: string (uri)
  The URI for the related party.
• id: string
  The ID of the related party.
• name: string
  The name of the related party.
• role: string
  The role of the related party.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is 'Party'."
        }
    }
}

Nested Schema : parentNetwork

Type: object

Read Only: true

The parent IP network of the IP address.

Match All

Show Source

• allOf schema
  An IP network or IP subnet.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPNetwork"
        }
    ],
    "description":"The parent IP network of the IP address.",
    "readOnly":true
}

Nested Schema : parentSubnet

Type: object

Read Only: true

The parent IP subnet of the IP address.

Match All

Show Source

• allOf schema
  An IP subnet.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPSubnet"
        }
    ],
    "description":"The parent IP subnet of the IP address.",
    "readOnly":true
}

Nested Schema : NetworkAddressDomain-allOf[1]

Type: object

Show Source

• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• name: string
  The name of the network address domain. It also indicates the ID of the domain.
• networkAddressType: string
  The type of network address, either IP Subnet or flow identifier.
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the network address domain. It also indicates the ID of the domain."
        },
        "networkAddressType":{
            "type":"string",
            "description":"The type of network address, either IP Subnet or flow identifier."
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

Nested Schema : schema

An IP network or IP subnet.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"An IP network or IP subnet.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "ipAddress":{
                    "type":"string",
                    "description":"The network's starting IP address."
                },
                "prefixLength":{
                    "type":"integer",
                    "description":"The number of bits in the address that are in the network."
                },
                "isIPNetwork":{
                    "type":"boolean",
                    "description":"Whether it's an IP network (true) or IP subnet (false)."
                },
                "availableHostCount":{
                    "type":"integer",
                    "description":"The total number of usable hosts in the network.",
                    "readOnly":true
                },
                "numericLowerAddress":{
                    "type":"integer",
                    "description":"The numeric equivalent of the start IP address of the network.",
                    "readOnly":true
                },
                "numericUpperAddress":{
                    "type":"integer",
                    "description":"The numeric equivalent of the end IP address of the network.",
                    "readOnly":true
                },
                "allowHostAtSubnetBoundaries":{
                    "type":"boolean",
                    "description":"Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false)."
                },
                "ipAddressDomain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "ipv6AddressType":{
                    "type":"string",
                    "description":"The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST."
                },
                "ipAddressVersion":{
                    "type":"string",
                    "description":"The version of the IP network, either IPv4 or IPv6."
                },
                "prefix":{
                    "type":"string",
                    "description":"The prefix for the IP network.",
                    "readOnly":true
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• allowHostAtSubnetBoundaries: boolean
  Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false).
• availableHostCount: integer
  Read Only: true

  The total number of usable hosts in the network.
• ipAddress: string
  The network's starting IP address.
• ipAddressDomain: NetworkAddressDomain
  A network address domain.
• ipAddressVersion: string
  The version of the IP network, either IPv4 or IPv6.
• ipv6AddressType: string
  The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST.
• isIPNetwork: boolean
  Whether it's an IP network (true) or IP subnet (false).
• numericLowerAddress: integer
  Read Only: true

  The numeric equivalent of the start IP address of the network.
• numericUpperAddress: integer
  Read Only: true

  The numeric equivalent of the end IP address of the network.
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• prefix: string
  Read Only: true

  The prefix for the IP network.
• prefixLength: integer
  The number of bits in the address that are in the network.

{
    "type":"object",
    "properties":{
        "ipAddress":{
            "type":"string",
            "description":"The network's starting IP address."
        },
        "prefixLength":{
            "type":"integer",
            "description":"The number of bits in the address that are in the network."
        },
        "isIPNetwork":{
            "type":"boolean",
            "description":"Whether it's an IP network (true) or IP subnet (false)."
        },
        "availableHostCount":{
            "type":"integer",
            "description":"The total number of usable hosts in the network.",
            "readOnly":true
        },
        "numericLowerAddress":{
            "type":"integer",
            "description":"The numeric equivalent of the start IP address of the network.",
            "readOnly":true
        },
        "numericUpperAddress":{
            "type":"integer",
            "description":"The numeric equivalent of the end IP address of the network.",
            "readOnly":true
        },
        "allowHostAtSubnetBoundaries":{
            "type":"boolean",
            "description":"Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false)."
        },
        "ipAddressDomain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "ipv6AddressType":{
            "type":"string",
            "description":"The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST."
        },
        "ipAddressVersion":{
            "type":"string",
            "description":"The version of the IP network, either IPv4 or IPv6."
        },
        "prefix":{
            "type":"string",
            "description":"The prefix for the IP network.",
            "readOnly":true
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

Nested Schema : schema

An IP subnet.

Match All

Show Source

• allOf schema
  An IP network or IP subnet.
• object type

{
    "description":"An IP subnet.",
    "allOf":[
        {
            "$ref":"#/components/schemas/IPNetwork"
        },
        {
            "type":"object",
            "properties":{
                "isSubnetPartitioned":{
                    "type":"boolean",
                    "description":"Whether the subnet has been partitioned (true) or not (false).",
                    "readOnly":true
                },
                "ipNetwork":{
                    "$ref":"#/components/schemas/IPNetwork"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "ipAddresses":{
                    "type":"string",
                    "format":"uri",
                    "description":"The list of IP addresses for the subnet.",
                    "readOnly":true
                },
                "partitionedSubnets":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IPSubnet"
                    },
                    "description":"The list of partitioned subnets.",
                    "readOnly":true
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• ipAddresses: string (uri)
  Read Only: true

  The list of IP addresses for the subnet.
• ipNetwork: schema
  An IP network or IP subnet.
• isSubnetPartitioned: boolean
  Read Only: true

  Whether the subnet has been partitioned (true) or not (false).
• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• partitionedSubnets: array partitionedSubnets
  Read Only: true

  The list of partitioned subnets.

{
    "type":"object",
    "properties":{
        "isSubnetPartitioned":{
            "type":"boolean",
            "description":"Whether the subnet has been partitioned (true) or not (false).",
            "readOnly":true
        },
        "ipNetwork":{
            "$ref":"#/components/schemas/IPNetwork"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "ipAddresses":{
            "type":"string",
            "format":"uri",
            "description":"The list of IP addresses for the subnet.",
            "readOnly":true
        },
        "partitionedSubnets":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IPSubnet"
            },
            "description":"The list of partitioned subnets.",
            "readOnly":true
        }
    }
}

Nested Schema : partitionedSubnets

Type: array

Read Only: true

The list of partitioned subnets.

Show Source

• Array of: schema
  An IP subnet.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IPSubnet"
    },
    "description":"The list of partitioned subnets.",
    "readOnly":true
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

401 Response

You aren't authorized to make this request.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

403 Response

The request is forbidden.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

404 Response

The IPv4 address wasn't found.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

500 Response

An internal server error occurred.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

Back to Top