Jump to

• Request
• Response

Get the subnode information

get

/subNodeInfo

Get the subnode information and Connectivity / Pipe entities terminated on it. Subnode is the UIM entity such as DeviceInterface, PhysicalConnector, PhysicalPort or Equipment. Whereas node represents the entity which encapsulates or is parent of the subnode such as PhysicalDevice, Equipment or LogicalDevice. Connections are the Connectivity / Pipe instances which are terminated on the looked up subnode and all of its children entities (if any).

Request

Query Parameters

• connections: boolean
  Defines if the connections information should be included in response or not.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• nodeInfo: object NodeInfoRequest
• subNodeInfo: object SubNodeInfoRequest

{
    "type":"object",
    "properties":{
        "nodeInfo":{
            "$ref":"#/components/schemas/NodeInfoRequest"
        },
        "subNodeInfo":{
            "$ref":"#/components/schemas/SubNodeInfoRequest"
        }
    }
}

Nested Schema : NodeInfoRequest

Type: object

Show Source

• type: string
  Allowed Values: [ "PhysicalPort", "PhysicalConnector", "DeviceInterface", "Equipment", "LogicalDevice", "PhysicalDevice" ]

  Type of the node or subnode.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/NodeRequestProperties"
        }
    ],
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        }
    }
}

Match All

Show Source

• object NodeRequestProperties
  Generic node request information.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/NodeRequestProperties"
        }
    ],
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        }
    }
}

Nested Schema : SubNodeInfoRequest

Type: object

Show Source

• identifier: string
• lookUpFieldOrder: array lookUpFieldOrder
  Order in which the subnode entity lookup should happen.
• type: string
  Allowed Values: [ "PhysicalPort", "PhysicalConnector", "DeviceInterface", "Equipment", "LogicalDevice", "PhysicalDevice" ]

  Type of the node or subnode.

{
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        },
        "identifier":{
            "type":"string"
        },
        "lookUpFieldOrder":{
            "items":{
                "type":"string"
            },
            "description":"Order in which the subnode entity lookup should happen.",
            "example":"[\"name\", \"id\", \"char:someChar\", \"nativeEMSName\"]",
            "type":"array"
        }
    }
}

Nested Schema : NodeRequestProperties

Type: object

Generic node request information.

Show Source

• id: string
  Id of the node entity.
• name: string
  Name of the node entity.
• nativeEMSName: string
  Native EMS Name of the node entity.

{
    "type":"object",
    "description":"Generic node request information.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the node entity."
        },
        "id":{
            "type":"string",
            "description":"Id of the node entity."
        },
        "nativeEMSName":{
            "type":"string",
            "description":"Native EMS Name of the node entity."
        }
    }
}

Nested Schema : lookUpFieldOrder

Type: array

Order in which the subnode entity lookup should happen.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "description":"Order in which the subnode entity lookup should happen.",
    "example":"[\"name\", \"id\", \"char:someChar\", \"nativeEMSName\"]",
    "type":"array"
}

Example:

["name", "id", "char:someChar", "nativeEMSName"]

Back to Top

Response

Supported Media Types

• application/json

200 Response

The node and subnode information were retrieved successfully.

Body ()

Root Schema : NodeLookupResponse

Type: object

Show Source

• connections: array connections
  List of Connectivity / Pipe entity terminated on the subnode.
• nodeInfo: object NodeInfoResponse
  General information about the node in the inventory system.
• subNodeInfo: object SubNodeInfoResponse
  General information about the subnode in the inventory system.

{
    "type":"object",
    "properties":{
        "nodeInfo":{
            "$ref":"#/components/schemas/NodeInfoResponse"
        },
        "subNodeInfo":{
            "$ref":"#/components/schemas/SubNodeInfoResponse"
        },
        "connections":{
            "type":"array",
            "description":"List of Connectivity / Pipe entity terminated on the subnode.",
            "items":{
                "$ref":"#/components/schemas/ConnectionInfo"
            }
        }
    }
}

Nested Schema : connections

Type: array

List of Connectivity / Pipe entity terminated on the subnode.

Show Source

• Array of: object ConnectionInfo
  General information about the Connectivity / Pipe entity terminated on the subnode.

