/api/space/managed-domain/equipment-holders/{equipment-holder-id}

The following operation is supported on this resource:

  • GET - Get specific Equipment Holder information
GET /equipment-holders/{equipment-holder-id}Version 1

Get specific Equipment Holder information.

Sample Usage

GET /equipment-holders/{equipment-holder-id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    equipment-holder-idIntegerPathEquipment Holder ID Y
  • Sample Output XML:
    <equipment-holder
         href="/api/space/managed-domain/equipment-holders/{id}" uri="/api/space/managed-domain/equipment-holders/{equipment-holder-id}">
         <child-count>Integer</child-count>
         <hosting-me href="/api/space/managed-domain/managed-elements/{id}" uri="/api/space/managed-domain/equipment-holders/{equipment-holder-id}">
               <id>Integer</id>
         </hosting-me>
         <expected-or-installed-equipment>
               <installed-equipment-object-type>String</installed-equipment-object-type>
               <expected-equipment-object-type>String</expected-equipment-object-type>
               <installed-serial-number>String</installed-serial-number>
               <installed-description>String</installed-description>
               <domain-name>String</domain-name>
               <manufacturer>String</manufacturer>
               <installed-vendor-part-number>String</installed-vendor-part-number>
               <display-name>String</display-name>
               <id>String</id>
               <installed-version>String</installed-version>
               <installed-model>String</installed-model>
               <domain-id>Integer</domain-id>
               <name>String</name>
               <device-id>Integer</device-id>
               <installed-part-number>String</installed-part-number>
               <installed-vendor-material-number>String</installed-vendor-material-number>
               <path>String</path>
               <comp-status>String</comp-status>
         </expected-or-installed-equipment>
         <holder-type>RACK</holder-type>
         <contained-equipment total="Integer">
               <equipment-holder
                   href="/api/space/managed-domain/equipment-holders/{id}" uri="/api/space/managed-domain/equipment-holders/{equipment-holder-id}">
                   <id>Integer</id>
               </equipment-holder>
         </contained-equipment>
         <id>Integer</id>
         <device-name>String</device-name>
         <domain-id>Integer</domain-id>
         <name>String</name>
         <path>String</path>
         <device-id>Integer</device-id>
         <belong-to href="/api/space/managed-domain/equipment-holders/{id}" uri="/api/space/managed-domain/equipment-holders/{equipment-holder-id}">
               <id>Integer</id>
               <name>String</name>
         </belong-to>
         <domain-name>String</domain-name>
         <holder-state>EMPTY</holder-state>
         <belong-to-id>Integer</belong-to-id>
         <display-name>String</display-name>
    </equipment-holder>

  • Sample Output JSON:
    {
      "equipment-holder": {
        "@href": "/api/space/managed-domain/equipment-holders/{id}",
        "@uri": "/api/space/managed-domain/equipment-holders/{equipment-holder-id}",
        "child-count": "Integer",
        "hosting-me": {
          "@href": "/api/space/managed-domain/managed-elements/{id}",
          "@uri": "/api/space/managed-domain/equipment-holders/{equipment-holder-id}",
          "id": "Integer"
        },
        "expected-or-installed-equipment": {
          "installed-equipment-object-type": "String",
          "expected-equipment-object-type": "String",
          "installed-serial-number": "String",
          "installed-description": "String",
          "domain-name": "String",
          "manufacturer": "String",
          "installed-vendor-part-number": "String",
          "display-name": "String",
          "id": "String",
          "installed-version": "String",
          "installed-model": "String",
          "domain-id": "Integer",
          "name": "String",
          "device-id": "Integer",
          "installed-part-number": "String",
          "installed-vendor-material-number": "String",
          "path": "String",
          "comp-status": "String"
        },
        "holder-type": "RACK",
        "contained-equipment": {
          "@total": "Integer",
          "equipment-holder": {
            "@href": "/api/space/managed-domain/equipment-holders/{id}",
            "@uri": "/api/space/managed-domain/equipment-holders/{equipment-holder-id}",
            "id": "Integer"
          }
        },
        "id": "Integer",
        "device-name": "String",
        "domain-id": "Integer",
        "name": "String",
        "path": "String",
        "device-id": "Integer",
        "belong-to": {
          "@href": "/api/space/managed-domain/equipment-holders/{id}",
          "@uri": "/api/space/managed-domain/equipment-holders/{equipment-holder-id}",
          "id": "Integer",
          "name": "String"
        },
        "domain-name": "String",
        "holder-state": "EMPTY",
        "belong-to-id": "Integer",
        "display-name": "String"
      }
    }

  • Access Control

    The following capabilities are required to access this API: ViewPhysicalInventory