nodegoat API
CORE AdminAs a result of our cooperation with nodegoat's institutional partners, we have been able to develop a RESTful API for nodegoat.
The API provides an additional interface to query and store data to your Projects in nodegoat. We have integrated the API with nodegoat's core functionalities and have optimised it for large operations. The API can also be used to update the data Model, which allows you to update specific attributes of a Type, or upload a whole data Model with multiple Type templates in one go.
You can use the Project settings to configure what parts of your data are exposed through the API. The API can be configured to require authentication or allow for public access.
Documentation for the API is available via the nodegoat Documentation. To learn how you can query your data to use it in other applications, see: https://nodegoat.gitbooks.io/documentation/content/usage/API/query.html. To learn about storing your data using the API, see: https://nodegoat.gitbooks.io/documentation/content/usage/API/store.html.
In case you want to use the API with your own research data, get in touch!
We have enabled the API for a demo domain. You can access this domain by logging in to nodegoat.net with the username 'demo' and password 'demo'. The following cURL commands give you a JSON package with the information that has been entered on the French intellectual Ernest Renan. You can also click on the URL to view the output in your web browser.
curl http://demo.nodegoat.io/project/1/data/type/4/object?search=renan -X GETor
curl http://demo.nodegoat.io/ngAQ3A96sAJ3kMmZiAQD3 -X GEToutput:
{
"info": "Welcome to the nodegoat Data API. For more information visit https://nodegoat.net/documentation.p/usage/API/.",
"timestamp": "2017-08-07T19:27:44+00:00",
"authenticated": false,
"data": {
"objects": {
"220839": {
"object": {
"nodegoat_id": "ngAQ3A96sAJ3kMmZiAQD3",
"object_id": 220839,
"object_name": "Renan Ernest",
"object_name_plain": "",
"object_name_style": [],
"object_style": [],
"object_sources": [],
"object_version": "",
"object_dating": "2014-06-04 02:04:29",
"object_locked": null
},
"object_definitions": {
"10": {
"object_description_id": 10,
"object_definition_ref_object_id": null,
"object_definition_value": "Renan",
"object_definition_sources": [],
"object_definition_style": []
},
"9": {
"object_description_id": 9,
"object_definition_ref_object_id": null,
"object_definition_value": "Ernest",
"object_definition_sources": [],
"object_definition_style": []
},
"29": {
"object_description_id": 29,
"object_definition_ref_object_id": null,
"object_definition_value": "ERn",
"object_definition_sources": [],
"object_definition_style": []
},
"31": {
"object_description_id": 31,
"object_definition_ref_object_id": null,
"object_definition_value": "http://fr.wikipedia.org/wiki/Ernest_Renan",
"object_definition_sources": [],
"object_definition_style": []
},
"203": {
"object_description_id": 203,
"object_definition_ref_object_id": null,
"object_definition_value": "100170528",
"object_definition_sources": [],
"object_definition_style": []
}
},
"object_subs": {
"198456": {
"object_sub": {
"object_sub_id": 198456,
"object_sub_details_id": 5,
"object_sub_date_start": 18230228,
"object_sub_date_end": 18230228,
"object_sub_location_lat": 48.78332901,
"object_sub_location_long": -3.23333001,
"object_sub_location_latlong_ref_object_id": 44669,
"object_sub_location_latlong_ref_type_id": 5,
"object_sub_location_ref_object_id": 44669,
"object_sub_location_ref_type_id": 5,
"object_sub_location_ref_object_sub_details_id": 57,
"object_sub_location_ref_object_name": "Tréguier (FR)",
"object_sub_location_type": "reference",
"object_sub_sources": [],
"object_sub_version": "",
"object_sub_style": []
},
"object_sub_definitions": []
},
"198457": {
"object_sub": {
"object_sub_id": 198457,
"object_sub_details_id": 6,
"object_sub_date_start": 18921002,
"object_sub_date_end": 18921002,
"object_sub_location_lat": 48.85340881,
"object_sub_location_long": 2.34879994,
"object_sub_location_latlong_ref_object_id": 47086,
"object_sub_location_latlong_ref_type_id": 5,
"object_sub_location_ref_object_id": 47086,
"object_sub_location_ref_type_id": 5,
"object_sub_location_ref_object_sub_details_id": 57,
"object_sub_location_ref_object_name": "Paris (FR)",
"object_sub_location_type": "reference",
"object_sub_sources": [],
"object_sub_version": "",
"object_sub_style": []
},
"object_sub_definitions": []
}
}
}
}
}
}
Comments
Add Comment