Changes

Odata Overview

285 bytes added, 17:41, 7 May 2018

no edit summary

==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:

==OData Services Endpoints==

Depending on the version of the SmartSimple OData required the endpoint will varyprovides two endpoints (Service Root URL): Private and Public Access Endpoints. Version 4: https: //mysmartsimpleurl/Endpoints will return a list of collections available for the OData/'''V4'''/424623/Serviceservice.svc/

===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/

Version 2: https: //mysmartsimpleurl/OData/'''V2'''/424623/Service.svc/

===Public accessAccess Endpoint===If you wish the data to be exposed publicly then the different URL is usedwithout basic authentication. Note the underlying report must be Internet and OData enabled.

Version 4: https: //mysmartsimpleurl/OData/'''PubV4'''/'''V4Pub'''/424623/Service.svc/

Version 3: https: //mysmartsimpleurl/OData/'''PubV3'''/'''V3Pub'''/424623/Service.svc/

Version 2: https: //mysmartsimpleurl/OData/'''Pub/V2'''/'''V2Pub'''/424623/Service.svc/

==How to setup OData from within SmartSimple==

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.

# Enable the OData checkbox on the Advanced tab

# Enable the Internet Enabled checkbox '''if you wish the data to be public

'''

 

<pre>http://localhost/OData/V4/pub/113/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)

==Troubleshooting==

* Column Headings '''must not''' contain special characters such as question marks 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=

* [[Reports]]

• ← Older edit
• Newer edit →

Lalaine Songalia

Smartstaff

1,385

edits