Namespace: Org.OData.Core.V1
\nCore terms needed to write vocabularies
\n\nTerm | \nType | \nDescription | \n
---|---|---|
ODataVersions | \nString | \nA space-separated list of supported versions of the OData Protocol. Note that 4.0 is implied by 4.01 and does not need to be separately listed. | \n
SchemaVersion | \nString | \nService-defined value representing the version of the schema. Services MAY use semantic versioning, but clients MUST NOT assume this is the case. | \n
Revisions | \n[RevisionType] | \nList of revisions of a model element | \n
Description | \nString? | \nA brief description of a model element | \n
LongDescription | \nString? | \nA long description of a model element | \n
Links | \n[Link] | \nLink to related information | \n
Example | \nExampleValue | \nExample for an instance of the annotated model element (Example) | \n
Messages | \n[MessageType] | \nInstance annotation for warning and info messages | \n
ValueException | \nValueExceptionType | \nThe annotated value is problematic | \n
ResourceException | \nResourceExceptionType | \nThe annotated instance within a success payload is problematic | \n
DataModificationException | \nDataModificationExceptionType | \nA modification operation failed on the annotated instance or collection within a success payload | \n
IsLanguageDependent | \nTag | \nProperties and terms annotated with this term are language-dependent | \n
RequiresType | \nString | \nTerms annotated with this term can only be applied to elements that have a type that is identical to or derived from the given type name | \n
AppliesViaContainer | \nTag | \nThe target path of an annotation with the tagged term MUST start with an entity container or the annotation MUST be embedded within an entity container, entity set or singleton Services MAY additionally annotate a container-independent model element (entity type, property, navigation property) if allowed by the AppliesTo property of the term and the annotation applies to all uses of that model element. | \n
ResourcePath | \nURL | \nResource path for entity container child, can be relative to xml:base and the request URL | \n
DereferenceableIDs | \nTag | \nEntity-ids are URLs that locate the identified entity | \n
ConventionalIDs | \nTag | \nEntity-ids follow OData URL conventions | \n
Permissions | \nPermission | \nPermissions for accessing a resource | \n
ContentID | \nString | \nA unique identifier for nested entities within a request. | \n
DefaultNamespace | \nTag | \nFunctions, actions and types in this namespace can be referenced in URLs with or without namespace- or alias- qualification. Data Modelers should ensure uniqueness of schema children across all default namespaces, and should avoid naming bound functions, actions, or derived types with the same name as a structural or navigational property of the type. | \n
Immutable | \nTag | \nA value for this non-key property can be provided by the client on insert and remains unchanged on update | \n
Computed | \nTag | \nA value for this property is generated on both insert and update | \n
ComputedDefaultValue | \nTag | \nA value for this property can be provided by the client on insert and update. If no value is provided on insert, a non-static default value is generated | \n
IsURL | \nTag | \nProperties and terms annotated with this term MUST contain a valid URL | \n
AcceptableMediaTypes | \n[MediaType] | \nLists the MIME types acceptable for the annotated entity type marked with HasStream=\"true\" or the annotated binary, stream, or string property or term The annotation of a TypeDefinition propagates to the model elements having this type | \n
MediaType | \nMediaType? | \nThe media type of the media stream of the annotated entity type marked with HasStream=\"true\" or the annotated binary, stream, or string property or term The annotation of a TypeDefinition propagates to the model elements having this type | \n
IsMediaType | \nTag | \nProperties and terms annotated with this term MUST contain a valid MIME type | \n
ContentDisposition | \nContentDispositionType | \nThe content disposition of the media stream of the annotated entity type marked with HasStream=\"true\" or the annotated binary, stream, or string property or term | \n
OptimisticConcurrency | \n[PropertyPath] | \nData modification requires the use of ETags. A non-empty collection contains the set of properties that are used to compute the ETag. An empty collection means that the service won't tell how it computes the ETag | \n
AdditionalProperties | \nTag | \nInstances of this type may contain properties in addition to those declared in $metadata If specified as false clients can assume that instances will not contain dynamic properties, irrespective of the value of the OpenType attribute. | \n
AutoExpand | \nTag | \nThe service will automatically expand this stream property, navigation property, or the media stream of this media entity type even if not requested with $expand | \n
AutoExpandReferences | \nTag | \nThe service will automatically expand this navigation property as entity references even if not requested with $expand=.../$ref | \n
MayImplement | \n[QualifiedTypeName] | \nA collection of qualified type names outside of the type hierarchy that instances of this type might be addressable as by using a type-cast segment. | \n
Ordered | \nTag | \nCollection has a stable order. Ordered collections of primitive or complex types can be indexed by ordinal. | \n
PositionalInsert | \nTag | \nItems can be inserted at a given ordinal index. | \n
AlternateKeys | \n[AlternateKey] | \nCommunicates available alternate keys | \n
OptionalParameter | \nOptionalParameterType | \nSupplying a value for the action or function parameter is optional. All parameters marked as optional must come after any parameters not marked as optional. The binding parameter must not be marked as optional. | \n
OperationAvailable | \nBoolean? | \nAction or function is available The annotation value will usually be an expression, e.g. using properties of the binding parameter type for instance-dependent availability, or using properties of a singleton for global availability. The static value null means that availability cannot be determined upfront and is instead expressed as an operation advertisement. | \n
RequiresExplicitBinding | \nTag? | \nThis bound action or function is only available on model elements annotated with the ExplicitOperationBindings term. | \n
ExplicitOperationBindings | \n[QualifiedBoundOperationName] | \nThe qualified names of explicitly bound operations that are supported on the target model element. These operations are in addition to any operations not annotated with RequiresExplicitBinding that are bound to the type of the target model element. | \n
SymbolicName | \nSimpleIdentifier | \nA symbolic name for a model element | \n
GeometryFeature | \nGeometryFeatureType? | \nA Feature Object represents a spatially bounded thing | \n
AnyStructure | \nTag | \nInstances of a type are annotated with this tag if they have no common structure in a given response payload The select-list of a context URL MUST be (@Core.AnyStructure) if it would otherwise be empty, but this instance annotation SHOULD be omitted from the response value. | \n
Property | \nType | \nDescription | \n
---|---|---|
Version | \nString? | \nThe schema version with which this revision was first published | \n
Kind | \nRevisionKind | \nThe kind of revision | \n
Description | \nString | \nText describing the reason for the revision | \n
Member | \nValue | \nDescription | \n
---|---|---|
Added | \n0 | \nModel element was added | \n
Modified | \n1 | \nModel element was modified | \n
Deprecated | \n2 | \nModel element was deprecated | \n
The Link term is inspired by the atom:link
element, see RFC4287, and the Link
HTTP header, see RFC5988
Property | \nType | \nDescription | \n
---|---|---|
rel | \nString | \nLink relation type, see IANA Link Relations | \n
href | \nURL | \nURL of related information | \n
Derived Types:
\n\nProperty | \nType | \nDescription | \n
---|---|---|
Description | \nString? | \nDescription of the example value | \n
Property | \nType | \nDescription | \n
---|---|---|
Description | \nString? | \nDescription of the example value | \n
Value | \nPrimitiveType | \nExample value for the custom parameter | \n
Property | \nType | \nDescription | \n
---|---|---|
Description | \nString? | \nDescription of the example value | \n
Value | \nComplexType | \nExample value for the custom parameter | \n
Property | \nType | \nDescription | \n
---|---|---|
Description | \nString? | \nDescription of the example value | \n
Value | \nEntityType | \nExample value for the custom parameter | \n
Property | \nType | \nDescription | \n
---|---|---|
Description | \nString? | \nDescription of the example value | \n
ExternalValue | \nURL | \nUrl reference to the value in its literal format | \n
Property | \nType | \nDescription | \n
---|---|---|
code | \nString | \nMachine-readable, language-independent message code | \n
message | \nString | \nHuman-readable, language-dependent message text | \n
severity | \nMessageSeverity | \nSeverity of the message | \n
target | \nString? | \nA path to the target of the message detail, relative to the annotated instance | \n
details | \n[MessageType] | \nList of detail messages | \n
Type: String
\nAllowed Value | \nDescription | \n
---|---|
success | \nPositive feedback - no action required | \n
info | \nAdditional information - no action required | \n
warning | \nWarning - action may be required | \n
error | \nError - action is required | \n
Derived Types:
\n\nProperty | \nType | \nDescription | \n
---|---|---|
info | \nMessageType? | \nInformation about the exception | \n
Property | \nType | \nDescription | \n
---|---|---|
info | \nMessageType? | \nInformation about the exception | \n
value | \nString? | \nString representation of the exact value | \n
Property | \nType | \nDescription | \n
---|---|---|
info | \nMessageType? | \nInformation about the exception | \n
retryLink | \nURL? | \nA GET request to this URL retries retrieving the problematic instance | \n
Property | \nType | \nDescription | \n
---|---|---|
info | \nMessageType? | \nInformation about the exception | \n
failedOperation | \nDataModificationOperationKind | \nThe kind of modification operation that failed | \n
responseCode | \nInt16? | \nResponse code of the failed operation, e.g. 424 for a failed dependency | \n
Member | \nValue | \nDescription | \n
---|---|---|
insert | \n0 | \nInsert new instance | \n
update | \n1 | \nUpdate existing instance | \n
upsert | \n2 | \nInsert new instance or update it if it already exists | \n
delete | \n3 | \nDelete existing instance | \n
invoke | \n4 | \nInvoke action or function | \n
link | \n5 | \nAdd link between entities | \n
unlink | \n6 | \nRemove link between entities | \n
Type: Boolean
\nThis is the type to use for all tagging terms
\n\n\nFlag Member | \nValue | \nDescription | \n
---|---|---|
None | \n0 | \nNo permissions | \n
Read | \n1 | \nRead permission | \n
Write | \n2 | \nWrite permission | \n
ReadWrite | \n3 | \nRead and write permission | \n
Invoke | \n4 | \nPermission to invoke actions | \n
Property | \nType | \nDescription | \n
---|---|---|
Type | \nString | \nThe disposition type of the binary or stream value, see RFC 6266, Disposition Type | \n
Filename | \nString? | \nThe proposed filename for downloading the binary or stream value, see RFC 6266, Disposition Parameter: 'Filename' | \n
Type: String
\nThe qualified name of a term in scope.
\n\n\nType: String
\nThe qualified name of a type in scope.
\n\n\nType: String
\nThe qualified name of an action in scope.
\n\n\nType: String
\nThe qualified name of a bound action or function in scope.
\nEither
\n- \n
- the qualified name of an action, to indicate the single bound overload with the specified binding parameter type, \n
- the qualified name of a function, to indicate all bound overloads with the specified binding parameter type, or \n
- the qualified name of a function followed by parentheses containing a comma-separated list of parameter types, in the order of their definition, to identify a single function overload with the first (binding) parameter matching the specified parameter type. \n
Property | \nType | \nDescription | \n
---|---|---|
Key | \n[PropertyRef] | \nThe set of properties that make up this key | \n
Property | \nType | \nDescription | \n
---|---|---|
Name | \nPropertyPath | \nA path expression resolving to a primitive property of the entity type itself or to a primitive property of a complex or navigation property (recursively) of the entity type. The names of the properties in the path are joined together by forward slashes. | \n
Alias | \nString | \nA SimpleIdentifier that MUST be unique within the set of aliases, structural and navigation properties of the containing entity type that MUST be used in the key predicate of URLs | \n
A dictionary of name-value pairs. Names must be valid property names, values may be restricted to a list of types via an annotation with term Validation.OpenPropertyTypeConstraint
.
Property | \nType | \n
---|---|
Any simple identifier | \nAny type listed in Validation.OpenPropertyTypeConstraint , or any type if there is no constraint | \n
Property | \nType | \nDescription | \n
---|---|---|
DefaultValue | \nString? | \nDefault value for an optional parameter of primitive or enumeration type, using the same rules as the cast function in URLs.If no explicit DefaultValue is specified, the service is free on how to interpret omitting the parameter from the request. For example, a service might interpret an omitted optional parameter KeyDate as having the current date. | \n
Type: String
\nA string representing a Local Date-Time value with no offset.
\n\n\nType: String
\n\n\n\nA Feature Object represents a spatially bounded thing
\nProperty | \nType | \nDescription | \n
---|---|---|
geometry | \nGeometry? | \nLocation of the Feature | \n
properties | \nDictionary? | \nProperties of the Feature | \n
id | \nString? | \nCommonly used identifer for a Feature | \n