Jump to

• Request
• Response
• Examples

Get Physical Connectors by Equipment

get

/equipment/{id}/physicalConnectors

Gets all physical connectors that match the specified equipment ID.

Attribute selection is enabled for all first-level attributes.

The filtering criteria can include:

• serialNumber

For information about the filter operators, see Get Resources.

Optionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.

Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.

For information about sorting details, see Get Resources.

Request

Path Parameters

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

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 physical connectors were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: schema
  A physical connector.

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

Nested Schema : schema

A physical connector.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical connector.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "physicalDeviceRef":{
                    "$ref":"#/components/schemas/PhysicalDevice"
                },
                "equipmentRef":{
                    "$ref":"#/components/schemas/Equipment"
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource

Type: object

The base class for physical resources.

Match All

Show Source

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

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

{
    "type":"object",
    "description":"The base class for physical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object",
            "properties":{
                "serialNumber":{
                    "type":"string",
                    "description":"The serial number for the physical resource."
                }
            }
        }
    ]
}

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 : PhysicalResource-allOf[1]

Type: object

Show Source

• serialNumber: string
  The serial number for the physical resource.

{
    "type":"object",
    "properties":{
        "serialNumber":{
            "type":"string",
            "description":"The serial number for the physical resource."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• equipmentRef: schema
  An equipment resource.
• physicalDeviceRef: schema
  A physical device resource.

{
    "type":"object",
    "properties":{
        "physicalDeviceRef":{
            "$ref":"#/components/schemas/PhysicalDevice"
        },
        "equipmentRef":{
            "$ref":"#/components/schemas/Equipment"
        }
    }
}

Nested Schema : schema

An equipment resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"An equipment resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
                    "readOnly":true
                },
                "vendorName":{
                    "type":"string",
                    "description":"The name of the equipment manufacturer.",
                    "readOnly":true
                },
                "modelNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.",
                    "readOnly":true
                },
                "partNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
                    "readOnly":true
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the equipment instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the physical port instances provided by the equipment instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of equipment inventory roles."
                }
            }
        }
    ]
}

Nested Schema : schema

A physical device resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical device resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalAddress":{
                    "type":"string",
                    "description":"The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address."
                },
                "physicalLocation":{
                    "type":"string",
                    "description":"The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System)."
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the physical device instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical ports provided by the physical device instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical device inventory roles."
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• category: string
  Read Only: true

  The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.
• modelNumber: string
  Read Only: true

  The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.
• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• partNumber: string
  Read Only: true

  The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.
• physicalConnectors: string (uri)
  Read Only: true

  The URI for the list of physical connector instances provided by the equipment instance.
• physicalPorts: string (uri)
  Read Only: true

  The URI for the physical port instances provided by the equipment instance.
• roles: array roles
  The list of equipment inventory roles.
• vendorName: string
  Read Only: true

  The name of the equipment manufacturer.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
            "readOnly":true
        },
        "vendorName":{
            "type":"string",
            "description":"The name of the equipment manufacturer.",
            "readOnly":true
        },
        "modelNumber":{
            "type":"string",
            "description":"The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
            "readOnly":true
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the equipment instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the physical port instances provided by the equipment instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of equipment inventory roles."
        }
    }
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : roles

Type: array

The list of equipment inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of equipment inventory roles."
}

Nested Schema : Role

Type: object

A role.

Show Source

• roleName: string
  The name of the role.
• roleType: string
  Allowed Values: [ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]

  The type of role.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

Nested Schema : type

Type: object

Show Source

• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• physicalAddress: string
  The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address.
• physicalConnectors: string (uri)
  Read Only: true

  The URI for the list of physical connector instances provided by the physical device instance.
• physicalLocation: string
  The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System).
• physicalPorts: string (uri)
  Read Only: true

  The URI for the list of physical ports provided by the physical device instance.
• roles: array roles
  The list of physical device inventory roles.

{
    "type":"object",
    "properties":{
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalAddress":{
            "type":"string",
            "description":"The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address."
        },
        "physicalLocation":{
            "type":"string",
            "description":"The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System)."
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the physical device instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical ports provided by the physical device instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of physical device inventory roles."
        }
    }
}

Nested Schema : roles

Type: array

The list of physical device inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical device inventory roles."
}

206 Response

A range of physical connectors were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: schema
  A physical connector.

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

Nested Schema : schema

