1. REST API for Unified Inventory Management
  2. Tasks
  3. Resource
  4. Equipment

Get an Equipment Entity by ID

get

/equipment/{id}

Gets the equipment entity that matches the specified ID.

Attribute selection is enabled for all first-level attributes.

Optionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, and 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.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The equipment was returned successfully.
Body ()
Root Schema : schema
An equipment resource.
Match All
Show Source
Nested Schema : PhysicalResource
Type: object
The base class for physical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : PhysicalResource-allOf[1]
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
  • Read Only: true
    The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.
  • 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.
  • PlaceRef
    A place to associate with the resource/service.
  • 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.
  • Read Only: true
    The URI for the list of physical connector instances provided by the equipment instance.
  • Read Only: true
    The URI for the physical port instances provided by the equipment instance.
  • roles
    The list of equipment inventory roles.
  • Read Only: true
    The name of the equipment manufacturer.
Nested Schema : PlaceRef
Type: object
A place to associate with the resource/service.
Show Source
Nested Schema : roles
Type: array
The list of equipment inventory roles.
Show Source
Nested Schema : Role
Type: object
A role.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

404 Response

The equipment 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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source
Back to Top

Examples

This example shows how to get the details for the equipment entity with an ID of 8-750008 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-750008" -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 full details for the equipment with ID 8-750008. 

{
   "id": "8-750008",
   "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/8-750008",
   "@type": "Equipment",
   "@baseType": "PhysicalResource",
   "name": "QAM MODULE",
   "version": "1",
   "lifecycleState": "INSTALLED",
   "lifecycleSubState": "UNASSIGNED",
   "category": "CARD",
   "startDate": "2020-01-08T16:46:50.804Z",
   "endDate": "2038-01-19T08:44:07.000Z",
   "resourceCharacteristic": [
      {
         "name": "EQUIPMENT_ACRONYM",
         "valueType": "ALPHANUMERIC",
         "value": "QAM MODULE 2X4"
      },
      {
         "name": "EQUIPMENT_TYPE",
         "valueType": "ALPHANUMERIC",
         "value": "Modulo HOT-SWAP"
      }
   ],
   "resourceSpecification": {
      "id": "Motorola_540273-001_Module",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/Motorola_540273-001_Module",
      "name": "Motorola_540273-001_Module",
      "version": "1",
      "entityType": "Equipment",
      "startDate": "2020-01-08T00:00:01.000Z",
      "endDate": "2038-01-19T08:44:07.000Z"
   },
   "vendorName": "MOTOROLA",
   "modelNumber": "2X4",
   "partNumber": "540273-001",
   "networkLocation": {
      "id": "HYD",
     "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
     "name": "HYD",
     "@referredType": "PropertyLocation"
   },
   "physicalConnectors": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/equipment/8-750008/physicalConnectors",
   "physicalPorts": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/equipment/8-750008/physicalPorts"
}
Back to Top