OData Feed URLs: Difference between revisions
No edit summary |
No edit summary |
||
| (20 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
OdataLink will expose your [[Data Files|data files]] data using [[OData]] compliant URLs. | |||
There are three types of URLs: | |||
* Service URL | |||
* Meta Data Url | |||
* Data URL | |||
The syntax is as follows: | OdataLink's URLs ensures that each [[Account|account]] will have different URLs so as to protect your organisation's data. | ||
''https:://< | |||
It also ensures that each [[Models|model]] will have different URLs so as to control how they can be used. | |||
= Service URLs = | |||
The service URLs are the main will you will use directly and exposes all [[Endpoints|endpoints]] for a given [[Models|model]] and [[Data Files|data file]]. | |||
The syntax is as follows: <br /> | |||
''<nowiki>https::// servername / account code / model code / data file code</nowiki>'' | |||
'''Example''' <br /> | |||
''<nowiki>https://nodata.odatalink.com/test-account/test-model/test-data-file/</nowiki>'' | |||
= Meta Data URLs = | |||
The meta data URLs are not used directly but exist to specify the meta data for the data urls. It catalogues all the objects and fields. | |||
The syntax is as follows: <br /> | |||
''<nowiki>https::// servername / account code / model code / data file code / $metadata</nowiki>'' | |||
'''Example''' <br /> | |||
''<nowiki>https://nodata.odatalink.com/test-account/test-model/test-data-file/$metadata</nowiki>'' | |||
= Data URLs = | |||
The data URLs exposes a single [[Endpoints|endpoints]] for a given [[Models|model]] and [[Data Files|data file]]. | |||
The syntax is as follows: <br /> | |||
''<nowiki>https::// servername / account code / model code / data file code / endpoint</nowiki>'' | |||
'''Example''' <br /> | |||
''<nowiki>https://nodata.odatalink.com/test-account/test-model/test-data-file/accounts</nowiki>'' | |||
= URL parts = | |||
; Account Code | ; Account Code | ||
: This is the code generated for your [[ | : This is the code generated for your [[Account|account]]. | ||
; Model Code | ; Model Code | ||
: These are the codes generated for your [[Models|models]]. | : These are the codes generated for your [[Models|models]]. | ||
| Line 14: | Line 55: | ||
; Endpoint | ; Endpoint | ||
: These are the endpoints you chose to include for your [[Models|models]]. | : These are the endpoints you chose to include for your [[Models|models]]. | ||
= Related Topics = | = Related Topics = | ||
[[ | [[Managing my account]] <br /> | ||
[[Configuring models]] <br /> | [[Configuring models]] <br /> | ||
[[Configuring data files]] <br /> | [[Configuring data files]] <br /> | ||
[[ | [[Integrating with OdataLink]] <br /> | ||
[[Account]] <br /> | |||
[[Models]] <br /> | [[Models]] <br /> | ||
[[Data Files]] <br /> | [[Data Files]] <br /> | ||
[[Endpoints]] <br /> | [[Endpoints]] <br /> | ||