https://github.com/4turesearchdata-carpentries/webapi4rdm
This repository contain information about a workshop on the API of 4TU.ResearchData for Research Data Management support staff.
https://github.com/4turesearchdata-carpentries/webapi4rdm
4turesearchdata api fetching-data-from-an-api upload-datasets
Last synced: 2 months ago
JSON representation
This repository contain information about a workshop on the API of 4TU.ResearchData for Research Data Management support staff.
- Host: GitHub
- URL: https://github.com/4turesearchdata-carpentries/webapi4rdm
- Owner: 4TUResearchData-Carpentries
- License: agpl-3.0
- Created: 2025-08-25T12:37:36.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-11-04T08:18:50.000Z (7 months ago)
- Last Synced: 2026-04-10T08:54:18.735Z (2 months ago)
- Topics: 4turesearchdata, api, fetching-data-from-an-api, upload-datasets
- Language: Jupyter Notebook
- Homepage:
- Size: 13.9 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# How RDM support staff can use the API of 4TU.ResearchData
Welcome to the **4TU.ResearchData API for Data supporters** workshop!
[](./schema-course.jsonld)
## 🚀 Workshop Overview
The idea of this workshop is to familiarize them with the main endpoints of the WebAPI for requesting, downloading, searching, and uploading datasets and software to the 4TU.ResearchData repository. The main target audience is the RDM support staff from the Dutch technical universities
The proposed schedule for a 3-hour session is:
Introduction (10 minutes)
Hands-on practice with the endpoints in the terminal (up to 2 hours, including one break)
Discussion and troubleshooting: time for questions and for addressing projects, issues, or challenges participants may already have within their faculties (1 hour)
## 📅 Schedule
Main topics:
- Fetching datasets, software, collections
- Searching and fetching data from authors
- Searching accounts within your institution
- Uploading
- Metadata uploading
- File uploading
- Submit for review
- Image preview
## 🛠 Prerequisites
Before attending the workshop, please ensure you have:
- (Required) Two private tokens in data.4tu.nl (main enviroment) and in next.data.4tu.nl (test environment)
- The `yq` a command-line YAML processor (similar syntax to `jq`).
- Linux
```bash
sudo apt-get update
sudo apt install yq
```
- macOS
```bash
brew install yq
```
- Windows (in powershell)
```bash
scoop install yq
```
or
```bash
choco install yq
```
- (Optional but nice to have) The `jq` program to render nicely json outputs:
- Linux
```bash
sudo apt-get update
sudo apt-get install -y jq
```
- macOS
```bash
brew install jq
```
- Windows
- If you’re using Git Bash or WSL, use the Linux instructions above.
- Otherwise, download the executable from the jq releases page (https://jqlang.org/download/) and add it to your PATH.
## 💡 License
This workshop material is licensed under **GNU AFFERO GENERAL PUBLIC LICENSE Version 3**. Feel free to share and modify the lesson according your needs.
--------------------------
Happy coding! 🎉