WebSphere Business Monitor, Version 6.2.0 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


Event Emitter Services - Emit Events Resource - POST Method

Use this service emit XSD style event(s)to WebSphere Business Monitor.

Resource URI

POST /rest/bpm/events

Parameters

None.

Request Content

Use this service to emit XSD styles events to WebSphere Business Monitor. To emit a single event use a content type of text/xml. For better performance emit a batch of events using content type of application/atom+xml to specify multiple event payloads

The default content-type is none.

MIME Type: application/atom+xml


+ View Schema
<!--
	@start_restricted_prolog@
	Licensed Materials - Property of IBM
	5639-D57,5630-A36,5630-A37,5724-D18            
	(C) Copyright IBM Corporation 2008 All Rights Reserved.
	US Government Users Restricted Rights- Use, duplication or disclosure
	restricted by GSA ADP Schedule Contract with IBM Corp.
	@end_restricted_prolog@
-->
<xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:thr="http://purl.org/syndication/thread/1.0"
targetNamespace="http://www.w3.org/2005/Atom"
elementFormDefault="qualified">

  <xsd:include schemaLocation="atom_common.xsd"/>
  <xsd:import namespace="http://purl.org/syndication/thread/1.0"
              schemaLocation="atom_threading_ext.xsd"/>

  <!-- Move xml common attributes to common attribute group when supported -->
  <xsd:import namespace="http://www.w3.org/XML/1998/namespace"
              schemaLocation="xml.xsd"/>

  <xsd:complexType name="atomTextConstruct">
    <xsd:simpleContent>
      <xsd:extension base="xsd:string">
        <xsd:attribute ref="xml:base" use="optional"/>
        <xsd:attribute ref="xml:lang" use="optional"/>
        <xsd:attribute name="type" use="optional">
          <xsd:simpleType>
            <xsd:restriction base="xsd:string">
              <xsd:enumeration value="text"/>
              <xsd:enumeration value="html"/>
              <xsd:enumeration value="xhtml"/>
            </xsd:restriction>
          </xsd:simpleType>
        </xsd:attribute>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>

  <xsd:simpleType name="atomEmailAddress">
    <xsd:restriction base="xsd:string">
      <xsd:pattern value=".+@.+"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:complexType name="atomPersonConstruct">
    <xsd:sequence>
      <xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
      <xsd:element name="uri" type="xsd:anyURI" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="email" type="atom:atomEmailAddress" minOccurs="0" maxOccurs="1"/>
      <xsd:any maxOccurs="unbounded" namespace="##other"/>
    </xsd:sequence>
    <xsd:attribute ref="xml:base" use="optional"/>
    <xsd:attribute ref="xml:lang" use="optional"/>
  </xsd:complexType>

  <xsd:complexType name="atomSource">
    <xsd:sequence>
      <xsd:element name="author" type="atom:atomAuthor" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="category" type="atom:atomCategory" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="contributor" type="atom:atomContributor" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="generator" type="atom:atomGenerator" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="icon" type="atom:atomIcon" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="id" type="atom:atomId" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="link" type="atom:atomLink" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="logo" type="atom:atomLogo" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="rights" type="atom:atomRights" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="subtitle" type="atom:atomSubtitle" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="title" type="atom:atomTitle" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="updated" type="atom:atomUpdated" minOccurs="0" maxOccurs="1"/>
      <xsd:any maxOccurs="unbounded" namespace="##other"/>
    </xsd:sequence>
    <xsd:attribute ref="xml:base" use="optional"/>
    <xsd:attribute ref="xml:lang" use="optional"/>
  </xsd:complexType>

  <xsd:element name="feed" type="atom:feed"/>
  <xsd:complexType name="feed">
    <xsd:complexContent>
      <xsd:extension base="atom:atomSource">
        <xsd:sequence>
          <xsd:element ref="atom:entry" minOccurs="0" maxOccurs="unbounded"/>
        </xsd:sequence>
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:element name="entry" type="atom:entry"/>
  <xsd:complexType name="entry">
    <xsd:sequence>
      <xsd:element name="author" type="atom:atomAuthor" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="category" type="atom:atomCategory" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="content" type="atom:atomContent" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="contributor" type="atom:atomContributor" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="id" type="atom:atomId" minOccurs="1" maxOccurs="1"/>
      <xsd:element name="link" type="atom:atomLink" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="published" type="atom:atomPublished" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="rights" type="atom:atomRights" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="source" type="atom:atomSource" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="summary" type="atom:atomSummary" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="title" type="atom:atomTitle" minOccurs="1" maxOccurs="1"/>
      <xsd:element name="updated" type="atom:atomUpdated" minOccurs="1" maxOccurs="1"/>
      <xsd:element name="in-reply-to" type="thr:threadExtInReplyTo" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="total" type="thr:threadExtTotal" minOccurs="0" maxOccurs="1"/>
      <xsd:any maxOccurs="unbounded" namespace="##other"/>
    </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="atomContent" mixed="true">
    <xsd:sequence>
      <xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
    </xsd:sequence>
    <xsd:attribute ref="xml:base" use="optional"/>
    <xsd:attribute ref="xml:lang" use="optional"/>
    <xsd:attribute name="type" type="xsd:string" use="required"/>
    <xsd:attribute name="src" type="xsd:anyURI" use="optional"/>
  </xsd:complexType>

  <xsd:complexType name="atomAuthor">
    <xsd:complexContent>
      <xsd:extension base="atom:atomPersonConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomCategory">
    <xsd:complexContent>
      <xsd:extension base="atom:undefinedContent">
         <xsd:attribute ref="xml:base" use="optional"/>
         <xsd:attribute ref="xml:lang" use="optional"/>
         <xsd:attribute name="term" type="xsd:string" use="required"/>
         <xsd:attribute name="scheme" type="xsd:anyURI" use="optional"/>
         <xsd:attribute name="label" type="xsd:string" use="optional"/>
       </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomContributor">
    <xsd:complexContent>
      <xsd:extension base="atom:atomPersonConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomGenerator">
    <xsd:simpleContent>
      <xsd:extension base="xsd:string">
        <xsd:attribute ref="xml:base" use="optional"/>
        <xsd:attribute ref="xml:lang" use="optional"/>
        <xsd:attribute name="uri" type="xsd:anyURI" use="optional"/>
        <xsd:attribute name="version" type="xsd:string" use="optional"/>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>

  <xsd:complexType name="atomIcon">
    <xsd:simpleContent>
      <xsd:extension base="xsd:anyURI">
        <xsd:attribute ref="xml:base" use="optional"/>
        <xsd:attribute ref="xml:lang" use="optional"/>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>

  <xsd:complexType name="atomId">
    <xsd:simpleContent>
      <xsd:extension base="xsd:anyURI">
        <xsd:attribute ref="xml:base" use="optional"/>
        <xsd:attribute ref="xml:lang" use="optional"/>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>

  <xsd:simpleType name="atomNCName">
    <xsd:restriction base="xsd:string">
      <xsd:minLength value="1"/>
      <xsd:pattern value="[^:]*"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:simpleType name="atomLanguageTag">
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="[A-Za-z]{1,8}(-[A-Za-z0-9]{1,8})*"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:complexType name="atomLink">
    <xsd:complexContent>
      <xsd:extension base="atom:undefinedContent">
         <xsd:attribute ref="xml:base" use="optional"/>
         <xsd:attribute ref="xml:lang" use="optional"/>
         <xsd:attribute name="href" type="xsd:anyURI" use="required"/>
         <xsd:attribute name="rel" type="xsd:string" use="optional"/>
         <xsd:attribute name="type" type="xsd:string" use="optional"/>
         <xsd:attribute name="hreflang" type="atom:atomLanguageTag" use="optional"/>
         <xsd:attribute name="title" type="xsd:string" use="optional"/>
         <xsd:attribute name="length" type="xsd:string" use="optional"/>
         <xsd:attribute name="count" type="thr:threadExtCount" use="optional"/>
         <xsd:attribute name="updated" type="thr:threadExtUpdated" use="optional"/>
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomLogo">
    <xsd:simpleContent>
      <xsd:extension base="xsd:anyURI">
        <xsd:attribute ref="xml:base" use="optional"/>
        <xsd:attribute ref="xml:lang" use="optional"/>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>

  <xsd:complexType name="atomPublished">
    <xsd:complexContent>
      <xsd:extension base="atom:atomDateConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomRights">
    <xsd:complexContent>
      <xsd:extension base="atom:atomTextConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomSubtitle">
    <xsd:complexContent>
      <xsd:extension base="atom:atomTextConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomTitle">
    <xsd:complexContent>
      <xsd:extension base="atom:atomTextConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomUpdated">
    <xsd:complexContent>
      <xsd:extension base="atom:atomDateConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="atomSummary">
    <xsd:complexContent>
      <xsd:extension base="atom:atomTextConstruct"/>
    </xsd:complexContent>
  </xsd:complexType>

