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

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>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 24.3