About the SYS Field Name Prefix
While reviewing the fields associated with an item in the Content Browser, you might have noticed some field names with the prefix
sys (see Inspect Items With the Content Browser if using Coveo Cloud V2). These fields may appear redundant, since their value is identical to the value of fields with the same name, minus the
These field pairs coexist for compatibility reasons. In Coveo Enterprise Search (CES) and Coveo Cloud V1 indexes, the names of the system fields are prefixed with
sys (Coveo Enterprise Search 7.0 and Coveo Cloud V1). This prefix was abandoned in Coveo Cloud V2. However, for backward compatibility reasons the Coveo REST Search API still includes the older field names (see REST Search API).
In a future version of the Coveo Cloud REST Search API, fields prefixed with
sys will not be available anymore, regardless of the index used. Therefore, future Coveo REST Search API releases will alter the functioning of search pages built using sys field names. Such a major breaking change will be announced in the Coveo Cloud New Features page.
To prepare for these future upgrades and keep your Coveo-powered search page running smoothly, you should make sure that your search page does not encompass field names with the
sys prefix anymore.