Maak een project

Een project is de eenheid van werk in Data Studio: een organisatie-gebonden werkruimte die de datasets bevat die je toevoegt en de configuratie die je erop bouwt. Deze pagina behandelt het maken van een project en de per-project eindpunten die het beheren.

Eindpunt

POST /v1/organization/:organizationId/data-studio/projects

Authenticatie

Net als alle Data Studio eindpunten, gebruikt dit een Bearer JWT (zie Authenticatie), niet X-API-Key. Het creëren of wijzigen van projecten vereist:

• lidmaatschap in de organisatie,
• de DATA_STUDIO_CREATE organisatie permissie (lezen vereist alleen DATA_STUDIO_ACCESS), en
• de data-studio add-on op de organisatie.

Verzoek

Stuur een JSON-body. Alleen name is vereist; description is optioneel.

curl -X POST \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Hotels nabij Restaurants",
    "description": "Hospitality clusters in de Randstad"
  }' \
  "https://api.topolab.nl/v1/organization/8f0c2e1a-4b6d-4c2a-9e3f-1a2b3c4d5e6f/data-studio/projects"

Veld	Type	Verplicht	Beschrijving
name	string	ja	Projectnaam, tot 255 tekens.
description	string	nee	Vrije tekst beschrijving.

Antwoord

Het gemaakte project wordt teruggegeven met zijn gegenereerde id. Een nieuw project begint in draft status, private zichtbaarheid, en is ontgrendeld.

{
  "id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
  "name": "Hotels nabij Restaurants",
  "description": "Hospitality clusters in de Randstad",
  "status": "draft",
  "visibility": "private",
  "isLocked": false,
  "createdById": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
  "createdAt": "2026-05-29T10:00:00.000Z"
}

Bewaar de id — elk ander per-project eindpunt is daarop gebaseerd.

Een project beheren

Eenmaal gemaakt, kan een project worden gelezen, bijgewerkt en verwijderd via deze eindpunten (dezelfde auth-regels — DATA_STUDIO_ACCESS om te lezen, DATA_STUDIO_CREATE om te wijzigen):

Methode & pad	Doel
GET .../projects/:projectId	Haal één project op, inclusief de volledige configuratie.
PUT .../projects/:projectId	Werk het project bij (naam, beschrijving, zichtbaarheid en de werkruimteconfiguratie).
DELETE .../projects/:projectId	Verwijder het project. Geeft { "message": "Project succesvol verwijderd" } terug.

De PUT body accepteert name, description, en visibility, plus het configuratieobject van de werkruimte van het project. Die configuratie is waar lagen, verwerking en output zijn gedefinieerd — zie Voeg een laag toe, Voer een pipeline uit, en Exporteer output.

Leden

Een project kan worden gedeeld met andere leden van de organisatie. Het toevoegen of verwijderen van leden vereist de DATA_STUDIO_MANAGE permissie.

Methode & pad	Doel
GET .../projects/:projectId/members	Leden van het project opsommen.
POST .../projects/:projectId/members	Voeg een lid toe aan het project.

curl -H "Authorization: Bearer eyJhbGci..." \
  "https://api.topolab.nl/v1/organization/8f0c2e1a-4b6d-4c2a-9e3f-1a2b3c4d5e6f/data-studio/projects/c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f/members"

Fouten

Status	Betekenis
400	Ongeldige body, bijvoorbeeld een ontbrekende name of een name langer dan 255 tekens.
401	Ontbrekende of ongeldige Bearer-token.
403	Geen lid, ontbrekende DATA_STUDIO_CREATE, of de data-studio add-on is niet ingeschakeld.
404	Onbekende organizationId of projectId.

Volgende

• Lijst projecten — som de projecten van de organisatie op.
• Voeg een laag toe — voeg datasets toe aan de projectwerkruimte.