DokumentationProdukteArtim Academy LMSWikiWiki V1
Freigabe setzen
Setzt, wer das Wiki lesen und schreiben darf.
Die Liste ersetzt die bisherige Freigabe vollständig. Jeder Eintrag nennt in kind seine Art: public für jedes Konto der Akademie, course mit courseId für die Eingeschriebenen eines Kurses, participants mit participantIds, editorIds, participantEmails und editorEmails für einzeln benannte Leute. Trainer und Admins der Akademie schreiben immer, unabhängig von dieser Liste.
PUT https://wikis.api.lms.artim-industries.com/v1/wikis/{id}/access
| Methode | PUT |
| Basis | wikis.api.lms.artim-industries.com/v1 |
| Scope | lms.wikis.access:update |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer lmsapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Die Kennung des Wikis. |
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
accesses | array | Die Freigaben. Mindestens eine. Pflicht. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "accesses": [{ "kind": "course", "courseId": "crs_18e2" }] }
Anfrage
curl -X PUT "https://wikis.api.lms.artim-industries.com/v1/wikis/{id}/access" \
-H "Authorization: Bearer lmsapi_…" \
-H "Content-Type: application/json" \
-d '{ "accesses": [{ "kind": "course", "courseId": "crs_18e2" }] }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
id | string | Die Kennung. |
accesses | array | Die Arten der Freigabe danach. |
{ "id": "wik_3a91", "accesses": ["course"] }
Fehler
| Status | code | Wann |
|---|---|---|
400 | invalid_request | Ein Pflichtfeld fehlt, ein Typ passt nicht, oder ein Verweis zeigt auf etwas, das es hier nicht gibt. |
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. |
403 | missing_scope | Das Token trägt den Scope dieses Endpunkts nicht. |
404 | not_found | Der Eintrag gehört nicht zum freigegebenen Akademie — oder die Anfrage kam auf der falschen Subdomain an. |
409 | conflict | Der Zustand verbietet die Änderung — der Fehlerkörper nennt den Grund. |
429 | rate_limited | Kontingent erschöpft, siehe Retry-After. |
Jede Fehlerantwort trägt dieselbe Hülle: error.code benennt den Fehler, error.message sagt in einem Satz, was fehlt.
Rate Limits
Das Limit gilt pro Team, nicht pro Token.
| Zugang | Produktion | Sandbox |
|---|---|---|
| Hobby | 60 Anfragen/Minute | ohne Limit |
| Developer Mitgliedschaft | 10.000 Anfragen/Minute | ohne Limit |
Bei 429 sagt der Retry-After-Header, wie lange du warten sollst.