Find Handheld Device operation

The Find Handheld Device operation retrieves the details of a hand-held device.

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

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

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `retrieve-hand-held-device`	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 `<contact-name>` element in the `<instance>` element. You can specify the `<contact-name>` element in the `<keys>` element, in the `<instance>` element, or in both elements.	Yes
`<logical-name>`	Specifies a unique name for identifying a hand-held device Valid value: Any unique string Note: The `<logical-name>` element must be used as the key and must be the child element of the `<keys>` element.	No
`<instance>`	Specifies a unique hand-held device 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
`<file-device>`	Specifies the attributes for a hand-held device The `<file-device>` element can contain multiple child elements.	Yes
`<istatus>`	Specifies the status of the hand-held device Valid values: Planned/On order Received In Stock Reserved In use Maintenance Disposed/Retired Installed	No
`<assignment>`	Specifies the assignment group for the hand-held device Valid value: Any string, or an existing record from the application	No
`<vendor>`	Specifies the name of the vendor for the hand-held device Valid value: Any string, or an existing record from the application	No
`<serial-number>`	Specifies the serial number of the hand-held device Valid value: Any string	No
`<location>`	Specifies the location of the hand-held device Valid value: Any string, or an existing record from the application	No
`<configuration-item-type>`	Specifies the type of the configuration item Valid value: handhelds	No
`<part-no>`	Specifies the part number related to the hand-held device Valid value: Any string; or an existing record from the application	No
`<version>`	Specifies the version of the hand-held device Valid value: Any string	No
`<model>`	Specifies the model of the hand-held device Valid value: Any string	No
`<updated-by>`	Specifies the name of the person who updated the record Default value: The user who updated the record	No
`<subtype>`	Specifies the subtype for a selected type for a configuration item The list of valid values is customizable. You can add and delete `<subtype>` values. For example: PDA Cell Phone Pager Blackberry Device GPS Device	No
`<building>`	Specifies the building for the hand-held device Valid value: Any string	No
`<floor>`	Specifies the floor related to the location Valid value: Any string	No
`<room>`	Specifies information about the room Valid value: Any string	No
`<system-down>`	Specifies whether the system is down Valid values: true: Indicates that the system is down false (default): Indicates that the system is up	No
`<asset-tag>`	Specifies the asset for the record Valid value: Any string	No
`<company>`	Specifies the name of the company Valid value: Any string	No
`<sysmodtime>`	Specifies the system time when the record was last modified Valid value: Any input in date and time format Default value: The date and time when the record is created	No
`<sysmoduser>`	Specifies the user name that last modified the record Valid value: Any string Default value: The current user of the service	No
`<sysmodcount>`	Specifies the number of times the record was modified Valid value: Any integer Default value: 0	No
`<environment>`	Specifies the environment of the hand-held device Valid values: Development Test Production Failover None	No
`<owner>`	Specifies the department that owns the hand-held device Valid value: Any valid department in the HP Service Manager application The list can be customized by using the HP Service Manager application.	No
`<default-impact>`	Specifies the default impact of the hand-held device Valid values: 1: Enterprise 2: Site / Dept 3: Multiple Users 4: User	No
`<title>`	Specifies the title of the hand-held device Valid value: Any string	No
`<problem-priority>`	Specifies the priority of the hand-held device Valid values: 1: Critical 2: High 3 - Average 4: Low	No
`<id>`	Specifies the ID of the hand-held device Valid value: Any unique string	No
`<file-handhelds>`	Contains child elements for describing the hand-held device; is a structure-type element	Yes

The following figure displays a sample adapter request for the Find Handheld Device operation.

