/api/space/managed-domain/equipment-holders

The following operations are supported on this resource:

  • GET - Get all Equipment Holder information
  • POST - Get Filtered Equipment Holders ID
GET /equipment-holdersVersion 1

Get all Equipment Holder information.

Sample Usage

GET /equipment-holders


  • Sample Output XML:
    <equipment-holders total="Integer" uri="/api/space/managed-domain/equipment-holders">
         <equipment-holder
               href="/api/space/managed-domain/equipment-holders/{id}" uri="/api/space/managed-domain/equipment-holders/{id}">
               <child-count>Integer</child-count>
               <hosting-me
                   href="/api/space/managed-domain/managed-elements/{id}" uri="/api/space/managed-domain/equipment-holders/{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>
                   <installed-vendor-part-number>String</installed-vendor-part-number>
                   <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>
               <id>Integer</id>
               <belong-to-id>Integer</belong-to-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/{id}">
                   <id>Integer</id>
                   <name>String</name>
               </belong-to>
               <domain-name>String</domain-name>
               <holder-state>EMPTY</holder-state>
               <display-name>String</display-name>
         </equipment-holder>
    </equipment-holders>

  • Sample Output JSON:
    {
      "equipment-holders": {
        "@total": "Integer",
        "@uri": "/api/space/managed-domain/equipment-holders",
        "equipment-holder": {
          "@href": "/api/space/managed-domain/equipment-holders/{id}",
          "@uri": "/api/space/managed-domain/equipment-holders/{id}",
          "child-count": "Integer",
          "hosting-me": {
            "@href": "/api/space/managed-domain/managed-elements/{id}",
            "@uri": "/api/space/managed-domain/equipment-holders/{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",
            "installed-vendor-part-number": "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",
          "id": "Integer",
          "belong-to-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/{id}",
            "id": "Integer",
            "name": "String"
          },
          "domain-name": "String",
          "holder-state": "EMPTY",
          "display-name": "String"
        }
      }
    }

  • Access Control

    The following capabilities are required to access this API: ViewPhysicalInventory

    POST /equipment-holdersVersion 1

    Get Filtered Equipment Holders ID.

    Sample Usage

    POST /equipment-holders


  • Sample Input XML:
    <filter-equipment-holders-request>
         <filter-string>String</filter-string>
         <devices>
               <device href="/api/space/device-management/devices/{id}"/>
         </devices>
    </filter-equipment-holders-request>

  • Sample Output XML:
    <equipment-holders total="Integer" uri="/api/space/managed-domain/equipment-holders">
         <equipment-holder
               href="/api/space/managed-domain/equipment-holders/{id}" uri="/api/space/managed-domain/equipment-holders/{id}">
               <id>Integer</id>
               <name>String</name>
               <device-id>Integer</device-id>
               <belong-to>
                   <id>Integer</id>
                   <name>String</name>
               </belong-to>
         </equipment-holder>
    </equipment-holders>

  • Sample Input JSON:
    {
       "filter-equipment-holders-request" : {
         "filter-string" : "String" ,
         "devices" : {
           "device" : {
             "@href" : "/api/space/device-management/devices/{id}"
           }
         }
       }
    }

  • Sample Output JSON:
    {
       "equipment-holders" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/managed-domain/equipment-holders" ,
         "equipment-holder" : {
           "@href" : "/api/space/managed-domain/equipment-holders/{id}" ,
           "@uri" : "/api/space/managed-domain/equipment-holders/{id}" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "device-id" : "Integer" ,
           "belong-to" : {
             "id" : "Integer" ,
             "name" : "String"
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ViewPhysicalInventory