--- schema_version: "1" id: f18e74efff1065fae48e51beb9cbf401a09117b448c90d0343f4058fed2abd9a title: DataStreamTemplate collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_datastreamtemplate.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_datastreamtemplate.htm source_site: developer.salesforce.com content_type: documentation content_hash: f6b774a701638c17dafdf16cd4f631b13db872575e1be3d154e6d99a66548b25 description: Represents metadata about the data stream that a user adds to a data kit. This object is available in API version 52.0 and later. --- # DataStreamTemplate Represents metadata about the data stream that a user adds to a data kit. This object is available in API version 52.0 and later. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Special Access Rules You need Data 360 permission to access this object. ## Fields | Field | Details | | --- | --- | | DataSourceBundleDefinitionId | Type reference Properties Filter, Group, Sort Description The ID of the DataSourceBundleDefinition, which refers to the data stream bundle to which a data stream template belongs. This field is a relationship field. **Relationship Name** DataSourceBundleDefinition **Relationship Type** Look up | | DataSourceObjectId | Type reference Properties Filter, Group, Sort Description The ID of the DataSourceObject, which represents the object from where the data was sourced. This field is a relationship field. **Relationship Name** DataSourceObject **Relationship Type** Look up | | DeveloperName | Type string Properties Filter, Group, Sort Description Unique name for the data stream template. Identical value to FullName. | | FilterCriteria | Type textarea Properties Nillable Description Describes the filter applied to the data stream before the information is sent to Data 360. | | FullName | Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API. | | Language | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Languages supported in the deployment. Possible values are: - af—Afrikaans - am—Amharic - ar—Arabic - ar\_AE—Arabic (United Arab Emirates) - ar\_BH—Arabic (Bahrain) - ar\_DZ—Arabic (Algeria) - ar\_EG—Arabic (Egypt) - ar\_IQ—Arabic (Iraq) - ar\_JO—Arabic (Jordan) - ar\_KW—Arabic (Kuwait) - ar\_LB—Arabic (Lebanon) - ar\_LY—Arabic (Libya) - ar\_MA—Arabic (Morocco) - ar\_OM—Arabic (Oman) - ar\_QA—Arabic (Qatar) - ar\_SA—Arabic (Saudi Arabia) - ar\_SD—Arabic (Sudan) - ar\_SY—Arabic (Syria) - ar\_TN—Arabic (Tunisia) - ar\_YE—Arabic (Yemen) - bg—Bulgarian - bn—Bengali - bs—Bosnian - ca—Catalan - cac—Chuj - cak—Kaqchikel - cs—Czech - cy—Welsh - da—Danish - de—German - de\_AT—German (Austria) - de\_BE—German (Belgium) - de\_CH—German (Switzerland) - de\_LI—German (Liechtenstein) - de\_LU—German (Luxembourg) - el—Greek - el\_CY—Greek (Cyprus) - en\_AD—English (Andorra) - en\_AE—English (United Arab Emirates) - en\_AG—English (Antigua and Barbuda) - en\_AL—English (Albania) - en\_AT—English (Austria) - en\_AU—English (Australian) - en\_BA—English (Bosnia and Herzegovina) - en\_BB—English (Barbados) - en\_BE—English (Belgium) - en\_BG—English (Bulgaria) - en\_BS—English (Bahamas) - en\_BZ—English (Belize) - en\_CA—English (Canadian) - en\_CH—English (Switzerland) - en\_CY—English (Cyprus) - en\_CZ—English (Czechia) - en\_DE—English (Germany) - en\_DK—English (Denmark) - en\_DM—English (Dominica) - en\_EE—English (Estonia) - en\_ES—English (Spain) - en\_FI—English (Finland) - en\_FR—English (France) - en\_GB—English (UK) - en\_GD—English (Grenada) - en\_GI—English (Gibraltar) - en\_GR—English (Greece) - en\_GY—English (Guyana) - en\_HK—English (Hong Kong) - en\_HR—English (Croatia) - en\_HU—English (Hungary) - en\_IE—English (Ireland) - en\_IL—English (Israel) - en\_IN—English (Indian) - en\_IS—English (Iceland) - en\_IT—English (Italy) - en\_JM—English (Jamaica) - en\_JP—English (Japan) - en\_KN—English (St. Kitts and Nevis) - en\_KR—English (South Korea) - en\_LC—English (St. Lucia) - en\_LI—English (Liechtenstein) - en\_LT—English (Lithuania) - en\_LU—English (Luxembourg) - en\_LV—English (Latvia) - en\_MC—English (Monaco) - en\_ME—English (Montenegro) - en\_MK—English (North Macedonia) - en\_MT—English (Malta) - en\_MY—English (Malaysian) - en\_NL—English (Netherlands) - en\_NO—English (Norway) - en\_NZ—English (New Zealand) - en\_PH—English (Phillipines) - en\_PL—English (Poland) - en\_PT—English (Portugal) - en\_RO—English (Romania) - en\_RS—English (Serbia) - en\_SE—English (Sweden) - en\_SG—English (Singapore) - en\_SI—English (Slovenia) - en\_SK—English (Slovakia) - en\_TH—English (Thailand) - en\_TR—English (Turkey) - en\_TT—English (Trinidad and Tobago) - en\_TW—English (Taiwan) - en\_US—English - en\_VC—English (St. Vincent and the Grenadines) - en\_ZA—English (South Africa) - eo—Esperanto (Pseudo) - es—Spanish - es\_AD—Spanish (Andorra) - es\_AR—Spanish (Argentina) - es\_BO—Spanish (Bolivia) - es\_CL—Spanish (Chile) - es\_CO—Spanish (Colombia) - es\_CR—Spanish (Costa Rica) - es\_DO—Spanish (Dominican Republic) - es\_EC—Spanish (Ecuador) - es\_GT—Spanish (Guatemala) - es\_HN—Spanish (Honduras) - es\_MX—Spanish (Mexico) - es\_NI—Spanish (Nicaragua) - es\_PA—Spanish (Panama) - es\_PE—Spanish (Peru) - es\_PR—Spanish (Puerto Rico) - es\_PY—Spanish (Paraguay) - es\_SV—Spanish (El Salvador) - es\_US—Spanish (United States) - es\_UY—Spanish (Uruguay) - es\_VE—Spanish (Venezuela) - et—Estonian - eu—Basque - fa—Farsi - fi—Finnish - fr—French - fr\_BE—French (Belgium) - fr\_CA—French (Canadian) - fr\_CH—French (Switzerland) - fr\_HT—French (Haiti) - fr\_LU—French (Luxembourg) - fr\_MA—French (Morocco) - ga—Irish - gu—Gujarati - haw—Hawaiian - hi—Hindi - hmn—Hmong - hr—Croatian - ht—Haitian Creole - hu—Hungarian - hy—Armenian - in—Indonesian - is—Icelandic - it—Italian - it\_CH—Italian (Switzerland) - iw—Hebrew - iw\_EO—Esperanto RTL (Pseudo) - ja—Japanese - ji—Yiddish - ka—Georgian - kk—Kazakh - kl—Greenlandic - km—Khmer - kn—Kannada - ko—Korean - lb—Luxembourgish - lt—Lithuanian - lv—Latvian - mi—Te reo - mk—Macedonian - ml—Malayalam - mr—Marathi - ms—Malay - mt—Maltese - my—Burmese - nl\_BE—Dutch (Belgium) - nl\_NL—Dutch - nl\_SR—Dutch (Suriname) - no—Norwegian - pa—Punjabi - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - quc—Kiche - rm—Romansh - ro—Romanian - ro\_MD—Romanian (Moldova) - ru—Russian - ru\_AM—Russian (Armenia) - ru\_BY—Russian (Belarus) - ru\_KG—Russian (Kyrgyzstan) - ru\_KZ—Russian (Kazakhstan) - ru\_LT—Russian (Lithuania) - ru\_MD—Russian (Moldova) - ru\_PL—Russian (Poland) - ru\_UA—Russian (Ukraine) - sh—Serbian (Latin) - sh\_ME—Montenegrin - sk—Slovak - sl—Slovene - sm—Samoan - sq—Albanian - sr—Serbian (Cyrillic) - sv—Swedish - sv\_FI—Swedish (Finland) - sw—Swahili - ta—Tamil - te—Telugu - th—Thai - tl—Tagalog - tr—Turkish - uk—Ukrainian - ur—Urdu - vi—Vietnamese - xh—Xhosa - zh\_CN—Chinese (Simplified) - zh\_HK—Chinese (Hong Kong) - zh\_MY—Chinese (Malaysia) - zh\_SG—Chinese (Singapore) - zh\_TW—Chinese (Traditional) - zu—Zulu | | ManageableState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the state of an entity in a package. Possible values are: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged | | MasterLabel | Type string Properties Filter, Group, Sort Description Indicates the name of the bundle. | | Metadata | Type complexvalue Properties Create, Nillable, Update Description Describes additional information that's necessary for the data stream template. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. | | RefreshDayOfMonth | Type int Properties Filter, Group, Nillable, Sort Description The duration of the day of the month after which the data stream template must be refreshed. | | RefreshDayOfWeek | Type int Properties Filter, Group, Nillable, Sort Description The duration of the day of the week after which the data stream must be refreshed. | | RefreshFrequency | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The frequency with which the data stream must be refreshed. Possible values are: - BATCH—Batch - DAILY—Daily - EVERY\_12\_HOURS—Every 12 Hours - EVERY\_4\_HOURS—Every 4 Hours - HOURLY—Hourly - MINUTES\_15—15 Minutes - MINUTES\_30—30 Minutes - MINUTES\_5—5 Minutes - MONTHLY—Monthly - NONE—None - NOT\_APPLICABLE—Not Applicable - STREAMING—Streaming - WEEKLY—Weekly | | RefreshHours | Type multipicklist Properties Filter, Nillable Description The duration after which the data stream template must be refreshed. Possible values are: - 0 - 1 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 2 - 20 - 21 - 22 - 23 - 3 - 4 - 5 - 6 - 7 - 8 - 9 | | RefreshMode | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The mode of refresh. Possible values are: - FULL\_REFRESH—Full Refresh - INCREMENTAL—Incremental - NEAR\_REAL\_TIME\_INCREMENTAL—Near Real-time Incremental - NOT\_APPLICABLE—Not Applicable - PARTIAL\_UPDATE—Partial Update - REPLACE—Replace By Date - UPSERT—Upsert | | RefreshStartDate | Type date Properties Filter, Group, Nillable, Sort Description The date to retrieve data based on the refresh frequency data. Available in API version 62.0 and later. | | SourceObjectName | Type string Properties Filter, Group, Nillable, Sort Description The name of the source object from which data is streamed. Available in API version 62.0 and later. | | StreamType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of data stream. Available in API version 62.0 and later. Possible values are: - DIRECT\_ACCESS—Direct Access - DIRECT\_ACCESS\_ACCELERATED—Direct Access (Accelerated) - INGEST—Ingest | | StreamingAppDataConnectorType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The connector app for data streaming. Available in API version 63.0 and later. Possible values are: - MobileApp—Mobile App - WebApp—Web App | | TemplateVersion | Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The version number of the template. Available in API version 62.0 and later. |