Difference between revisions of "OData Feed URLs"
| (24 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 | |||
OdataLink's URLs ensures that each [[Account|account]] will have different URLs so as to protect your organisation's data. | |||
The syntax is as follows: | It also ensures that each [[Models|model]] will have different URLs so as to control how they can be used. | ||
https::// '' | |||
= 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 16: | 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 /> | ||
Latest revision as of 19:44, 3 February 2021
OdataLink will expose your data files data using OData compliant URLs.
There are three types of URLs:
- Service URL
- Meta Data Url
- Data URL
OdataLink's URLs ensures that each account will have different URLs so as to protect your organisation's data.
It also ensures that each 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 for a given model and data file.
The syntax is as follows:
https::// servername / account code / model code / data file code
Example
https://nodata.odatalink.com/test-account/test-model/test-data-file/
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:
https::// servername / account code / model code / data file code / $metadata
Example
https://nodata.odatalink.com/test-account/test-model/test-data-file/$metadata
Data URLs
The data URLs exposes a single endpoints for a given model and data file.
The syntax is as follows:
https::// servername / account code / model code / data file code / endpoint
Example
https://nodata.odatalink.com/test-account/test-model/test-data-file/accounts
URL parts
- Account Code
- This is the code generated for your account.
- Model Code
- These are the codes generated for your models.
- Data File Code
- These are the codes generated for your data files.
- Endpoint
- These are the endpoints you chose to include for your models.
Related Topics
Managing my account
Configuring models
Configuring data files
Integrating with OdataLink
Account
Models
Data Files
Endpoints