Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Hier vind je de stappen om alle bestaande werkruimtes voor een specifieke tenant op te halen.
HTTP-responses
HTTP-responsestatuscode | Betekenis |
200 OK | Een lijst met werkruimtes is succesvol opgehaald |
401 Unauthorized | Ongeldige of ontbrekende API-sleutel, secret en/of tenant |
Om de lijst met werkruimtes voor een bepaalde tenant op te halen, doe je een GET-verzoek naar het /workspaces-endpoint en geef je het volgende op:
Bedrijfsmiddel/endpoint bestemmings-URL
De header voor je API-verzoek
In dit voorbeeld willen we de lijst met bestaande werkruimtes voor de tenant yourtenantname ophalen. Om de lijst te krijgen, sturen we een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/workspaces.
curl -L 'https://public-api.eu.bluedolphin.app/v1/workspaces' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
[].id | string | Unieke identificatie voor de werkruimte |
[].name | string | De Naam van de werkruimte |
[].status | integer | De Status van de werkruimte. Mogelijke waarden zijn: 1 (niet klaar voor gebruik, de werkruimte wordt nog gekopieerd) en 0 (de werkruimte is klaar voor gebruik). |
[].is_root | boolean | Geeft aan of de werkruimte root is of niet. De root-werkruimte is onveranderlijk en is de hoofd- (of Master-) werkruimte. |
Een succesvol verzoek geeft een response met een 200 OK HTTP-statuscode en de volgende array terug:
[ { "id": "95c720561359c48a8eefa7b0", "name": "Company Main", "status": 0, "is_root": true }, { "id": "64366bf99418b8a0978b448f", "name": "Company France", "status": 0, "is_root": false }]