Skip to content

Latest commit

 

History

History
266 lines (195 loc) · 18.3 KB

Org.OData.Capabilities.V1.md

File metadata and controls

266 lines (195 loc) · 18.3 KB

Capabilities Vocabulary

Namespace: Org.OData.Capabilities.V1

Terms describing capabilities of a service

There are some capabilities which are strongly recommended for services to support even though they are optional. Support for $top and $skip is a good example as supporting these query options helps with performance of a service and are essential. Such capabilities are assumed to be default capabilities of an OData service even in the case that a capabilities annotation doesn’t exist. Capabilities annotations are mainly expected to be used to explicitly specify that a service doesn’t support such capabilities. Capabilities annotations can as well be used to declaratively specify the support of such capabilities.

On the other hand, there are some capabilities that a service may choose to support or not support and in varying degrees. $filter and $orderby are such good examples. This vocabulary aims to define terms to specify support or no support for such capabilities.

A service is assumed to support by default the following capabilities even though an annotation doesn’t exist:

  • Countability ($count)
  • Client pageability ($top, $skip)
  • Expandability ($expand)
  • Indexability by key
  • Batch support ($batch)
  • Navigability of navigation properties

A service is expected to support the following capabilities. If not supported, the service is expected to call out the restrictions using annotations:

  • Filterability ($filter)
  • Sortability ($orderby)
  • Queryability of top level entity sets
  • Query functions

A client cannot assume that a service supports certain capabilities. A client can try, but it needs to be prepared to handle an error in case the following capabilities are not supported:

  • Insertability
  • Updatability
  • Deletability
Term Type Description
ConformanceLevel ConformanceLevelType The conformance level achieved by this service
SupportedFormats [MediaType] Media types of supported formats, including format parameters
SupportedMetadataFormats [MediaType] Media types of supported formats for $metadata, including format parameters
AcceptableEncodings [String] List of acceptable compression methods for ($batch) requests, e.g. gzip
AsynchronousRequestsSupported Tag Service supports the asynchronous request preference
BatchContinueOnErrorSupported 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 IsolationLevel Supported odata.isolation levels
CrossJoinSupported Tag Supports cross joins for the entity sets in this container
CallbackSupported CallbackType Supports callbacks for the specified protocols
ChangeTracking ChangeTrackingType Change tracking capabilities of this service or entity set
CountRestrictions CountRestrictionsType Restrictions on /$count path suffix and $count=true system query option
NavigationRestrictions NavigationRestrictionsType Restrictions on navigating properties according to OData URL conventions
IndexableByKey Tag Supports key values according to OData URL conventions
TopSupported Tag Supports $top
SkipSupported Tag Supports $skip
BatchSupported Tag Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term.
BatchSupport BatchSupportType Batch Support for the service
FilterFunctions [String] List of functions and operators supported in $filter
FilterRestrictions FilterRestrictionsType Restrictions on $filter expressions
SortRestrictions SortRestrictionsType Restrictions on $orderby expressions
ExpandRestrictions ExpandRestrictionsType Restrictions on $expand expressions
SearchRestrictions SearchRestrictionsType Restrictions on $search expressions
InsertRestrictions InsertRestrictionsType Restrictions on insert operations
DeepInsertSupport DeepInsertSupportType Deep Insert Support for the service
UpdateRestrictions UpdateRestrictionsType Restrictions on update operations
DeleteRestrictions DeleteRestrictionsType Restrictions on delete operations

ConformanceLevelType

Member Value Description
Minimal 0 Minimal conformance level
Intermediate 1 Intermediate conformance level
Advanced 2 Advanced conformance level

IsolationLevel

Flag Member Value Description
Snapshot 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

A non-empty collection lists the full set of supported protocols. A empty collection means 'only HTTP is supported'

Property Type Description
CallbackProtocols [CallbackProtocol] List of supported callback protocols, e.g. http or wss

CallbackProtocol

Property Type Description
Id String Protocol Identifier
UrlTemplate String URL Template including parameters. Parameters are enclosed in curly braces {} as defined in RFC6570
DocumentationUrl URL Human readable description of the meaning of the URL Template parameters

ChangeTrackingType

Property Type Description
Supported Boolean This entity set supports the odata.track-changes preference
FilterableProperties [PropertyPath] Change tracking supports filters on these properties
ExpandableProperties [NavigationPropertyPath] Change tracking supports these properties expanded

