Difference between revisions of "OData URIs"
From Lianjapedia
Yvonne.milne (Talk | contribs) (Created page with "''Under Construction'' ==See Also== OData Operators, ODATA_CREATE(), ODATA_DELETE(), ODATA_READ(), ODATA_UPDATE(), Working with JSON and JQL,[http://w...") |
Yvonne.milne (Talk | contribs) |
||
| Line 5: | Line 5: | ||
==OData URIs== | ==OData URIs== | ||
| − | The following arguments are available: | + | |
| + | ===Lianja Cloud Server=== | ||
| + | When used with the Lianja Cloud Server, the URI is formed as follows: | ||
| + | |||
| + | <pre><server>/odata/<database>/<table>?<arg1>&<arg2>&<arg3>...</pre> | ||
| + | |||
| + | e.g. | ||
| + | |||
| + | <pre>http://localhost:8001/odata/southwind/customers?$skip=10&$top=5</pre> | ||
| + | |||
| + | Or, if the Lianja Server is [[Lianja Server Manager on Windows#HTTP_Settings|listening on port 80]] or the [[ISAPI Extension for IIS]] is installed: | ||
| + | |||
| + | <pre>http://localhost/odata/southwind/customers?$skip=10&$top=5</pre> | ||
| + | |||
| + | ===OData Functions=== | ||
| + | When using the [[:Category:OData Functions|OData Functions]] from the Lianja App Builder Console or from a Lianja/VFP program (.prg), [[Visual FoxPro Server Pages|Lianja/VFP Server Page]] (.rsp) or [[JavaScript Server Pages|JavaScript Server Page]] (.jssp), the URI is formed as follows: | ||
| + | |||
| + | <pre>/<database>/<table>?<arg1>&<arg2>&<arg3>...</pre> | ||
| + | |||
| + | e.g. | ||
| + | |||
| + | <pre>/southwind/customers?$skip=10&$top=5</pre> | ||
| + | |||
| + | ===Arguments=== | ||
| + | The following URI arguments are available: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
Revision as of 12:29, 1 February 2017
Under Construction
See Also
OData Operators, ODATA_CREATE(), ODATA_DELETE(), ODATA_READ(), ODATA_UPDATE(), Working with JSON and JQL,Working with OData in Lianja Cloud Server
OData URIs
Lianja Cloud Server
When used with the Lianja Cloud Server, the URI is formed as follows:
<server>/odata/<database>/<table>?<arg1>&<arg2>&<arg3>...
e.g.
http://localhost:8001/odata/southwind/customers?$skip=10&$top=5
Or, if the Lianja Server is listening on port 80 or the ISAPI Extension for IIS is installed:
http://localhost/odata/southwind/customers?$skip=10&$top=5
OData Functions
When using the OData Functions from the Lianja App Builder Console or from a Lianja/VFP program (.prg), Lianja/VFP Server Page (.rsp) or JavaScript Server Page (.jssp), the URI is formed as follows:
/<database>/<table>?<arg1>&<arg2>&<arg3>...
e.g.
/southwind/customers?$skip=10&$top=5
Arguments
The following URI arguments are available:
| Argument | Description | Example |
|---|---|---|
| $callback | Specify a callback function that will wrap the data returned. This is used with JSONP calls to bypass SOP issues in the browser |
$callback=your_javascript_function |
| $count | Don't return any data just tell me how many records would have been selected | $count |
| $filter | Selects only those records that match the specified filter | $filter=contactname eq 'A' and amount gt 0 |
| $format | The output format | $format=ado $format=attachment $format=csv $format=excel $format=html $format=img $format=json $format=jsonarray $format=jsongrid |
| $metadata | Returns metadata describing the columns in the table; name, type, width and decimals. | $metadata |
| $nocount | Don't return the __count member which details the total number of rows that match the query. This improves performance on Virtual Tables |
$nocount |
| $orderby | Specify a column or expression that the data should be ordered by | $orderby=contactname |
| $rowid | Add the unique rowid into the output ( __rowid ) which can be used to update data later | $rowid |
| $select | Selects only the specified columns (or expressions) | $select=customerid,contactname |
| $skip | Skips a number of selected records | $skip=50 |
| $sql | Evaluate a SQL SELECT statement directly and return the results. | $sql=select * from customers |
| $top | Selects the specified number of records | $top=10 |
