From 682334ad3329832e0a2e804b5f41a2ecd23be77e Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Mon, 25 Nov 2024 15:18:21 +0100 Subject: [PATCH 1/3] initial commit --- vocabularies/Org.OData.Capabilities.V1.json | 24 +- vocabularies/Org.OData.Capabilities.V1.md | 651 ++++++++++---------- vocabularies/Org.OData.Capabilities.V1.xml | 8 +- 3 files changed, 354 insertions(+), 329 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 9d13ce7b..090b7475 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -92,9 +92,29 @@ "$Type": "Core.Tag", "$DefaultValue": true, "$AppliesTo": [ - "EntityContainer" + "EntityContainer", + "EntitySet", + "Action", + "ActionImport", + "Function", + "FunctionImport" + ], + "@Core.Description": "Requests in scope require the asynchronous request preference" + }, + "AsynchronousRequestsRequired": { + "$Kind": "Term", + "$Type": "Core.Tag", + "$DefaultValue": true, + "$AppliesTo": [ + "EntityContainer", + "EntitySet", + "Action", + "ActionImport", + "Function", + "FunctionImport" ], - "@Core.Description": "Service supports the asynchronous request preference" + "$BaseTerm": "Capabilities.AsynchronousRequestsSupported", + "@Core.Description": "Requests in scope require the asynchronous request preference" }, "BatchContinueOnErrorSupported": { "$Kind": "Term", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 241abbfe..3a6aaafc 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -51,42 +51,43 @@ Term|Type|Description [SupportedFormats](Org.OData.Capabilities.V1.xml#L132)|\[MediaType\]|Media types of supported formats, including format parameters [SupportedMetadataFormats](Org.OData.Capabilities.V1.xml#L137)|\[MediaType\]|Media types of supported formats for $metadata, including format parameters [AcceptableEncodings](Org.OData.Capabilities.V1.xml#L142)|\[String\]|List of acceptable compression methods for ($batch) requests, e.g. gzip -[AsynchronousRequestsSupported](Org.OData.Capabilities.V1.xml#L148)|[Tag](Org.OData.Core.V1.md#Tag)|Service supports the asynchronous request preference -[BatchContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L152)|[Tag](Org.OData.Core.V1.md#Tag)|Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term. -[IsolationSupported](Org.OData.Capabilities.V1.xml#L156)|[IsolationLevel](#IsolationLevel)|Supported odata.isolation levels -[CrossJoinSupported](Org.OData.Capabilities.V1.xml#L165)|[Tag](Org.OData.Core.V1.md#Tag)|Supports cross joins for the entity sets in this container -[CallbackSupported](Org.OData.Capabilities.V1.xml#L169)|[CallbackType](#CallbackType)|Supports callbacks for the specified protocols -[ChangeTracking](Org.OData.Capabilities.V1.xml#L191)|[ChangeTrackingType](#ChangeTrackingType)|Change tracking capabilities of this service or entity set -[CountRestrictions](Org.OData.Capabilities.V1.xml#L212)|[CountRestrictionsType](#CountRestrictionsType)|Restrictions on /$count path suffix and $count=true system query option -[NavigationRestrictions](Org.OData.Capabilities.V1.xml#L230)|[NavigationRestrictionsType](#NavigationRestrictionsType)|Restrictions on navigating properties according to OData URL conventions
Restrictions specified on an entity set are valid whether the request is directly to the entity set or through a navigation property bound to that entity set. Services can specify a different set of restrictions specific to a path, in which case the more specific restrictions take precedence. -[IndexableByKey](Org.OData.Capabilities.V1.xml#L321)|[Tag](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions -[TopSupported](Org.OData.Capabilities.V1.xml#L326)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L331)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $skip -[ComputeSupported](Org.OData.Capabilities.V1.xml#L336)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $compute -[SelectSupport](Org.OData.Capabilities.V1.xml#L341)|[SelectSupportType](#SelectSupportType)|Support for $select and nested query options within $select -[BatchSupported](Org.OData.Capabilities.V1.xml#L378)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. -[BatchSupport](Org.OData.Capabilities.V1.xml#L382)|[BatchSupportType](#BatchSupportType)|Batch Support for the service -[FilterFunctions](Org.OData.Capabilities.V1.xml#L428)|\[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#L434)|[FilterRestrictionsType](#FilterRestrictionsType)|Restrictions on filter expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L511)|[SortRestrictionsType](#SortRestrictionsType)|Restrictions on orderby expressions -[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L537)|[ExpandRestrictionsType](#ExpandRestrictionsType)|Restrictions on expand expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L567)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions -[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L605)|[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#L609)|[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#L615)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations -[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L694)|[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#L707)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations -[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L793)|[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#L806)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations -[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L850)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties -[OperationRestrictions](Org.OData.Capabilities.V1.xml#L891)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation -[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L911)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options -[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L915)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L939)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L981)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L983)) -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L1007)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1010))
If the entity container is annotated, the query option is supported/required by all resources in that container. -[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1059)|[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#L1064)|[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:

+[AsynchronousRequestsSupported](Org.OData.Capabilities.V1.xml#L148)|[Tag](Org.OData.Core.V1.md#Tag)|Requests in scope require the asynchronous request preference +[AsynchronousRequestsRequired](Org.OData.Capabilities.V1.xml#L152)|[Tag](Org.OData.Core.V1.md#Tag)|Requests in scope require the asynchronous request preference +[BatchContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L156)|[Tag](Org.OData.Core.V1.md#Tag)|Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term. +[IsolationSupported](Org.OData.Capabilities.V1.xml#L160)|[IsolationLevel](#IsolationLevel)|Supported odata.isolation levels +[CrossJoinSupported](Org.OData.Capabilities.V1.xml#L169)|[Tag](Org.OData.Core.V1.md#Tag)|Supports cross joins for the entity sets in this container +[CallbackSupported](Org.OData.Capabilities.V1.xml#L173)|[CallbackType](#CallbackType)|Supports callbacks for the specified protocols +[ChangeTracking](Org.OData.Capabilities.V1.xml#L195)|[ChangeTrackingType](#ChangeTrackingType)|Change tracking capabilities of this service or entity set +[CountRestrictions](Org.OData.Capabilities.V1.xml#L216)|[CountRestrictionsType](#CountRestrictionsType)|Restrictions on /$count path suffix and $count=true system query option +[NavigationRestrictions](Org.OData.Capabilities.V1.xml#L234)|[NavigationRestrictionsType](#NavigationRestrictionsType)|Restrictions on navigating properties according to OData URL conventions
Restrictions specified on an entity set are valid whether the request is directly to the entity set or through a navigation property bound to that entity set. Services can specify a different set of restrictions specific to a path, in which case the more specific restrictions take precedence. +[IndexableByKey](Org.OData.Capabilities.V1.xml#L325)|[Tag](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions +[TopSupported](Org.OData.Capabilities.V1.xml#L330)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L335)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $skip +[ComputeSupported](Org.OData.Capabilities.V1.xml#L340)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $compute +[SelectSupport](Org.OData.Capabilities.V1.xml#L345)|[SelectSupportType](#SelectSupportType)|Support for $select and nested query options within $select +[BatchSupported](Org.OData.Capabilities.V1.xml#L382)|[Tag](Org.OData.Core.V1.md#Tag)|Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term. +[BatchSupport](Org.OData.Capabilities.V1.xml#L386)|[BatchSupportType](#BatchSupportType)|Batch Support for the service +[FilterFunctions](Org.OData.Capabilities.V1.xml#L432)|\[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#L438)|[FilterRestrictionsType](#FilterRestrictionsType)|Restrictions on filter expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L515)|[SortRestrictionsType](#SortRestrictionsType)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L541)|[ExpandRestrictionsType](#ExpandRestrictionsType)|Restrictions on expand expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L571)|[SearchRestrictionsType](#SearchRestrictionsType)|Restrictions on search expressions +[KeyAsSegmentSupported](Org.OData.Capabilities.V1.xml#L609)|[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#L613)|[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#L619)|[InsertRestrictionsType](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L698)|[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#L711)|[UpdateRestrictionsType](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L797)|[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#L810)|[DeleteRestrictionsType](#DeleteRestrictionsType)|Restrictions on delete operations +[CollectionPropertyRestrictions](Org.OData.Capabilities.V1.xml#L854)|\[[CollectionPropertyRestrictionsType](#CollectionPropertyRestrictionsType)\]|Describes restrictions on operations applied to collection-valued structural properties +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L895)|[OperationRestrictionsType](#OperationRestrictionsType)|Restrictions for function or action operation +[AnnotationValuesInQuerySupported](Org.OData.Capabilities.V1.xml#L915)|[Tag](Org.OData.Core.V1.md#Tag)|Supports annotation values within system query options +[ModificationQueryOptions](Org.OData.Capabilities.V1.xml#L919)|[ModificationQueryOptionsType](#ModificationQueryOptionsType)|Support for query options with modification requests (insert, update, action invocation) +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L943)|[ReadRestrictionsType](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L985)|\[[CustomParameter](#CustomParameter)\]|Custom headers that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L987)) +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L1011)|\[[CustomParameter](#CustomParameter)\]|Custom query options that are supported/required for the annotated resource ([Example](Org.OData.Capabilities.V1.xml#L1014))
If the entity container is annotated, the query option is supported/required by all resources in that container. +[MediaLocationUpdateSupported](Org.OData.Capabilities.V1.xml#L1063)|[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#L1068)|[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) @@ -99,33 +100,33 @@ Member|Value|Description [Advanced](Org.OData.Capabilities.V1.xml#L125)|2|Advanced conformance level -## [IsolationLevel](Org.OData.Capabilities.V1.xml#L159) +## [IsolationLevel](Org.OData.Capabilities.V1.xml#L163) Flag Member|Value|Description :-----|----:|:---------- -[Snapshot](Org.OData.Capabilities.V1.xml#L160)|1|All data returned for a request, including multiple requests within a batch or results retrieved across multiple pages, will be consistent as of a single point in time +[Snapshot](Org.OData.Capabilities.V1.xml#L164)|1|All data returned for a request, including multiple requests within a batch or results retrieved across multiple pages, will be consistent as of a single point in time -## [CallbackType](Org.OData.Capabilities.V1.xml#L172) +## [CallbackType](Org.OData.Capabilities.V1.xml#L176) A non-empty collection lists the full set of supported protocols. A empty collection means 'only HTTP is supported' Property|Type|Description :-------|:---|:---------- -[CallbackProtocols](Org.OData.Capabilities.V1.xml#L173)|\[[CallbackProtocol](#CallbackProtocol)\]|List of supported callback protocols, e.g. `http` or `wss` +[CallbackProtocols](Org.OData.Capabilities.V1.xml#L177)|\[[CallbackProtocol](#CallbackProtocol)\]|List of supported callback protocols, e.g. `http` or `wss` -## [CallbackProtocol](Org.OData.Capabilities.V1.xml#L178) +## [CallbackProtocol](Org.OData.Capabilities.V1.xml#L182) Property|Type|Description :-------|:---|:---------- -[Id](Org.OData.Capabilities.V1.xml#L179)|String?|Protocol Identifier -[UrlTemplate](Org.OData.Capabilities.V1.xml#L182)|String?|URL Template including parameters. Parameters are enclosed in curly braces {} as defined in RFC6570 -[DocumentationUrl](Org.OData.Capabilities.V1.xml#L185)|URL?|Human readable description of the meaning of the URL Template parameters +[Id](Org.OData.Capabilities.V1.xml#L183)|String?|Protocol Identifier +[UrlTemplate](Org.OData.Capabilities.V1.xml#L186)|String?|URL Template including parameters. Parameters are enclosed in curly braces {} as defined in RFC6570 +[DocumentationUrl](Org.OData.Capabilities.V1.xml#L189)|URL?|Human readable description of the meaning of the URL Template parameters -## [ChangeTrackingBase](Org.OData.Capabilities.V1.xml#L194) +## [ChangeTrackingBase](Org.OData.Capabilities.V1.xml#L198) **Derived Types:** @@ -133,20 +134,20 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L195)|Boolean|odata.track-changes preference is supported +[Supported](Org.OData.Capabilities.V1.xml#L199)|Boolean|odata.track-changes preference is supported -## [ChangeTrackingType](Org.OData.Capabilities.V1.xml#L199): [ChangeTrackingBase](#ChangeTrackingBase) +## [ChangeTrackingType](Org.OData.Capabilities.V1.xml#L203): [ChangeTrackingBase](#ChangeTrackingBase) Property|Type|Description :-------|:---|:---------- -[*Supported*](Org.OData.Capabilities.V1.xml#L195)|Boolean|odata.track-changes preference is supported -[FilterableProperties](Org.OData.Capabilities.V1.xml#L200)|\[PropertyPath\]|Change tracking supports filters on these properties
If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. -[ExpandableProperties](Org.OData.Capabilities.V1.xml#L204)|\[NavigationPropertyPath\]|Change tracking supports these properties expanded
If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. +[*Supported*](Org.OData.Capabilities.V1.xml#L199)|Boolean|odata.track-changes preference is supported +[FilterableProperties](Org.OData.Capabilities.V1.xml#L204)|\[PropertyPath\]|Change tracking supports filters on these properties
If no properties are specified or FilterableProperties is omitted, clients cannot assume support for filtering on any properties in combination with change tracking. +[ExpandableProperties](Org.OData.Capabilities.V1.xml#L208)|\[NavigationPropertyPath\]|Change tracking supports these properties expanded
If no properties are specified or ExpandableProperties is omitted, clients cannot assume support for expanding any properties in combination with change tracking. -## [CountRestrictionsBase](Org.OData.Capabilities.V1.xml#L216) +## [CountRestrictionsBase](Org.OData.Capabilities.V1.xml#L220) **Derived Types:** @@ -154,29 +155,29 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Countable](Org.OData.Capabilities.V1.xml#L217)|Boolean|Instances can be counted in requests targeting a collection +[Countable](Org.OData.Capabilities.V1.xml#L221)|Boolean|Instances can be counted in requests targeting a collection -## [CountRestrictionsType](Org.OData.Capabilities.V1.xml#L221): [CountRestrictionsBase](#CountRestrictionsBase) +## [CountRestrictionsType](Org.OData.Capabilities.V1.xml#L225): [CountRestrictionsBase](#CountRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Countable*](Org.OData.Capabilities.V1.xml#L217)|Boolean|Instances can be counted in requests targeting a collection -[NonCountableProperties](Org.OData.Capabilities.V1.xml#L222)|\[PropertyPath\]|Members of these collection properties cannot be counted -[NonCountableNavigationProperties](Org.OData.Capabilities.V1.xml#L225)|\[NavigationPropertyPath\]|Members of these navigation properties cannot be counted +[*Countable*](Org.OData.Capabilities.V1.xml#L221)|Boolean|Instances can be counted in requests targeting a collection +[NonCountableProperties](Org.OData.Capabilities.V1.xml#L226)|\[PropertyPath\]|Members of these collection properties cannot be counted +[NonCountableNavigationProperties](Org.OData.Capabilities.V1.xml#L229)|\[NavigationPropertyPath\]|Members of these navigation properties cannot be counted -## [NavigationRestrictionsType](Org.OData.Capabilities.V1.xml#L235) +## [NavigationRestrictionsType](Org.OData.Capabilities.V1.xml#L239) Property|Type|Description :-------|:---|:---------- -[Navigability](Org.OData.Capabilities.V1.xml#L236)|[NavigationType?](#NavigationType)|Default navigability for all navigation properties of the annotation target. Individual navigation properties can override this value via `RestrictedProperties/Navigability`. -[RestrictedProperties](Org.OData.Capabilities.V1.xml#L239)|\[[NavigationPropertyRestriction](#NavigationPropertyRestriction)\]|List of navigation properties with restrictions +[Navigability](Org.OData.Capabilities.V1.xml#L240)|[NavigationType?](#NavigationType)|Default navigability for all navigation properties of the annotation target. Individual navigation properties can override this value via `RestrictedProperties/Navigability`. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L243)|\[[NavigationPropertyRestriction](#NavigationPropertyRestriction)\]|List of navigation properties with restrictions -## [NavigationPropertyRestriction](Org.OData.Capabilities.V1.xml#L243) +## [NavigationPropertyRestriction](Org.OData.Capabilities.V1.xml#L247) Using a property of `NavigationPropertyRestriction` in a [`NavigationRestrictions`](#NavigationRestrictions) annotation @@ -186,64 +187,64 @@ Using a property of `NavigationPropertyRestriction` in a [`NavigationRestriction Property|Type|Description :-------|:---|:---------- -[NavigationProperty](Org.OData.Capabilities.V1.xml#L250)|NavigationPropertyPath|Navigation properties can be navigated
The target path of a [`NavigationRestrictions`](#NavigationRestrictions) annotation followed by this navigation property path addresses the resource to which the other properties of `NavigationPropertyRestriction` apply. Instance paths that occur in dynamic expressions are evaluated starting at the boundary between both paths, which must therefore be chosen accordingly. -[Navigability](Org.OData.Capabilities.V1.xml#L259)|[NavigationType?](#NavigationType)|Supported navigability of this navigation property -[FilterFunctions](Org.OData.Capabilities.V1.xml#L262)|\[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#L266)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L269)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L272)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions -[TopSupported](Org.OData.Capabilities.V1.xml#L275)|Boolean|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L278)|Boolean|Supports $skip -[SelectSupport](Org.OData.Capabilities.V1.xml#L281)|[SelectSupportType?](#SelectSupportType)|Support for $select -[IndexableByKey](Org.OData.Capabilities.V1.xml#L284)|Boolean|Supports key values according to OData URL conventions -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L287)|[InsertRestrictionsType?](#InsertRestrictionsType)|Restrictions on insert operations -[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L290)|[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#L293)|[UpdateRestrictionsType?](#UpdateRestrictionsType)|Restrictions on update operations -[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L296)|[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#L299)|[DeleteRestrictionsType?](#DeleteRestrictionsType)|Restrictions on delete operations -[OptimisticConcurrencyControl](Org.OData.Capabilities.V1.xml#L302)|Boolean|Data modification (including insert) along this navigation property requires the use of ETags -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L305)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving entities +[NavigationProperty](Org.OData.Capabilities.V1.xml#L254)|NavigationPropertyPath|Navigation properties can be navigated
The target path of a [`NavigationRestrictions`](#NavigationRestrictions) annotation followed by this navigation property path addresses the resource to which the other properties of `NavigationPropertyRestriction` apply. Instance paths that occur in dynamic expressions are evaluated starting at the boundary between both paths, which must therefore be chosen accordingly. +[Navigability](Org.OData.Capabilities.V1.xml#L263)|[NavigationType?](#NavigationType)|Supported navigability of this navigation property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L266)|\[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#L270)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L273)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L276)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L279)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L282)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L285)|[SelectSupportType?](#SelectSupportType)|Support for $select +[IndexableByKey](Org.OData.Capabilities.V1.xml#L288)|Boolean|Supports key values according to OData URL conventions +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L291)|[InsertRestrictionsType?](#InsertRestrictionsType)|Restrictions on insert operations +[DeepInsertSupport](Org.OData.Capabilities.V1.xml#L294)|[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#L297)|[UpdateRestrictionsType?](#UpdateRestrictionsType)|Restrictions on update operations +[DeepUpdateSupport](Org.OData.Capabilities.V1.xml#L300)|[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#L303)|[DeleteRestrictionsType?](#DeleteRestrictionsType)|Restrictions on delete operations +[OptimisticConcurrencyControl](Org.OData.Capabilities.V1.xml#L306)|Boolean|Data modification (including insert) along this navigation property requires the use of ETags +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L309)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving entities -## [NavigationType](Org.OData.Capabilities.V1.xml#L309) +## [NavigationType](Org.OData.Capabilities.V1.xml#L313) Member|Value|Description :-----|----:|:---------- -[Recursive](Org.OData.Capabilities.V1.xml#L310)|0|Navigation properties can be recursively navigated -[Single](Org.OData.Capabilities.V1.xml#L313)|1|Navigation properties can be navigated to a single level -[None](Org.OData.Capabilities.V1.xml#L316)|2|Navigation properties are not navigable +[Recursive](Org.OData.Capabilities.V1.xml#L314)|0|Navigation properties can be recursively navigated +[Single](Org.OData.Capabilities.V1.xml#L317)|1|Navigation properties can be navigated to a single level +[None](Org.OData.Capabilities.V1.xml#L320)|2|Navigation properties are not navigable -## [SelectSupportType](Org.OData.Capabilities.V1.xml#L345) +## [SelectSupportType](Org.OData.Capabilities.V1.xml#L349) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L346)|Boolean|Supports $select -[InstanceAnnotationsSupported](Org.OData.Capabilities.V1.xml#L349)|Boolean|Supports instance annotations in $select list -[Expandable](Org.OData.Capabilities.V1.xml#L352)|Boolean|$expand within $select is supported -[Filterable](Org.OData.Capabilities.V1.xml#L355)|Boolean|$filter within $select is supported -[Searchable](Org.OData.Capabilities.V1.xml#L358)|Boolean|$search within $select is supported -[TopSupported](Org.OData.Capabilities.V1.xml#L361)|Boolean|$top within $select is supported -[SkipSupported](Org.OData.Capabilities.V1.xml#L364)|Boolean|$skip within $select is supported -[ComputeSupported](Org.OData.Capabilities.V1.xml#L367)|Boolean|$compute within $select is supported -[Countable](Org.OData.Capabilities.V1.xml#L370)|Boolean|$count within $select is supported -[Sortable](Org.OData.Capabilities.V1.xml#L373)|Boolean|$orderby within $select is supported +[Supported](Org.OData.Capabilities.V1.xml#L350)|Boolean|Supports $select +[InstanceAnnotationsSupported](Org.OData.Capabilities.V1.xml#L353)|Boolean|Supports instance annotations in $select list +[Expandable](Org.OData.Capabilities.V1.xml#L356)|Boolean|$expand within $select is supported +[Filterable](Org.OData.Capabilities.V1.xml#L359)|Boolean|$filter within $select is supported +[Searchable](Org.OData.Capabilities.V1.xml#L362)|Boolean|$search within $select is supported +[TopSupported](Org.OData.Capabilities.V1.xml#L365)|Boolean|$top within $select is supported +[SkipSupported](Org.OData.Capabilities.V1.xml#L368)|Boolean|$skip within $select is supported +[ComputeSupported](Org.OData.Capabilities.V1.xml#L371)|Boolean|$compute within $select is supported +[Countable](Org.OData.Capabilities.V1.xml#L374)|Boolean|$count within $select is supported +[Sortable](Org.OData.Capabilities.V1.xml#L377)|Boolean|$orderby within $select is supported -## [BatchSupportType](Org.OData.Capabilities.V1.xml#L385) +## [BatchSupportType](Org.OData.Capabilities.V1.xml#L389) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L392)|Boolean|Service supports requests to $batch -[ContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L395)|Boolean|Service supports the continue on error preference -[ReferencesInRequestBodiesSupported](Org.OData.Capabilities.V1.xml#L398)|Boolean|Service supports Content-ID referencing in request bodies -[ReferencesAcrossChangeSetsSupported](Org.OData.Capabilities.V1.xml#L401)|Boolean|Service supports Content-ID referencing across change sets -[EtagReferencesSupported](Org.OData.Capabilities.V1.xml#L404)|Boolean|Service supports referencing Etags from previous requests -[RequestDependencyConditionsSupported](Org.OData.Capabilities.V1.xml#L407)|Boolean|Service supports the `if` member in JSON batch requests -[SupportedFormats](Org.OData.Capabilities.V1.xml#L410)|\[MediaType\]|Media types of supported formats for $batch
Allowed Values:
[multipart/mixed](Org.OData.Capabilities.V1.xml#L415)
[Multipart Batch Format](http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_MultipartBatchFormat)
[application/json](Org.OData.Capabilities.V1.xml#L419)
[JSON Batch Format](http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_BatchRequestsandResponses)
+[Supported](Org.OData.Capabilities.V1.xml#L396)|Boolean|Service supports requests to $batch +[ContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L399)|Boolean|Service supports the continue on error preference +[ReferencesInRequestBodiesSupported](Org.OData.Capabilities.V1.xml#L402)|Boolean|Service supports Content-ID referencing in request bodies +[ReferencesAcrossChangeSetsSupported](Org.OData.Capabilities.V1.xml#L405)|Boolean|Service supports Content-ID referencing across change sets +[EtagReferencesSupported](Org.OData.Capabilities.V1.xml#L408)|Boolean|Service supports referencing Etags from previous requests +[RequestDependencyConditionsSupported](Org.OData.Capabilities.V1.xml#L411)|Boolean|Service supports the `if` member in JSON batch requests +[SupportedFormats](Org.OData.Capabilities.V1.xml#L414)|\[MediaType\]|Media types of supported formats for $batch
Allowed Values:
[multipart/mixed](Org.OData.Capabilities.V1.xml#L419)
[Multipart Batch Format](http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_MultipartBatchFormat)
[application/json](Org.OData.Capabilities.V1.xml#L423)
[JSON Batch Format](http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_BatchRequestsandResponses)
**Applicable Annotation Terms:** @@ -251,7 +252,7 @@ Property|Type|Description - [LongDescription](Org.OData.Core.V1.md#LongDescription) -## [FilterRestrictionsBase](Org.OData.Capabilities.V1.xml#L438) +## [FilterRestrictionsBase](Org.OData.Capabilities.V1.xml#L442) **Derived Types:** @@ -259,57 +260,57 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Filterable](Org.OData.Capabilities.V1.xml#L444)|Boolean|$filter is supported -[RequiresFilter](Org.OData.Capabilities.V1.xml#L447)|Boolean|$filter is required -[MaxLevels](Org.OData.Capabilities.V1.xml#L450)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. +[Filterable](Org.OData.Capabilities.V1.xml#L448)|Boolean|$filter is supported +[RequiresFilter](Org.OData.Capabilities.V1.xml#L451)|Boolean|$filter is required +[MaxLevels](Org.OData.Capabilities.V1.xml#L454)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L454): [FilterRestrictionsBase](#FilterRestrictionsBase) +## [FilterRestrictionsType](Org.OData.Capabilities.V1.xml#L458): [FilterRestrictionsBase](#FilterRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Filterable*](Org.OData.Capabilities.V1.xml#L444)|Boolean|$filter is supported -[*RequiresFilter*](Org.OData.Capabilities.V1.xml#L447)|Boolean|$filter is required -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L450)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. -[RequiredProperties](Org.OData.Capabilities.V1.xml#L455)|\[PropertyPath\]|These properties must be specified in the $filter clause (properties of derived types are not allowed here) -[NonFilterableProperties](Org.OData.Capabilities.V1.xml#L458)|\[PropertyPath\]|These structural properties cannot be used in filter expressions -[FilterExpressionRestrictions](Org.OData.Capabilities.V1.xml#L461)|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|These properties only allow a subset of filter expressions. A valid filter expression for a single property can be enclosed in parentheses and combined by `and` with valid expressions for other properties. +[*Filterable*](Org.OData.Capabilities.V1.xml#L448)|Boolean|$filter is supported +[*RequiresFilter*](Org.OData.Capabilities.V1.xml#L451)|Boolean|$filter is required +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L454)|Int32|The maximum number of levels (including recursion) that can be traversed in a filter expression. A value of -1 indicates there is no restriction. +[RequiredProperties](Org.OData.Capabilities.V1.xml#L459)|\[PropertyPath\]|These properties must be specified in the $filter clause (properties of derived types are not allowed here) +[NonFilterableProperties](Org.OData.Capabilities.V1.xml#L462)|\[PropertyPath\]|These structural properties cannot be used in filter expressions +[FilterExpressionRestrictions](Org.OData.Capabilities.V1.xml#L465)|\[[FilterExpressionRestrictionType](#FilterExpressionRestrictionType)\]|These properties only allow a subset of filter expressions. A valid filter expression for a single property can be enclosed in parentheses and combined by `and` with valid expressions for other properties. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [FilterExpressionRestrictionType](Org.OData.Capabilities.V1.xml#L465) +## [FilterExpressionRestrictionType](Org.OData.Capabilities.V1.xml#L469) Property|Type|Description :-------|:---|:---------- -[Property](Org.OData.Capabilities.V1.xml#L466)|PropertyPath?|Path to the restricted property -[AllowedExpressions](Org.OData.Capabilities.V1.xml#L469)|[FilterExpressionType?](#FilterExpressionType)|Allowed subset of expressions +[Property](Org.OData.Capabilities.V1.xml#L470)|PropertyPath?|Path to the restricted property +[AllowedExpressions](Org.OData.Capabilities.V1.xml#L473)|[FilterExpressionType?](#FilterExpressionType)|Allowed subset of expressions -## [FilterExpressionType](Org.OData.Capabilities.V1.xml#L473) +## [FilterExpressionType](Org.OData.Capabilities.V1.xml#L477) **Type:** String Allowed Value|Description :------------|:---------- -[SingleValue](Org.OData.Capabilities.V1.xml#L476)|Property can be used in a single `eq` clause -[MultiValue](Org.OData.Capabilities.V1.xml#L480)|Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause) -[SingleRange](Org.OData.Capabilities.V1.xml#L484)|Property can be compared to a single closed, half-open, or open interval
The filter expression for this property consists of a single interval expression, which is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or a pair of boundaries combined by `and`. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. -[MultiRange](Org.OData.Capabilities.V1.xml#L489)|Property can be compared to a union of one or more closed, half-open, or open intervals
The filter expression for this property consists of one or more interval expressions, combined by `or`. See SingleRange for the definition of an interval expression.
Alternatively the filter expression can consist of one or more `ne` expressions combined by `and`, which is roughly equivalent to the union of the complementing open intervals. Roughly equivalent because `null` is allowed as a right-side operand of an `ne` expression. -[SearchExpression](Org.OData.Capabilities.V1.xml#L498)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses -[MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L502)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See SingleRange for the definition of an interval expression. See SearchExpression for the allowed string comparison functions. +[SingleValue](Org.OData.Capabilities.V1.xml#L480)|Property can be used in a single `eq` clause +[MultiValue](Org.OData.Capabilities.V1.xml#L484)|Property can be used in multiple `eq` and `in` clauses, combined by `or` (which is logically equivalent to a single `in` clause) +[SingleRange](Org.OData.Capabilities.V1.xml#L488)|Property can be compared to a single closed, half-open, or open interval
The filter expression for this property consists of a single interval expression, which is either a single comparison of the property and a literal value with `eq`, `le`, `lt`, `ge`, or `gt`, or a pair of boundaries combined by `and`. The lower boundary is either `ge` or `gt`, the upper boundary either `le` or `lt`. +[MultiRange](Org.OData.Capabilities.V1.xml#L493)|Property can be compared to a union of one or more closed, half-open, or open intervals
The filter expression for this property consists of one or more interval expressions, combined by `or`. See SingleRange for the definition of an interval expression.
Alternatively the filter expression can consist of one or more `ne` expressions combined by `and`, which is roughly equivalent to the union of the complementing open intervals. Roughly equivalent because `null` is allowed as a right-side operand of an `ne` expression. +[SearchExpression](Org.OData.Capabilities.V1.xml#L502)|String property can be used as first operand in `startswith`, `endswith`, and `contains` clauses +[MultiRangeOrSearchExpression](Org.OData.Capabilities.V1.xml#L506)|Property can be compared to a union of zero or more closed, half-open, or open intervals plus zero or more simple string patterns
The filter expression for this property consists of one or more interval expressions or string comparison functions combined by `or`. See SingleRange for the definition of an interval expression. See SearchExpression for the allowed string comparison functions. -## [SortRestrictionsBase](Org.OData.Capabilities.V1.xml#L515) +## [SortRestrictionsBase](Org.OData.Capabilities.V1.xml#L519) **Derived Types:** @@ -317,29 +318,29 @@ Allowed Value|Description Property|Type|Description :-------|:---|:---------- -[Sortable](Org.OData.Capabilities.V1.xml#L521)|Boolean|$orderby is supported +[Sortable](Org.OData.Capabilities.V1.xml#L525)|Boolean|$orderby is supported **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L525): [SortRestrictionsBase](#SortRestrictionsBase) +## [SortRestrictionsType](Org.OData.Capabilities.V1.xml#L529): [SortRestrictionsBase](#SortRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Sortable*](Org.OData.Capabilities.V1.xml#L521)|Boolean|$orderby is supported -[AscendingOnlyProperties](Org.OData.Capabilities.V1.xml#L526)|\[PropertyPath\]|These properties can only be used for sorting in Ascending order -[DescendingOnlyProperties](Org.OData.Capabilities.V1.xml#L529)|\[PropertyPath\]|These properties can only be used for sorting in Descending order -[NonSortableProperties](Org.OData.Capabilities.V1.xml#L532)|\[PropertyPath\]|These structural properties cannot be used in orderby expressions +[*Sortable*](Org.OData.Capabilities.V1.xml#L525)|Boolean|$orderby is supported +[AscendingOnlyProperties](Org.OData.Capabilities.V1.xml#L530)|\[PropertyPath\]|These properties can only be used for sorting in Ascending order +[DescendingOnlyProperties](Org.OData.Capabilities.V1.xml#L533)|\[PropertyPath\]|These properties can only be used for sorting in Descending order +[NonSortableProperties](Org.OData.Capabilities.V1.xml#L536)|\[PropertyPath\]|These structural properties cannot be used in orderby expressions **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [ExpandRestrictionsBase](Org.OData.Capabilities.V1.xml#L541) +## [ExpandRestrictionsBase](Org.OData.Capabilities.V1.xml#L545) **Derived Types:** @@ -347,58 +348,58 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Expandable](Org.OData.Capabilities.V1.xml#L547)|Boolean|$expand is supported -[StreamsExpandable](Org.OData.Capabilities.V1.xml#L550)|Boolean|$expand is supported for stream properties and media streams -[MaxLevels](Org.OData.Capabilities.V1.xml#L553)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. +[Expandable](Org.OData.Capabilities.V1.xml#L551)|Boolean|$expand is supported +[StreamsExpandable](Org.OData.Capabilities.V1.xml#L554)|Boolean|$expand is supported for stream properties and media streams +[MaxLevels](Org.OData.Capabilities.V1.xml#L557)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L557): [ExpandRestrictionsBase](#ExpandRestrictionsBase) +## [ExpandRestrictionsType](Org.OData.Capabilities.V1.xml#L561): [ExpandRestrictionsBase](#ExpandRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Expandable*](Org.OData.Capabilities.V1.xml#L547)|Boolean|$expand is supported -[*StreamsExpandable*](Org.OData.Capabilities.V1.xml#L550)|Boolean|$expand is supported for stream properties and media streams -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L553)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. -[NonExpandableProperties](Org.OData.Capabilities.V1.xml#L558)|\[NavigationPropertyPath\]|These properties cannot be used in expand expressions -[NonExpandableStreamProperties](Org.OData.Capabilities.V1.xml#L561)|\[PropertyPath\]|These stream properties cannot be used in expand expressions +[*Expandable*](Org.OData.Capabilities.V1.xml#L551)|Boolean|$expand is supported +[*StreamsExpandable*](Org.OData.Capabilities.V1.xml#L554)|Boolean|$expand is supported for stream properties and media streams +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L557)|Int32|The maximum number of levels that can be expanded in a expand expression. A value of -1 indicates there is no restriction. +[NonExpandableProperties](Org.OData.Capabilities.V1.xml#L562)|\[NavigationPropertyPath\]|These properties cannot be used in expand expressions +[NonExpandableStreamProperties](Org.OData.Capabilities.V1.xml#L565)|\[PropertyPath\]|These stream properties cannot be used in expand expressions **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SearchRestrictionsType](Org.OData.Capabilities.V1.xml#L571) +## [SearchRestrictionsType](Org.OData.Capabilities.V1.xml#L575) Property|Type|Description :-------|:---|:---------- -[Searchable](Org.OData.Capabilities.V1.xml#L577)|Boolean|$search is supported -[UnsupportedExpressions](Org.OData.Capabilities.V1.xml#L580)|[SearchExpressions](#SearchExpressions)|Expressions not supported in $search +[Searchable](Org.OData.Capabilities.V1.xml#L581)|Boolean|$search is supported +[UnsupportedExpressions](Org.OData.Capabilities.V1.xml#L584)|[SearchExpressions](#SearchExpressions)|Expressions not supported in $search **Applicable Annotation Terms:** - [Description](Org.OData.Core.V1.md#Description) -## [SearchExpressions](Org.OData.Capabilities.V1.xml#L584) +## [SearchExpressions](Org.OData.Capabilities.V1.xml#L588) Flag Member|Value|Description :-----|----:|:---------- -[none](Org.OData.Capabilities.V1.xml#L585)|0|Single search term -[AND](Org.OData.Capabilities.V1.xml#L588)|1|Multiple search terms, optionally separated by `AND` -[OR](Org.OData.Capabilities.V1.xml#L591)|2|Multiple search terms separated by `OR` -[NOT](Org.OData.Capabilities.V1.xml#L594)|4|Search terms preceded by `NOT` -[phrase](Org.OData.Capabilities.V1.xml#L597)|8|Search phrases enclosed in double quotes -[group](Org.OData.Capabilities.V1.xml#L600)|16|Precedence grouping of search expressions with parentheses +[none](Org.OData.Capabilities.V1.xml#L589)|0|Single search term +[AND](Org.OData.Capabilities.V1.xml#L592)|1|Multiple search terms, optionally separated by `AND` +[OR](Org.OData.Capabilities.V1.xml#L595)|2|Multiple search terms separated by `OR` +[NOT](Org.OData.Capabilities.V1.xml#L598)|4|Search terms preceded by `NOT` +[phrase](Org.OData.Capabilities.V1.xml#L601)|8|Search phrases enclosed in double quotes +[group](Org.OData.Capabilities.V1.xml#L604)|16|Precedence grouping of search expressions with parentheses -## [InsertRestrictionsBase](Org.OData.Capabilities.V1.xml#L619) +## [InsertRestrictionsBase](Org.OData.Capabilities.V1.xml#L623) **Derived Types:** @@ -406,65 +407,65 @@ Flag Member|Value|Description Property|Type|Description :-------|:---|:---------- -[Insertable](Org.OData.Capabilities.V1.xml#L620)|Boolean|Entities can be inserted -[MaxLevels](Org.OData.Capabilities.V1.xml#L623)|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#L626)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[QueryOptions](Org.OData.Capabilities.V1.xml#L629)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L632)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L635)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L638)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L642)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L646)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Insertable](Org.OData.Capabilities.V1.xml#L624)|Boolean|Entities can be inserted +[MaxLevels](Org.OData.Capabilities.V1.xml#L627)|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#L630)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[QueryOptions](Org.OData.Capabilities.V1.xml#L633)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L636)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L639)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L642)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L646)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L650)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L650): [InsertRestrictionsBase](#InsertRestrictionsBase) +## [InsertRestrictionsType](Org.OData.Capabilities.V1.xml#L654): [InsertRestrictionsBase](#InsertRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Insertable*](Org.OData.Capabilities.V1.xml#L620)|Boolean|Entities can be inserted -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L623)|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#L626)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment -[*QueryOptions*](Org.OData.Capabilities.V1.xml#L629)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L632)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L635)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L638)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L642)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L646)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L651)|\[PropertyPath\]|These structural properties cannot be specified on insert -[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L654)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts -[RequiredProperties](Org.OData.Capabilities.V1.xml#L657)|\[PropertyPath\]|These structural properties must be specified on insert -[Permissions](Org.OData.Capabilities.V1.xml#L660)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. +[*Insertable*](Org.OData.Capabilities.V1.xml#L624)|Boolean|Entities can be inserted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L627)|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#L630)|Boolean|Entities of a specific derived type can be created by specifying a type-cast segment +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L633)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with insert requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L636)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L639)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L642)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L646)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L650)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[NonInsertableProperties](Org.OData.Capabilities.V1.xml#L655)|\[PropertyPath\]|These structural properties cannot be specified on insert +[NonInsertableNavigationProperties](Org.OData.Capabilities.V1.xml#L658)|\[NavigationPropertyPath\]|These navigation properties do not allow deep inserts +[RequiredProperties](Org.OData.Capabilities.V1.xml#L661)|\[PropertyPath\]|These structural properties must be specified on insert +[Permissions](Org.OData.Capabilities.V1.xml#L664)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the insert. -## [PermissionType](Org.OData.Capabilities.V1.xml#L665) +## [PermissionType](Org.OData.Capabilities.V1.xml#L669) Property|Type|Description :-------|:---|:---------- -[SchemeName](Org.OData.Capabilities.V1.xml#L666)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name -[Scopes](Org.OData.Capabilities.V1.xml#L669)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource +[SchemeName](Org.OData.Capabilities.V1.xml#L670)|[SchemeName](Org.OData.Authorization.V1.md#SchemeName)|Authorization flow scheme name +[Scopes](Org.OData.Capabilities.V1.xml#L673)|\[[ScopeType](#ScopeType)\]|List of scopes that can provide access to the resource -## [ScopeType](Org.OData.Capabilities.V1.xml#L674) +## [ScopeType](Org.OData.Capabilities.V1.xml#L678) Property|Type|Description :-------|:---|:---------- -[Scope](Org.OData.Capabilities.V1.xml#L675)|String|Name of the scope. -[RestrictedProperties](Org.OData.Capabilities.V1.xml#L678)|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#L679)|String|Name of the scope. +[RestrictedProperties](Org.OData.Capabilities.V1.xml#L682)|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#L698) +## [DeepInsertSupportType](Org.OData.Capabilities.V1.xml#L702) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L699)|Boolean|Annotation target supports deep inserts -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L702)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L703)|Boolean|Annotation target supports deep inserts +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L706)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [UpdateRestrictionsBase](Org.OData.Capabilities.V1.xml#L711) +## [UpdateRestrictionsBase](Org.OData.Capabilities.V1.xml#L715) **Derived Types:** @@ -472,70 +473,70 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Updatable](Org.OData.Capabilities.V1.xml#L712)|Boolean|Entities can be updated -[Upsertable](Org.OData.Capabilities.V1.xml#L715)|Boolean|Entities can be upserted -[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L718)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload -[UpdateMethod](Org.OData.Capabilities.V1.xml#L721)|[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#L724)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L727)|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#L730)|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#L733)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. -[QueryOptions](Org.OData.Capabilities.V1.xml#L736)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests -[CustomHeaders](Org.OData.Capabilities.V1.xml#L739)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L742)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L745)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L749)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L753)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Updatable](Org.OData.Capabilities.V1.xml#L716)|Boolean|Entities can be updated +[Upsertable](Org.OData.Capabilities.V1.xml#L719)|Boolean|Entities can be upserted +[DeltaUpdateSupported](Org.OData.Capabilities.V1.xml#L722)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[UpdateMethod](Org.OData.Capabilities.V1.xml#L725)|[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#L728)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L731)|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#L734)|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#L737)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[QueryOptions](Org.OData.Capabilities.V1.xml#L740)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[CustomHeaders](Org.OData.Capabilities.V1.xml#L743)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L746)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L749)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L753)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L757)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L757): [UpdateRestrictionsBase](#UpdateRestrictionsBase) +## [UpdateRestrictionsType](Org.OData.Capabilities.V1.xml#L761): [UpdateRestrictionsBase](#UpdateRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Updatable*](Org.OData.Capabilities.V1.xml#L712)|Boolean|Entities can be updated -[*Upsertable*](Org.OData.Capabilities.V1.xml#L715)|Boolean|Entities can be upserted -[*DeltaUpdateSupported*](Org.OData.Capabilities.V1.xml#L718)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload -[*UpdateMethod*](Org.OData.Capabilities.V1.xml#L721)|[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#L724)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment -[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L727)|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#L730)|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#L733)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. -[*QueryOptions*](Org.OData.Capabilities.V1.xml#L736)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L739)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L742)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L745)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L749)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L753)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L758)|\[PropertyPath\]|These structural properties cannot be specified on update -[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L761)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding -[RequiredProperties](Org.OData.Capabilities.V1.xml#L764)|\[PropertyPath\]|These structural properties must be specified on update +[*Updatable*](Org.OData.Capabilities.V1.xml#L716)|Boolean|Entities can be updated +[*Upsertable*](Org.OData.Capabilities.V1.xml#L719)|Boolean|Entities can be upserted +[*DeltaUpdateSupported*](Org.OData.Capabilities.V1.xml#L722)|Boolean|Entities can be inserted, updated, and deleted via a PATCH request with a delta payload +[*UpdateMethod*](Org.OData.Capabilities.V1.xml#L725)|[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#L728)|Boolean|Members of collections can be updated via a PATCH request with a `/$filter(...)/$each` segment +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L731)|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#L734)|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#L737)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the update. +[*QueryOptions*](Org.OData.Capabilities.V1.xml#L740)|[ModificationQueryOptionsType?](#ModificationQueryOptionsType)|Support for query options with update requests +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L743)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L746)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L749)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L753)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L757)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[NonUpdatableProperties](Org.OData.Capabilities.V1.xml#L762)|\[PropertyPath\]|These structural properties cannot be specified on update +[NonUpdatableNavigationProperties](Org.OData.Capabilities.V1.xml#L765)|\[NavigationPropertyPath\]|These navigation properties do not allow rebinding +[RequiredProperties](Org.OData.Capabilities.V1.xml#L768)|\[PropertyPath\]|These structural properties must be specified on update -## [HttpMethod](Org.OData.Capabilities.V1.xml#L769) +## [HttpMethod](Org.OData.Capabilities.V1.xml#L773) Flag Member|Value|Description :-----|----:|:---------- -[GET](Org.OData.Capabilities.V1.xml#L770)|1|The HTTP GET Method -[PATCH](Org.OData.Capabilities.V1.xml#L773)|2|The HTTP PATCH Method -[PUT](Org.OData.Capabilities.V1.xml#L776)|4|The HTTP PUT Method -[POST](Org.OData.Capabilities.V1.xml#L779)|8|The HTTP POST Method -[DELETE](Org.OData.Capabilities.V1.xml#L782)|16|The HTTP DELETE Method -[OPTIONS](Org.OData.Capabilities.V1.xml#L785)|32|The HTTP OPTIONS Method -[HEAD](Org.OData.Capabilities.V1.xml#L788)|64|The HTTP HEAD Method +[GET](Org.OData.Capabilities.V1.xml#L774)|1|The HTTP GET Method +[PATCH](Org.OData.Capabilities.V1.xml#L777)|2|The HTTP PATCH Method +[PUT](Org.OData.Capabilities.V1.xml#L780)|4|The HTTP PUT Method +[POST](Org.OData.Capabilities.V1.xml#L783)|8|The HTTP POST Method +[DELETE](Org.OData.Capabilities.V1.xml#L786)|16|The HTTP DELETE Method +[OPTIONS](Org.OData.Capabilities.V1.xml#L789)|32|The HTTP OPTIONS Method +[HEAD](Org.OData.Capabilities.V1.xml#L792)|64|The HTTP HEAD Method -## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L797) +## [DeepUpdateSupportType](Org.OData.Capabilities.V1.xml#L801) Property|Type|Description :-------|:---|:---------- -[Supported](Org.OData.Capabilities.V1.xml#L798)|Boolean|Annotation target supports deep updates -[ContentIDSupported](Org.OData.Capabilities.V1.xml#L801)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. +[Supported](Org.OData.Capabilities.V1.xml#L802)|Boolean|Annotation target supports deep updates +[ContentIDSupported](Org.OData.Capabilities.V1.xml#L805)|Boolean|Annotation target supports accepting and returning nested entities annotated with the `Core.ContentID` instance annotation. -## [DeleteRestrictionsBase](Org.OData.Capabilities.V1.xml#L810) +## [DeleteRestrictionsBase](Org.OData.Capabilities.V1.xml#L814) **Derived Types:** @@ -543,80 +544,80 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Deletable](Org.OData.Capabilities.V1.xml#L811)|Boolean|Entities can be deleted -[MaxLevels](Org.OData.Capabilities.V1.xml#L814)|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#L817)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L820)|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#L823)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L826)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L829)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L832)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L836)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L840)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Deletable](Org.OData.Capabilities.V1.xml#L815)|Boolean|Entities can be deleted +[MaxLevels](Org.OData.Capabilities.V1.xml#L818)|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#L821)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L824)|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#L827)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L830)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L833)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L836)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L840)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L844)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L844): [DeleteRestrictionsBase](#DeleteRestrictionsBase) +## [DeleteRestrictionsType](Org.OData.Capabilities.V1.xml#L848): [DeleteRestrictionsBase](#DeleteRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Deletable*](Org.OData.Capabilities.V1.xml#L811)|Boolean|Entities can be deleted -[*MaxLevels*](Org.OData.Capabilities.V1.xml#L814)|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#L817)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment -[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L820)|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#L823)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L826)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L829)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L832)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L836)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L840)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L845)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests +[*Deletable*](Org.OData.Capabilities.V1.xml#L815)|Boolean|Entities can be deleted +[*MaxLevels*](Org.OData.Capabilities.V1.xml#L818)|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#L821)|Boolean|Members of collections can be deleted via a DELETE request with a `/$filter(...)/$each` segment +[*TypecastSegmentSupported*](Org.OData.Capabilities.V1.xml#L824)|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#L827)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to perform the delete. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L830)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L833)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L836)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L840)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L844)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[NonDeletableNavigationProperties](Org.OData.Capabilities.V1.xml#L849)|\[NavigationPropertyPath\]|These navigation properties do not allow DeleteLink requests -## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L853) +## [CollectionPropertyRestrictionsType](Org.OData.Capabilities.V1.xml#L857) Property|Type|Description :-------|:---|:---------- -[CollectionProperty](Org.OData.Capabilities.V1.xml#L854)|PropertyPath?|Restricted Collection-valued property -[FilterFunctions](Org.OData.Capabilities.V1.xml#L857)|\[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#L861)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L864)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L867)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions -[TopSupported](Org.OData.Capabilities.V1.xml#L870)|Boolean|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L873)|Boolean|Supports $skip -[SelectSupport](Org.OData.Capabilities.V1.xml#L876)|[SelectSupportType?](#SelectSupportType)|Support for $select -[Insertable](Org.OData.Capabilities.V1.xml#L879)|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#L883)|Boolean|Members of this ordered collection can be updated by ordinal -[Deletable](Org.OData.Capabilities.V1.xml#L886)|Boolean|Members of this ordered collection can be deleted by ordinal +[CollectionProperty](Org.OData.Capabilities.V1.xml#L858)|PropertyPath?|Restricted Collection-valued property +[FilterFunctions](Org.OData.Capabilities.V1.xml#L861)|\[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#L865)|[FilterRestrictionsType?](#FilterRestrictionsType)|Restrictions on filter expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L868)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L871)|[SortRestrictionsType?](#SortRestrictionsType)|Restrictions on orderby expressions +[TopSupported](Org.OData.Capabilities.V1.xml#L874)|Boolean|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L877)|Boolean|Supports $skip +[SelectSupport](Org.OData.Capabilities.V1.xml#L880)|[SelectSupportType?](#SelectSupportType)|Support for $select +[Insertable](Org.OData.Capabilities.V1.xml#L883)|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#L887)|Boolean|Members of this ordered collection can be updated by ordinal +[Deletable](Org.OData.Capabilities.V1.xml#L890)|Boolean|Members of this ordered collection can be deleted by ordinal -## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L894) +## [OperationRestrictionsType](Org.OData.Capabilities.V1.xml#L898) Property|Type|Description :-------|:---|:---------- -[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L895)|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#L898)|\[[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#L901)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L904)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[ErrorResponses](Org.OData.Capabilities.V1.xml#L907)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[FilterSegmentSupported](Org.OData.Capabilities.V1.xml#L899)|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#L902)|\[[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#L905)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L908)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[ErrorResponses](Org.OData.Capabilities.V1.xml#L911)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L918) +## [ModificationQueryOptionsType](Org.OData.Capabilities.V1.xml#L922) Property|Type|Description :-------|:---|:---------- -[ExpandSupported](Org.OData.Capabilities.V1.xml#L919)|Boolean|Supports $expand with modification requests -[SelectSupported](Org.OData.Capabilities.V1.xml#L922)|Boolean|Supports $select with modification requests -[ComputeSupported](Org.OData.Capabilities.V1.xml#L925)|Boolean|Supports $compute with modification requests -[FilterSupported](Org.OData.Capabilities.V1.xml#L928)|Boolean|Supports $filter with modification requests -[SearchSupported](Org.OData.Capabilities.V1.xml#L931)|Boolean|Supports $search with modification requests -[SortSupported](Org.OData.Capabilities.V1.xml#L934)|Boolean|Supports $orderby with modification requests +[ExpandSupported](Org.OData.Capabilities.V1.xml#L923)|Boolean|Supports $expand with modification requests +[SelectSupported](Org.OData.Capabilities.V1.xml#L926)|Boolean|Supports $select with modification requests +[ComputeSupported](Org.OData.Capabilities.V1.xml#L929)|Boolean|Supports $compute with modification requests +[FilterSupported](Org.OData.Capabilities.V1.xml#L932)|Boolean|Supports $filter with modification requests +[SearchSupported](Org.OData.Capabilities.V1.xml#L935)|Boolean|Supports $search with modification requests +[SortSupported](Org.OData.Capabilities.V1.xml#L938)|Boolean|Supports $orderby with modification requests -## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L943) +## [*ReadRestrictionsBase*](Org.OData.Capabilities.V1.xml#L947) **Derived Types:** @@ -625,86 +626,86 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Readable](Org.OData.Capabilities.V1.xml#L944)|Boolean|Entities can be retrieved -[Permissions](Org.OData.Capabilities.V1.xml#L947)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[CustomHeaders](Org.OData.Capabilities.V1.xml#L950)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L953)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[Description](Org.OData.Capabilities.V1.xml#L956)|String?|A brief description of the request -[LongDescription](Org.OData.Capabilities.V1.xml#L960)|String?|A long description of the request -[ErrorResponses](Org.OData.Capabilities.V1.xml#L964)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[Readable](Org.OData.Capabilities.V1.xml#L948)|Boolean|Entities can be retrieved +[Permissions](Org.OData.Capabilities.V1.xml#L951)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[CustomHeaders](Org.OData.Capabilities.V1.xml#L954)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[CustomQueryOptions](Org.OData.Capabilities.V1.xml#L957)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[Description](Org.OData.Capabilities.V1.xml#L960)|String?|A brief description of the request +[LongDescription](Org.OData.Capabilities.V1.xml#L964)|String?|A long description of the request +[ErrorResponses](Org.OData.Capabilities.V1.xml#L968)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L968): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadByKeyRestrictionsType](Org.OData.Capabilities.V1.xml#L972): [ReadRestrictionsBase](#ReadRestrictionsBase) Restrictions for retrieving an entity by key Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L944)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L947)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L950)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L953)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L956)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L960)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L964)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[*Readable*](Org.OData.Capabilities.V1.xml#L948)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L951)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L954)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L957)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L960)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L964)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L968)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L971): [ReadRestrictionsBase](#ReadRestrictionsBase) +## [ReadRestrictionsType](Org.OData.Capabilities.V1.xml#L975): [ReadRestrictionsBase](#ReadRestrictionsBase) Property|Type|Description :-------|:---|:---------- -[*Readable*](Org.OData.Capabilities.V1.xml#L944)|Boolean|Entities can be retrieved -[*Permissions*](Org.OData.Capabilities.V1.xml#L947)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. -[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L950)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers -[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L953)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options -[*Description*](Org.OData.Capabilities.V1.xml#L956)|String?|A brief description of the request -[*LongDescription*](Org.OData.Capabilities.V1.xml#L960)|String?|A long description of the request -[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L964)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. -[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L972)|Boolean|Entities of a specific derived type can be read by specifying a type-cast segment -[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L975)|[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#L948)|Boolean|Entities can be retrieved +[*Permissions*](Org.OData.Capabilities.V1.xml#L951)|\[[PermissionType?](#PermissionType)\]|Required permissions. One of the specified sets of scopes is required to read. +[*CustomHeaders*](Org.OData.Capabilities.V1.xml#L954)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom headers +[*CustomQueryOptions*](Org.OData.Capabilities.V1.xml#L957)|\[[CustomParameter](#CustomParameter)\]|Supported or required custom query options +[*Description*](Org.OData.Capabilities.V1.xml#L960)|String?|A brief description of the request +[*LongDescription*](Org.OData.Capabilities.V1.xml#L964)|String?|A long description of the request +[*ErrorResponses*](Org.OData.Capabilities.V1.xml#L968)|\[[HttpResponse](#HttpResponse)\]|Possible error responses returned by the request. +[TypecastSegmentSupported](Org.OData.Capabilities.V1.xml#L976)|Boolean|Entities of a specific derived type can be read by specifying a type-cast segment +[ReadByKeyRestrictions](Org.OData.Capabilities.V1.xml#L979)|[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#L1038) +## [CustomParameter](Org.OData.Capabilities.V1.xml#L1042) 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#L1041)|String|Name of the custom parameter -[Description](Org.OData.Capabilities.V1.xml#L1044)|String?|Description of the custom parameter -[DocumentationURL](Org.OData.Capabilities.V1.xml#L1047)|URL?|URL of related documentation -[Required](Org.OData.Capabilities.V1.xml#L1051)|Boolean|true: parameter is required, false or not specified: parameter is optional -[ExampleValues](Org.OData.Capabilities.V1.xml#L1054)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter +[Name](Org.OData.Capabilities.V1.xml#L1045)|String|Name of the custom parameter +[Description](Org.OData.Capabilities.V1.xml#L1048)|String?|Description of the custom parameter +[DocumentationURL](Org.OData.Capabilities.V1.xml#L1051)|URL?|URL of related documentation +[Required](Org.OData.Capabilities.V1.xml#L1055)|Boolean|true: parameter is required, false or not specified: parameter is optional +[ExampleValues](Org.OData.Capabilities.V1.xml#L1058)|\[[PrimitiveExampleValue](Org.OData.Core.V1.md#PrimitiveExampleValue)\]|Example values for the custom parameter -## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1073) +## [DefaultCapabilitiesType](Org.OData.Capabilities.V1.xml#L1077) Property|Type|Description :-------|:---|:---------- -[ChangeTracking](Org.OData.Capabilities.V1.xml#L1074)|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities -[CountRestrictions](Org.OData.Capabilities.V1.xml#L1077)|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option -[IndexableByKey](Org.OData.Capabilities.V1.xml#L1080)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions -[TopSupported](Org.OData.Capabilities.V1.xml#L1083)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top -[SkipSupported](Org.OData.Capabilities.V1.xml#L1086)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip -[ComputeSupported](Org.OData.Capabilities.V1.xml#L1089)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute -[SelectSupport](Org.OData.Capabilities.V1.xml#L1092)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select -[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1095)|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions -[SortRestrictions](Org.OData.Capabilities.V1.xml#L1098)|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions -[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1101)|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions -[SearchRestrictions](Org.OData.Capabilities.V1.xml#L1104)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions -[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1107)|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations -[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1110)|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations -[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1113)|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations -[OperationRestrictions](Org.OData.Capabilities.V1.xml#L1116)|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations -[ReadRestrictions](Org.OData.Capabilities.V1.xml#L1119)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance +[ChangeTracking](Org.OData.Capabilities.V1.xml#L1078)|[ChangeTrackingBase?](#ChangeTrackingBase)|Change tracking capabilities +[CountRestrictions](Org.OData.Capabilities.V1.xml#L1081)|[CountRestrictionsBase?](#CountRestrictionsBase)|Restrictions on /$count path suffix and $count=true system query option +[IndexableByKey](Org.OData.Capabilities.V1.xml#L1084)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports key values according to OData URL conventions +[TopSupported](Org.OData.Capabilities.V1.xml#L1087)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $top +[SkipSupported](Org.OData.Capabilities.V1.xml#L1090)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $skip +[ComputeSupported](Org.OData.Capabilities.V1.xml#L1093)|[Tag?](Org.OData.Core.V1.md#Tag)|Supports $compute +[SelectSupport](Org.OData.Capabilities.V1.xml#L1096)|[SelectSupportType?](#SelectSupportType)|Support for $select and nested query options within $select +[FilterRestrictions](Org.OData.Capabilities.V1.xml#L1099)|[FilterRestrictionsBase?](#FilterRestrictionsBase)|Restrictions on filter expressions +[SortRestrictions](Org.OData.Capabilities.V1.xml#L1102)|[SortRestrictionsBase?](#SortRestrictionsBase)|Restrictions on orderby expressions +[ExpandRestrictions](Org.OData.Capabilities.V1.xml#L1105)|[ExpandRestrictionsBase?](#ExpandRestrictionsBase)|Restrictions on expand expressions +[SearchRestrictions](Org.OData.Capabilities.V1.xml#L1108)|[SearchRestrictionsType?](#SearchRestrictionsType)|Restrictions on search expressions +[InsertRestrictions](Org.OData.Capabilities.V1.xml#L1111)|[InsertRestrictionsBase?](#InsertRestrictionsBase)|Restrictions on insert operations +[UpdateRestrictions](Org.OData.Capabilities.V1.xml#L1114)|[UpdateRestrictionsBase?](#UpdateRestrictionsBase)|Restrictions on update operations +[DeleteRestrictions](Org.OData.Capabilities.V1.xml#L1117)|[DeleteRestrictionsBase?](#DeleteRestrictionsBase)|Restrictions on delete operations +[OperationRestrictions](Org.OData.Capabilities.V1.xml#L1120)|[OperationRestrictionsType?](#OperationRestrictionsType)|Restrictions for function or action operations +[ReadRestrictions](Org.OData.Capabilities.V1.xml#L1123)|[ReadRestrictionsType?](#ReadRestrictionsType)|Restrictions for retrieving a collection of entities, retrieving a singleton instance -## [HttpResponse](Org.OData.Capabilities.V1.xml#L1124) +## [HttpResponse](Org.OData.Capabilities.V1.xml#L1128) Property|Type|Description :-------|:---|:---------- -[StatusCode](Org.OData.Capabilities.V1.xml#L1125)|String|HTTP response status code, for example 400, 403, 501 -[Description](Org.OData.Capabilities.V1.xml#L1128)|String|Human-readable description of the response +[StatusCode](Org.OData.Capabilities.V1.xml#L1129)|String|HTTP response status code, for example 400, 403, 501 +[Description](Org.OData.Capabilities.V1.xml#L1132)|String|Human-readable description of the response diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index e68ac23f..ce4b5eeb 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -145,8 +145,12 @@ supported: - - + + + + + + From 36861ce49a1756e5d3ef928baa5607722250f318 Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Tue, 26 Nov 2024 12:21:24 +0100 Subject: [PATCH 2/3] address review feedback --- vocabularies/Org.OData.Capabilities.V1.json | 6 ++++-- vocabularies/Org.OData.Capabilities.V1.md | 4 ++-- vocabularies/Org.OData.Capabilities.V1.xml | 8 ++++---- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index 090b7475..b463f12a 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -94,12 +94,13 @@ "$AppliesTo": [ "EntityContainer", "EntitySet", + "Singleton", "Action", "ActionImport", "Function", "FunctionImport" ], - "@Core.Description": "Requests in scope require the asynchronous request preference" + "@Core.Description": "Supports the `respond-async` preference" }, "AsynchronousRequestsRequired": { "$Kind": "Term", @@ -108,13 +109,14 @@ "$AppliesTo": [ "EntityContainer", "EntitySet", + "Singleton", "Action", "ActionImport", "Function", "FunctionImport" ], "$BaseTerm": "Capabilities.AsynchronousRequestsSupported", - "@Core.Description": "Requests in scope require the asynchronous request preference" + "@Core.Description": "Requires the `respond-async` preference" }, "BatchContinueOnErrorSupported": { "$Kind": "Term", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index 3a6aaafc..a7a80b43 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -51,8 +51,8 @@ Term|Type|Description [SupportedFormats](Org.OData.Capabilities.V1.xml#L132)|\[MediaType\]|Media types of supported formats, including format parameters [SupportedMetadataFormats](Org.OData.Capabilities.V1.xml#L137)|\[MediaType\]|Media types of supported formats for $metadata, including format parameters [AcceptableEncodings](Org.OData.Capabilities.V1.xml#L142)|\[String\]|List of acceptable compression methods for ($batch) requests, e.g. gzip -[AsynchronousRequestsSupported](Org.OData.Capabilities.V1.xml#L148)|[Tag](Org.OData.Core.V1.md#Tag)|Requests in scope require the asynchronous request preference -[AsynchronousRequestsRequired](Org.OData.Capabilities.V1.xml#L152)|[Tag](Org.OData.Core.V1.md#Tag)|Requests in scope require the asynchronous request preference +[AsynchronousRequestsSupported](Org.OData.Capabilities.V1.xml#L148)|[Tag](Org.OData.Core.V1.md#Tag)|Supports the `respond-async` preference +[AsynchronousRequestsRequired](Org.OData.Capabilities.V1.xml#L152)|[Tag](Org.OData.Core.V1.md#Tag)|Requires the `respond-async` preference [BatchContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L156)|[Tag](Org.OData.Core.V1.md#Tag)|Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term. [IsolationSupported](Org.OData.Capabilities.V1.xml#L160)|[IsolationLevel](#IsolationLevel)|Supported odata.isolation levels [CrossJoinSupported](Org.OData.Capabilities.V1.xml#L169)|[Tag](Org.OData.Core.V1.md#Tag)|Supports cross joins for the entity sets in this container diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index ce4b5eeb..82231274 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -145,12 +145,12 @@ supported: - - + + - - + + From 9d732ab55b413e210fca7736572f4e6c707cef7e Mon Sep 17 00:00:00 2001 From: Gerald Krause Date: Tue, 14 Jan 2025 09:12:41 +0100 Subject: [PATCH 3/3] updated after discussion 2024-11-27 --- vocabularies/Org.OData.Capabilities.V1.json | 20 ++++---------------- vocabularies/Org.OData.Capabilities.V1.md | 4 ++-- vocabularies/Org.OData.Capabilities.V1.xml | 8 ++++---- 3 files changed, 10 insertions(+), 22 deletions(-) diff --git a/vocabularies/Org.OData.Capabilities.V1.json b/vocabularies/Org.OData.Capabilities.V1.json index b463f12a..72060706 100644 --- a/vocabularies/Org.OData.Capabilities.V1.json +++ b/vocabularies/Org.OData.Capabilities.V1.json @@ -92,31 +92,19 @@ "$Type": "Core.Tag", "$DefaultValue": true, "$AppliesTo": [ - "EntityContainer", - "EntitySet", - "Singleton", - "Action", - "ActionImport", - "Function", - "FunctionImport" + "EntityContainer" ], - "@Core.Description": "Supports the `respond-async` preference" + "@Core.Description": "Service supports the asynchronous request preference" }, "AsynchronousRequestsRequired": { "$Kind": "Term", "$Type": "Core.Tag", "$DefaultValue": true, "$AppliesTo": [ - "EntityContainer", - "EntitySet", - "Singleton", - "Action", - "ActionImport", - "Function", - "FunctionImport" + "EntityContainer" ], "$BaseTerm": "Capabilities.AsynchronousRequestsSupported", - "@Core.Description": "Requires the `respond-async` preference" + "@Core.Description": "Service requires the asynchronous request preference" }, "BatchContinueOnErrorSupported": { "$Kind": "Term", diff --git a/vocabularies/Org.OData.Capabilities.V1.md b/vocabularies/Org.OData.Capabilities.V1.md index a7a80b43..84be9e6c 100644 --- a/vocabularies/Org.OData.Capabilities.V1.md +++ b/vocabularies/Org.OData.Capabilities.V1.md @@ -51,8 +51,8 @@ Term|Type|Description [SupportedFormats](Org.OData.Capabilities.V1.xml#L132)|\[MediaType\]|Media types of supported formats, including format parameters [SupportedMetadataFormats](Org.OData.Capabilities.V1.xml#L137)|\[MediaType\]|Media types of supported formats for $metadata, including format parameters [AcceptableEncodings](Org.OData.Capabilities.V1.xml#L142)|\[String\]|List of acceptable compression methods for ($batch) requests, e.g. gzip -[AsynchronousRequestsSupported](Org.OData.Capabilities.V1.xml#L148)|[Tag](Org.OData.Core.V1.md#Tag)|Supports the `respond-async` preference -[AsynchronousRequestsRequired](Org.OData.Capabilities.V1.xml#L152)|[Tag](Org.OData.Core.V1.md#Tag)|Requires the `respond-async` preference +[AsynchronousRequestsSupported](Org.OData.Capabilities.V1.xml#L148)|[Tag](Org.OData.Core.V1.md#Tag)|Service supports the asynchronous request preference +[AsynchronousRequestsRequired](Org.OData.Capabilities.V1.xml#L152)|[Tag](Org.OData.Core.V1.md#Tag)|Service requires the asynchronous request preference [BatchContinueOnErrorSupported](Org.OData.Capabilities.V1.xml#L156)|[Tag](Org.OData.Core.V1.md#Tag)|Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term. [IsolationSupported](Org.OData.Capabilities.V1.xml#L160)|[IsolationLevel](#IsolationLevel)|Supported odata.isolation levels [CrossJoinSupported](Org.OData.Capabilities.V1.xml#L169)|[Tag](Org.OData.Core.V1.md#Tag)|Supports cross joins for the entity sets in this container diff --git a/vocabularies/Org.OData.Capabilities.V1.xml b/vocabularies/Org.OData.Capabilities.V1.xml index 82231274..10933358 100644 --- a/vocabularies/Org.OData.Capabilities.V1.xml +++ b/vocabularies/Org.OData.Capabilities.V1.xml @@ -145,12 +145,12 @@ supported: - - + + - - + +