2.6 PostEvent

POST method to post an event to Workflow Automation.

2.6.1 Request Parameters

Include the following parameters in the request URL as needed.

Parameter	Description
sessionID userName password hostName portNumber	All web service calls require BSL authentication and may optionally identify a Workflow Automation Server. For more information about authentication and identification, see Authentication and Identification.

2.6.2 Request Data

Include the following elements in the POST request data as needed.

NOTE:All PostEvent request data elements are optional and can be omitted. Each omitted element is populated with an appropriate default value such as minimum or current time, zero, false, or an empty string.

Although it is possible to omit all the request data elements, doing so has little use beyond verifying that the web service can post a generic, empty event and return its event identifier.

Element	Description
AffectedObject	OPTIONAL. Object name that caused the event generation.
CanonicalSource	OPTIONAL. Canonical path to the object on which the event was observed.
Classifications	OPTIONAL. Numeric event classification value.
CreationTime	OPTIONAL. Date and time the event was created.
CustomData1 – CustomData8	OPTIONAL.Eight custom data values that can be returned by an event in addition to the event Message and OtherData.
ElapsedTimeInSeconds	OPTIONAL. Elapsed time in seconds since the event was created.
FirstOccurence	OPTIONAL. Date and time the event was first observed.
GlobalID	OPTIONAL. Globally unique event identifier.
KnowledgeScript	OPTIONAL. Knowledge script name responsible for observing the event.
LastModificationTime	OPTIONAL. Date and time the event was last modified.
LastOccurence	OPTIONAL. Date and time the event was last observed.
LocalID	OPTIONAL. Local identifier that identifies the event within the publisher’s scope.
Message	OPTIONAL. Event message.
Name	OPTIONAL. Event name.
Observer	OPTIONAL. Object name that observed the event.
OtherData	OPTIONAL. Optional additional data returned by the event.
Priority	OPTIONAL. Numeric event priority.
RepeatCount	OPTIONAL. Number of times the event repeated.
SequenceNumber	OPTIONAL. Sequence number.
Severity	OPTIONAL. Severity. Possible values are Not Noteworthy, Information, Attention, Emergency, or Fatal.
Source	OPTIONAL. Object name on which the event was observed.
Status	OPTIONAL. Event status. Possible values are New, Open, Acknowledged, Closed, or Deleted.
XmlData	OPTIONAL. XML data field.
XmlSchemaURL	OPTIONAL. XML schema that defines XMLData structure.

Sample POST XML Request Body

The following is a sample POST XML request body.

<PostEventInfo xmlns="http://www.attachmate.com/Aegis/">
  <AffectedObject>String content</AffectedObject>
  <CanonicalSource>String content</CanonicalSource>
  <Classifications>18446744073709551615</Classifications>
  <CreationTime>1999-05-31T11:20:00</CreationTime>
  <CustomData1>String content</CustomData1>
  <CustomData2>String content</CustomData2>
  <CustomData3>String content</CustomData3>
  <CustomData4>String content</CustomData4>
  <CustomData5>String content</CustomData5>
  <CustomData6>String content</CustomData6>
  <CustomData7>String content</CustomData7>
  <CustomData8>String content</CustomData8>
  <ElapsedTimeInSeconds>9223372036854775807</ElapsedTimeInSeconds>
  <FirstOccurence>1999-05-31T11:20:00</FirstOccurence>
  <GlobalID>String content</GlobalID>
  <KnowledgeScript>String content</KnowledgeScript>
  <LastModificationTime>1999-05-31T11:20:00</LastModificationTime>
  <LastOccurence>1999-05-31T11:20:00</LastOccurence>
  <LocalID>String content</LocalID>
  <Message>String content</Message>
  <Name>String content</Name>
  <Observer>String content</Observer>
  <OtherData>String content</OtherData>
  <Priority>32767</Priority>
  <RepeatCount>4294967295</RepeatCount>
  <SequenceNumber>4294967295</SequenceNumber>
  <Severity>NotNoteworthy</Severity>
  <Source>String content</Source>
  <Status>New</Status>
  <XmlData>String content</XmlData>
  <XmlSchemaURL>String content</XmlSchemaURL>
</PostEventInfo>

Sample POST Json Request Body

The following is a sample POST Json request body.

