|
Purpose
Pass dynamic values in OData API calls
Dynamic values such as keys and filter conditions are passed into GuiXT OData API calls through one of four parameter types, depending on context: key:=, filter:=, parameters:=, headerVariables:=. Which one to use depends on the specific service call being made.
The GuiXT OData API follows the OData specification, with a few SAP-specific conventions layered on top.
|
|
| API Call |
key:= |
filter:= |
parameters:= |
headerVariables:= |
| odata.read |
Key for single-record access |
Condition for set (multi-record) access |
- |
Used only in exceptional cases |
| odata.create |
Not used directly. If the object key must be set on create (i.e. not assigned
automatically by the system), it is part of the data payload itself, e.g. a material number under external number assignment.
|
- |
- |
Used only in exceptional cases |
| odata.update |
Full key of the object to update |
- |
- |
Used only in exceptional cases |
| odata.delete |
Full key of the object to delete |
- |
- |
Used only in exceptional cases |
| odata.execute |
- |
- |
Parameters for a FunctionImport or Action |
Used instead of parameters for upload/download, to specify the keys
|
|
|
Request generation by GuiXT
| Parameter |
Where it goes |
Format |
Notes |
| key:= |
Appended to the URL in parentheses |
('value') for a single, unnamed key,
or (name1='value1',name2='value2',...) for a composite key
|
Single-quote characters inside values are doubled by the interface when it builds the string literal.
|
| filter:= |
Query options |
OData v4 filter expression (string) |
- |
| headerVariables:= |
Request header, as name/value pairs |
name/value pairs |
Values are automatically URI-encoded (umlauts etc.).
|
| parameters:= |
Query options |
name1='value1'&name2='value2'&...
|
Single-quote characters inside values are doubled by the interface when it builds the string literal.
|
Components InputAssistant + GuiXT Controls
|