Attribute | Type | Definition |
---|---|---|
ConfInfoInUpdates | boolean | Specifies whether the consumer wants ConflationInfo in updates. ConfInfoInUpdates defaults to false. |
Domain | string,int | Specifies the domain model represented by this message. If absent, Domain defaults to MarketPrice. Click here for a list of available domains • Analytics • Contribution • Dictionary • EconomicIndicator • Forecast • Headline • History • Login • MarketByOrder • MarketByPrice • MarketMaker • MarketPrice • MarketByTime • NewsTextAnalytics • Poll • ProviderAdmin • Reference • ReplayHeadline • ReplayStory • ServiceProviderStatus • Source • Story • SymbolList • System • Transaction • YieldCurve |
ID | int,array(int) | Required. Integer value(s) representing the event stream. It can also be used to match the request and responses. |
Key | object | Required. The key representing the data content or capability requested. |
![]() | object | An Element List describing additional attributes of the item stream. |
![]() | object | A filter specification used to request which filter entries will be present in a Filter List payload. |
![]() | int | A user-defined numeric identifier. Identifier is defined on a per-domain basis. This attribute's range is from -2,147,483,648 to 2,147,483,647. |
![]() | string,array(string) | Name(s) of the information requested. If absent, Name defaults to 0. |
![]() | string,int | An enumeration representing the different forms the name can take. If absent, NameType defaults to Ric. Click here for a list of available values • AuthnToken: Authentication Token • Cookie: User information is specified in cookie • EmailAddress: Email Address • Name: Username • Ric: Reuters Instrument Code • Token: User Token (Typically AAA Token) • Unspecified: Unspecified |
![]() | string,int | A name or ID representing the identifier of the service provider. If absent, Service defaults to the default service in the Refinitiv Real-Time Advanced Distribution Server configuration. |
KeyInUpdates | boolean | Whether the consumer wants the key encoded in every update. If absent, KeyInUpdates defaults to true. |
Pause | boolean | Pause item. Pause defaults to false. |
Priority | object | When specified, indicates the relative importance of the request and resulting event stream. Priority defaults to Class=1, Count=1. |
![]() | int | Required. Specifies the priority’s class. |
![]() | int | Required. Specifies the priority’s count. |
Private | boolean | Private stream. Private defaults to false. |
Qos | object | Specifies the Quality of Service. Provides classification of data/events to provide different tiers of service. • When specified without a WorstQos member, this is the only allowable Quality of Service for the requested stream. If this Quality of Service is unavailable, the stream is not opened. • When specified with a WorstQos, this is the best in the range of allowable Quality of Services. When a Quality of Service range is specified, any Quality of Service within the range is acceptable for servicing the stream. • If neither Qos nor WorstQos are present on the request, this indicates that any available Quality of Service will satisfy the request. • Some components may require Qos on the initial request and on reissue messages. For details, refer to specific component documentation. |
![]() | boolean | Specifies whether or not the Qos is dynamic. If absent, KeyInUpdates defaults to false. |
![]() | string,int | Required. Maximum period of change in data (for streaming events). Click here for a list of available values • JitConflated: Just-in-time conflated, meaning that quality is typically tick-by-tick, but if burst data occurs (or if a component cannot keep up with tick-by-tick delivery), multiple updates are combined into a single update to reduce traffic. This value is usually considered a lower quality than TickByTick. • TickByTick: Tick-by-Tick, meaning data is sent for every update. This is the highest quality of rate value. The best overall Quality of Service is a Rate of TickByTick and a Timeliness of Realtime. • TimeConflated: The interval of time (usually in milliseconds) over which data are conflated is provided in RateInfo. This is a lower quality than TickByTick and at times even lower than JitConflated. |
![]() | int | Specifies any information related to Rate. |
![]() | int | Information related to Timeliness. |
![]() | string,int | Required. Specifies the data’s age. Click here for a list of available values • Delayed: Timeliness is delayed and the amount of delay is provided in TimeInfo. This is lower quality than Realtime and might be better than DelayedUnknown. • DelayedUnknown: Timeliness is delayed, although the amount of delay is unknown. This is a lower quality than Realtime and might be worse than Delayed (in which case the delay is known). • Realtime: Data is updated as soon as new data is available, and is the highest-quality Timeliness value. In conjunction with a Rate of TickByTick, Realtime is the best overall Quality of Service. |
Qualified | boolean | Qualified stream. Qualified defaults to false. |
Refresh | boolean | Indicates whether the user requires a Refresh for this content. This will typically be set to false when changing Priority, View, or when pausing/resuming a stream. Refresh defaults to true. |
Streaming | boolean | The application wishes to create an event stream based on this request (i.e. the request/response with interest interaction paradigm). Streaming defaults to true. |
Type | string,int | Specifies the message classification. If absent, Type defaults to Request. Click here for a list of available types • Ack • Close • Generic • Post • Refresh • Request • Status • Update |
View | array(string,number) | An array of field names or IDs that the client application would like to specifically request. |
WorstQos | object | Specifies the least acceptable Quality of Service for the requested stream. • When specified with a Qos value, indicates the lower bounds of the quality-of-service required by the application. • When not specified, the best Quality of Service defines the exact Quality of Service required by the application (e.g. application requires realtime/tick-by-tick data). |
![]() | boolean | Whether or not Qos is dynamic. If absent, Dynamic defaults to false. |
![]() | string,int | Required. Specifies the maximum period of change in data (for streaming events). Click here for a list of available values • JitConflated: Just-In-Time Conflated, meaning that quality is typically tick-by-tick, but if burst data occurs (or if a component cannot keep up with tick-by-tick delivery), multiple updates are combined into a single update to reduce traffic. This value is usually considered a lower quality than TickByTick. • TickByTick: Data is sent for every update. This is the highest quality of rate value. The best overall Quality of Service is a Rate of TickByTick and a Timeliness of Realtime. • TimeConflated: The interval of time (usually in milliseconds) over which data are conflated is provided in RateInfo. This is lower quality than TickByTick and at times even lower than JitConflated. |
![]() | int | Information related to Rate. |
![]() | string,int | Required. Specifies the data’s age. Click here for a list of available values • Delayed: Timeliness is delayed and the amount of delay is provided in TimeInfo. This is lower quality than Realtime and might be better than DelayedUnknown. • DelayedUnknown: Timeliness is delayed, although the amount of delay is unknown. This is a lower quality than Realtime and might be worse than Delayed (in which case the delay is known). • Realtime: Data is updated as soon as new data is available. This is the highest-quality Timeliness value. In conjunction with a Rate of TickByTick, Realtime is the best overall Quality of Service. |
![]() | int | Information relate to Timeliness. |