You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/integration/odata-services/published-odata-services/_index.md
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,9 @@ In Studio Pro, entities can be exposed as [OData resources](/refguide/published-
12
12
13
13
A published OData service is a REST service with an OpenAPI contract, which means that OpenAPI compatible REST clients can easily interact with it.
14
14
15
-
The standards used for OData in Mendix are:
15
+
The standard used for OData in Mendix is [OData version 4](http://www.odata.org/documentation), which returns data in JSON format.
16
16
17
-
*[OData version 3](http://www.odata.org/documentation/odata-version-3-0), which returns data in Atom XML format.
18
-
*[OData version 4](http://www.odata.org/documentation), which returns data in JSON format.
17
+
The option to publish [OData version 3](http://www.odata.org/documentation/odata-version-3-0) services, which return data in Atom XML format, is deprecated and will be removed in a future version.
19
18
20
19
Not all parts of the standard are implemented. If something is not documented here, it is has not yet been added.
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/integration/odata-services/published-odata-services/odata-query-options.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ For this example, imagine that you have four entities in your domain model: **Em
30
30
* An association between **Employee** and **Address**
31
31
* An association between **City** and **Address**
32
32
33
-
Associated objects can be retrieved by passing the `$expand` query parameter. For example: `/odata/myservice/v1/Employees?$expand=Cars,Address($expand=City)` (OData 4) or `/odata/myservice/v1/Employees?$expand=Cars,Address/City` (OData 3).
33
+
Associated objects can be retrieved by passing the `$expand` query parameter. For example: `/odata/myservice/v1/Employees?$expand=Cars,Address($expand=City)` (OData 4) or `/odata/myservice/v1/Employees?$expand=Cars,Address/City` (OData 3 (deprecated)).
34
34
35
35
## 3 Counting the Number of Objects
36
36
@@ -42,7 +42,7 @@ You can find out how many objects there are by passing the `$count` query option
42
42
43
43
For OData 4, by setting the `$count` query option to `true`, a count of the number of items returned will be included in the result. For example: `?$count=true`.
44
44
45
-
For OData 3, by setting the `$inlinecount` query option to `allpages`, a count of the number of items returned will be included in the result. For example: `?$inlinecount=allpages`.
45
+
For OData 3 (deprecated), by setting the `$inlinecount` query option to `allpages`, a count of the number of items returned will be included in the result. For example: `?$inlinecount=allpages`.
46
46
47
47
## 4 Filtering
48
48
@@ -56,7 +56,7 @@ This table describes how to pass values for different attribute types:
56
56
| --- | --- |
57
57
| String | Enclosed in single quotes (for example, `'John'`) |
58
58
| Enumeration | The enumeration member name between single quotes, prefixed with the enum type (for example, `DefaultNamespace.PrimaryColor'Red'`). OData v4.01 syntax without the qualified enum type name is not supported |
59
-
| Datetime | For OData 4: a plain value (for example, `2021-12-31`). For OData 3: Preceded with `datetime` and enclosed in single quotes (for example, `datetime'2021-12-31'` or `datetime'<epoch value here>'`) |
59
+
| Datetime | For OData 4: a plain value (for example, `2021-12-31`). For OData 3 (deprecated): Preceded with `datetime` and enclosed in single quotes (for example, `datetime'2021-12-31'` or `datetime'<epoch value here>'`) |
60
60
| Other | Plain value (for example, 15) |
61
61
62
62
### 4.2 Comparison Operators
@@ -97,7 +97,7 @@ We support the following comparison operators:
97
97
| minute |`/Employees?$filter=minute(Registration) eq 55`| All employees registered on the 55th minute of any hour |
98
98
| second |`/Employees?$filter=second(Registration) eq 55`| All employees registered on the 55th second of any minute of any hour |
99
99
100
-
<small><sup>1</sup> In OData 3, the `contains` function is called `substringof`, and its arguments are reversed For example, `/Employees?$filter=substringof('f', Name)`</small>
100
+
<small><sup>1</sup> In OData 3 (deprecated), the `contains` function is called `substringof`, and its arguments are reversed For example, `/Employees?$filter=substringof('f', Name)`</small>
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/integration/odata-services/published-odata-services/published-odata-attribute.md
-2Lines changed: 0 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -40,8 +40,6 @@ The type of the attribute.
40
40
41
41
This field is shown when the type is an enumeration that was previously exposed as a string, and only for OData version 4. Change the value to **Enumeration** to publish the enumeration. This informs clients of the possible values of this attribute.
42
42
43
-
In Studio Pro 9.23 and below, enumeration attributes were published as strings.
44
-
45
43
### 2.7 Capabilities
46
44
47
45
Select **Sortable** to allow clients to sort results based on this attribute.
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/integration/odata-services/wrap-services-odata.md
-4Lines changed: 0 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -116,10 +116,6 @@ When you use a microflow to provide data, any security constraints are applied t
116
116
117
117
If the **ODataResponse** is present as a microflow parameter, then it will return the **Count** attribute value regardless of the result list of objects. Otherwise, it will return -1 for not defined, which is the default value. A **Count** value of 0 means that there no record.
118
118
119
-
{{% alert color="info" %}}
120
-
In Studio Pro [9.17](/releasenotes/studio-pro/9.17/) and above, the count value can be stored in the `ODataResponse` object.
121
-
{{% /alert %}}
122
-
123
119
## 5 Key Selection When Exposing Entities as OData Resources {#select-key}
124
120
125
121
Select which attribute(s) to use as a [key](/refguide/published-odata-resource/#key) when exposing an entity as Published OData Resource so that clients will be able to identify objects returned by the service.
0 commit comments