NOTE => If you are going to run semantic-engine in your individual environment 'FOR VERY FIRST TIME ONLY" , please add add environment variables "APP_NODE=YOUR NODE: and "APP_KEY=YOUR KEY" to your container command . Also , please add previous environemnt variables if you are running semantic-engine very first time and not if you are already registered to federated network , also please run semantic-engine at port 8082 only .
The semantic engine is a data microservice, which can interact with other services of the i3-Market for data offering registration. The semantic engine also provides necessary information such as contract parameters, pricing models, etc for other services and users. The repository of the semantic engine on the i3-Market gitlab can be found here . The Swagger reference of the semantic engine itself can be found here
The semantic engine provides necessary API endpoints in relation to the data offering purpose of the i3Market. Details of each API endpoint can be found in the following sections.
- User registration with the semantic engine:
POST /api/registration/
Example of user registration is shown below:
{
"providerId": "uiot-provider",
"name": "My name",
"description": "This is UIoT data Provider",
"organization": {
{
"organizationId": "NUIGP1",
"name": "National University of Ireland Galway",
"description": "Education Organisation",
"address": "University Road, Galway",
"contactPoint": "chihung.le@nuigalway.ie"
}
}
}
- Data offering registration with the semantic engine
POST /api/registration/data-offering
A sample of a data offering can be found here in a JSON data format.
- Update an existing data offering:
PATCH /api/registration/update-offering
- Get a list of providers using category:
GET /api/registration/providers{category}/category
- Get a list of all providers:
GET/api/registration/provider-list
- Get a number of total offerings for a specific data provider. This number would be helpful for loading pages in a Web UI Application:
GET/api/registration/offerings/{providerId}/totalOfferings
- Get a number of total offerings for a specific data provider at a specific category. This number would be helpful for loading pages in a Web UI Application:
GET/api/registration/offerings/category={category}/providerId={providerId}
- Get a list of offeringId:
GET/api/registration/offering-list
- Get a list of data offering by data providerId:
GET/api/registration/offering/{id}/providerId
- Get a list of data offering by data offeringId:
GET/api/registration/offering/{id}/offeringId
- Get a list of active offering by category
```/ActiveOfferingByCategory/{category}``
- Get a list of active offering by provider
````/ActiveOfferingByProvider/{id}/providerId```
- Get a list of Offerings searched via text/keyword
```/textSearch/text/{text}``
- Get a list of offerings on shared network
```/offerings-list/on-SharedNetwork``
- Get a list of all active offerings
```/offerings-list/on-active``
- Get a list of offerings by category in network
```/federated-offering/{category}``
- Get a list of offerings in a network
```/federated-offerings-list``
- Get active offerings in a network
```/federated-offerings-list/on-Active``
- Get offering list in a network
```/federated-offering/{id}/offeringId``
-Get offering list by Provider in a network
```/federated-offering/{id}/providerId``
- Get a list of offerings via text search in a network
```/federated-offering/textSearch/text/{text}``
- Get a list of data offering by category. This API will getch data from all node, e.g. in this case where have four nodes 244, 249, 250, and 251:
GET/api/registration/offering/{category}
- Download a template of the data offering in the JSON (JavaScript Object Notation) format. This might be helpfull in some case, e.g. convert from this JSON file into a Java Class:
GET/api/registration/offering/offering-template
- Get contract parameters object of a data offering by data offeringId:
GET/api/registration/contract-parameter/{offeringId}/offeringId
- Get a list of category from distributed storage at its original API endpoint click here :
GET/api/registration/categories-list
- Delete a data offering by data offeringid. This will delete all information of a data offering from the database:
DELETE/api/registration/delete-offering/{offeringId}
-
If you would like to get accessed to the semantic engine through the Backplane, please refer to the Backplane specification defined in this developer portal.
-
Similarly, you would like to get accessed to the semantic engine through the SDK-RI, please refer to the SDK-RI specification defined in this developer portal.
Achille: achille.zappa@insight-centre.org
or
Mirza: mirza.fardeenbaig@insight-centre.org
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to http://unlicense.org/