Namespace: com.sap.vocabularies.Common.v1
Common terms for all SAP vocabularies
| Term | Type | Description |
|---|---|---|
| Experimental | String? | Terms, types, and properties annotated with this term are experimental and can be changed incompatibly or removed completely any time without prior warning. Do not use or rely on experimental terms, types, and properties in production environments. |
| ServiceVersion | Int32 | 1 for first version of a service, incremented when schema changes incompatibly and service is published with a different URI |
| ServiceSchemaVersion | Int32 | 0 for first schema version within a service version, incremented when schema changes compatibly |
| Label | String | A short, human-readable text suitable for labels and captions in UIs |
| Heading | String | A short, human-readable text suitable for column headings in UIs |
| QuickInfo | String | A short, human-readable text suitable for tool tips in UIs |
| DocumentationRef (Experimental) | String | A URI referencing language-dependent documentation for the annotated model element (Example) |
| Text | String? | A descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation. Applicable Annotation Terms: |
| TextFor (Experimental) | PropertyPath | The annotated property contains a descriptive text for values of the referenced property. |
| ExternalID (Experimental) | String? | A human readable identifier for values of the annotated property or parameter. Value MUST be a dynamic expression when used as metadata annotation. If the annotated property is (part of) a foreign key of a resource, the external id is a human readable (part of an) identifier of this resource. There is a one-to-one relationship between each possible value of the annotated property and the corresponding external id. The annotation of a parameter refers to a property of the operation binding parameter. |
| IsLanguageIdentifier (Experimental) | Tag | An identifier to distinguish multiple texts in different languages for the same entity |
| TextFormat | TextFormatType | The annotated property, parameter, or return type contains human-readable text that may contain formatting information |
| Timezone (Experimental) | String? | The point in time represented by the annotated property or parameter shall be interpreted in the given time zone Time zones shall be specified according to the IANA standard. If this annotation is absent or null or an empty string, points in time are typically interpreted in the current user's or default time zone. The annotation value can be a path expression resolving to a property that may be tagged with IsTimezone. |
| IsTimezone (Experimental) | Tag | Annotated property or parameter is a time zone |
| IsDigitSequence | Tag | Contains only digits |
| IsUpperCase | Tag | Contains just uppercase characters |
| IsCurrency | Tag | Annotated property or parameter is a currency code |
| IsUnit | Tag | Annotated property or parameter is a unit of measure |
| UnitSpecificScale | PrimitiveType | The number of fractional decimal digits of a currency amount or measured quantity The annotated property contains a currency code or unit of measure, and the annotation value specifies the default scale of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of fractional digits captured by that device. |
| UnitSpecificPrecision (Experimental) | PrimitiveType | The number of significant decimal digits of a currency amount or measured quantity The annotated property contains a currency code or unit of measure, and the annotation value specifies the default precision of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of significant digits captured by that device. |
| SecondaryKey | [PropertyPath] | The listed properties form a secondary key Multiple secondary keys are possible using different qualifiers. Unlike Core.AlternateKeys, secondary keys need not support addressing an entity in a resource path. |
| MinOccurs | Int64 | The annotated set or collection contains at least this number of items |
| MaxOccurs | Int64 | The annotated set or collection contains at most this number of items |
| AssociationEntity | [NavigationPropertyPath] | Entity representing an n:m association with attributes |
| DerivedNavigation | NavigationPropertyPath | Shortcut for a multi-segment navigation, contains the long path with all its segments |
| Masked (Deprecated) | Tag | Use terms MaskedValue instead |
| MaskedValue (Experimental) | String? | Property contains sensitive data that is by default not transferred By default a masked property is excluded from responses and instead an instance annotation with this term is sent, containing a masked value that can be rendered by user interfaces. |
| RevealOnDemand (Experimental) | Boolean | Unmasked data for this property can be requested with custom query option masked-values=false |
| SemanticObject | String? | Name of the Semantic Object represented as this entity type or identified by this property |
| SemanticObjectMapping | [SemanticObjectMappingAbstract] | Maps properties of the annotated entity type or sibling properties of the annotated property to properties of the Semantic Object This allows "renaming" of properties in the current context to match property names of the Semantic Object, e.g. SenderPartyID to PartyID. Only properties explicitly listed in the mapping are renamed, all other properties are available for intent-based navigation with their "local" name. |
| SemanticObjectUnavailableActions | [String] | List of actions that are not available in the current state of the instance of the Semantic Object |
| IsInstanceAnnotation | Tag | Term can also be used as instance annotation; AppliesTo of this term specifies where it can be applied |
| FilterExpressionRestrictions (Deprecated) | [FilterExpressionRestrictionType] | Use term Capabilities.FilterRestrictions instead |
| FieldControl | FieldControlType? | Control state of a property, parameter, or the media stream of a media entity This term can be used for static field control, providing an enumeration member value in $metadata, as well as dynamically, providing a Path expression.In the dynamic case the property referenced by the Path expression MUST be of type Edm.Byte to accommodate OData V2 services as well as V4 infrastructures that don't support enumeration types. |
| ExceptionCategory (Experimental) | String | A machine-readable exception category |
| Application (Experimental) | ApplicationType | ... |
| Timestamp (Experimental) | DateTimeOffset | ... |
| TransactionId (Experimental) | String | ... |
| ErrorResolution (Experimental) | ErrorResolutionType | Hints for resolving this error |
| Messages | [ComplexType] | Collection of end-user messages The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure. The minimum structure is
|
| additionalTargets (Experimental) | [String] | Additional targets for the message This instance annotation can be applied to the error object and the objects within the details array of an OData error response |
| longtextUrl | URL | Location of the message long text This instance annotation can be applied to the error object and the objects within the details array of an OData error response |
| numericSeverity | NumericMessageSeverityType | Classifies an end-user message as info, success, warning, or error This instance annotation can be applied to the error object and the objects within the details array of an OData error response |
| MaximumNumericMessageSeverity (Experimental) | NumericMessageSeverityType? | The maximum severity of all end-user messages attached to an entity, null if no messages are attached This metadata annotation can be applied to entity types that are also annotated with term Common.Messages |
| IsActionCritical | Boolean | Criticality of the function or action to enforce a warning or similar before it's executed |
| Attributes | [PropertyPath] | Attributes related to this property, which may occur in denormalized entity types |
| RelatedRecursiveHierarchy | AnnotationPath | A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. |
| Interval | IntervalType | An interval with lower and upper boundaries described by two properties |
| ResultContext | Tag | The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. |
| SAPObjectNodeType (Experimental) | SAPObjectNodeTypeType | The SAP Object Node Type represented by the annotated entity type SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. |
| Composition (Experimental) | Tag | The annotated navigation property represents a logical composition, even though it is non-containment The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. |
| SAPObjectNodeTypeReference (Experimental) | String | The entity referenced by the annotated property has the SAPObjectNodeType with this nameThe entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. |
| IsNaturalPerson | Tag | The annotated entity type (e.g. Employee) or annotation (e.g. IsImageUrl) represents a natural person |
| ValueList | ValueListType | Specifies how to get a list of acceptable values for a property or parameter The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. |
| ValueListRelevantQualifiers | [SimpleIdentifier] | List of qualifiers of relevant ValueList annotations The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. |
| ValueListWithFixedValues | Tag | If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values Applicable Annotation Terms: |
| ValueListShowValuesImmediately (Experimental) | Tag | A value list with a very small number of fixed values, can decide to show all values immediately |
| ValueListForValidation | String | Contains the qualifier of the ValueList or ValueListMapping that should be used for validation An empty string identifies the ValueList or ValueListMapping without a qualifier. |
| ValueListReferences | [URL] | A list of URLs of CSDL documents containing value list mappings for this parameter or property |
| ValueListMapping | ValueListMappingType | Specifies the mapping between data service properties and value list properties The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. |
| IsCalendarYear | Tag | Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3}) |
| IsCalendarHalfyear | Tag | Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] |
| IsCalendarQuarter | Tag | Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] |
| IsCalendarMonth | Tag | Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]|1[0-2] |
| IsCalendarWeek | Tag | Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]|[1-4][0-9]|5[0-3] |
| IsDayOfCalendarMonth | Tag | Day number relative to a calendar month. Valid values are between 1 and 31. |
| IsDayOfCalendarYear | Tag | Day number relative to a calendar year. Valid values are between 1 and 366. |
| IsCalendarYearHalfyear | Tag | Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})[1-2] |
| IsCalendarYearQuarter | Tag | Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})[1-4] |
| IsCalendarYearMonth | Tag | Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|1[0-2]) |
| IsCalendarYearWeek | Tag | Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|[1-4][0-9]|5[0-3]) |
| IsCalendarDate | Tag | Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. |
| IsFiscalYear | Tag | Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} |
| IsFiscalPeriod | Tag | Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} |
| IsFiscalYearPeriod | Tag | Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) |
| IsFiscalQuarter | Tag | Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] |
| IsFiscalYearQuarter | Tag | Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] |
| IsFiscalWeek | Tag | Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]|[1-4][0-9]|5[0-3] |
| IsFiscalYearWeek | Tag | Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]|[1-4][0-9]|5[0-3]) |
| IsDayOfFiscalYear | Tag | Day number relative to a fiscal year. Valid values are between 1 and 371. |
| IsFiscalYearVariant | Tag | Property encodes a fiscal year variant |
| MutuallyExclusiveTerm | Tag | Only one term of the group identified with the Qualifier attribute can be applied |
| DraftRoot | DraftRootType | Root entities of business documents that support the draft pattern |
| DraftNode | DraftNodeType | Entities in this set are parts of business documents that support the draft pattern |
| DraftActivationVia | [SimpleIdentifier] | Draft entities in this set are indirectly activated via draft entities in the referenced entity sets |
| EditableFieldFor | PropertyPath | The annotated property is an editable field for the referenced key property |
| SemanticKey | [PropertyPath] | The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity |
| SideEffects | SideEffectsType | Describes side-effects of modification operations |
| DefaultValuesFunction | QualifiedName | Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service The default values function must have a bound overload whose binding parameter type matches the annotation target - for an entity set: collection of entity type of entity set - for a navigation property: identical to the type of the navigation property (single- or collection-valued) - for a bound action/function: identical to the binding parameter type of the annotated action/function In addition the overload can have non-binding parameters for values that the user has already entered: - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called The result type of the default values function is a complex type whose properties correspond in name and type to a subset of - the properties of the entity to create, or - the parameters of the action or function to call |
| DerivedDefaultValue (Experimental) | String | Function import to derive a default value for the property from a given context. Function import has two parameters of complex types: - parameters, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property- properties, a structure resembling the type of the entity set of the annotated propertyThe return type must be of the same type as the annotated property. Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. |
| FilterDefaultValue | PrimitiveType? | A default value for the property to be used in filter expressions. |
| FilterDefaultValueHigh (Experimental) | PrimitiveType? | A default upper limit for the property to be used in 'less than or equal' filter expressions. |
| DerivedFilterDefaultValue (Experimental) | String | Function import to derive a default value for the property from a given context in order to use it in filter expressions. Function import has two parameters of complex types: - parameters, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property- properties, a structure resembling the type of the entity set of the annotated propertyThe return type must be of the same type as the annotated property. Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. |
| SortOrder | [SortOrderType] | List of sort criteria The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. |
| RecursiveHierarchy (Deprecated) | RecursiveHierarchyType | Use terms Aggregation.RecursiveHierarchy and Hierarchy.RecursiveHierarchy instead |
| CreatedAt | DateTimeOffset? | Creation timestamp |
| CreatedBy | UserID? | First editor |
| ChangedAt | DateTimeOffset? | Last modification timestamp |
| ChangedBy | UserID? | Last editor |
| OriginalProtocolVersion | String | Original protocol version of a converted (V4) CSDL document, allowed values 2.0 and 3.0 |
| ApplyMultiUnitBehaviorForSortingAndFiltering | Tag | Sorting and filtering of amounts in multiple currencies needs special consideration TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ |
| mediaUploadLink (Experimental) | URL | URL for uploading new media content to a Document Management Service In contrast to the @odata.mediaEditLink this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with Content-Type: multipart/form-data following RFC 7578. The upload request must contain one multipart representing the content of the file. The name parameter in the Content-Disposition header (as described in RFC 7578) is irrelevant, but the filename parameter is expected. If the request succeeds the response will contain a JSON body of Content-Type: application/json with a JSON property readLink. The newly uploaded media resource can be linked to the stream property by changing the @odata.mediaReadLink to the value of this readLink in a subsequent PATCH request to the OData entity. |
| PrimitivePropertyPath (Experimental) | Tag | A term or term property with this tag whose type is (a collection of) Edm.PropertyPath MUST resolve to a primitive structural property |
| WebSocketBaseURL (Experimental) | URL | Base URL for WebSocket connections This annotation MUST be unqualified. |
| WebSocketChannel (Experimental) | String? | Channel for WebSocket connections Messages sent over the channel follow the ABAP Push Channel Protocol. To consume a channel, the client opens a web socket connection at the
|
| Member | Value | Description |
|---|---|---|
| plain | 0 | Plain text, line breaks represented as the character 0x0A |
| html | 1 | Plain text with markup that can validly appear directly within an HTML DIV element |
Maps a property of the Semantic Object to a property of the annotated entity type or a sibling property of the annotated property or a constant value
Derived Types:
| Property | Type | Description |
|---|---|---|
| SemanticObjectProperty | String | Name of the Semantic Object property |
| Property | Type | Description |
|---|---|---|
| SemanticObjectProperty | String | Name of the Semantic Object property |
| LocalProperty | PropertyPath | Path to a local property that provides the value for the Semantic Object property |
| Property | Type | Description |
|---|---|---|
| SemanticObjectProperty | String | Name of the Semantic Object property |
| Constant | PrimitiveType | Constant value for the Semantic Object property |
Use term Capabilities.FilterRestrictions instead
Use term Capabilities.FilterRestrictions instead
Control state of a property
When changes are requested, the value of this annotation in the before-image or after-image of the request plays a role. These may differ if the value is given dynamically in the metadata.
| Member | Value | Description |
|---|---|---|
| Mandatory | 7 | Property is mandatory from a business perspective A request that
fails entirely if this annotation is |
| Optional | 3 | Property may have a value This value does not make sense as a static annotation value. |
| ReadOnly | 1 | Property value cannot be changed A request to change the property to a value that differs from the before-image fails entirely according to OData-Protocol, section 11.4.3 if this annotation is given dynamically as ReadOnly in the before-image of the request.To statically mark a property as read-only use term Core.Computed instead. |
| Inapplicable | 0 | Property has no meaning in the current entity state A request that sets the property to a non-initial non-null value fails entirely if this annotation is Inapplicable in the after-image of the request.This value does not make sense as a static annotation value. Example for dynamic use: in a travel expense report the property DestinationCountry is inapplicable if trip type is domestic, and mandatory if trip type is international. |
| Hidden | 0 | Deprecated synonym for Inapplicable, do not use To statically hide a property on a UI use UI.Hidden instead |
| Property | Type | Description |
|---|---|---|
| Component | String? | Software component of service implementation |
| ServiceRepository | String? | ... |
| ServiceId | String? | ... |
| ServiceVersion | String? | ... |
| Property | Type | Description |
|---|---|---|
| Analysis | String? | Short hint on how to analyze this error |
| Note | String? | Note for error resolution |
| AdditionalNote | String? | Additional note for error resolution |
Type: Byte
Classifies an end-user message as info, success, warning, or error
| Allowed Value | Description |
|---|---|
| 1 | Success - no action required |
| 2 | Information - no action required |
| 3 | Warning - action may be required |
| 4 | Error - action is required |
| Property | Type | Description |
|---|---|---|
| Label (Experimental) | String? | A short, human-readable text suitable for labels and captions in UIs |
| LowerBoundary | PropertyPath | Property holding the lower interval boundary |
| LowerBoundaryIncluded | Boolean | The lower boundary value is included in the interval |
| UpperBoundary | PropertyPath | Property holding the upper interval boundary |
| UpperBoundaryIncluded | Boolean | The upper boundary value is included in the interval |
Information about an SAP Object Node Type
| Property | Type | Description |
|---|---|---|
| Name | String | The name of the SAP Object Node Type |
| Property | Type | Description |
|---|---|---|
| Label | String? | Headline for value list, fallback is the label of the property or parameter |
| CollectionPath | String | Resource path of an OData collection with possible values, relative to CollectionRoot |
| CollectionRoot | String? | Service root of the value list collection; not specified means local to the document containing the annotation |
| DistinctValuesSupported | Boolean | Indicates that the value list supports a 'distinct' aggregation on the value list properties defined via ValueListParameterInOut and ValueListParameterOut |
| SearchSupported | Boolean | Value list supports the $search query option The value of the target property is used as the search expression instead of in $filter |
| FetchValues | FetchValuesType? | Hint on when to fetch values |
| PresentationVariantQualifier | SimpleIdentifier? | Alternative representation of a value help, e.g. as a bar chart Qualifier for annotation with term UI.PresentationVariant on the entity set identified via CollectionPath |
| SelectionVariantQualifier | SimpleIdentifier? | Optional combination of parameters and filters to query the value help entity set Qualifier for annotation with term UI.SelectionVariant on the entity set identified via CollectionPath |
| Parameters | [ValueListParameter] | Instructions on how to construct the value list request and consume response properties |
Applicable Annotation Terms:
Type: Byte
Hint on when to fetch values
| Allowed Value | Description |
|---|---|
| 1 | Fetch values immediately without filter |
| 2 | Fetch values with a filter |
| Property | Type | Description |
|---|---|---|
| Label | String? | Headline for value list, fallback is the label of the property or parameter |
| CollectionPath | String | Resource path of an OData collection with possible values, relative to the document containing the value list mapping |
| DistinctValuesSupported | Boolean | Indicates that the value list supports a 'distinct' aggregation on the value list properties defined via ValueListParameterInOut and ValueListParameterOut |
| FetchValues | FetchValuesType? | Hint on when to fetch values |
| PresentationVariantQualifier | SimpleIdentifier? | Alternative representation of a value help, e.g. as a bar chart Qualifier for annotation with term UI.PresentationVariant on the value list entity set identified via CollectionPath in the ValueListReference annotation |
| SelectionVariantQualifier | SimpleIdentifier? | Optional combination of parameters and filters to query the value help entity set Qualifier for annotation with term UI.SelectionVariant on the entity set identified via CollectionPath |
| Parameters | [ValueListParameter] | Instructions on how to construct the value list request and consume response properties |
Applicable Annotation Terms:
Derived Types:
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
| LocalDataProperty | PropertyPath | Path to property that is used to filter the value list with eq comparisonIn case the property path contains a collection-based navigation or structural property, the filter is a set of eq comparisons connected by or operators |
| InitialValueIsSignificant | Boolean | Initial value, e.g. empty string, is a valid and significant value |
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
| Constant | PrimitiveType | Constant value that is used to filter the value list with eq comparison, using the same representation as property default values, see CSDL XML, 7.2.7 Default Value |
| InitialValueIsSignificant (Experimental) | Boolean | Initial value, e.g. empty string, is a valid and significant value |
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
| Constants | [PrimitiveType] | List of constant values that are used to filter the value list with eq comparisons connected by or operators, using the same representation as property default values, see CSDL XML, 7.2.7 Default Value. Initial values are significant.An empty list means a vacuous filter condition |
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
| LocalDataProperty | PropertyPath | Path to property that is used to filter the value list with startswith comparison and filled from the picked value list item |
| InitialValueIsSignificant | Boolean | Initial value, e.g. empty string, is a valid and significant value |
Applicable Annotation Terms:
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
| LocalDataProperty | PropertyPath | Path to property that is filled from response |
Applicable Annotation Terms:
Value list property that is not used to fill the edited entity
| Property | Type | Description |
|---|---|---|
| ValueListProperty | String | Path to property in the value list . Format is identical to PropertyPath annotations. |
Applicable Annotation Terms:
All filterable properties of the value list can be used to filter
| Property | Type | Description |
|---|---|---|
| PreparationAction | QualifiedName? | Action that prepares a draft document for later activation |
| ValidationFunction (Deprecated) | QualifiedName? | Separate validation without side-effects is not useful |
| ActivationAction | QualifiedName | Action that activates a draft document |
| DiscardAction (Experimental) | QualifiedName? | Action that discards a draft document |
| EditAction | QualifiedName? | Action that creates an edit draft |
| NewAction | QualifiedName? | Action that creates a new draft New drafts may also be created by POSTing an empty entity without any properties to the entity set. |
| AdditionalNewActions (Experimental) | [QualifiedName] | Additional actions that create a new draft Additional actions beside the default POST or standard NewAction that create a new draft. |
| ShareAction | QualifiedName? | Action that shares a draft document with other users The action is bound to the draft document root node and has the following signature:
It restricts access to the listed users in their specified roles. If this action is present, the client can receive notifications about changes to the collaborative draft by opening a web socket connection at the
|
Derived Types:
| Property | Type | Description |
|---|---|---|
| PreparationAction | QualifiedName? | Action that prepares a draft document for later activation |
| ValidationFunction (Deprecated) | QualifiedName? | Separate validation without side-effects is not useful |
Use type Core.SimpleIdentifier instead
Type: String
The namespace-qualified name of an OData construct in scope
Alias-qualified names are not fully supported, and the use of namespace-qualified names is strongly recommended.
Type: String
The namespace-qualified name of an action with an optional overload
The namespace-qualified name of an action, optionally followed by parentheses containing the binding parameter type of a bound action overload to identify that bound overload, or by empty parentheses to identify the unbound overload, like in the Target attribute of an Annotation.
Changes to the source properties or source entities may have side-effects on the target properties or entities.
If neither TargetProperties nor TargetEntities are specified, a change to the source property values may have unforeseeable side-effects. An empty NavigationPropertyPath may be used in TargetEntities to specify that any property of the annotated entity type may be affected.
Side effects without a TriggerAction happen immediately when modifying one of the source properties or source entities. Side effects with a TriggerAction are deferred until explicitly triggered via the TriggerAction.
Special case where the side effect is annotated on an action: here the change trigger is the action invocation, so SourceProperties and SourceEntities have no meaning, only TargetProperties and TargetEntities are relevant. They are addressed via the binding parameter of the action, e.g. if the binding parameter is named _it, all paths have to start with _it/. This can also be used with OData V2 services: the annotation target is a function import that is marked with sap:action-for, and all paths have to start with _it/.
| Property | Type | Description |
|---|---|---|
| SourceProperties | [PropertyPath] | Changes to the values of one or more of these structural properties may affect the targets |
| SourceEntities | [NavigationPropertyPath] | Changes to one or more of these entities may affect the targets. An empty path means the annotation target. |
| SourceEvents (Experimental) | [String] | When the service raises one or more of these "events for side effects", the targets may be affected |
| TargetProperties | [String] | These structural properties may be affected if the value of one of the sources changes The syntax follows closely the syntax rules for Edm.PropertyPath, with the addition of * as the last path segment meaning all structural properties directly reached via the preceding path |
| TargetEntities | [NavigationPropertyPath] | These entities will be affected if the value of one of the sources changes. All affected entities need to be explicitly listed. An empty path means the annotation target. |
| EffectTypes (Deprecated) | EffectType? | All side effects are essentially value changes, differentiation not needed. |
| TriggerAction | QualifiedName? | Bound action to trigger side-effects after modifying an entity Binding parameter type of the trigger action is the entity type annotated with SideEffects. The action does not have any additional parameters and does not return anything. It either succeeds with 204 No Content or it fails with 4xx or 5xx. |
| Discretionary (Experimental) | Boolean | Indicates whether the client can decide if a side-effect should be triggered or not The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. |
All side effects are essentially value changes, differentiation not needed.
Exactly one of Property, DynamicProperty and Expression must be present
| Property | Type | Description |
|---|---|---|
| Property | PropertyPath? | Sort property |
| DynamicProperty | AnnotationPath? | Dynamic property introduced by an annotation and used as sort property If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being sorted according to the UI.PresentationVariant or Common.SortOrder annotation, this instance of UI.PresentationVariant/SortOrder or Common.SortOrder MUST be silently ignored.Allowed Terms: |
| Expression (Experimental) | PrimitiveType? | Dynamic expression whose primitive result value is used to sort the instances |
| Descending | Boolean? | Sort direction, ascending if not specified otherwise |
Use terms Aggregation.RecursiveHierarchy and Hierarchy.RecursiveHierarchy instead
Type: String
User ID