{
    "type":"array",
    "description":"List of Connectivity / Pipe entity terminated on the subnode.",
    "items":{
        "$ref":"#/components/schemas/ConnectionInfo"
    }
}

Nested Schema : NodeInfoResponse

Type: object

General information about the node in the inventory system.

Show Source

• type: string
  Allowed Values: [ "PhysicalPort", "PhysicalConnector", "DeviceInterface", "Equipment", "LogicalDevice", "PhysicalDevice" ]

  Type of the node or subnode.

{
    "type":"object",
    "description":"General information about the node in the inventory system.",
    "allOf":[
        {
            "$ref":"#/components/schemas/NodeResponseProperties"
        }
    ],
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        }
    }
}

Match All

General information about the node in the inventory system.

Show Source

• object NodeResponseProperties
  Generic node response information.

{
    "type":"object",
    "description":"General information about the node in the inventory system.",
    "allOf":[
        {
            "$ref":"#/components/schemas/NodeResponseProperties"
        }
    ],
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        }
    }
}

Nested Schema : SubNodeInfoResponse

Type: object

General information about the subnode in the inventory system.

Show Source

• type: string
  Allowed Values: [ "PhysicalPort", "PhysicalConnector", "DeviceInterface", "Equipment", "LogicalDevice", "PhysicalDevice" ]

  Type of the node or subnode.

{
    "type":"object",
    "description":"General information about the subnode in the inventory system.",
    "allOf":[
        {
            "$ref":"#/components/schemas/NodeResponseProperties"
        }
    ],
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        }
    }
}

Match All

General information about the subnode in the inventory system.

Show Source

• object NodeResponseProperties
  Generic node response information.

{
    "type":"object",
    "description":"General information about the subnode in the inventory system.",
    "allOf":[
        {
            "$ref":"#/components/schemas/NodeResponseProperties"
        }
    ],
    "properties":{
        "type":{
            "$ref":"#/components/schemas/NodeType"
        }
    }
}

Nested Schema : ConnectionInfo

Type: object

General information about the Connectivity / Pipe entity terminated on the subnode.

Show Source

• connectionType: string
  Allowed Values: [ "Pipe", "Connectivity" ]

  Type of the Connection.
• connectivityIdentifier: string
  The identifier of the Connectivity.
• entityId: string
  The Entity ID of the Pipe / Connectivity.
• href: string (uri)
  The inventory system URI of the Connectivity / Pipe.
• id: string
  The ID of the Pipe / Connectivity.
• name: string
  The name of the Pipe.
• rateCode: string
  The ratecode of the Connectivity.
• specName: string
  The name of the specification.
• technology: string
  The technology of the Connectivity.

{
    "type":"object",
    "description":"General information about the Connectivity / Pipe entity terminated on the subnode.",
    "properties":{
        "connectivityIdentifier":{
            "type":"string",
            "description":"The identifier of the Connectivity."
        },
        "id":{
            "type":"string",
            "description":"The ID of the Pipe / Connectivity."
        },
        "entityId":{
            "type":"string",
            "description":"The Entity ID of the Pipe / Connectivity."
        },
        "name":{
            "type":"string",
            "description":"The name of the Pipe."
        },
        "connectionType":{
            "$ref":"#/components/schemas/ConnectionType"
        },
        "href":{
            "type":"string",
            "description":"The inventory system URI of the Connectivity / Pipe.",
            "format":"uri"
        },
        "specName":{
            "type":"string",
            "description":"The name of the specification."
        },
        "technology":{
            "type":"string",
            "description":"The technology of the Connectivity."
        },
        "rateCode":{
            "type":"string",
            "description":"The ratecode of the Connectivity."
        }
    }
}

Nested Schema : NodeResponseProperties

Type: object

Generic node response information.

Show Source

• entityId: string
  Entity Id of the node entity.
• id: string
  Id of the node entity.
• name: string
  Name of the node entity.

{
    "type":"object",
    "description":"Generic node response information.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the node entity."
        },
        "id":{
            "type":"string",
            "description":"Id of the node entity."
        },
        "entityId":{
            "type":"string",
            "description":"Entity Id of the node entity."
        }
    }
}

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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 resources (either node or subnode) weren'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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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