Jump to: navigation, search

GetUpdates

Purpose

This method cannot filter by tenantID because it is possible to receive events from other tenants. This is a technical limitation of the UCS event system and there is no workaround. Because GetUpdates can be a blocking operation, there is a limit of 10 concurrent blocking calls, to prevent usage of all UCS connections.

URL

  • GET /OMResponse/GetUpdates/


Request

Parameters

Key ValueType Value Description Mandatory Unique Default
EventType String Comma (,)-separated list of Persistent names within:
  • Category
  • CategoryAttribute
  • CategoryStructure
  • EmRoute
  • TrainingJob
  • Model
  • StandardResponse
  • PIIRule
  • PIIRegEx
  • PIIGroup
  • PIIGroupContent
  • PIITestMessage

Can also contain only one value without comma.

false true Empty means all monitored Persistent names will be returned.
Since String Date in ISO8601 Date Format Will retrieve all updates since that date. Time is UCS time. You can use GetServerTime to retrieve it or use a returned date. false true
PoolTimeout Integer Value is in minutes If present, request will block until an event occurs or timeout expires. You must set your ESP client timeout to a value higher than PoolTimeout. false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Since String Date in ISO8601 Date Format All returned Persistent IDs are updates from that date. true true
EventDate String Date in ISO8601 Date Format Date when events were gathered. You can use this value for the 'Since' parameter of next GetUpdates request. true true
  • Category
  • CategoryAttribute
  • CategoryStructure
  • EmRoute
  • TrainingJob
  • Model
  • PIIRule
  • PIIRegEx
  • PIIGroup
  • PIIGroupContent
  • PIITestMessage
KVList Depending on the number of requested EventType you get at least one of these KVList A KVList with below content with Persistent IDs and the date when the event occurred. Note that several identical events can occur on the same ID but only the last one will be shown. Notice that the same ID (like 00001a8VK7EC003T below) can be seen in several lists to be able to reconstruct the event flow:

Inserted={ 00001a8VK7EC003S= 2013 - 06 - 25T13:40:38.792Z 00001a8VK7EC003T= 2013 - 06 - 25T13:40:38.801Z } Updated = { 00001a8VK7EC003T= 2013 - 06 - 25T13:40:59.523Z } Deleted = { 00001a8VK7EC003T= 2013 - 06 - 25T13:41:40.221Z }

true true
  • Category
  • CategoryAttribute
  • CategoryStructure
  • EmRoute
  • TrainingJob
  • Model
  • PIIRule
  • PIIRegEx
  • PIIGroup
  • PIIGroupContent
  • PIITestMessage
KVList See above for description false true


Error

FaultCode FaultString Description
204 Incorrect value for parameter {0}, expected {1} but was {2} Incorrect value for parameter
739 Too many 'blocking getUpdates' in use, request rejected. 10 blocking get updates request are currently in progress.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.