Difference between revisions of "Odata Overview"

From SmartWiki
Jump to: navigation, search
m (→‎How to setup an authenticated user to consume a private OData Service)
 
(58 intermediate revisions by one other user not shown)
Line 20: Line 20:
  
 
==OData Services Endpoints==
 
==OData Services Endpoints==
−
SmartSimple OData provides two endpoints (Service Root URL): Private and Public Access Endpoints.
+
SmartSimple OData provides two endpoints: Private and Public Access Endpoints.<br />
−
Endpoints will return a list of collections available for the OData service.
+
Endpoints will return a list of collections (Reports that are OData enabled).
 +
Enable [https://wiki.smartsimple.com/wiki/OData_Connector OData Connector] to use these endpoints.
  
 
===Private Access Endpoint===
 
===Private Access Endpoint===
−
A private endpoint will need basic authentication for '''authenticated access''' user to access the collection of entities.
+
A private endpoint will need basic authentication for '''authenticated access''' user to access the collection of entities.<br />
−
Version 4: https: //mysmartsimpleurl/OData/'''V4'''/'''pri'''/424623/Service.svc/
+
Version 4: https: //mysmartsimpleurl/OData/'''V4'''/'''pri'''/424623/Service.svc/<br />
−
Version 3: https: //mysmartsimpleurl/OData/'''V3'''/'''pri'''/424623/Service.svc/
+
Version 3: https: //mysmartsimpleurl/OData/'''V3'''/'''pri'''/424623/Service.svc/<br />
 
Version 2: https: //mysmartsimpleurl/OData/'''V2'''/'''pri'''/424623/Service.svc/
 
Version 2: https: //mysmartsimpleurl/OData/'''V2'''/'''pri'''/424623/Service.svc/
  
 +
===Public Access Endpoint===
 +
If you wish data to be exposed publicly without basic authentication. Note the underlying report must be Internet and OData enabled.<br />
 +
Version 4: https: //mysmartsimpleurl/OData/'''V4'''/'''pub'''/424623/Service.svc/<br />
 +
Version 3: https: //mysmartsimpleurl/OData/'''V3'''/'''pub'''/424623/Service.svc/<br />
 +
Version 2: https: //mysmartsimpleurl/OData/'''V2'''/'''pub'''/424623/Service.svc/
  
−
===Public Access Endpoint===
+
==How to setup an authenticated user to consume a private OData Service==
−
If you wish data to be exposed publicly without basic authentication. Note the underlying report must be Internet and OData enabled.
+
For [[JSON API (SmartConnect) Prerequisite|'''authenticated access''']], you will need to create a new user with the API Access attribute.
  
−
Version 4: https: //mysmartsimpleurl/OData/'''V4'''/'''Pub'''/424623/Service.svc/
+
# Create the new user and set access to API Access.
 +
# Set a password for this user.
  
−
Version 3: https: //mysmartsimpleurl/OData/'''V3'''/'''Pub'''/424623/Service.svc/
+
For public access there is no requirement to create a user.
  
−
Version 2: https: //mysmartsimpleurl/OData/'''V2'''/'''Pub'''/424623/Service.svc/
+
==Accessing a Report with OData==
 +
SmartSimple OData support requests for data via HTTP GET request.
 +
Private and Public Endpoints exposes all collections (Reports enabled by OData Connector).
  
−
==How to setup OData from within SmartSimple==
+
Syntax below is an example to view OData records from a report named '''my_Neo_Report''' 
−
For '''authenticated access''', you will need to create a new user with the Web Service Client Access attribute.
 
  
−
# Create the new user and set access to Web Service Client Access.
+
<pre>http://mysmartsimpleurl/OData/V2/pub/424623/Service.svc/my_Neo_Report_records
 +
http://mysmartsimpleurl/OData/V3/pub/424623/Service.svc/my_Neo_Report_records
 +
http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/my_Neo_Report_records</pre>
  
−
# Set a password for this user.
+
==OData Primitive Data Types==
 +
Primitive type representations in XML request is based on the [[Custom Field Type IDs|Data Type]] of the [[Standard Field|Standard Fields]] / [[Custom Fields – General Information|Custom Fields]]<br />
 +
Column headers from a report with the following data types will not be successfully transformed in the OData Service Report:
  
−
For public access there is no requirement to create a user.
+
* Display Only
 +
* Link
 +
* Read Only
 +
* Store Values
  
−
==Modifying a Report for Use with OData==
+
==Syntax of OData Queries==
−
# Edit the Report in Neo Report Builder
+
1. Service Metadata Document - describes the data model exposed as HTTP endpoints by the service.
−
# Enable the OData checkbox on the Advanced tab
 
−
# Enable the Internet Enabled checkbox '''if you wish the data to be public
 
  
 +
<pre>http://mysmartsimpleurl/OData/V2/pub/424623/Service.svc/$metadata</pre>
  
−
==Syntax==
+
2. Search syntax i.e. criteria on report using “???”: the URL below returns OData records with firstname equal ‘steve’ only
−
1. Search syntax i.e. criteria on report using “???”: the URL below returns OData records with firstname equal ‘steve’ only
 
  
−
<pre>http://localhost/OData/V4/pub/113/Service.svc/report_Neo_records?$search=steve</pre>
+
<pre>http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$search=steve</pre>
  
−
2. Filter for dynamical search: the URL below returns OData records with firstname equal ‘steve’ only (eq stands for equal in OData protocol)
+
3. Filter for dynamical search: the URL below returns OData records with firstname equal ‘steve’ only (eq stands for equal in OData protocol)
  
−
<pre>http://localhost/OData/V4/pub/113/Service.svc/report_Neo_records?$filter=first_name +eq+steve  </pre>
+
<pre>http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$filter=first_name +eq+steve  </pre>
  
−
3. Ordering: the URL below orders by first name
+
4. Ordering: the URL below orders by first name
  
−
<pre>http://localhost/OData/V4/pub/113/Service.svc/report_Neo_records?$orderby=first_name+asc  
+
<pre>http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$orderby=first_name+asc  
 
or   
 
or   
−
http://localhost/OData/V4/pub/113/Service.svc/report_Neo_records?$orderby=first_name
+
http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$orderby=first_name
 
</pre>
 
</pre>
  
−
4. $top and $skip, used mainly for pagination: The syntax below skips 3 records and return 2 records only (i.e. only 4th and 5th will return)
+
5. $top and $skip, used mainly for pagination: The syntax below skips 3 records and return 2 records only (i.e. only 4th and 5th will return)
  
−
<pre> ?$top=2&$skip=3</pre>
+
<pre> http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$top=2&$skip=3</pre>
 +
 
 +
6. $count, used to determine how many rows in a collection
 +
 
 +
<pre> http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records/$count</pre>
 +
 
 +
==Consuming SmartSimple OData Feed==
 +
The following examples show how to consume OData.
 +
 
 +
* [[SmartSimple_OData_Feed_to_Excel|Pulling OData feed to Excel]]
 +
* [[SmartSimple_OData_Feed_to_SQL_Server_Database|Import OData feed to SQL Server Database using SQL Server Integration Services]]
  
 
==Troubleshooting==
 
==Troubleshooting==
−
* Column Headings '''must not''' contain special characters such as question marks or brackets. Some characters, such as hyphens, are supported.
+
* Report name '''must not''' contain special characters such as question marks, underscore, number sign. Some characters, such as hyphens, are supported.
 +
* Column Headings '''must not''' contain special characters such as question marks, number sign or brackets. Some characters, such as hyphens, are supported.
 
* Some applications, such as older versions of MS Excel / .NET , may not support the appropriate level of TLS Encryption (i.e. https) required.
 
* Some applications, such as older versions of MS Excel / .NET , may not support the appropriate level of TLS Encryption (i.e. https) required.
  
 
=See Also=
 
=See Also=
−
* [[Reports]]
+
* [[Reports: SmartSimple Reports]]
 +
* [[OData Connector]]
 +
* [http://www.odata.org More information on OData]
 +
 
 +
[[Category:Integration]][[Category:API]]

Latest revision as of 10:06, 8 April 2024

What is OData?

OData is described in the following article: Wikipedia article.

OData provides clients with the ability to publish their data to their communities. It's as if each clients has their own API for their own communities. For example, a client can expose their annual grant/funding information so tax payers can retrieve in real time data for further analysis.

How does it work

SmartSimple provides OData V2, V3 and V4 services.

These can be consumed by OData clients such as MS Excel, MS SQL server, SaleForce, or used though another API such as .NET.

SmartSimple Entities Exposed to OData Services

Currently Reports are the only entities exposed through Odata. In the future other entities may be added. Reports were chosen for the following reasons:

  1. Easier to control security and data format such as fields and fieldname
  2. Most clients wish to consume read only data
  3. Data relationships are handled in SmartSimple, the external client does not need to understand underlying data relationships
  4. Easy to implement as there is no need to configure OData service and metadata endpoints (as required by the OData protocol), these are automatically handled by the SmartSimple Report Engine
  5. Greater flexible as the SmartSimple user is able to create dummy tables (similar to SQL views) by combining tables, applying formulas and aggregations
  6. Filtering and ordering are pre-defined in SmartSimple Report, eliminate SQL injection vulnerability

OData Services Endpoints

SmartSimple OData provides two endpoints: Private and Public Access Endpoints.
Endpoints will return a list of collections (Reports that are OData enabled). Enable OData Connector to use these endpoints.

Private Access Endpoint

A private endpoint will need basic authentication for authenticated access user to access the collection of entities.
Version 4: https: //mysmartsimpleurl/OData/V4/pri/424623/Service.svc/
Version 3: https: //mysmartsimpleurl/OData/V3/pri/424623/Service.svc/
Version 2: https: //mysmartsimpleurl/OData/V2/pri/424623/Service.svc/

Public Access Endpoint

If you wish data to be exposed publicly without basic authentication. Note the underlying report must be Internet and OData enabled.
Version 4: https: //mysmartsimpleurl/OData/V4/pub/424623/Service.svc/
Version 3: https: //mysmartsimpleurl/OData/V3/pub/424623/Service.svc/
Version 2: https: //mysmartsimpleurl/OData/V2/pub/424623/Service.svc/

How to setup an authenticated user to consume a private OData Service

For authenticated access, you will need to create a new user with the API Access attribute.

  1. Create the new user and set access to API Access.
  2. Set a password for this user.

For public access there is no requirement to create a user.

Accessing a Report with OData

SmartSimple OData support requests for data via HTTP GET request. Private and Public Endpoints exposes all collections (Reports enabled by OData Connector).

Syntax below is an example to view OData records from a report named my_Neo_Report  

http://mysmartsimpleurl/OData/V2/pub/424623/Service.svc/my_Neo_Report_records
http://mysmartsimpleurl/OData/V3/pub/424623/Service.svc/my_Neo_Report_records
http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/my_Neo_Report_records

OData Primitive Data Types

Primitive type representations in XML request is based on the Data Type of the Standard Fields / Custom Fields
Column headers from a report with the following data types will not be successfully transformed in the OData Service Report:

  • Display Only
  • Link
  • Read Only
  • Store Values

Syntax of OData Queries

1. Service Metadata Document - describes the data model exposed as HTTP endpoints by the service. 

http://mysmartsimpleurl/OData/V2/pub/424623/Service.svc/$metadata

2. Search syntax i.e. criteria on report using “???”: the URL below returns OData records with firstname equal ‘steve’ only 

http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$search=steve

3. Filter for dynamical search: the URL below returns OData records with firstname equal ‘steve’ only (eq stands for equal in OData protocol) 

http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$filter=first_name +eq+steve

4. Ordering: the URL below orders by first name 

http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$orderby=first_name+asc 
or  
http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$orderby=first_name

5. $top and $skip, used mainly for pagination: The syntax below skips 3 records and return 2 records only (i.e. only 4th and 5th will return) 

 http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records?$top=2&$skip=3

6. $count, used to determine how many rows in a collection 

 http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records/$count

Consuming SmartSimple OData Feed

The following examples show how to consume OData.

Troubleshooting

  • Report name must not contain special characters such as question marks, underscore, number sign. Some characters, such as hyphens, are supported.
  • Column Headings must not contain special characters such as question marks, number sign or brackets. Some characters, such as hyphens, are supported.
  • Some applications, such as older versions of MS Excel / .NET , may not support the appropriate level of TLS Encryption (i.e. https) required.

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Odata_Overview&oldid=42505’