Unlimited Gateway Query (DEPRECATED)
| Request |
|
| Description |
This query provides an XML document with all task attachments that have been created in OMD since the last synchronization. This query is deprecated since a restart of the interface after a longer time-out period may cause massive downloads of new attachments, causing performance or memory issues on either end. |
| Context |
https://<instance>.optimizemyday.com/omdservices-basic/Configuration/<ConfigurationIdentifier> |
| URL |
/Query/omd.domain.s4.TaskAttachment.gateway |
| Method |
GET |
| Response Code |
200 when successful, another HTTP status code otherwise |
| Success Response |
A document containing the list of the requested attachments. |
| Response Type |
XML or JSON |
| Parameter |
Datatype |
Description |
| lastUpdate* |
Datetime |
The lower boundary for which attachments are requested. It is advised to use a backInTime window, i.e. a minimum amount of minutes that should always be subtracted from the last stored synchronization timestamp to avoid missing attachments that were processed in another transaction while downloading data from OMD during the last synchronization. Normally, a backInTime window of a minute or two should suffice. |
| excludeTaskType |
String |
Exclude TaskAttachments of Tasks of the given taskType. This parameter can be defined multiple times, to pass a list of taskTypes. Usage of the parameters excludeTaskType and includeTaskType is mutually exclusive. |
| includeTaskType |
String |
Include TaskAttachments of Tasks of the given taskType. This parameter can be defined multiple times, to pass a list of taskTypes. Usage of the parameters excludeTaskType and includeTaskType is mutually exclusive. |
| _output |
String |
The requested output format being xml or json. If omitted, xml is assumed. |
| zipped |
boolean |
Allows for smaller amount of traffic. In that case, the receiving client must be able to process the zipped stream, of which the first entry is called content. |
| stylesheet |
String |
May contain the name of the XSL stylesheet applied to the output. The stylesheet gateway.xsl removes the namespaces from the XML elements, i.e. a Task Attachment element is named TaskAttachment instead of omd.domain.s4.TaskAttachment. Only applicable to XML output. |
Sample Call
https://sandbox.optimizemyday.com/omdservices-basic/Configuration/16167225/Query/omd.domain.s4.TaskAttachment.gateway?lastUpdate=2017-09-18%2002:00:00
Sample Result
<Result date="2017-09-18 16:20:13" version="OMD on JVM 1.8.0_31">
<omd.domain.s4.TaskAttachment id="1336056c-187f-4f05-8e98-8cafc1654ad4" version="1" task="ea2a2919-c-1-1-2017-05-11" attachmentType="1" externalId="1336056c-187f-4f05-8e98-8cafc1654ad4" subType="move" content="2017-09-21,10000021" createdOn="2017-09-18 02:10:17" createdBy="admin" extra="ea2a2919-c" quantity="0.0" lastUpdate="2017-09-18 02:10:17" processFlow="IP"/>
<omd.domain.s4.TaskAttachment id="d724bc18-b235-46b2-bb2c-406674dc5695" version="1" task="f3c952ca-8-1-1-2017-05-11" attachmentType="1" externalId="d724bc18-b235-46b2-bb2c-406674dc5695" subType="move" content="2017-09-21,10000021" createdOn="2017-09-18 02:10:17" createdBy="admin" extra="f3c952ca-8" quantity="0.0" lastUpdate="2017-09-18 02:10:17" processFlow="IP"/>
<omd.domain.s4.TaskAttachment id="72cb960a-65aa-428e-8dfd-f9ca31269006" version="1" task="f787e1ea-5-1-1-2017-05-11" attachmentType="1" externalId="72cb960a-65aa-428e-8dfd-f9ca31269006" subType="move" content="2017-09-21,10000021" createdOn="2017-09-18 02:16:37" createdBy="admin" extra="f787e1ea-5" quantity="0.0" lastUpdate="2017-09-18 02:10:17" processFlow="IP"/>
</Result>
The following query can be used to retrieve attachments with a specific sub-type:
https://sandbox.optimizemyday.com/omdservices-basic/Configuration/Configuration Identifier/Query/omd.domain.s4.TaskAttachment.gatewaySubTypeLimit?lastUpdate=timestamp&limitDateTime=limit timestamp&subtype=kpi