APIkit OData Extension Reference
The Entity Data Model (EDM) that you create using RAML is the basis for building an OData API. You use EDM-compatible data types to create the
odata.raml file, as described in this reference. After generating flows using the APIkit OData Extension, you need to implement API endpoints.
Entity Data Model
The APIkit OData Extension builds the OData API based on an
odata.raml file that describes the OData entity data model (EDM) using supported EDM types. The
odata.raml file is a RAML Library. Each DataType represents an EntityModel. For example:
#%RAML 1.0 Library uses: odata: !include libraries/odata.raml types: Employee: properties: id: type: integer (odata.key): bool (odata.nullable): bool name: type: string
Annotate at least one of the properties on each entity using the annotation (odata.key).
The following annotations pertain to each property:
(odata.precision): int (odata.scale): int
Use the optional (odata.remote) annotation to provide the name of the entity in the remote data source:
types: Employee: (odata.remote): SAP_VBAK properties: ...
Supported EDM Data Types
The APIkit OData Extension supports all EDM types except Edm.Sbyte. In your model, you define the RAML types that map to the EDM type shown in the following list of supported EDM types:
The Boolean data type is used to represent the mathematical concept of binary valued logic. There are no applicable facets for this type.
The Double type represents a floating point number with 15 digits precision that can represent values with an approximate range of ± 2.23e -308 through ± 1.79e +308.
The Single type represents a floating point number with seven digits precision that can represent values with an approximate range of ± 1.18e -38 through ± 3.40e +38
The binary data type is used to represent fixed or variable length binary data.
The DateTime type represents date and time with values ranging from 12:00:00 midnight, January 1, 1753 A.D. through 11:59:59 P.M, December 31, 9999 A.D.
The Int64 type represents a signed 64-bit integer value.
The Int16 type represents a signed 16-bit integer value.
The Byte type represents an unsigned 8-bit integer value.
The Decimal type represents numeric values with fixed precision and scale. You can specify the required precision and scale by modifying these optional properties. This type can describe a numeric value ranging from negative 10^255 + 1 to positive 10^255 -1.
The globally unique identifier (GUID) type represents a 16-byte (128-bit) number compliant with the UUID standard (RFC 4122).
The Time type represents the time of day with values ranging from 0:00:00.x to 23:59:59.y, where x and y depend upon the precision.