A physical connector.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical connector.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "physicalDeviceRef":{
                    "$ref":"#/components/schemas/PhysicalDevice"
                },
                "equipmentRef":{
                    "$ref":"#/components/schemas/Equipment"
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource

Type: object

The base class for physical resources.

Match All

Show Source

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

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

{
    "type":"object",
    "description":"The base class for physical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object",
            "properties":{
                "serialNumber":{
                    "type":"string",
                    "description":"The serial number for the physical resource."
                }
            }
        }
    ]
}

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 : PhysicalResource-allOf[1]

Type: object

Show Source

• serialNumber: string
  The serial number for the physical resource.

{
    "type":"object",
    "properties":{
        "serialNumber":{
            "type":"string",
            "description":"The serial number for the physical resource."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• equipmentRef: schema
  An equipment resource.
• physicalDeviceRef: schema
  A physical device resource.

{
    "type":"object",
    "properties":{
        "physicalDeviceRef":{
            "$ref":"#/components/schemas/PhysicalDevice"
        },
        "equipmentRef":{
            "$ref":"#/components/schemas/Equipment"
        }
    }
}

Nested Schema : schema

An equipment resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"An equipment resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
                    "readOnly":true
                },
                "vendorName":{
                    "type":"string",
                    "description":"The name of the equipment manufacturer.",
                    "readOnly":true
                },
                "modelNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.",
                    "readOnly":true
                },
                "partNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
                    "readOnly":true
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the equipment instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the physical port instances provided by the equipment instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of equipment inventory roles."
                }
            }
        }
    ]
}

Nested Schema : schema

A physical device resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical device resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalAddress":{
                    "type":"string",
                    "description":"The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address."
                },
                "physicalLocation":{
                    "type":"string",
                    "description":"The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System)."
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the physical device instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical ports provided by the physical device instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical device inventory roles."
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• category: string
  Read Only: true

  The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.
• modelNumber: string
  Read Only: true

  The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.
• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• partNumber: string
  Read Only: true

  The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.
• physicalConnectors: string (uri)
  Read Only: true

  The URI for the list of physical connector instances provided by the equipment instance.
• physicalPorts: string (uri)
  Read Only: true

  The URI for the physical port instances provided by the equipment instance.
• roles: array roles
  The list of equipment inventory roles.
• vendorName: string
  Read Only: true

  The name of the equipment manufacturer.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
            "readOnly":true
        },
        "vendorName":{
            "type":"string",
            "description":"The name of the equipment manufacturer.",
            "readOnly":true
        },
        "modelNumber":{
            "type":"string",
            "description":"The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
            "readOnly":true
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the equipment instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the physical port instances provided by the equipment instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of equipment inventory roles."
        }
    }
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : roles

Type: array

The list of equipment inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of equipment inventory roles."
}

Nested Schema : Role

Type: object

A role.

Show Source

• roleName: string
  The name of the role.
• roleType: string
  Allowed Values: [ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]

  The type of role.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

Nested Schema : type

Type: object

Show Source

• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• physicalAddress: string
  The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address.
• physicalConnectors: string (uri)
  Read Only: true

  The URI for the list of physical connector instances provided by the physical device instance.
• physicalLocation: string
  The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System).
• physicalPorts: string (uri)
  Read Only: true

  The URI for the list of physical ports provided by the physical device instance.
• roles: array roles
  The list of physical device inventory roles.

{
    "type":"object",
    "properties":{
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalAddress":{
            "type":"string",
            "description":"The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address."
        },
        "physicalLocation":{
            "type":"string",
            "description":"The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System)."
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the physical device instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical ports provided by the physical device instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of physical device inventory roles."
        }
    }
}

Nested Schema : roles

Type: array

The list of physical device inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical device inventory roles."
}

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 physical connectors 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", "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

Examples

This example shows how to get the physical connector details for the equipment entity with an ID of 8-750002 by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X GET "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/equipment/8-750002/physicalConnectors?fields=none" -H credentials

where:

• hostname is the URL for the UIM REST server.
• port is the port for the UIM REST server.
• version is the version of the API you're using.
• credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the list of physical connectors for the equipment entity with ID 8-750002.

[
   {
     "id": "9-750002-1875011",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/9-750002-1875010",
      "@type": "PhysicalConnector"
   },
   {
      "id": "9-750002-1875011",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/9-750002-1875011",
      "@type": " PhysicalConnector "
   },
]

Back to Top