Smartstaff
281
edits
Changes
m
Currently Reports are the only entities exposed through Odata. In the future other entities may be added. Reports were chosen for the following reasons: # Easier to control security and data format such as fields and fieldname
Depending on the version of the ==Accessing a Report with OData required the endpoint will vary==SmartSimple OData support requests for data via HTTP GET request.Private and Public Endpoints exposes all collections (Reports enabled by OData Connector).
Version 4: https: //mysmartsimpleurl/Syntax below is an example to view OData/records from a report named '''V4my_Neo_Report'''/424623/Service.svc/
Version 3<pre>http: https//mysmartsimpleurl/OData/V2/pub/424623/Service.svc/my_Neo_Report_recordshttp: //mysmartsimpleurl/OData/'''V3'''/pub/424623/Service.svc/my_Neo_Report_recordshttp://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/my_Neo_Report_records</pre>
Version 2: https: ==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 /mysmartsimpleurl/>Column headers from a report with the following data types will not be successfully transformed in the OData/'''V2'''/424623/Service.svc/Report:
==Public access==* Display Only* Link* Read Only* Store Values
If you wish ==Syntax of OData Queries==1. Service Metadata Document - describes the data to be model exposed publicly then as HTTP endpoints by the different URL is used. Note the underlying report must be Internet and OData enabledservice.
Version 4: https<pre>http: //mysmartsimpleurl/OData/'''Pub'''V2/'''V4'''pub/424623/Service.svc/$metadata</pre>
Version 32. Search syntax i.e. criteria on report using “???”: https: //mysmartsimpleurl/the URL below returns OData/'''Pub'''/'''V3'''/424623/Service.svc/records with firstname equal ‘steve’ only
Version 2: https<pre>http: //mysmartsimpleurl/OData/'''PubV4/''''''V2'''pub/424623/Service.svc/report_Neo_records?$search=steve</pre>
==How to setup 3. Filter for dynamical search: the URL below returns OData from within SmartSimple==records with firstname equal ‘steve’ only (eq stands for equal in OData protocol)
For '''authenticated access''' you will need to create a new user with the Web <pre>http://mysmartsimpleurl/OData/V4/pub/424623/Service Client Access attribute.svc/report_Neo_records?$filter=first_name +eq+steve </pre>
# Create 4. Ordering: the new user and set access to Web Service Client Access.URL below orders by first name
# Set <pre>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</pre> 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> 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 password for this usercollection <pre> http://mysmartsimpleurl/OData/V4/pub/424623/Service.svc/report_Neo_records/$count</pre>
For public access there is no requirement ==Consuming SmartSimple OData Feed==The following examples show how to create a userconsume OData.
==Modifying a Report for Use with * [[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]]
# Edit the ==Troubleshooting==* Report in Neo Report Buildername '''must not''' contain special characters such as question marks, underscore, number sign. Some characters, such as hyphens, are supported.# Enable the OData checkbox on the Advanced tab# Enable the Internet Enabled checkbox * Column Headings '''if you wish the data to be publicmust 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.
→How to setup an authenticated user to consume a private OData Service
==What is OData?==
OData is described in the following article: [https://en.wikipedia.org/wiki/Open_Data_Protocol 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:
# Most clients wish to consume read only data
# Data relationships are handled in SmartSimple, the external client does not need to understand underlying data relationships # 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
# Greater flexible as the SmartSimple user is able to create dummy tables (similar to SQL views) by combining tables, applying formulas and aggregations
# 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.<br />
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===
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/<br />
Version 3: https: //mysmartsimpleurl/OData/'''V3'''/'''pri'''/424623/Service.svc/<br />
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/
==How to setup an authenticated user to consume a private OData Service==
For [[JSON API (SmartConnect) Prerequisite|'''authenticated access''']], you will need to create a new user with the API Access attribute.
# Create the new user and set access to API Access.
# Set a password for this user.
For public access there is no requirement to create a user.
=See Also=
* [[Reports: SmartSimple Reports]]* [[OData Connector]]* [http://www.odata.org More information on OData] [[Category:Integration]][[Category:API]]