Get Annotation operation

The Get Annotation operation finds all the annotations of a message by the specified ID.

The following table describes the <items> XML and request elements for the Get Annotation operation:

Adapter request elements for the Get 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 identifier (ID) of the message that contains the annotation

Yes

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

Sample adapter request for the Get Annotation operation

<hpom-request>
  <operation>get-annotation</operation>
  <username>user</username>
  <password>pass</password>
  <arguments>
    <message-id>231c15d8-915c-71de-13f5-ac1031690000</message-id>
  </arguments>
</hpom-request>


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

Sample adapter response for the Get Annotation operation

<hpom-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <messages-response>
    <message-response>
      <metadata>
        <status>success</status>
        <count>17</count>
      </metadata>
      <Annotations>
        <Annotation>
          <Author>opc_adm</Author>
          <Text>Test annotation</Text>
          <Date>2009-08-09T14:13:44.000+05:30</Date>
          <ID>bef6e33c-84c0-71de-162b-ac1031690000</ID>
        </Annotation>
...
        <Annotation>
          <Author>opc_adm</Author>
          <Text>Test annotation</Text>
          <Date>2009-09-02T13:46:09.000+05:30</Date>
          <ID>dea69d18-9798-71de-0676-ac1031690000</ID>
        </Annotation>
      </Annotations>
    </message-response>
  </messages-response>
</hpom-response>
Was this page helpful? Yes No Submitting... Thank you

Comments