Delete Mainframe operation

The Delete Mainframe operation deletes the details of a mainframe item.

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 Mainframe operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `delete-main-frame`	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 the unique name for identifying a mainframe item The `<logical-name>` element must be used as the key and must be the child item of the `<keys>` element. Valid value: Any unique string	Yes
`<instance>`	Specifies a unique mainframe 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 a mainframe item The `<file-device>` element can have multiple child elements.	Yes
`<istatus>`	Specifies the status of the mainframe item Valid values: Planned/On order Received In Stock Reserved In use Maintenance Disposed/Retired Installed	No
`<assignment>`	Specifies the assignment group for the mainframe item Valid value: Any string, or an existing record from the application	No
`<vendor>`	Specifies the name of the vendor for the mainframe item Valid value: Any string, or an existing record from the application	No
`<serial-no>`	Specifies the serial number of the mainframe item Valid value: Any string	No
`<location>`	Specifies the location of the mainframe item Valid value: Any string, or an existing record from the application	No
`<configuration-item-type>`	Specifies the type of configuration item Valid value: mainframe Note: The `<configuration-item-type>` field is optional in the WebService API but is required to filter the records for computer items. If you do not specify the value for `<configuration-item-type>`, then the records will be searched for all configuration items, such as furnishing, device, and computer. Therefore, BMC recommends that you provide a value for the `<configuration-item-type>` element.	No
`<part-no>`	Specifies the part number related to the mainframe item Valid value: Any string; or an existing record from the application	No
`<version>`	Specifies the version of the mainframe item Valid value: Any string	No
`<model>`	Specifies the model of the mainframe item Valid value: Any string	No
`<updated-by>`	Specifies the name of the person who updated the record Default value: The user name of the person 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, the following subtypes are available for the "computer" configuration item type: Controller Host CPU FEP NCP LPAR	No
`<building>`	Specifies the building for the mainframe 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 mainframe item Valid values: Development Test Production Failover None	No
`<owner>`	Specifies the department that owns the mainframe 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>`	Specifies the default impact of the mainframe item Valid values: 1: Enterprise 2: Site / Dept 3: Multiple Users 4: User	No
`<title>`	Specifies the title for the mainframe item Valid value: Any string	No
`<problem-priority>`	Specifies the priority of the mainframe item Valid values: 1: Critical 2: High 3 - Average 4: Low	No
`<id>`	Specifies the ID of the computer item Valid value: Any unique string	No
`<file-mainframe>`	Contains child elements for describing the mainframe item; is a structure-type element	Yes

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

Sample adapter request for the Delete Mainframe operation


 <hp-service-manager-request>
    <entity>configurationitem</entity>
    <entity-type>mainframe</entity-type>
    <request>
      <operation-name>delete-main-frame</operation-name>
      <parameters>
        <delete-main-frame-request>
          <model>
            <keys>
              <logical-name>
                <value>MF-001</value>
                <type>String</type>
              </logical-name>
            </keys>
            <instance>
              <file-device>
                <type>Structure</type>
                <vendor>
                  <value>Casio</value>
                  <type>String</type>
                </vendor>
                <serial-no>
                  <value>Sr No 1234</value>
                  <type>String</type>
                </serial-no>
                <location>
                  <value>Asia</value>
                  <type>String</type>
                </location>
                <configuration-item-type>
                  <value>mainframe</value>
                  <type>String</type>
                </configuration-item-type>
                <id>
                  <value>CI10916</value>
                  <type>String</type>
                </id>
                <updated-by>
                  <value>falcon</value>
                  <type>String</type>
                </updated-by>
                <part-no>
                  <value>PartNumber 1234</value>
                  <type>String</type>
                </part-no>
                <istatus>
                  <value>In Stock</value>
                  <type>String</type>
                </istatus>
                <version>
                  <value>Version 1.0</value>
                  <type>String</type>
                </version>
                <subtype>
                  <value>Controller</value>
                  <type>String</type>
                </subtype>
                <location-code>
                  <value>advantageasia</value>
                  <type>String</type>
                </location-code>
                <vendor-id>
                  <value>CASIO</value>
                  <type>String</type>
                </vendor-id>
                <building>
                  <value>Building Del4</value>
                  <type>String</type>
                </building>
                <floor>
                  <value>Floor LG</value>
                  <type>String</type>
                </floor>
                <room>
                  <value>Room Beta</value>
                  <type>String</type>
                </room>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <assignment>
                  <value>Application</value>
                  <type>String</type>
                </assignment>
                <title>
                  <value>Title</value>
                  <type>String</type>
                </title>
              </file-device>
              <file-mainframe>
              </file-mainframe>
            </instance>
          </model>
        </delete-main-frame-request>
      </parameters>
    </request>
  </hp-service-manager-request>

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

Sample adapter response for Delete Mainframe 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>MF-001</value>
                <type>String</type>
              </logical-name>
            </keys>
            <instance>
              <file-device>
                <type>Structure</type>
                <vendor>
                  <value>Casio</value>
                  <type>String</type>
                </vendor>
                <serial-no>
                  <value>Sr No 1234</value>
                  <type>String</type>
                </serial-no>
                <location>
                  <value>Asia</value>
                  <type>String</type>
                </location>
                <configuration-item-type>
                  <value>mainframe</value>
                  <type>String</type>
                </configuration-item-type>
                <id>
                  <value>CI10916</value>
                  <type>String</type>
                </id>
                <updated-by>
                  <value>falcon</value>
                  <type>String</type>
                </updated-by>
                <part-no>
                  <value>PartNumber 1234</value>
                  <type>String</type>
                </part-no>
                <istatus>
                  <value>In Stock</value>
                  <type>String</type>
                </istatus>
                <version>
                  <value>Version 1.0</value>
                  <type>String</type>
                </version>
                <subtype>
                  <value>Controller</value>
                  <type>String</type>
                </subtype>
                <location-code>
                  <value>advantageasia</value>
                  <type>String</type>
                </location-code>
                <vendor-id>
                  <value>CASIO</value>
                  <type>String</type>
                </vendor-id>
                <building>
                  <value>Building Del4</value>
                  <type>String</type>
                </building>
                <floor>
                  <value>Floor LG</value>
                  <type>String</type>
                </floor>
                <room>
                  <value>Room Beta</value>
                  <type>String</type>
                </room>
                  <sysmodtime>
                  <value>2010.02.19 12:14:37</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <assignment>
                  <value>Application</value>
                  <type>String</type>
                </assignment>
                <title>
                  <value>Title</value>
                  <type>String</type>
                </title>
              </file-device>
              <file-mainframe>
                <type>Structure</type>
                <sysmodtime>
                  <value>2010.02.19 12:14:37</value>
                  <type>DateTime</type>
                </sysmodtime>
                <sysmoduser>
                  <value>falcon</value>
                  <type>String</type>
                </sysmoduser>
                <sysmodcount>
                  <value>0</value>
                  <type>Decimal</type>
                </sysmodcount>
              </file-mainframe>
              <uniquequery>file.device,logical.name="MF-001"</uniquequery>
            </instance>
          </model>
          <messages>
            <element>
              <value>joinmainframe 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>

Delete Mainframe operation

Comments