Searching using externalID in EngageOne Server

Product Feature: API (Web Service, SDI, etc.)


 
The below steps can be used during externalID Workitem search in EngageOne® Server.

1.  Create a workitem, by using pushData. (https://example-abcd.net:8080/EngageOneWS/DataPushService)

For example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dat="http://abc.com/EngageOne/ws/datapush" xmlns:com="http://abc.com/EngageOne/ws/common">
<soapenv:Header/>
<soapenv:Body>
<dat:PushData>
<com:authContext>
<com:UsernameToken>
<com:domain>
<com:ident>
<com:name>Test</com:name>
</com:ident>
</com:domain>
<com:userId>Admin</com:userId>
<com:password>Test1</com:password>
<com:transientSession>false</com:transientSession>
<com:ondemand>false</com:ondemand>
</com:UsernameToken>
</com:authContext>
<template>
<ident>
<com:name>Test_A</com:name>
</ident>
<effectiveDate>9999-12-31</effectiveDate>
</template>
<pushDataFile>
<data>PD94bWwgdmYWxvbmU9Im5vIj8</data>
</pushDataFile>
<mapId>DataMap</mapId>
<returnFiles>false</returnFiles>
<externalId>ffff</externalId>
</dat:PushData>
</soapenv:Body>
</soapenv:Envelope>

Note: <externalId> is set to ffff.

2. Make use of searchWorkitems (http://example-abcd.net:8080/EngageOneWS/WorkItemService)
The query that returns a created work item looks like this:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wor="http://abc.com/EngageOne/ws/workItem" xmlns:com="http://abc.com/EngageOne/ws/common" xmlns:mod="http://abc.com/EngageOne/ws/model">
<soapenv:Header/>
<soapenv:Body>
<wor:SearchWorkItems>
<com:authContext>
<com:UsernameToken>
<com:domain>
<com:ident>
<com:name>Test</com:name>
</com:ident>
</com:domain>
<com:userId>Admin</com:userId>
<com:password>Test1</com:password>
<com:transientSession>false</com:transientSession>
<com:ondemand>false</com:ondemand>
</com:UsernameToken>
</com:authContext>
<com:filter>LIST</com:filter>
<workItemListType>SUBMITTED</workItemListType>
<workItems>
<workItem>
<ident>
<com:name>ffff</com:name>
</ident>
</workItem>
</workItems>
</wor:SearchWorkItems>
</soapenv:Body>
</soapenv:Envelope>

The searching of workitems behavior is the same as LIKE operator (The fragment should be specified not the whole name).
Note that the workworkitem/ident/name is the external id.
UPDATED:  April 6, 2020