Annotate operation

The Annotate operation adds an annotation to a message.

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

Adapter request elements for the Annotate 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 a unique identifier (ID) for the message to which the annotation is added	Yes
`<annotation>`	Specifies the annotation text	Yes

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

Sample adapter request for the Annotate operation

<hpom-request>
  <operation>annotate</operation>
  <username>user</username>
  <password>pass</password>
  <arguments>
    <message-id>9bb78fe0-b344-71de-1714-ac1031860000</message-id>
    <annotation>test annotate text</annotation>
  </arguments>
</hpom-request>

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

Sample adapter response for the Annotate operation

<hpom-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <messages-response>
    <message-response>
      <metadata>
        <status>success</status>
        <count>1</count>
      </metadata>
      <Annotations>
        <Annotation>
          <Author>WIN3STDVM\Administrator</Author>
          <Text><![CDATA[test annotate text]]></Text>
          <Date>2009-10-28T17:33:36</Date>
          <ID>53a7f037-96c4-4f0f-9528-775a4bd91542</ID>
        </Annotation>
      </Annotations>
    </message-response>
  </messages-response>
</hpom-response>

Annotate operation

Comments