Delete Office Electronic operation

The Delete Office Electronic operation deletes the details of an office electronic device.

Delete wrappers can delete only a single record. If information provided in the request refers to zero or more than one record, then no record is deleted. The entry to be deleted is first located by executing a logical AND operation using the elements provided in request. The located entry is then deleted.

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 Delete Office Electronic operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: delete-office-electronic

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 <logical-name> element in the <instance> element.

You can specify the <logical-name> element in the <keys> element, in the <instance> element, or in both elements.

Yes

<logical-name>

Specifies a unique name for identifying an office electronic item

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.

Yes

<instance>

Specifies a unique office electronic item 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 an office electronic item

The <file-device> element can contain multiple child elements.

Yes

<istatus>

Specifies the status of the office electronic item

Valid values:

  • Planned/On order
  • Received
  • In Stock
  • Reserved
  • In use
  • Maintenance
  • Disposed/Retired
  • Installed

No

<assignment>

Specifies the assignment group for the office electronic item

Valid value: Any string, or an existing record from the application

No

<vendor>

Specifies the name of the vendor for the office electronic item

Valid value: Any string, or an existing record from the application

No

<serial-number>

Specifies the serial number of the office electronic item

Valid value: Any string

No

<location>

Specifies the location of the office electronic item

Valid value: Any string, or an existing record from the application

No

<configuration-item-type>

Specifies the type of the configuration item

Valid value: officeelectronics

No

<part-no>

Specifies the part number related to the office electronic item

Valid value: Any string; or an existing record from the application

No

<version>

Specifies the version of the office electronic item

Valid value: Any string

No

<model>

Specifies the model of the electronic 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

Valid values:

  • Copy Machine
  • Printer
  • Fax Machine
  • Paper Shredder
  • Camera
  • Speaker
  • Calculator
  • Multifunction
  • Word Processer
  • Typewriter
  • VCR
  • Television
  • UPS
  • Net Printer

No

<building>

Specifies the building for the office electronic item

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 office electronic item

Valid values:

  • Development
  • Test
  • Production
  • Failover
  • None

No

<owner>

Specifies the department that owns the office electronic item

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 office electronic item

Valid values:

  • 1: Enterprise
  • 2: Site / Dept
  • 3: Multiple Users
  • 4: User

No

<title>

Specifies the title for the office electronic item

Valid value: Any string

No

<problem-priority>

Specifies the priority of the office electronic item

Valid values:

  • 1: Critical
  • 2: High
  • 3 - Average
  • 4: Low

No

<id>

Specifies the ID of the office electronic item

Valid value: Any unique string

No

<file-officeelectronics>

Contains child elements for describing the office electronic item; is a structure-type element

Yes

The following figure displays a sample adapter request for the Delete Office Electronic operation.

