Delete Annotation operation

The Delete Annotation operation deletes an annotation from a message.

The following table describes the <items> XML elements for the Delete Annotation operation:

Adapter request elements for the Delete Annotation operation

Element

Definition

Required

<username>

Specifies the user name for the HP Operations Manager server authentication

Note

If the <username> element is not specified, the adapter uses the user name specified in BMC Atrium Orchestrator Grid Manager.

No

<password>

Specifies the password that corresponds to the user name

Note

If the <password> element is not specified, the adapter uses the password specified in Grid Manager.

No

<arguments>

Specifies a list of arguments that are required for this operation

Yes

<message-id>

Specifies the ID of the message that contains the annotation to be deleted

Yes

<annotation-id>

Specifies the ID of the annotation to be deleted

Yes

The following figure shows a sample adapter request for the Delete Annotation operation:

Sample adapter request for the Delete Annotation operation

<hpom-request>
  <operation>delete-annotation</operation>
  <username>user</username>
  <password>pass</password>
  <arguments>
    <message-id>1b04be00-8643-71de-0f13-ac1031860000</message-id>
    <annotation-id>6fcd15f8-fbd2-4c2f-98eb-ce96b6fa706b</annotation-id>
  </arguments>
</hpom-request>

The following figure shows the adapter response for the sample request:

Sample adapter response for the Delete Annotation operation

<hpom-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <messages-response>
    <message-response>
      <metadata>
        <status>success</status>
        <count>3</count>
      </metadata>
      <Items>
        <Annotations>
          <Annotation>
            <Author>WIN3STDVM\Administrator</Author>
            <Text>test 1</Text>
            <Date>2009-09-07T15:41:11</Date>
            <ID>cddf0864-f617-47d4-b059-2567cd390c8e</ID>
          </Annotation>
          <Annotation>
            <Author>WIN3STDVM\Administrator</Author>
            <Text>test 3</Text>
            <Date>2009-09-07T15:41:11</Date>
            <ID>70e8fbc4-211e-43b1-8ede-1dcf08e2f531</ID>
          </Annotation>
          <Annotation>
            <Author>WIN3STDVM\Administrator</Author>
            <Text>for delete</Text>
            <Date>2009-09-07T15:41:11</Date>
            <ID>abbd8df7-f5a0-4dca-a6ce-344dd412c2e3</ID>
          </Annotation>
        </Annotations>
      </Items>
    </message-response>
  </messages-response>
</hpom-response>
Was this page helpful? Yes No Submitting... Thank you

Comments