preview
Data for fields marked with directive will be returned in case if API consumer has corresponding /fields/@preview
or /fields/@all
permission.
E.g., if an API consumer has urn:cx/core:data/candidates/fields/@preview:read:all
permission, but not urn:cx/core:data/candidates/fields/@all:read:all
,
then when requesting a list of candidates,
he will be able to fetch only fields marked with this directive (_id
, _kind
, displayName
and emailAddresses
) and for others an error will be returned.
But if API consumer has urn:cx/core:data/candidates/fields/@all:read:all
permission, then any candidate field will be returned,
regardless of whether it's marked with @preview
directive.
Previous
anyScope
Next
searchable