Sample adapter request for the Find Handheld Device operation


 <hp-service-manager-request>
    <entity>configurationitem</entity>
    <entity-type>handheld-device</entity-type>
    <request>
      <operation-name>retrieve-hand-held-device</operation-name>
      <parameters>
        <retrieve-hand-held-device-request>
          <model>
            <keys>
              <logical-name>
                <value>HandHeld-001</value>
                <type>String</type>
              </logical-name>
            </keys>
            <instance>
              <file-device>
                <type>Structure</type>
                <vendor>
                  <value>Intel</value>
                  <type>String</type>
                </vendor>
                <serial-no>
                  <value>Sr. No. 8</value>
                  <type>String</type>
                </serial-no>
                <location>
                  <value>MyLocation25</value>
                  <type>String</type>
                </location>
                <configuration-item-type>
                  <value>handhelds</value>
                  <type>String</type>
                </configuration-item-type>
                <id>
                  <value>CI10924</value>
                  <type>String</type>
                </id>
                <updated-by>
                  <value>falcon</value>
                  <type>String</type>
                </updated-by>
                <part-no>
                  <value>part no 55</value>
                  <type>String</type>
                </part-no>
                <istatus>
                  <value>Maintenance</value>
                  <type>String</type>
                </istatus>
                <version>
                  <value>Ver 2.2</value>
                  <type>String</type>
                </version>
                <subtype>
                  <value>PDA</value>
                  <type>String</type>
                </subtype>
                <location-code>
                  <value>Location Code</value>
                  <type>String</type>
                </location-code>
                <building>
                  <value>Building DEL1</value>
                  <type>String</type>
                </building>
                <floor>
                  <value>Lower Ground</value>
                  <type>String</type>
                </floor>
                <room>
                  <value>Room</value>
                  <type>String</type>
                </room>
                <sysmodtime>
                  <value>2010.02.10 12:26:15</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <assignment>
                  <value>Hardware</value>
                  <type>String</type>
                </assignment>
                <title>
                  <value>Title for the Hand Held device</value>
                  <type>String</type>
                </title>
                <environment>
                  <value>Test</value>
                  <type>String</type>
                </environment>
              </file-device>
              <file-handhelds>
                <type>Structure</type>
              </file-handhelds>
            </instance>
          </model>
        </retrieve-hand-held-device-request>
      </parameters>
    </request>
  </hp-service-manager-request>

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

Sample adapter response for the Find Handheld Device operation


<hp-service-manager-response>
  <metadata>
    <count>1</count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <count>1</count>
      </metadata>
      <item>
        <metadata>
          <status>success</status>
        </metadata>
        <parameters>
          <model>
            <keys>
              <logical-name>
                <value>HandHeld-001</value>
                <type>String</type>
              </logical-name>
            </keys>
            <instance>
              <file-device>
                <type>Structure</type>
                <vendor>
                  <value>Intel</value>
                  <type>String</type>
                </vendor>
                <serial-no>
                  <value>Sr. No. 8</value>
                  <type>String</type>
                </serial-no>
                <location>
                  <value>MyLocation25</value>
                  <type>String</type>
                </location>
                <configuration-item-type>
                  <value>handhelds</value>
                  <type>String</type>
                </configuration-item-type>
                <id>
                  <value>CI10924</value>
                  <type>String</type>
                </id>
                <updated-by>
                  <value>falcon</value>
                  <type>String</type>
                </updated-by>
                <part-no>
                  <value>part no 55</value>
                  <type>String</type>
                </part-no>
                <istatus>
                  <value>Maintenance</value>
                  <type>String</type>
                </istatus>
                <version>
                  <value>Ver 2.2</value>
                  <type>String</type>
                </version>
                <subtype>
                  <value>PDA</value>
                  <type>String</type>
                </subtype>
                <location-code>
                  <value>Location Code</value>
                  <type>String</type>
                </location-code>
                <building>
                  <value>Building1</value>
                  <type>String</type>
                </building>
                <floor>
                  <value>Lower Ground</value>
                  <type>String</type>
                </floor>
                <room>
                  <value>Room</value>
                  <type>String</type>
                </room>
                <sysmodtime>
                  <value>2010.02.16 12:44:23</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmodcount>
                  <value>3</value>
                  <type>Decimal</type>
                </sysmodcount>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <assignment>
                  <value>Hardware</value>
                  <type>String</type>
                </assignment>
                <title>
                  <value>Title for the Hand Held device</value>
                  <type>String</type>
                </title>
                <environment>
                  <value>Test</value>
                  <type>String</type>
                </environment>
              </file-device>
              <file-handhelds>
                <type>Structure</type>
                <sysmodtime>
                  <value>2010.02.16 12:42:20</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <sysmodcount>
                  <value>2</value>
                  <type>Decimal</type>
                </sysmodcount>
              </file-handhelds>
              <uniquequery>file.device,logical.name="HandHeld-001"</uniquequery>
            </instance>
          </model>
          <status>SUCCESS</status>
          <message>Success</message>
          <schema-revision-date>2010.02.04 00:00:00</schema-revision-date>
          <schema-revision-level>0</schema-revision-level>
          <return-code>0</return-code>
        </parameters>
      </item>
    </response>
  </responses>
</hp-service-manager-response>

Find Handheld Device operation

Comments