Sample adapter request for the Delete Office Electronic operation


 <hp-service-manager-request>
    <entity>configurationitem</entity>
    <entity-type>office-electronic</entity-type>
    <request>
      <operation-name>delete-office-electronic</operation-name>
      <parameters>
        <delete-office-electronic-request>
          <model>
            <keys>
              <logical-name>
                <value>OffElec-001</value>
                <type>String</type>
              </logical-name>
            </keys>
            <instance>
              <file-device>
                <type>Structure</type>
                <logical-name>
                  <value>OffElec-001</value>
                  <type>String</type>
                </logical-name>
                <vendor>
                  <value>Hewlett-Packard</value>
                  <type>String</type>
                </vendor>
                <serial-no>
                  <value>Serial No 12</value>
                  <type>String</type>
                </serial-no>
                <location>
                  <value>Australia</value>
                  <type>String</type>
                </location>
                <configuration-item-type>
                  <value>officeelectronics</value>
                  <type>String</type>
                </configuration-item-type>
                <id>
                  <value>CI10921</value>
                  <type>String</type>
                </id>
                <updated-by>
                  <value>falcon</value>
                  <type>String</type>
                </updated-by>
                <part-no>
                  <value>Prt No 11</value>
                  <type>String</type>
                </part-no>
                <istatus>
                  <value>In use</value>
                  <type>String</type>
                </istatus>
                <version>
                  <value>Ver 12</value>
                  <type>String</type>
                </version>
                <subtype>
                  <value>Copy Machine</value>
                  <type>String</type>
                </subtype>
                <location-code>
                  <value>advantageaustralia</value>
                  <type>String</type>
                </location-code>
                <building>
                  <value>Building DEL4</value>
                  <type>String</type>
                </building>
                <floor>
                  <value>LG</value>
                  <type>String</type>
                </floor>
                <room>
                  <value>BETA</value>
                  <type>String</type>
                </room>
                <sysmodtime>
                  <value>2010.02.17 18:52:52</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <assignment>
                  <value>Applications</value>
                  <type>String</type>
                </assignment>
                <title>
                  <value>Title for Office Elec</value>
                  <type>String</type>
                </title>
                <environment>
                  <value>Development</value>
                  <type>String</type>
                </environment>
                <owner>
                  <value>Test_Owner</value>
                  <type>String</type>
                </owner>
              </file-device>
                <file-officeelectronics>
                <type>Structure</type>
                <sysmodtime>
                  <value>2010.02.17 18:52:52</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
              </file-officeelectronics>
              <uniquequery>file.device,logical.name="OffElec-001"</uniquequery>
            </instance>
          </model>
        </delete-office-electronic-request>
      </parameters>
    </request>
  </hp-service-manager-request>


The following figure displays an adapter response for the Delete Office Electronic operation.

Sample adapter response for the Delete Office Electronic 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>OffElec-001</value>
                <type>String</type>
              </logical-name>
            </keys>
            <instance>
              <file-device>
                <type>Structure</type>
                <logical-name>
                  <value>OffElec-001</value>
                  <type>String</type>
                </logical-name>
                <vendor>
                  <value>Hewlett-Packard</value>
                  <type>String</type>
                </vendor>
                <serial-no>
                  <value>Serial No 12</value>
                  <type>String</type>
                </serial-no>
                <location>
                  <value>Australia</value>
                  <type>String</type>
                </location>
                <configuration-item-type>
                  <value>officeelectronics</value>
                  <type>String</type>
                </configuration-item-type>
                <id>
                  <value>CI10921</value>
                  <type>String</type>
                </id>
                <updated-by>
                  <value>falcon</value>
                  <type>String</type>
                </updated-by>
                <part-no>
                  <value>Prt No 11</value>
                  <type>String</type>
                </part-no>
                <istatus>
                  <value>In use</value>
                  <type>String</type>
                </istatus>
                <version>
                  <value>Ver 12</value>
                  <type>String</type>
                </version>
                <subtype>
                  <value>Copy Machine</value>
                  <type>String</type>
                </subtype>
                <location-code>
                  <value>advantageaustralia</value>
                  <type>String</type>
                </location-code>
                <building>
                  <value>Building DEL4</value>
                  <type>String</type>
                </building>
                <floor>
                  <value>LG</value>
                  <type>String</type>
                </floor>
                <room>
                  <value>BETA</value>
                  <type>String</type>
                </room>
                <sysmodtime>
                  <value>2010.02.17 18:52:52</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <assignment>
                  <value>Applications</value>
                  <type>String</type>
                </assignment>
                <title>
                  <value>Title for Office Elec</value>
                  <type>String</type>
                </title>
                <environment>
                  <value>Development</value>
                  <type>String</type>
                </environment>
                <owner>
                  <value>Test_Owner</value>
                  <type>String</type>
                </owner>
              </file-device>
              <file-officeelectronics>
                <type>Structure</type>
                <sysmodtime>
                  <value>2010.02.17 18:52:52</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
              </file-officeelectronics>
              <uniquequery>file.device,logical.name="OffElec-001"</uniquequery>
            </instance>
          </model>
          <messages>
            <element>
              <value>joinofficeelectronics record deleted.</value>
            </element>
          </messages>
          <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>
Was this page helpful? Yes No Submitting... Thank you

Comments