Acknowledge Message operation


The Acknowledge Message operation acknowledges a message.

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

Adapter request elements for the Acknowledge Message operation

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

Sample adapter request for the Acknowledge Message operation

<hpom-request>
  <operation>acknowledge-message</operation>
  <username>user</username>
  <password>pass</password>
  <arguments>
    <message-id>cc978718-2af2-71dd-1221-ac1031690000</message-id>
  </arguments>
</hpom-request>

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

Sample adapter response for the Acknowledge Message 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>
      <Items>
        <Message>
          <AssignedOperator>
            <PersonAttributes>
              <Name>opc_test</Name>
            </PersonAttributes>
          </AssignedOperator>
          <MessageID>4a9fe99c-92ef-71de-0676-ac1031690000</MessageID>
          <Title>Test Title</Title>
          <Description>Test Description</Description>
          <LifecycleState>closed</LifecycleState>
          <Severity>Critical</Severity>
          <Solution>Test_Solution</Solution>
          <Category>Test_Category</Category>
          <SubCategory>test_sub_category</SubCategory>
          <ProductType>test_ProductType</ProductType>
          <ProblemType>test_ProblemType</ProblemType>
          <CollaborationMode>peer</CollaborationMode>
          <EmittingCI>
            <ConfigurationItemProperties>
              <ID />
            </ConfigurationItemProperties>
          </EmittingCI>
          <EmittingNode>
            <NodeProperties>
              <DnsName>s-14686.synapse.com</DnsName>
            </NodeProperties>
          </EmittingNode>
          <Type>message_type</Type>
          <Extensions>
            <OperationsExtension>
              <Application>My custom app</Application>
              <Object>Test_Object</Object>
              <StateChangeTime>2009-08-27T16:23:52.000+05:30</StateChangeTime>
              <CreationTime>2009-08-26T05:10:00.000+05:30</CreationTime>
              <ReceivedTime>2009-08-27T15:22:11.000+05:30</ReceivedTime>
              <NumberOfDuplicates>0</NumberOfDuplicates>
              <CorrelationKey>test key</CorrelationKey>
              <ConditionMatched>false</ConditionMatched>
              <AutomaticActionStatus>notAvailable</AutomaticActionStatus>
              <OperatorActionStatus>notAvailable</OperatorActionStatus>
              <EscalationStatus>notEscalated</EscalationStatus>
              <Source>j53365608</Source>
              <NumberOfAnnotations>0</NumberOfAnnotations>
              <OriginalEvent />
              <CustomAttributes>
                <CustomAttribute>
                  <Key>custom_Attribute_1</Key>
                  <Text>value_1</Text>
                </CustomAttribute>
              </CustomAttributes>
            </OperationsExtension>
          </Extensions>
        </Message>
      </Items>
    </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 20.19.01