</xsd:schema>

Example content:

 <?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"> 
        <author><name>lsivakum@us.ibm.com</name></author>
        <id>tag:example.org,2007:/foo</id> 
        <title type="text">Test Feed</title>
        <link href="http://events.com"></link>
        <entry> 
          <author><name>lsivakum@us.ibm.com</name></author>
          <id>-5925067920588736622</id><title type="text">Entry 0</title> 
          <content type="application/xml">
             <a xmlns="http://www.w3.org/2001/XMLSchema-instance"><b><c><d>Customer 1 Data</d></c></b></a>
          </content> 
        </entry>
        <entry> 
          <author><name>lsivakum@us.ibm.com</name></author>
          <id>-5925067920588736622</id><title type="text">Entry 0</title> 
          <content type="application/xml">
             <a xmlns="http://www.w3.org/2001/XMLSchema-instance"><b><c><d>Customer 2 Data</d></c></b></a> 
          </content> 
        </entry>
 </feed>

MIME Type: text/xml


+ View Schema
<!--
Well-formed XML that refers to an event definition that defines its structure. Event definitions can be found 
in XML Schema Definition (XSD). See the WebSphere Business Monitor Infocenter for more detail about XSD style events.
-->

Example content:

<wbe:event-bundle xmlns:wbe="http://www.ibm.com/xmlns/prod/websphere/businessEvents/6.1.0">
  <wbe:connector-info>
    <wbe:name>WBE</wbe:name>
    <wbe:version>2.2</wbe:version>
    <wbe:system>lc2d266010</wbe:system>
    <wbe:timestamp>2008-10-09T19:47:29.078-04:00</wbe:timestamp>
    <wbe:log-info>This is an event from IBMs WebSphere Business Events</wbe:log-info>
  </wbe:connector-info>
  <wbe:event-info>
    <wbe:name>Sell After Buy</wbe:name>
    <wbe:type>Action</wbe:type>
    <wbe:workflow>649D38F1BDB0160411DDE8CC23A73733</wbe:workflow>
  </wbe:event-info>
  <wbe:payload-data>
    <wbe:payload name="Trade Out">
       <payload:Trade-Out-array xmlns:payload="http://lc2d266010/wbe/action/Sell-After-Buy"><payload:Trade-Out>
         <payload:Key>String_CustomerV String_StockID</payload:Key>
         <payload:Date>2008-06-16T14:08:20Z</payload:Date><payload:Quantity>9.9</payload:Quantity>
         <payload:StockID>String_StockID</payload:StockID><payload:CustomerID>String_CustomerV</payload:CustomerID>
         <payload:Price>9.9</payload:Price></payload:Trade-Out>
       </payload:Trade-Out-array>
    </wbe:payload>
  </wbe:payload-data>
</wbe:event-bundle>

Response Content

This service returns a JSON object with a list sucessfully emitted Event IDS

MIME Type: application/json


+ View Schema
{"Event Emission":{"type":"string"},
 "Request ContentType":{"type":"string"},
 "Event IDs":{"type":["string"]}
}

Example content:

{"Event Emission":"WBM.CEI",
 "Request ContentType":"text\/xml",
 "Event IDs":
 {"Event IDs":["CE879D78FDCC23B385A1DDA93AA6C3CCB0","CE879D78FDCC23B385A1DDA93AA6C3CCB0"]}
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{ 
   { "Emission Completion Status" : {"type":"integer"},
     "Error" : {"type":"string"},
   }
} 

Example content:

{
   {"Emission Completion Status":500,
    "Error":"CWMDS6840E: The payload content type is not valid. It must be of type
                         'application/atom+xml' or 'text/xml'."
   }
}

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - requested data returned. Note that the list may be empty.
404 Not Found
Resource not found or URL not supported.
500 Internal Server Error
Internal error processing the request.

Available Since

6.2.0

Parent Topic: Emit Events Resource