iambmelt / OData-V4.0-Vocabularies

A cheatsheet for OData Core, Capability, and Measures Vocabularies

OData-V4.0-Vocabularies

A cheatsheet for OData Core, Capability, and Measures Vocabularies

Disclaimer

I take no responsibility for the correctness or currency of this data. The authoritative source can be found here.

The contents of this document are adapted from works bearing the following copyright

OData Version 4.0
OASIS Standard
24 February 2014
Copyright (c) OASIS Open 2014. All Rights Reserved.
Source: http://docs.oasis-open.org/odata/odata/v4.0/os/vocabularies/

Core

Core terms needed to write vocabularies.

Documentation

• Description - A brief description of a model element
• LongDescription - A lengthy description of a model element

Localization

• IsLanguageDependent - Properties and terms annotated with this term are language-dependent

Term Restrictions

• RequiresType - This is the type to use for all tagging terms

Resource Paths

• ResourcePath - Resource path for entity container child, can be relative to xml:base and the request URL
• DereferenceableIDs - Entity-ids are URLs that locate the identified entity
• ConventionalIDs - Entity-ids follow OData URL conventions

Permissions

• Permissions - Permissions available for a property. The value of 2 is reserved for future use.

Permission	Value
None	0
Read	1
ReadWrite	3

Metadata Extensions

• Immutable - A value for this non-key property can be provided on insert and remains unchanged on update
• Computed - A value for this property is generated on both insert and update
• IsURL - Properties and terms annotated with this term MUST contain a valid URL
• AcceptableMediaTypes - Lists the MIME types acceptable for the annotated entity type marked with HasStream="true" or the annotated stream property
• MediaType
• IsMediaType - Properties and terms annotated with this term MUST contain a valid MIME type
• OptimisticConcurrency - Data modification requires the use of Etags. A non-empty collection contains the set of properties that are used to compute the ETag

Capabilities

The Capabilities vocabulary aims to provide a way for service authors to describe certain capabilities of an OData 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, $inlinecount)
• 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

Conformance Level

• ConformanceLevel

ConformanceLevelType
Minimal
Intermediate
Advanced

Request Capabilities

• SupportedFormats - Media types of supported formats, including format parameters
• AcceptableEncodings - List of acceptable compression methods for ($batch) requests, e.g. gzip

Supported Preferences

• AsynchronousRequestsSupported - Service supports the asynchronous request preference
• BatchContinueOnErrorSupported - Service supports the continue on error preference
• IsolationSupported - Supported odata.isolation levels

IsolationLevel	Value
Snapshot	1

• CallbackSupported - Supports callbacks for the specified protocols
• CrossJoinSupported - Supports cross joins for the entity sets in this container
• ChangeTracking - Change tracking capabilities of this service or entity set

Query Capabilities

• CountRestrictions - Restrictions on /$count path suffix and $count=true system query option
• NavigationRestrictions - Restrictions on navigating properties according to OData URL conventions
• IndexableByKey - Supports key values according to OData URL conventions
• TopSupported - Supports $top
• SkipSupported - Supports $skip
• BatchSupported - Supports $batch requests
• FilterFunctions - List of functions supported in $filter
• FilterRestrictions - Restrictions on $filter expressions
• SortRestrictions - Restrictions on $orderby expressions
• ExpandRestrictions - Restrictions on $expand expressions
• SearchRestrictions - Restrictions on $search expressions

Data Modification Capabilities

• InsertRestrictions - Restrictions on insert operations
• UpdateRestrictions - Restrictions on update operations
• DeleteRestrictions - Restrictions on delete operations

Measures

Terms describing monetary amounts and measured quantities.

• ISOCurrency - The currency for this monetary amount as an ISO 4217 currency code
• Scale - The number of significant decimal places in the scale part (less than or equal to the number declared in the Scale facet)
• Unit - The unit of measure for this measured quantity, e.g. cm for centimeters or % for percentages