CountRestrictionsType

Property Type Description
Countable Boolean Entities can be counted
NonCountableProperties [PropertyPath] These collection properties do not allow /$count segments
NonCountableNavigationProperties [NavigationPropertyPath] These navigation properties do not allow /$count segments

NavigationRestrictionsType

Property Type Description
Navigability NavigationType Supported Navigability
RestrictedProperties [NavigationPropertyRestriction] List of navigation properties with restrictions

NavigationPropertyRestriction

Property Type Description
NavigationProperty NavigationPropertyPath Navigation properties can be navigated
Navigability NavigationType Navigation properties can be navigated to this level
FilterFunctions [String] List of functions and operators supported in $filter. If null, all functions and operators may be attempted.
FilterRestrictions FilterRestrictionsType Restrictions on $filter expressions
SortRestrictions SortRestrictionsType Restrictions on $orderby expressions

NavigationType

Member Value Description
Recursive 0 Navigation properties can be recursively navigated
Single 1 Navigation properties can be navigated to a single level
None 2 Navigation properties are not navigable

BatchSupportType

Property Type Description
Supported Boolean Service supports requests to $batch
ContinueOnErrorSupported Boolean Service supports the continue on error preference
ReferencesInRequestBodiesSupported Boolean Service supports Content-ID referencing in request bodies
ReferencesAcrossChangeSetsSupported Boolean Service supports Content-ID referencing across change sets
EtagReferencesSupported Boolean Service supports referencing Etags from previous requests

FilterRestrictionsType

Property Type Description
Filterable Boolean $filter is supported
RequiresFilter Boolean $filter is required
RequiredProperties [PropertyPath] These properties must be specified in the $filter clause (properties of derived types are not allowed here)
NonFilterableProperties [PropertyPath] These structural or navigation properties cannot be used in $filter expressions
FilterExpressionRestrictions [FilterExpressionRestrictionType] These properties only allow a subset of expressions
MaxLevels 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.

FilterExpressionRestrictionType

Property Type Description
Property PropertyPath Path to the restricted property
AllowedExpressions FilterExpressionType Allowed subset of expressions

FilterExpressionType

Type: String

Allowed Value Description
SingleValue Property can be used in a single eq clause
MultiValue Property can be used in a single in clause
SingleRange Property can be used in at most one ge and/or one le clause, separated by and
SearchExpression String property can be used as first operand in startswith, endswith, and contains clauses

SortRestrictionsType

Property Type Description
Sortable Boolean $orderby is supported
AscendingOnlyProperties [PropertyPath] These properties can only be used for sorting in Ascending order
DescendingOnlyProperties [PropertyPath] These properties can only be used for sorting in Descending order
NonSortableProperties [PropertyPath] These structural or navigation properties cannot be used in $orderby expressions

ExpandRestrictionsType

Property Type Description
Expandable Boolean $expand is supported
NonExpandableProperties [NavigationPropertyPath] These properties cannot be used in $expand expressions
MaxLevels Int32 The maximum number of levels that can be expanded in a $expand expression. A value of -1 indicates there is no restriction.

SearchRestrictionsType

Property Type Description
Searchable Boolean $search is supported
UnsupportedExpressions SearchExpressions Expressions not supported in $search

SearchExpressions

Flag Member Value Description
none 0 Single search term
AND 1 Multiple search terms separated by AND
OR 2 Multiple search terms separated by OR
NOT 4 Search terms preceded by NOT
phrase 8 Search phrases enclosed in double quotes
group 16 Precedence grouping of search expressions with parentheses

InsertRestrictionsType

Property Type Description
Insertable Boolean Entities can be inserted
NonInsertableNavigationProperties [NavigationPropertyPath] These navigation properties do not allow deep inserts
MaxLevels 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.

DeepInsertSupportType

Property Type Description
Supported Boolean Service supports deep inserts
ContentIDSupported Boolean Service supports accepting and returning nested entities annotated with the contentID instance annotation.

UpdateRestrictionsType

Property Type Description
Updatable Boolean Entities can be updated
NonUpdatableNavigationProperties [NavigationPropertyPath] These navigation properties do not allow rebinding
MaxLevels 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.

DeleteRestrictionsType

Property Type Description
Deletable Boolean Entities can be deleted
NonDeletableNavigationProperties [NavigationPropertyPath] These navigation properties do not allow DeleteLink requests
MaxLevels 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.