Find Model operation

The Find Model operation retrieves the details of a model.

The following table describes the elements of the <items> XML element and the adapter request. If not specified, the valid value for an element should be assumed to be a string.

Elements for the <items> XML element and adapter request for the Find Model operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `retrieve-model`	Yes
`<model>`	Contains the other elements in the request	Yes
`<keys>`	Contains elements that uniquely identify a record If you do not specify the child elements of the `<keys>` element, the application tries to find the `<part-number>` element in the `<instance>` element. You can specify the `<part-number>` element in the `<keys>` element, in the `<instance>` element, or in both elements.	Yes
`<instance>`	Specifies a unique model record The children of the `<instance>` element describe the fields of the record. The only two higher-level elements are `<keys>` and `<instance>`. All other elements are child elements of the `<instance>` element.	Yes
`<part-number>`	Specifies the part number of a model The `<part-number>` element must be used as the key. Valid value: Any string	No
`<manufacturer>`	Specifies the name of the manufacturer of the model Valid values: ACME, AT&T Systems, Adobe Systems, Advanced Systems, BizTrain, Casio, Cisco Systems, Compaq, Computer Clearance, DEC, Decision One, Epson, Hewlett-Packard, Hewlett-Packard, IBM France, IBM Germany, IBM North America, IBM United Kingdom, Install Group, Intel, Internal, Internal Access, Iomega, Linksys, Logitech, Lotus, Microsoft - CA, Microsoft - WA, Microsoft Corp., Microsoft Corporation, NCR corporation, Nokia, Office Depot, Oracle Corporation, Pacific Bell, Palm, Inc., Panasonic, Paradyne, Quantum, SAP, Sales Force, Seagate, Sony, Staples, Steelcase, Symantec, Telex, Texas Instruments, Toshiba, Viewsonic, Vodafone, WinRar, and Xerox Note: You can add, update, or delete manufacturers by using the HP Service Manager application.	No
`<model>`	Specifies the details of the model Valid value: Any string	No
`<category>`	Specifies the category of the model Valid values: Chairs Changes Changes to Lines Computer Accessories Computer Components Computers and Related Contractor Conversion Corporate Corporate Security Corporate Telecom Corporate Telecom PKG Desks Desktop Desktop Packages Desktops Employee Change Employee Office Move Employee Promotion Employee Termination Employee Transfer Furniture HR Tasks Handheld And PDAs Hardware Hardware Upgrade Human Resource PC Note: You can add, update, or delete categories by using the HP Service Manager application.	No
`<description>`	Specifies the description of the model; is an array- type element	No
`<brief-description>`	Specifies a brief description of the model Valid value: Any string	No
`<installed-quantity>`	Specifies the installed quantity for the model Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface for the Create Model screen.	No
`<quantity-available>`	Specifies the available quantity for the model Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<quantity-on-order>`	Specifies the quantity on open purchase orders or manufacturing orders for the model Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<min-order-amount>`	Specifies the minimum number of the models required to place a purchase order Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<max-order-amount>`	Specifies the maximum quantity that can be ordered when purchasing the model Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<order-lot-size>`	Specifies the size details of the order for the model Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<quantity-received>`	Specifies the quantity of the model that was received Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<quantity-reserved>`	Specifies the quantity of the model that is reserved Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<quantity-on-request>`	Specifies the quantity for the model that is available on request Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<quantity-unavailable>`	Specifies the quantity for the model that is not available Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<default-priority>`	Specifies the default priority for the model Valid value: Any decimal	No
`<default-quantity>`	Specifies the default quantity for the model Valid value: Any decimal	No
`<quantity-back-ordered>`	Specifies the quantity for the model that could not be filled on the requested date Valid value: Any decimal Default value: 0 Note: This field is not available on the user interface of the Create Model screen.	No
`<cost>`	Specifies the cost for the model Valid value: Any decimal	No
`<material-group>`	Specifies the material group for the model Valid value: Any string Note: This field is not available on the user interface of the Create Model screen.	No
`<GLNumber>`	Specifies the GL number for the model Valid value: Any string	No
`<g-l-number>`	Specifies the GL number for the model Valid value: Any string	No

The following figure displays the sample adapter request for the Find Model operation.

Sample adapter request for the Find Model operation


 <hp-service-manager-request>
    <entity>configurationitem</entity>
    <entity-type>model</entity-type>
    <request>
      <operation-name>retrieve-model</operation-name>
      <parameters>
        <retrieve-model-request>
          <model>
            <keys>
            </keys>
            <instance>
              <category>
                <value>Desktops</value>
                <type>String</type>
              </category>
            </instance>
          </model>
        </retrieve-model-request>
      </parameters>
    </request>
  </hp-service-manager-request>

The following figure displays an adapter response for the Find Model operation.

Sample adapter response for the Find Model operation


<hp-service-manager-response>
  <metadata>
    <count>4</count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <count>4</count>
      </metadata>
      <item>
        <metadata>
          <status>success</status>
        </metadata>
        <parameters>
          <model>
            <keys>
              <part-number>
                <value>1003</value>
                <type>String</type>
              </part-number>
            </keys>
            <instance>
              <part-number>
                <value>1003</value>
                <type>String</type>
              </part-number>
              <manufacturer>
                <value>Compaq</value>
                <type>String</type>
              </manufacturer>
              <model>
                <value>RA-2001</value>
                <type>String</type>
              </model>
              <category>
                <value>Desktops</value>
                <type>String</type>
              </category>
              <brief-description>
                <value>Dell Desktop - Inspiron</value>
                <type>String</type>
              </brief-description>
              <installed-quantity>
                <value>10</value>
                <type>Decimal</type>
              </installed-quantity>
              <quantity-available>
                <value>2</value>
                <type>Decimal</type>
              </quantity-available>
              <quantity-on-order>
                <value>3</value>
              <type>Decimal</type>
              </quantity-on-order>
              <min-order-amount>
                <value>4</value>
                <type>Decimal</type>
              </min-order-amount>
              <max-order-amount>
                <value>5</value>
                <type>Decimal</type>
              </max-order-amount>
              <order-lot-size>
                <value>6</value>
                <type>Decimal</type>
              </order-lot-size>
              <quantity-recieved>
                <value>7</value>
                <type>Decimal</type>
              </quantity-recieved>
              <quantity-reserved>
                <value>8</value>
                <type>Decimal</type>
              </quantity-reserved>
              <quantity-on-request>
                <value>9</value>
                <type>Decimal</type>
              </quantity-on-request>
              <quantity-unavailable>
                <value>10</value>
                <type>Decimal</type>
              </quantity-unavailable>
              <default-priority>
                <value>11</value>
                <type>Decimal</type>
              </default-priority>
              <default-quantity>
                <value>12</value>
                <type>Decimal</type>
              </default-quantity>
              <quantity-back-ordered>
                <value>13</value>
                <type>Decimal</type>
              </quantity-back-ordered>
              <cost>
                <value>14</value>
                <type>Decimal</type>
              </cost>
              <material-group>
                <value>material group</value>
                <type>String</type>
              </material-group>
              <GLNumber>
                <value>g l Number</value>
              <type>String</type>
              </GLNumber>
              <uniquequery>part.no="1003"</uniquequery>
              <recordid>1003</recordid>
              <g-l-number>
                <value>g l Number</value>
                <type>String</type>
              </g-l-number>
            </instance>
          </model>
          <status>SUCCESS</status>
          <message>Success</message>
          <schema-revision-date>2005.03.15 00:00:00</schema-revision-date>
          <schema-revision-level>0</schema-revision-level>
          <return-code>0</return-code>
        </parameters>
      </item>
   
      <item> ... </item>
       ...
      <item> ... </item>
    
    </response>
  </responses>
</hp-service-manager-response>

Find Model operation

Comments