diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 501c149c..585a8ecb 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -791,6 +791,23 @@ ], "@Core.Description": "Supports [passing query options in the request body](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_PassingQueryOptionsintheRequestBody)" }, + "PayloadExpressionSupport": { + "$Kind": "Term", + "$Type": "Capabilities.PayloadExpressionSupportType", + "$AppliesTo": [ + "EntityContainer" + ], + "@Core.Description": "Whether expressions for parameters in action payloads [OData-JSON, section 18] and `$query` payloads [OData-URL, section 4.17] are supported", + "@Core.LongDescription": "Expressions can occur in payload properties that represent\n- action parameters if the property name has the suffix `@expression` or\n- function parameters if the property name has the suffix `@expression` in `\\$query` payloads\n- system query options (without suffix) in `\\$query` payloads." + }, + "PayloadExpressionSupportType": { + "$Kind": "ComplexType", + "URLExpressionsSupported": { + "$Type": "Edm.Boolean", + "$DefaultValue": false, + "@Core.Description": "Common expressions defined in [OData-URL](https://oasis-tcs.github.io/odata-specs/odata-url-conventions/odata-url-conventions.html#CommonExpressionSyntax) are supported in payloads" + } + }, "InsertRestrictions": { "$Kind": "Term", "$Type": "Capabilities.InsertRestrictionsType", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 9a96e47c..c0a477dc 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -73,20 +73,21 @@ Term|Type|Description [SearchRestrictions](Org.OData.Capabilities.V1.xml#L562)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions [KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L608)|[Tag](Org.OData.Core.V1.md#Tag)|Supports [key-as-segment convention](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_KeyasSegmentConvention) for addressing entities within a collection [QuerySegmentSupported](Org.OData.Capabilities.V1.xml#L612)|[Tag](Org.OData.Core.V1.md#Tag)|Supports [passing query options in the request body](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_PassingQueryOptionsintheRequestBody) -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L618)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations -[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L697)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L710)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations -[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L796)|[DeepUpdateSupportType](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L809)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations -[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L853)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties -[OperationRestrictions](Org.OData.Capabilities.V1.xml#L894)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation -[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L914)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options -[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L918)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L942)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L984)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L986)) -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L1010)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1013))
If the entity container is annotated, the query option is supported/required by all resources in that container. -[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1062)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property or media stream supports update of its media edit URL and/or media read URL -[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L1067)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container

Annotating a specific capability term, which is included as property in DefaultCapabilitiesType, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:

+[PayloadExpressionSupport](Org.OData.Capabilities.V1.xml#L616)|[PayloadExpressionSupportType](#PayloadExpressionSupportType)|Whether expressions for parameters in action payloads [OData-JSON, section 18] and `$query` payloads [OData-URL, section 4.17] are supported

Expressions can occur in payload properties that represent

+[InsertRestrictions](Org.OData.Capabilities.V1.xml#L638)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L717)|[DeepInsertSupportType?](#DeepInsertSupportType)|Deep Insert Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L730)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L816)|[DeepUpdateSupportType](#DeepUpdateSupportType)|Deep Update Support of the annotated resource (the whole service, an entity set, or a collection-valued resource) +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L829)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations +[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L873)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L914)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation +[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L934)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options +[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L938)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L962)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L1004)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1006)) +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L1030)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1033))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1082)|[Tag](Org.OData.Core.V1.md#Tag)|Stream property or media stream supports update of its media edit URL and/or media read URL +[DefaultCapabilities](Org.OData.Capabilities.V1.xml#L1087)|[DefaultCapabilitiesType](#DefaultCapabilitiesType)|Default capability settings for all collection-valued resources in the container

Annotating a specific capability term, which is included as property in DefaultCapabilitiesType, for a specific collection-valued resource overrides the default capability with the specified properties using PATCH semantics:

## [ConformanceLevelType](Org.OData.Capabilities.V1.xml#L118) @@ -398,8 +399,16 @@ Flag Member|Value|Description [phrase](Org.OData.Capabilities.V1.xml#L600)|8|Search phrases enclosed in double quotes [group](Org.OData.Capabilities.V1.xml#L603)|16|Precedence grouping of search expressions with parentheses + +## [PayloadExpressionSupportType](Org.OData.Capabilities.V1.xml#L625) + + +Property|Type|Description +:-------|:---|:---------- +[URLExpressionsSupported](Org.OData.Capabilities.V1.xml#L626)|Boolean|Common expressions defined in [OData-URL](https://oasis-tcs.github.io/odata-specs/odata-url-conventions/odata-url-conventions.html#CommonExpressionSyntax) are supported in payloads + -## [InsertRestrictionsBase](Org.OData.Capabilities.V1.xml#L622) +## [InsertRestrictionsBase](Org.OData.Capabilities.V1.xml#L642) **Derived Types:** @@ -407,65 +416,65 @@ Flag Member|Value|Description Property|Type|Description :-------|:---|:---------- -[Insertable](Org.OData.Capabilities.V1.xml#L623)|Boolean|Entities can be inserted -[MaxLevels](Org.OData.Capabilities.V1.xml#L626)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to insert into. A value of -1 indicates there is no restriction. -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L629)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[QueryOptions](Org.OData.Capabilities.V1.xml#L632)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L635)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L638)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L641)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L645)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L649)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Insertable](Org.OData.Capabilities.V1.xml#L643)|Boolean|Entities can be inserted +[MaxLevels](Org.OData.Capabilities.V1.xml#L646)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to insert into. A value of -1 indicates there is no restriction. +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L649)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[QueryOptions](Org.OData.Capabilities.V1.xml#L652)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L655)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L658)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L661)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L665)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L669)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L653): [InsertRestrictionsBase](#InsertRestrictionsBase) +## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L673): [InsertRestrictionsBase](#InsertRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Insertable*](Org.OData.Capabilities.V1.xml#L623)|Boolean|Entities can be inserted -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L626)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to insert into. A value of -1 indicates there is no restriction. -[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L629)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[*QueryOptions*](Org.OData.Capabilities.V1.xml#L632)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L635)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L638)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L641)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L645)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L649)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L654)|\[PropertyPath\]|These structural properties cannot be specified on insert -[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L657)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts -[RequiredProperties](Org.OData.Capabilities.V1.xml#L660)|\[PropertyPath\]|These structural properties must be specified on insert -[Permissions](Org.OData.Capabilities.V1.xml#L663)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. +[*Insertable*](Org.OData.Capabilities.V1.xml#L643)|Boolean|Entities can be inserted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L646)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to insert into. A value of -1 indicates there is no restriction. +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L649)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L652)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L655)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L658)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L661)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L665)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L669)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L674)|\[PropertyPath\]|These structural properties cannot be specified on insert +[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L677)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts +[RequiredProperties](Org.OData.Capabilities.V1.xml#L680)|\[PropertyPath\]|These structural properties must be specified on insert +[Permissions](Org.OData.Capabilities.V1.xml#L683)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. -## [PermissionType](Org.OData.Capabilities.V1.xml#L668) +## [PermissionType](Org.OData.Capabilities.V1.xml#L688) Property|Type|Description :-------|:---|:---------- -[SchemeName](Org.OData.Capabilities.V1.xml#L669)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name -[Scopes](Org.OData.Capabilities.V1.xml#L672)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource +[SchemeName](Org.OData.Capabilities.V1.xml#L689)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name +[Scopes](Org.OData.Capabilities.V1.xml#L692)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource -## [ScopeType](Org.OData.Capabilities.V1.xml#L677) +## [ScopeType](Org.OData.Capabilities.V1.xml#L697) Property|Type|Description :-------|:---|:---------- -[Scope](Org.OData.Capabilities.V1.xml#L678)|String|Name of the scope. -[RestrictedProperties](Org.OData.Capabilities.V1.xml#L681)|String?|Comma-separated string value of all properties that will be included or excluded when using the scope.
Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. +[Scope](Org.OData.Capabilities.V1.xml#L698)|String|Name of the scope. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L701)|String?|Comma-separated string value of all properties that will be included or excluded when using the scope.
Possible string value identifiers when specifying properties are `*`, _PropertyName_, `-`_PropertyName_.
`*` denotes all properties are accessible.
`-`_PropertyName_ excludes that specific property.
_PropertyName_ explicitly provides access to the specific property.
The absence of `RestrictedProperties` denotes all properties are accessible using that scope. -## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L701) +## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L721) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L702)|Boolean|Annotation target supports deep inserts -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L705)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L722)|Boolean|Annotation target supports deep inserts +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L725)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [UpdateRestrictionsBase](Org.OData.Capabilities.V1.xml#L714) +## [UpdateRestrictionsBase](Org.OData.Capabilities.V1.xml#L734) **Derived Types:** @@ -473,70 +482,70 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Updatable](Org.OData.Capabilities.V1.xml#L715)|Boolean|Entities can be updated -[Upsertable](Org.OData.Capabilities.V1.xml#L718)|Boolean|Entities can be upserted -[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L721)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload -[UpdateMethod](Org.OData.Capabilities.V1.xml#L724)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L727)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L730)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment -[MaxLevels](Org.OData.Capabilities.V1.xml#L733)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection or entity to update. A value of -1 indicates there is no restriction. -[Permissions](Org.OData.Capabilities.V1.xml#L736)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. -[QueryOptions](Org.OData.Capabilities.V1.xml#L739)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L742)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L745)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L748)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L752)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L756)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Updatable](Org.OData.Capabilities.V1.xml#L735)|Boolean|Entities can be updated +[Upsertable](Org.OData.Capabilities.V1.xml#L738)|Boolean|Entities can be upserted +[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L741)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[UpdateMethod](Org.OData.Capabilities.V1.xml#L744)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L747)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L750)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[MaxLevels](Org.OData.Capabilities.V1.xml#L753)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection or entity to update. A value of -1 indicates there is no restriction. +[Permissions](Org.OData.Capabilities.V1.xml#L756)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[QueryOptions](Org.OData.Capabilities.V1.xml#L759)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L762)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L765)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L768)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L772)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L776)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L760): [UpdateRestrictionsBase](#UpdateRestrictionsBase) +## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L780): [UpdateRestrictionsBase](#UpdateRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Updatable*](Org.OData.Capabilities.V1.xml#L715)|Boolean|Entities can be updated -[*Upsertable*](Org.OData.Capabilities.V1.xml#L718)|Boolean|Entities can be upserted -[*DeltaUpdateSupported*](Org.OData.Capabilities.V1.xml#L721)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload -[*UpdateMethod*](Org.OData.Capabilities.V1.xml#L724)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. -[*FilterSegmentSupported*](Org.OData.Capabilities.V1.xml#L727)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L730)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L733)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection or entity to update. A value of -1 indicates there is no restriction. -[*Permissions*](Org.OData.Capabilities.V1.xml#L736)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. -[*QueryOptions*](Org.OData.Capabilities.V1.xml#L739)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L742)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L745)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L748)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L752)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L756)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L761)|\[PropertyPath\]|These structural properties cannot be specified on update -[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L764)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding -[RequiredProperties](Org.OData.Capabilities.V1.xml#L767)|\[PropertyPath\]|These structural properties must be specified on update +[*Updatable*](Org.OData.Capabilities.V1.xml#L735)|Boolean|Entities can be updated +[*Upsertable*](Org.OData.Capabilities.V1.xml#L738)|Boolean|Entities can be upserted +[*DeltaUpdateSupported*](Org.OData.Capabilities.V1.xml#L741)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[*UpdateMethod*](Org.OData.Capabilities.V1.xml#L744)|[HttpMethod?](#HttpMethod)|Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported. +[*FilterSegmentSupported*](Org.OData.Capabilities.V1.xml#L747)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L750)|Boolean|Members of collections can be updated via a PATCH request with a type-cast segment and a `/$each` segment +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L753)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection or entity to update. A value of -1 indicates there is no restriction. +[*Permissions*](Org.OData.Capabilities.V1.xml#L756)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L759)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L762)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L765)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L768)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L772)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L776)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L781)|\[PropertyPath\]|These structural properties cannot be specified on update +[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L784)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding +[RequiredProperties](Org.OData.Capabilities.V1.xml#L787)|\[PropertyPath\]|These structural properties must be specified on update -## [HttpMethod](Org.OData.Capabilities.V1.xml#L772) +## [HttpMethod](Org.OData.Capabilities.V1.xml#L792) Flag Member|Value|Description :-----|----:|:---------- -[GET](Org.OData.Capabilities.V1.xml#L773)|1|The HTTP GET Method -[PATCH](Org.OData.Capabilities.V1.xml#L776)|2|The HTTP PATCH Method -[PUT](Org.OData.Capabilities.V1.xml#L779)|4|The HTTP PUT Method -[POST](Org.OData.Capabilities.V1.xml#L782)|8|The HTTP POST Method -[DELETE](Org.OData.Capabilities.V1.xml#L785)|16|The HTTP DELETE Method -[OPTIONS](Org.OData.Capabilities.V1.xml#L788)|32|The HTTP OPTIONS Method -[HEAD](Org.OData.Capabilities.V1.xml#L791)|64|The HTTP HEAD Method +[GET](Org.OData.Capabilities.V1.xml#L793)|1|The HTTP GET Method +[PATCH](Org.OData.Capabilities.V1.xml#L796)|2|The HTTP PATCH Method +[PUT](Org.OData.Capabilities.V1.xml#L799)|4|The HTTP PUT Method +[POST](Org.OData.Capabilities.V1.xml#L802)|8|The HTTP POST Method +[DELETE](Org.OData.Capabilities.V1.xml#L805)|16|The HTTP DELETE Method +[OPTIONS](Org.OData.Capabilities.V1.xml#L808)|32|The HTTP OPTIONS Method +[HEAD](Org.OData.Capabilities.V1.xml#L811)|64|The HTTP HEAD Method -## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L800) +## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L820) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L801)|Boolean|Annotation target supports deep updates -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L804)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L821)|Boolean|Annotation target supports deep updates +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L824)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [DeleteRestrictionsBase](Org.OData.Capabilities.V1.xml#L813) +## [DeleteRestrictionsBase](Org.OData.Capabilities.V1.xml#L833) **Derived Types:** @@ -544,80 +553,80 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Deletable](Org.OData.Capabilities.V1.xml#L814)|Boolean|Entities can be deleted -[MaxLevels](Org.OData.Capabilities.V1.xml#L817)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L820)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L823)|Boolean|Members of collections can be deleted via a DELETE request with a type-cast segment and a `/$each` segment -[Permissions](Org.OData.Capabilities.V1.xml#L826)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L829)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L832)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L835)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L839)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L843)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Deletable](Org.OData.Capabilities.V1.xml#L834)|Boolean|Entities can be deleted +[MaxLevels](Org.OData.Capabilities.V1.xml#L837)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L840)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L843)|Boolean|Members of collections can be deleted via a DELETE request with a type-cast segment and a `/$each` segment +[Permissions](Org.OData.Capabilities.V1.xml#L846)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L849)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L852)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L855)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L859)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L863)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L847): [DeleteRestrictionsBase](#DeleteRestrictionsBase) +## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L867): [DeleteRestrictionsBase](#DeleteRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Deletable*](Org.OData.Capabilities.V1.xml#L814)|Boolean|Entities can be deleted -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L817)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. -[*FilterSegmentSupported*](Org.OData.Capabilities.V1.xml#L820)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment -[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L823)|Boolean|Members of collections can be deleted via a DELETE request with a type-cast segment and a `/$each` segment -[*Permissions*](Org.OData.Capabilities.V1.xml#L826)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L829)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L832)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L835)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L839)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L843)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L848)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests +[*Deletable*](Org.OData.Capabilities.V1.xml#L834)|Boolean|Entities can be deleted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L837)|Int32|The maximum number of navigation properties that can be traversed when addressing the collection to delete from or the entity to delete. A value of -1 indicates there is no restriction. +[*FilterSegmentSupported*](Org.OData.Capabilities.V1.xml#L840)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L843)|Boolean|Members of collections can be deleted via a DELETE request with a type-cast segment and a `/$each` segment +[*Permissions*](Org.OData.Capabilities.V1.xml#L846)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L849)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L852)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L855)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L859)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L863)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L868)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests -## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L856) +## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L876) Property|Type|Description :-------|:---|:---------- -[CollectionProperty](Org.OData.Capabilities.V1.xml#L857)|PropertyPath?|Restricted Collection-valued property -[FilterFunctions](Org.OData.Capabilities.V1.xml#L860)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L864)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L867)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L870)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions -[TopSupported](Org.OData.Capabilities.V1.xml#L873)|Boolean|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L876)|Boolean|Supports $skip -[SelectSupport](Org.OData.Capabilities.V1.xml#L879)|[SelectSupportType?](#SelectSupportType)|Support for $select -[Insertable](Org.OData.Capabilities.V1.xml#L882)|Boolean|Members can be inserted into this collection
If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position -[Updatable](Org.OData.Capabilities.V1.xml#L886)|Boolean|Members of this ordered collection can be updated by ordinal -[Deletable](Org.OData.Capabilities.V1.xml#L889)|Boolean|Members of this ordered collection can be deleted by ordinal +[CollectionProperty](Org.OData.Capabilities.V1.xml#L877)|PropertyPath?|Restricted Collection-valued property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L880)|\[String\]|List of functions and operators supported in filter expressions
If not specified, null, or empty, all functions and operators may be attempted. +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L884)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L887)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L890)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L893)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L896)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L899)|[SelectSupportType?](#SelectSupportType)|Support for $select +[Insertable](Org.OData.Capabilities.V1.xml#L902)|Boolean|Members can be inserted into this collection
If additionally annotated with [Core.PositionalInsert](Org.OData.Core.V1.md#PositionalInsert), members can be inserted at a specific position +[Updatable](Org.OData.Capabilities.V1.xml#L906)|Boolean|Members of this ordered collection can be updated by ordinal +[Deletable](Org.OData.Capabilities.V1.xml#L909)|Boolean|Members of this ordered collection can be deleted by ordinal -## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L897) +## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L917) Property|Type|Description :-------|:---|:---------- -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L898)|Boolean|Bound action or function can be invoked on a collection-valued binding parameter path with a `/$filter(...)` segment -[Permissions](Org.OData.Capabilities.V1.xml#L901)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to invoke an action or function -[CustomHeaders](Org.OData.Capabilities.V1.xml#L904)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L907)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[ErrorResponses](Org.OData.Capabilities.V1.xml#L910)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L918)|Boolean|Bound action or function can be invoked on a collection-valued binding parameter path with a `/$filter(...)` segment +[Permissions](Org.OData.Capabilities.V1.xml#L921)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to invoke an action or function +[CustomHeaders](Org.OData.Capabilities.V1.xml#L924)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L927)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[ErrorResponses](Org.OData.Capabilities.V1.xml#L930)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L921) +## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L941) Property|Type|Description :-------|:---|:---------- -[ExpandSupported](Org.OData.Capabilities.V1.xml#L922)|Boolean|Supports $expand with modification requests -[SelectSupported](Org.OData.Capabilities.V1.xml#L925)|Boolean|Supports $select with modification requests -[ComputeSupported](Org.OData.Capabilities.V1.xml#L928)|Boolean|Supports $compute with modification requests -[FilterSupported](Org.OData.Capabilities.V1.xml#L931)|Boolean|Supports $filter with modification requests -[SearchSupported](Org.OData.Capabilities.V1.xml#L934)|Boolean|Supports $search with modification requests -[SortSupported](Org.OData.Capabilities.V1.xml#L937)|Boolean|Supports $orderby with modification requests +[ExpandSupported](Org.OData.Capabilities.V1.xml#L942)|Boolean|Supports $expand with modification requests +[SelectSupported](Org.OData.Capabilities.V1.xml#L945)|Boolean|Supports $select with modification requests +[ComputeSupported](Org.OData.Capabilities.V1.xml#L948)|Boolean|Supports $compute with modification requests +[FilterSupported](Org.OData.Capabilities.V1.xml#L951)|Boolean|Supports $filter with modification requests +[SearchSupported](Org.OData.Capabilities.V1.xml#L954)|Boolean|Supports $search with modification requests +[SortSupported](Org.OData.Capabilities.V1.xml#L957)|Boolean|Supports $orderby with modification requests -## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L946) +## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L966) **Derived Types:** @@ -626,86 +635,86 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Readable](Org.OData.Capabilities.V1.xml#L947)|Boolean|Entities can be retrieved -[Permissions](Org.OData.Capabilities.V1.xml#L950)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L953)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L956)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L959)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L963)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L967)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Readable](Org.OData.Capabilities.V1.xml#L967)|Boolean|Entities can be retrieved +[Permissions](Org.OData.Capabilities.V1.xml#L970)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L973)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L976)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L979)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L983)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L987)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L971): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L991): [ReadRestrictionsBase](#ReadRestrictionsBase) Restrictions for retrieving an entity by key Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L947)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L950)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L953)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L956)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L959)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L963)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L967)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[*Readable*](Org.OData.Capabilities.V1.xml#L967)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L970)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L973)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L976)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L979)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L983)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L987)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L974): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L994): [ReadRestrictionsBase](#ReadRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L947)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L950)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L953)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L956)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L959)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L963)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L967)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L975)|Boolean|Entities of a specific derived type can be read by specifying a type-cast segment -[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L978)|[ReadByKeyRestrictionsType?](#ReadByKeyRestrictionsType)|Restrictions for retrieving an entity by key
Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. +[*Readable*](Org.OData.Capabilities.V1.xml#L967)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L970)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L973)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L976)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L979)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L983)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L987)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L995)|Boolean|Entities of a specific derived type can be read by specifying a type-cast segment +[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L998)|[ReadByKeyRestrictionsType?](#ReadByKeyRestrictionsType)|Restrictions for retrieving an entity by key
Only valid when applied to a collection. If a property of `ReadByKeyRestrictions` is not specified, the corresponding property value of `ReadRestrictions` applies. -## [CustomParameter](Org.OData.Capabilities.V1.xml#L1041) +## [CustomParameter](Org.OData.Capabilities.V1.xml#L1061) A custom parameter is either a header or a query option The type of a custom parameter is always a string. Restrictions on the parameter values can be expressed by annotating the record expression describing the parameter with terms from the Validation vocabulary, e.g. Validation.Pattern or Validation.AllowedValues. Property|Type|Description :-------|:---|:---------- -[Name](Org.OData.Capabilities.V1.xml#L1044)|String|Name of the custom parameter -[Description](Org.OData.Capabilities.V1.xml#L1047)|String?|Description of the custom parameter -[DocumentationURL](Org.OData.Capabilities.V1.xml#L1050)|URL?|URL of related documentation -[Required](Org.OData.Capabilities.V1.xml#L1054)|Boolean|true: parameter is required, false or not specified: parameter is optional -[ExampleValues](Org.OData.Capabilities.V1.xml#L1057)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter +[Name](Org.OData.Capabilities.V1.xml#L1064)|String|Name of the custom parameter +[Description](Org.OData.Capabilities.V1.xml#L1067)|String?|Description of the custom parameter +[DocumentationURL](Org.OData.Capabilities.V1.xml#L1070)|URL?|URL of related documentation +[Required](Org.OData.Capabilities.V1.xml#L1074)|Boolean|true: parameter is required, false or not specified: parameter is optional +[ExampleValues](Org.OData.Capabilities.V1.xml#L1077)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter -## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1076) +## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1096) Property|Type|Description :-------|:---|:---------- -[ChangeTracking](Org.OData.Capabilities.V1.xml#L1077)|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities -[CountRestrictions](Org.OData.Capabilities.V1.xml#L1080)|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option -[IndexableByKey](Org.OData.Capabilities.V1.xml#L1083)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions -[TopSupported](Org.OData.Capabilities.V1.xml#L1086)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L1089)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip -[ComputeSupported](Org.OData.Capabilities.V1.xml#L1092)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute -[SelectSupport](Org.OData.Capabilities.V1.xml#L1095)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1098)|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L1101)|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions -[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1104)|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L1107)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1110)|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1113)|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1116)|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations -[OperationRestrictions](Org.OData.Capabilities.V1.xml#L1119)|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L1122)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance +[ChangeTracking](Org.OData.Capabilities.V1.xml#L1097)|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities +[CountRestrictions](Org.OData.Capabilities.V1.xml#L1100)|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option +[IndexableByKey](Org.OData.Capabilities.V1.xml#L1103)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions +[TopSupported](Org.OData.Capabilities.V1.xml#L1106)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L1109)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip +[ComputeSupported](Org.OData.Capabilities.V1.xml#L1112)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute +[SelectSupport](Org.OData.Capabilities.V1.xml#L1115)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1118)|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L1121)|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1124)|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L1127)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1130)|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1133)|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1136)|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L1139)|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L1142)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance -## [HttpResponse](Org.OData.Capabilities.V1.xml#L1127) +## [HttpResponse](Org.OData.Capabilities.V1.xml#L1147) Property|Type|Description :-------|:---|:---------- -[StatusCode](Org.OData.Capabilities.V1.xml#L1128)|String|HTTP response status code, for example 400, 403, 501 -[Description](Org.OData.Capabilities.V1.xml#L1131)|String|Human-readable description of the response +[StatusCode](Org.OData.Capabilities.V1.xml#L1148)|String|HTTP response status code, for example 400, 403, 501 +[Description](Org.OData.Capabilities.V1.xml#L1151)|String|Human-readable description of the response diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index edb29d17..bfbcb982 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -613,6 +613,26 @@ supported: + + + + Expressions can occur in payload properties that represent +- action parameters if the property name has the suffix `@expression` or +- function parameters if the property name has the suffix `@expression` in `\$query` payloads +- system query options (without suffix) in `\$query` payloads. + + + + + + + + +