role

resourceKind
serviceOperation
query

First level elements

Describes the role that the XSD element plays in the contract.

path

relative URL

Service operation or named query  definition

Relative URL to query resources or invoke the operation.

pluralName

pluralized name

Name of the resource kind in plural form. For example, accounts.

label

string

All definitions

A friendly name for the element (localized).

canGet
canPost
canPut
canDelete

true (default for canGet)
false (default for others)

Relationship definition

Does the resource kind or relationship property support GET (read and query), POST, PUT and DELETE operations?

canPagePrevious
canPageNext
canPageIndex

true
false (default)

Relationship definition

The paging modes supported by the resource kind or relationship property. See Query Paging section.

canSort

true
false (default)

Can the feed be sorted by this property?

canFilter

true
false (default)

Can the feed be filtered by the property?

canGroup

true
false (default)

Can feed entries be grouped by values of this property?

canSearch

true
false (default)

Does the resource kind support full-text search through the search query parameter? See Query Parameters section for details.

hasUuid

true
false (default)

Does the resource kind use UUIDs to identify resources?
When this attribute is set, feeds payload MUST carry sdata:uuid attributes

hasTemplate

true
false (default)

Does the resource kind, service operation or named query provide a $template URL?
See Operation Template section for details.

supportsETag

true
false (default)

Does the resource kind support the ETag mechanism to control concurrent updates?

relationship

parent
child
reference
association

Type of relationship.

isCollection

true
false (default)

Does the property refer to a collection of resources or a single resource?

isMandatory

true
false (default)

Is the property value mandatory when creating a new resource?

isReadOnly

true
false (default)

Is the property read-only?  For example, an ID set by the provider or a calculated property.

isLocalized

true
false (default)

Does the property contain localized text?

isUniqueKey

true
false (default)

Is the property a key that identifies a unique resource?

precedence

integer

Controls the visibility of properties on small screens.

groupName

string

A group (category) name to group related properties.

maxLength

integer

Maximum length of a string property value.

This attribute is a hint for the user interface. A service consumer may pass a string which is longer than maxLength. In this case, the value will be truncated by the provider.
A more sophisticated consumer may use this value to limit the size of its edit field and/or adjust its storage requirements so that they match what the provider uses.

averageLength

integer

Average length (number of characters) of a string property value.

This attribute is a hint for the user interface. A service consumer can use it to set the visible size of edit fields in a form.

totalDigits

integer

Maximum overall number of digits for a decimal property value.

This attribute is a hint for the user interface. A service consumer may ignore it and pass a  decimal value with more digits. In this case the provider will round or truncate the value.

fractionDigits

integer

Maximum number of digits to the right of the decimal point for a decimal property value.

This attribute is a hint for the user interface. A service consumer may ignore it and pass a  decimal value with more decimal digits. In this case the provider will round or truncate the value.

unsupported

true
false (default)

All definitions

Is the element part of a global contract that it is not supported by this specific provider?

tags (1.1)

comma separated string

All definitions

List of tags that apply to the definition.
SData does not impose any predefined list of tags. Instead, each contract is free to define its own list of tags.

This feature is an extensibility mechanism. It should be used when the information cannot be captured by one of the other SME attributes, not as a replacement for existing SME attributes.

protocolFilters

comma separated string

List of protocol filter variables supported in where parameters and resource selectors. See Query Language section for details.

compliance

may
should
must

All definitions

Applies to elements that are part of a global contract. Defines the compliance requirement for providers that implement the contract.

batchingMode

none (default)
sync
async
syncOrAsync

Does the resource kind support batching? If so, which invocation modes does it support?

invocationMode

sync (default)
async
syncOrAsync

The supported invocation modes.

isSyncSource

true
false (default)

Can the resource kind be used as a source in a synchronization operation?
See SData Synchronization for details.

isSyncTarget

true
false (default)

Can the resource kind be used as a target in a synchronization operation?
See SData Synchronization for details.

syncConflictPriority

integer

Priority to resolve conflicts in synchronization.
See SData Synchronization for details.

syncOrder (1.1)

integer

Order in which the resource kind should be processed in a synchronization pass.
See SData Synchronization for details.

isGlobalId

true
false (default)

Is the property a global identifier for the resource?
Deprecated.

isIdentifier

true
false (default)

Is the property an identifier for the resource?
Deprecated.

isDescriptor

true
false (default)

Is the property a descriptor for the resource?
Deprecated.

copiedFrom

XPath expression

Indicates that the property is dependent upon a related resource and gives the XPath expression for the corresponding property in the related resource.
See Relationship Definition section for details.
Deprecated.