API Endpoint: getDatasetFile (bestand opvragen)

Gewijzigd op Wo, 22 Jan, 2025 om 5:02 PM

API Endpoint: `getDatasetFile`

Overzicht

De getDatasetFile-endpoint biedt toegang tot specifieke bestanden binnen datasets die zijn opgeslagen op het Georizon-platform. Deze endpoint is ontworpen om ontwikkelaars en gebruikers van de API eenvoudige en efficiënte toegang te bieden tot datasetbestanden.

URL

https://georizon.nl/api/storage#/operations/getDatasetFile

Functionaliteit

Met deze endpoint kun je:

Een bestand ophalen uit een dataset.
Filteren op specifieke datasetparameters.
Veilig bestanden downloaden met geautoriseerde toegang.

Aanroepen van de Endpoint

HTTP Methode

GET

Headers

Header	Vereist?	Beschrijving
`Authorization`	Ja	Bevat een geldige API-token.

Query Parameters

Parameter	Vereist?	Beschrijving
`datasetId`	Ja	Unieke identificatie van de dataset.
`fileId`	Ja	Unieke identificatie van het bestand.
`fileFormat`	Optioneel	Gewenst bestandsformaat (bijv. `json`, `csv`).

Voorbeeld van een API-aanroep

cURL

curl --request GET \  --url https://storage.georizon.nl/tenant/{tenantId}/datasets/{datasetId}/files/path/to/file.jpg \  --header 'Accept: application/octet-stream' \  --header 'If-None-Match: ' \  --header 'Range: '

Voorbeeld-URL

https://georizon.nl/api/storage/datasets/files?datasetId=12345&fileId=67890&fileFormat=json

Mogelijke Reacties

Succes

Statuscode	Beschrijving
`200 OK`	Het bestand is succesvol opgehaald.

Respons Voorbeeld (`200 OK`)

{  "fileName": "voorbeeld.json",  "fileSize": 2048,  "fileContent": "{...}" }

Fouten

Statuscode	Beschrijving
`400 Bad Request`	Verkeerde of ontbrekende parameters.
`401 Unauthorized`	Geen geldige autorisatie of verlopen API-token.
`404 Not Found`	Dataset of bestand niet gevonden.
`500 Internal Server Error`	Er is iets misgegaan aan de serverzijde.

Voorbeeld Foutrespons (`404 Not Found`)

{  "error": "Dataset of bestand niet gevonden." }

Veelgestelde Vragen

Hoe vraag ik een API-token aan?

Om een API-token te verkrijgen, neem contact op met de beheerder van Georizon of registreer je via het Georizon-platform.

Wat moet ik doen bij een `500 Internal Server Error`?

Controleer of je aanroep correct is geconfigureerd. Neem contact op met support als het probleem blijft aanhouden.

Disclaimer

Zorg ervoor dat je API-token en datasetinformatie beveiligd blijven. Onbevoegd gebruik van de API kan leiden tot blokkering van toegang.