{
  "AffectedObject":"String content",
  "CanonicalSource":"String content",
  "Classifications":18446744073709551615,
  "CreationTime":"\/Date(928167600000-0500)\/",
  "CustomData1":"String content",
  "CustomData2":"String content",
  "CustomData3":"String content",
  "CustomData4":"String content",
  "CustomData5":"String content",
  "CustomData6":"String content",
  "CustomData7":"String content",
  "CustomData8":"String content",
  "ElapsedTimeInSeconds":9223372036854775807,
  "FirstOccurence":"\/Date(928167600000-0500)\/",
  "GlobalID":"String content",
  "KnowledgeScript":"String content",
  "LastModificationTime":"\/Date(928167600000-0500)\/",
  "LastOccurence":"\/Date(928167600000-0500)\/",
  "LocalID":"String content",
  "Message":"String content",
  "Name":"String content",
  "Observer":"String content",
  "OtherData":"String content",
  "Priority":32767,
  "RepeatCount":4294967295,
  "SequenceNumber":4294967295,
  "Severity":0,
  "Source":"String content",
  "Status":0,
  "XmlData":"String content",
  "XmlSchemaURL":"String content"
}

POST Request XML Schema

The following is the POST request XML schema.

<xs:schema xmlns:tns="http://www.attachmate.com/Aegis/" elementFormDefault="qualified" targetNamespace="http://www.attachmate.com/Aegis/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="PostEventInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="AffectedObject" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CanonicalSource" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Classifications" type="xs:unsignedLong" />
      <xs:element minOccurs="0" name="CreationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="CustomData1" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData2" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData3" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData4" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData5" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData6" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData7" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CustomData8" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ElapsedTimeInSeconds" type="xs:long" />
      <xs:element minOccurs="0" name="FirstOccurence" type="xs:dateTime" />
      <xs:element minOccurs="0" name="GlobalID" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="KnowledgeScript" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="LastModificationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="LastOccurence" type="xs:dateTime" />
      <xs:element minOccurs="0" name="LocalID" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Observer" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="OtherData" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Priority" type="xs:short" />
      <xs:element minOccurs="0" name="RepeatCount" type="xs:unsignedInt" />
      <xs:element minOccurs="0" name="SequenceNumber" type="xs:unsignedInt" />
      <xs:element minOccurs="0" name="Severity" type="tns:EventSeverity" />
      <xs:element minOccurs="0" name="Source" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Status" type="tns:EventStatus" />
      <xs:element minOccurs="0" name="XmlData" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="XmlSchemaURL" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="PostEventInfo" nillable="true" type="tns:PostEventInfo" />
  <xs:simpleType name="EventSeverity">
    <xs:annotation>
      <xs:appinfo>
        <ActualType Name="unsignedShort" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
      </xs:appinfo>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:enumeration value="NotNoteworthy" />
      <xs:enumeration value="Information" />
      <xs:enumeration value="Attention" />
      <xs:enumeration value="Emergency" />
      <xs:enumeration value="Fatal" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="EventSeverity" nillable="true" type="tns:EventSeverity" />
  <xs:simpleType name="EventStatus">
    <xs:annotation>
      <xs:appinfo>
        <ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
      </xs:appinfo>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:enumeration value="New" />
      <xs:enumeration value="Open" />
      <xs:enumeration value="Acknowledged" />
      <xs:enumeration value="Closed" />
      <xs:enumeration value="Deleted" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="EventStatus" nillable="true" type="tns:EventStatus" />
</xs:schema>

Additional POST Request XML Schemas

The following is an additional POST request XML schema.

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

The following is an additional POST request XML schema.

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>

2.6.3 Response Data

The POST response data contains the following elements.

Element	Description
EventID	Workflow Automation event identifier for the posted event.

Sample XML Response Body

The following is a sample XML response body.

<PostEventResult xmlns="http://www.attachmate.com/Aegis/">
  <EventID>String content</EventID>
</PostEventResult>

Sample Json Response Body

The following is a sample Json response body.

{
  "EventID":"String content"
}

Response XML Schema

The following is the response XML schema.

<xs:schema xmlns:tns="http://www.attachmate.com/Aegis/" elementFormDefault="qualified" targetNamespace="http://www.attachmate.com/Aegis/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="PostEventResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="EventID" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="PostEventResult" nillable="true" type="tns:PostEventResult" />
</xs:schema>

Additional XML Response Schemas

The following is an additional XML response schema.

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

The following is an additional XML response schema.

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>