Objekte
Error
Standard-Fehlerantwort. detail ist eine Zeichenkette, ein Objekt mit code (zum Beispiel choose_org, org_suspended, Codes von Einladungen) oder eine Liste von Validierungsfehlern (422). error ist eine strukturierte Beschreibung: ein Code aus dem Fehlerkatalog, eine englische Meldung, strukturierte Details und die Anfrage-ID.
Felder
Fehlermeldung, ein Objekt mit einem Code oder eine Liste von Validierungsfehlern.
errorErrorInfo
Verwendet von
- GET
/v1/healthDienststatus und Version abrufen - GET
/v1/usersBenutzer der Organisation auflisten - POST
/v1/usersBenutzer erstellen - PATCH
/v1/users/{user_id}Benutzer aktualisieren - GET
/v1/api-keysAPI-Schlüssel der Organisation auflisten - POST
/v1/api-keysAPI-Schlüssel erstellen - DELETE
/v1/api-keys/{key_id}API-Schlüssel widerrufen - PATCH
/v1/api-keys/{key_id}API-Schlüssel aktualisieren - POST
/v1/api-keys/{key_id}/rollAPI-Schlüssel rotieren - POST
/v1/api-keys/{key_id}/revoke-previousVorherigen Wert eines API-Schlüssels widerrufen - GET
/v1/auditEinträge des Audit-Logs auflisten - GET
/v1/audit/actionsAktionen des Audit-Logs mit Anzahl auflisten - GET
/v1/audit/export.csvAudit-Log als CSV exportieren - GET
/v1/orgOrganisation abrufen - GET
/v1/categoriesDokumentkategorien auflisten - POST
/v1/categoriesKategorie erstellen - DELETE
/v1/categories/{key}Benutzerdefinierte Kategorie löschen - PATCH
/v1/categories/{key}Kategorie aktualisieren - GET
/v1/collectionsFür den Benutzer verfügbare Sammlungen auflisten - POST
/v1/collectionsSammlung erstellen - DELETE
/v1/collections/{name}Sammlung löschen - PATCH
/v1/collections/{name}Sammlung aktualisieren - POST
/v1/collections/{name}/reindexSammlung neu indexieren - GET
/v1/collections/{name}/statsÜbersicht der Sammlung abrufen: Statistik, Kategorien, neueste Karten, Berechtigungen - GET
/v1/cardsKarten auflisten - POST
/v1/cardsDatei als Karte hochladen - GET
/v1/jobsIndexierungsjobs auflisten - GET
/v1/jobs/summaryÜbersicht der Warteschlange abrufen - GET
/v1/jobs/streamÄnderungen an Jobs streamen (SSE) - GET
/v1/jobs/{job_id}Job abrufen - DELETE
/v1/jobs/{job_id}Eingereihten Job abbrechen - GET
/v1/cards/countKarten zählen - GET
/v1/cards/export.xlsxKartenliste als XLSX exportieren - POST
/v1/cards/bulkMassenaktion für Karten ausführen - GET
/v1/cards/{card_id}Karte mit Versionen, Kommentaren, Tabellen und Ereignissen abrufen - DELETE
/v1/cards/{card_id}Karte löschen - PATCH
/v1/cards/{card_id}Karte aktualisieren - GET
/v1/cards-by-external-id/{external_id}Karte nach externer ID abrufen - PUT
/v1/cards-by-external-id/{external_id}Karte nach externer ID erstellen oder ersetzen - GET
/v1/cards/{card_id}/contentText der Karte nach Abschnitten abrufen - PUT
/v1/cards/{card_id}/contentInhalt einer Karte ersetzen - GET
/v1/cards/{card_id}/tables/{table_id}/rowsZeilen einer Faktentabelle auflisten - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Zwei Versionen einer Karte vergleichen - GET
/v1/cards/{card_id}/usageFragen auflisten, deren Antworten die Karte verwendet haben - POST
/v1/cards/{card_id}/usageNutzungsereignis einer Karte erfassen - POST
/v1/cards/{card_id}/reindexKarte neu indexieren - DELETE
/v1/cards/{card_id}/comments/{comment_id}Kommentar löschen - GET
/v1/cards/{card_id}/fileOriginaldatei einer Karte herunterladen - GET
/v1/cards/{card_id}/exportKarte als Dokument exportieren - POST
/v1/cards/{card_id}/verifyBestätigen, dass eine Karte aktuell ist - POST
/v1/cards/{card_id}/commentsKommentar hinzufügen - GET
/v1/conversationsUnterhaltungen auflisten - GET
/v1/conversations/{conv_id}Unterhaltung mit ihren Gesprächsrunden abrufen - POST
/v1/searchSammlungen durchsuchen - POST
/v1/askAntwort des Assistenten ohne Streaming abrufen - POST
/v1/chatAntwort des Assistenten streamen (SSE) - POST
/v1/questions/{question_id}/feedbackAntwort bewerten - GET
/v1/questions/export.csvFrageprotokoll als CSV exportieren - GET
/v1/questions/{question_id}Gespeicherte Frage mit ihrer Antwort abrufen - GET
/v1/questions/{question_id}/followupsVorgeschlagene Folgefragen abrufen - GET
/v1/questionsFrageprotokoll auflisten - GET
/v1/questions/{question_id}/exportAntwort als Dokument exportieren - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportDatensatz einer Antwort exportieren - GET
/v1/questions/{question_id}/answer-tables/{index}/exportTabelle aus dem Text der Antwort exportieren - POST
/v1/questions/{question_id}/refreshDatensätze einer Antwort aktualisieren (Live-Antwort) - POST
/v1/questions/{question_id}/save-cardAntwort als Karte speichern - POST
/v1/cards/textTextkarte erstellen (Markdown) - GET
/v1/filesExportdateien auflisten - GET
/v1/files/authorsAutoren von Dateien auflisten (für den Administratorfilter) - GET
/v1/files/{file_id}Angaben zu einer Datei abrufen - DELETE
/v1/files/{file_id}Datei löschen - GET
/v1/files/{file_id}/downloadDatei herunterladen - GET
/v1/files/{file_id}/previewVorschau einer Datei anzeigen - POST
/v1/files/{file_id}/extendAufbewahrungsfrist einer Datei verlängern - POST
/v1/files/{file_id}/regenerateDatei aus ihren gespeicherten Parametern neu erstellen - GET
/v1/tasksAufgaben eines Benutzers oder eines Teams auflisten - POST
/v1/sourcesQuelle erstellen - GET
/v1/sources/{source_id}Quelle abrufen - DELETE
/v1/sources/{source_id}Quelle löschen - PATCH
/v1/sources/{source_id}Quelle aktualisieren - PATCH
/v1/sources/{source_id}/settingsEinstellungen einer Quelle aktualisieren - GET
/v1/cards/{card_id}/similarÄhnliche Karten auflisten - GET
/v1/insights/gapsWissenslücken auflisten (Cluster unbeantworteter Fragen) - GET
/v1/permissionsBerechtigungsregister auflisten - POST
/v1/uploadsMultipart-Upload starten - GET
/v1/uploads/{upload_id}Upload abrufen - DELETE
/v1/uploads/{upload_id}Upload abbrechen - PUT
/v1/uploads/{upload_id}/parts/{n}Teil eines Uploads senden - POST
/v1/uploads/{upload_id}/completeUpload abschließen - GET
/v1/meAufrufer der API abrufen - GET
/v1/me/permissionsBerechtigungen des aktuellen Benutzers für die Organisation abrufen - GET
/v1/rolesRollen auflisten (integrierte und benutzerdefinierte) - POST
/v1/rolesBenutzerdefinierte Rolle erstellen - DELETE
/v1/roles/{role_id}Benutzerdefinierte Rolle löschen - PATCH
/v1/roles/{role_id}Benutzerdefinierte Rolle aktualisieren - GET
/v1/groupsGruppen der Organisation auflisten - POST
/v1/groupsGruppe erstellen - GET
/v1/groups/{group_id}Gruppe mit ihren Mitgliedern abrufen - DELETE
/v1/groups/{group_id}Gruppe löschen - PATCH
/v1/groups/{group_id}Gruppe umbenennen - PUT
/v1/groups/{group_id}/members/{user_id}Mitglied zu einer Gruppe hinzufügen - DELETE
/v1/groups/{group_id}/members/{user_id}Mitglied aus einer Gruppe entfernen - GET
/v1/org/permissionsBerechtigungen für die Organisation abrufen (wer Administrator ist) - PUT
/v1/org/permissionsRollen für die Organisation erteilen - DELETE
/v1/org/permissionsRollen für die Organisation widerrufen - GET
/v1/collections/{name}/permissionsBerechtigungen für eine Sammlung abrufen (direkte und geerbte) - PUT
/v1/collections/{name}/permissionsRollen für eine Sammlung erteilen - DELETE
/v1/collections/{name}/permissionsRollen für eine Sammlung widerrufen - GET
/v1/cards/{card_id}/permissionsBerechtigungen für eine Karte abrufen (direkte und geerbte) - PUT
/v1/cards/{card_id}/permissionsRollen für eine Karte erteilen - DELETE
/v1/cards/{card_id}/permissionsRollen für eine Karte widerrufen - GET
/v1/sources/{source_id}/permissionsBerechtigungen für eine Quelle abrufen (direkte und geerbte) - PUT
/v1/sources/{source_id}/permissionsRollen für eine Quelle erteilen - DELETE
/v1/sources/{source_id}/permissionsRollen für eine Quelle widerrufen - POST
/v1/users/{user_id}/offboardOffboarding eines Benutzers durchführen - GET
/v1/collections/{name}/foldersOrdnerbaum einer Sammlung abrufen - POST
/v1/collections/{name}/foldersOrdner erstellen - GET
/v1/foldersOrdnerbäume aller Sammlungen abrufen - GET
/v1/folders/{folder_id}Ordner abrufen - DELETE
/v1/folders/{folder_id}Ordner löschen und Inhalt eine Ebene nach oben verschieben - PATCH
/v1/folders/{folder_id}Ordner umbenennen, verschieben oder neu anordnen - GET
/v1/folders/{folder_id}/cardsKarten eines Ordners auflisten - GET
/v1/folders/{folder_id}/permissionsBerechtigungen für einen Ordner abrufen (direkte und geerbte) - PUT
/v1/folders/{folder_id}/permissionsRollen für einen Ordner erteilen - DELETE
/v1/folders/{folder_id}/permissionsRollen für einen Ordner widerrufen - GET
/v1/catalog/servicesDienste im Katalog auflisten - GET
/v1/catalog/services/{service_id}Dienst aus dem Katalog abrufen - GET
/v1/catalog/services/{service_id}/iconSymbol eines Dienstes abrufen - GET
/v1/catalog/categoriesKatalogkategorien auflisten - GET
/v1/catalog/spend-taxonomyTaxonomie für Ausgaben und Einnahmen abrufen - POST
/v1/catalog/resolveNamen Diensten im Katalog zuordnen - GET
/v1/draftsEntwürfe auflisten - POST
/v1/draftsEntwurf erstellen - GET
/v1/drafts/{draft_id}Entwurf abrufen - PATCH
/v1/drafts/{draft_id}Entwurf aktualisieren - POST
/v1/drafts/{draft_id}/request-publishVeröffentlichung anfordern - POST
/v1/drafts/{draft_id}/approveVeröffentlichung freigeben - GET
/v1/tagsKarten-Tags der Organisation auflisten - POST
/v1/cards/archiveArchiv mit Dokumenten hochladen - GET
/v1/archives/{job_id}Extraktionsjob eines Archivs abrufen - GET
/v1/cards/{card_id}/verificationPrüfblock einer Karte abrufen - POST
/v1/cards/{card_id}/verification/verifyKarte prüfen - POST
/v1/cards/{card_id}/verification/unverifyVertrauensstatus entziehen oder den Prüfer erinnern - PUT
/v1/cards/{card_id}/verification/verifiersPrüfer einer Karte festlegen - PUT
/v1/cards/{card_id}/verification/intervalPrüfart und Fälligkeitsdatum ändern - GET
/v1/verification/queuePrüfwarteschlange abrufen - GET
/v1/collections/{name}/trustVertrauenswert einer Sammlung abrufen - GET
/v1/org/trustVertrauenswert der Organisation abrufen - GET
/v1/announcementsAnkündigungen auflisten - POST
/v1/announcementsAnkündigung als Pflichtlektüre senden - GET
/v1/announcements/{announcement_id}Ankündigung abrufen - GET
/v1/announcements/{announcement_id}/statsBericht zur Ankündigung abrufen - POST
/v1/announcements/{announcement_id}/remindPersonen erinnern, die noch nicht gelesen haben - GET
/v1/cards/{card_id}/threadsKommentarthreads einer Karte auflisten - POST
/v1/cards/{card_id}/threadsKommentar oder Antwort in einem Thread hinzufügen - DELETE
/v1/cards/{card_id}/threads/{comment_id}Kommentar mit seinen Antworten löschen - PATCH
/v1/cards/{card_id}/threads/{comment_id}Text bearbeiten, Thread als erledigt markieren oder wieder öffnen - GET
/v1/openapi-public.jsonÖffentliche OpenAPI-Spezifikation abrufen - GET
/v1/webhooksWebhooks der Organisation auflisten - POST
/v1/webhooksWebhook erstellen - GET
/v1/webhooks/catalogEreignistypen auflisten - GET
/v1/webhooks/{webhook_id}Webhook abrufen - DELETE
/v1/webhooks/{webhook_id}Webhook löschen - PATCH
/v1/webhooks/{webhook_id}Webhook aktualisieren - POST
/v1/webhooks/{webhook_id}/testTestereignis senden - POST
/v1/webhooks/{webhook_id}/rotate-secretSignatur-Secret rotieren - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretVorheriges Secret widerrufen - POST
/v1/webhooks/{webhook_id}/resumeWebhook fortsetzen - POST
/v1/webhooks/{webhook_id}/redeliverZustellungen für einen Zeitraum erneut zustellen - GET
/v1/webhooks/{webhook_id}/attemptsZustellversuche auflisten - GET
/v1/webhooks/{webhook_id}/deliveriesWebhook-Zustellungen auflisten - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Zustellung mit Anfrage- und Antworttexten und Versuchen abrufen - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverEreignis erneut zustellen - GET
/v1/webhook-eventsEreignisse auflisten - GET
/v1/webhook-events/{event_id}Ereignis abrufen - GET
/v1/api-usageAPI-Nutzung abrufen - GET
/v1/api-logsAPI-Anfragen auflisten - GET
/v1/api-logs/{request_id}API-Anfrage abrufen - GET
/v1/appsOAuth-Apps auflisten - POST
/v1/appsOAuth-App erstellen - GET
/v1/apps/{app_id}OAuth-App abrufen - DELETE
/v1/apps/{app_id}OAuth-App löschen - PATCH
/v1/apps/{app_id}OAuth-App aktualisieren - POST
/v1/apps/{app_id}/rotate-secretClient-Secret rotieren - GET
/v1/app-authorizationsAutorisierungen von Apps auflisten - DELETE
/v1/app-authorizations/{authorization_id}Autorisierung eines Mitarbeitenden widerrufen - GET
/v1/analytics/healthDashboard zum Zustand des Wissens abrufen - GET
/v1/analytics/usageNutzungs-Dashboard abrufen - GET
/v1/analytics/contributionDashboard der Beiträge abrufen - GET
/v1/analytics/cards/{card_id}Kennzahlen einer Karte abrufen - GET
/v1/audit/verifyIntegrität des Audit-Logs der Organisation prüfen - POST
/v1/users/importBenutzer aus CSV importieren - GET
/v1/quality/gaps/followupsWissenslücken in Bearbeitung auflisten - POST
/v1/quality/gaps/followupsWissenslücke in Bearbeitung nehmen - PATCH
/v1/quality/gaps/followups/{followup_id}Wissenslücke in Bearbeitung aktualisieren - GET
/v1/access-requestsEigene oder eingehende Zugriffsanfragen auflisten - GET
/v1/access-requests/{request_id}Zugriffsanfrage für eine entscheidende Person abrufen - POST
/v1/access-requests/{request_id}/grantZugriff auf eine Anfrage hin gewähren - POST
/v1/access-requests/{request_id}/denyZugriff ablehnen - POST
/v1/finance/reportFinanzübersicht abrufen - POST
/v1/finance/report/exportFinanzübersicht exportieren - POST
/v1/finance/invoicesRechnungen auflisten - POST
/v1/finance/invoices/exportRechnungsliste exportieren - POST
/v1/finance/paymentsZahlungen auflisten - POST
/v1/finance/payments/exportZahlungsliste exportieren - GET
/v1/sources/{source_id}/push-keysAPI-Schlüssel einer benutzerdefinierten Quelle auflisten - POST
/v1/sources/{source_id}/push-keysAPI-Schlüssel für eine benutzerdefinierte Quelle erstellen - DELETE
/v1/sources/{source_id}/push-keys/{key_id}API-Schlüssel einer benutzerdefinierten Quelle widerrufen - GET
/v1/sources/{source_id}/push-syncsSynchronisierungen einer benutzerdefinierten Quelle auflisten - GET
/v1/push/sources/{source_id}Schlüssel prüfen und Zustand einer benutzerdefinierten Quelle abrufen - POST
/v1/push/sources/{source_id}/syncsSynchronisierung öffnen - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Synchronisierung abrufen - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsErgebnisse der Dokumente einer Synchronisierung auflisten - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeSynchronisierung schließen - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchDokumente bestätigen, ohne sie erneut zu senden - POST
/v1/push/sources/{source_id}/documentsDokument senden (erstellen oder ersetzen) - POST
/v1/push/sources/{source_id}/documents/batchBatch von Dokumenten senden - GET
/v1/push/sources/{source_id}/documents/{external_id}Ergebnis eines Dokuments abrufen - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Dokument löschen