Objekt
Error
Standardsvar vid fel. detail är en sträng, ett objekt med code (till exempel choose_org, org_suspended, inbjudningskoder) eller en lista med valideringsfel (422). error är en strukturerad beskrivning: en kod från felkatalogen, ett engelskt meddelande, strukturerade detaljer och anrops-id:t.
Fält
Felmeddelande, ett objekt med en kod eller en lista med valideringsfel.
errorErrorInfo
Används av
- GET
/v1/healthHämta tjänstens status och version - GET
/v1/usersLista organisationens användare - POST
/v1/usersSkapa en användare - PATCH
/v1/users/{user_id}Uppdatera en användare - GET
/v1/api-keysLista organisationens API-nycklar - POST
/v1/api-keysSkapa en API-nyckel - DELETE
/v1/api-keys/{key_id}Återkalla en API-nyckel - PATCH
/v1/api-keys/{key_id}Uppdatera en API-nyckel - POST
/v1/api-keys/{key_id}/rollRotera en API-nyckel - POST
/v1/api-keys/{key_id}/revoke-previousÅterkalla det tidigare värdet för en API-nyckel - GET
/v1/auditLista poster i granskningsloggen - GET
/v1/audit/actionsLista åtgärder i granskningsloggen med antal - GET
/v1/audit/export.csvExportera granskningsloggen som CSV - GET
/v1/orgHämta organisationen - GET
/v1/categoriesLista dokumentkategorier - POST
/v1/categoriesSkapa en kategori - DELETE
/v1/categories/{key}Ta bort en anpassad kategori - PATCH
/v1/categories/{key}Uppdatera en kategori - GET
/v1/collectionsLista samlingar som är tillgängliga för användaren - POST
/v1/collectionsSkapa en samling - DELETE
/v1/collections/{name}Ta bort en samling - PATCH
/v1/collections/{name}Uppdatera en samling - POST
/v1/collections/{name}/reindexIndexera om en samling - GET
/v1/collections/{name}/statsHämta en översikt över samlingen: statistik, kategorier, senaste kort, behörigheter - GET
/v1/cardsLista kort - POST
/v1/cardsLadda upp en fil som ett kort - GET
/v1/jobsLista indexeringsjobb - GET
/v1/jobs/summaryHämta en sammanfattning av kön - GET
/v1/jobs/streamStrömma ändringar i jobb (SSE) - GET
/v1/jobs/{job_id}Hämta ett jobb - DELETE
/v1/jobs/{job_id}Avbryt ett jobb i kön - GET
/v1/cards/countRäkna kort - GET
/v1/cards/export.xlsxExportera kortlistan till XLSX - POST
/v1/cards/bulkKör en massåtgärd på kort - GET
/v1/cards/{card_id}Hämta ett kort med dess versioner, kommentarer, tabeller och händelser - DELETE
/v1/cards/{card_id}Ta bort ett kort - PATCH
/v1/cards/{card_id}Uppdatera ett kort - GET
/v1/cards-by-external-id/{external_id}Hämta ett kort efter externt id - PUT
/v1/cards-by-external-id/{external_id}Skapa eller ersätt ett kort efter externt id - GET
/v1/cards/{card_id}/contentHämta kortets text per avsnitt - PUT
/v1/cards/{card_id}/contentErsätt innehållet i ett kort - GET
/v1/cards/{card_id}/tables/{table_id}/rowsLista rader i en faktatabell - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Jämför två versioner av ett kort - GET
/v1/cards/{card_id}/usageLista frågor vars svar använde kortet - POST
/v1/cards/{card_id}/usageRegistrera en händelse för användning av ett kort - POST
/v1/cards/{card_id}/reindexIndexera om ett kort - DELETE
/v1/cards/{card_id}/comments/{comment_id}Ta bort en kommentar - GET
/v1/cards/{card_id}/fileLadda ned originalfilen för ett kort - GET
/v1/cards/{card_id}/exportExportera ett kort till ett dokument - POST
/v1/cards/{card_id}/verifyBekräfta att ett kort är aktuellt - POST
/v1/cards/{card_id}/commentsLägg till en kommentar - GET
/v1/conversationsLista konversationer - GET
/v1/conversations/{conv_id}Hämta en konversation med dess omgångar - POST
/v1/searchSök i samlingar - POST
/v1/askHämta ett svar från assistenten utan strömning - POST
/v1/chatStrömma ett svar från assistenten (SSE) - POST
/v1/questions/{question_id}/feedbackBetygsätt ett svar - GET
/v1/questions/export.csvExportera frågeloggen till CSV - GET
/v1/questions/{question_id}Hämta en sparad fråga med dess svar - GET
/v1/questions/{question_id}/followupsHämta förslag på följdfrågor - GET
/v1/questionsLista frågeloggen - GET
/v1/questions/{question_id}/exportExportera ett svar till ett dokument - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportera en datamängd från ett svar - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportera en tabell från svarstexten - POST
/v1/questions/{question_id}/refreshUppdatera ett svars datamängder (live-svar) - POST
/v1/questions/{question_id}/save-cardSpara ett svar som ett kort - POST
/v1/cards/textSkapa ett textkort (Markdown) - GET
/v1/filesLista exportfiler - GET
/v1/files/authorsLista filernas författare (för administratörens filter) - GET
/v1/files/{file_id}Hämta uppgifter om en fil - DELETE
/v1/files/{file_id}Ta bort en fil - GET
/v1/files/{file_id}/downloadLadda ned en fil - GET
/v1/files/{file_id}/previewFörhandsvisa en fil - POST
/v1/files/{file_id}/extendFörläng lagringstiden för en fil - POST
/v1/files/{file_id}/regenerateGenerera om en fil från dess sparade parametrar - GET
/v1/tasksLista uppgifterna för en användare eller ett team - POST
/v1/sourcesSkapa en källa - GET
/v1/sources/{source_id}Hämta en källa - DELETE
/v1/sources/{source_id}Ta bort en källa - PATCH
/v1/sources/{source_id}Uppdatera en källa - PATCH
/v1/sources/{source_id}/settingsUppdatera källans inställningar - GET
/v1/cards/{card_id}/similarLista liknande kort - GET
/v1/insights/gapsLista kunskapsluckor (kluster av obesvarade frågor) - GET
/v1/permissionsLista behörighetsregistret - POST
/v1/uploadsStarta en uppladdning i delar - GET
/v1/uploads/{upload_id}Hämta en uppladdning - DELETE
/v1/uploads/{upload_id}Avbryt en uppladdning - PUT
/v1/uploads/{upload_id}/parts/{n}Skicka en del av en uppladdning - POST
/v1/uploads/{upload_id}/completeSlutför en uppladdning - GET
/v1/meHämta API:ets anropare - GET
/v1/me/permissionsHämta den aktuella användarens behörigheter på organisationen - GET
/v1/rolesLista roller (inbyggda och anpassade) - POST
/v1/rolesSkapa en anpassad roll - DELETE
/v1/roles/{role_id}Ta bort en anpassad roll - PATCH
/v1/roles/{role_id}Uppdatera en anpassad roll - GET
/v1/groupsLista organisationens grupper - POST
/v1/groupsSkapa en grupp - GET
/v1/groups/{group_id}Hämta en grupp med dess medlemmar - DELETE
/v1/groups/{group_id}Ta bort en grupp - PATCH
/v1/groups/{group_id}Byt namn på en grupp - PUT
/v1/groups/{group_id}/members/{user_id}Lägg till en medlem i en grupp - DELETE
/v1/groups/{group_id}/members/{user_id}Ta bort en medlem från en grupp - GET
/v1/org/permissionsHämta behörigheter på organisationen (vem som är administratör) - PUT
/v1/org/permissionsTilldela roller på organisationen - DELETE
/v1/org/permissionsÅterkalla roller på organisationen - GET
/v1/collections/{name}/permissionsHämta behörigheter på en samling (direkta och ärvda) - PUT
/v1/collections/{name}/permissionsTilldela roller på en samling - DELETE
/v1/collections/{name}/permissionsÅterkalla roller på en samling - GET
/v1/cards/{card_id}/permissionsHämta behörigheter på ett kort (direkta och ärvda) - PUT
/v1/cards/{card_id}/permissionsTilldela roller på ett kort - DELETE
/v1/cards/{card_id}/permissionsÅterkalla roller på ett kort - GET
/v1/sources/{source_id}/permissionsHämta behörigheter på en källa (direkta och ärvda) - PUT
/v1/sources/{source_id}/permissionsTilldela roller på en källa - DELETE
/v1/sources/{source_id}/permissionsÅterkalla roller på en källa - POST
/v1/users/{user_id}/offboardGenomför offboarding av en användare - GET
/v1/collections/{name}/foldersHämta mappträdet för en samling - POST
/v1/collections/{name}/foldersSkapa en mapp - GET
/v1/foldersHämta mappträden för alla samlingar - GET
/v1/folders/{folder_id}Hämta en mapp - DELETE
/v1/folders/{folder_id}Ta bort en mapp och flytta upp dess innehåll - PATCH
/v1/folders/{folder_id}Byt namn på, flytta eller ändra ordning på en mapp - GET
/v1/folders/{folder_id}/cardsLista korten i en mapp - GET
/v1/folders/{folder_id}/permissionsHämta behörigheter på en mapp (direkta och ärvda) - PUT
/v1/folders/{folder_id}/permissionsTilldela roller på en mapp - DELETE
/v1/folders/{folder_id}/permissionsÅterkalla roller på en mapp - GET
/v1/catalog/servicesLista tjänster i katalogen - GET
/v1/catalog/services/{service_id}Hämta en tjänst i katalogen - GET
/v1/catalog/services/{service_id}/iconHämta ikonen för en tjänst - GET
/v1/catalog/categoriesLista katalogens kategorier - GET
/v1/catalog/spend-taxonomyHämta klassificeringen av utgifter och intäkter - POST
/v1/catalog/resolveMatcha namn mot tjänster i katalogen - GET
/v1/draftsLista utkast - POST
/v1/draftsSkapa ett utkast - GET
/v1/drafts/{draft_id}Hämta ett utkast - PATCH
/v1/drafts/{draft_id}Uppdatera ett utkast - POST
/v1/drafts/{draft_id}/request-publishBegär publicering - POST
/v1/drafts/{draft_id}/approveGodkänn publicering - GET
/v1/tagsLista organisationens korttaggar - POST
/v1/cards/archiveLadda upp ett arkiv med dokument - GET
/v1/archives/{job_id}Hämta ett jobb för uppackning av ett arkiv - GET
/v1/cards/{card_id}/verificationHämta verifieringsblocket för ett kort - POST
/v1/cards/{card_id}/verification/verifyVerifiera ett kort - POST
/v1/cards/{card_id}/verification/unverifyTa bort förtroendet eller påminn granskaren - PUT
/v1/cards/{card_id}/verification/verifiersAnge granskare för ett kort - PUT
/v1/cards/{card_id}/verification/intervalÄndra verifieringstyp och förfallodatum - GET
/v1/verification/queueHämta verifieringskön - GET
/v1/collections/{name}/trustHämta ”Trust Score” (förtroendepoäng) för en samling - GET
/v1/org/trustHämta ”Trust Score” (förtroendepoäng) för organisationen - GET
/v1/announcementsLista meddelanden - POST
/v1/announcementsSkicka ett meddelande med obligatorisk läsning - GET
/v1/announcements/{announcement_id}Hämta ett meddelande - GET
/v1/announcements/{announcement_id}/statsHämta rapporten för ett meddelande - POST
/v1/announcements/{announcement_id}/remindPåminn dem som inte har läst - GET
/v1/cards/{card_id}/threadsLista kommentarstrådar för ett kort - POST
/v1/cards/{card_id}/threadsLägg till en kommentar eller ett svar i en tråd - DELETE
/v1/cards/{card_id}/threads/{comment_id}Ta bort en kommentar med dess svar - PATCH
/v1/cards/{card_id}/threads/{comment_id}Redigera texten, markera som löst eller öppna en tråd igen - GET
/v1/openapi-public.jsonHämta den offentliga OpenAPI-specifikationen - GET
/v1/webhooksLista organisationens webhookar - POST
/v1/webhooksSkapa en webhook - GET
/v1/webhooks/catalogLista händelsetyper - GET
/v1/webhooks/{webhook_id}Hämta en webhook - DELETE
/v1/webhooks/{webhook_id}Ta bort en webhook - PATCH
/v1/webhooks/{webhook_id}Uppdatera en webhook - POST
/v1/webhooks/{webhook_id}/testSkicka en testhändelse - POST
/v1/webhooks/{webhook_id}/rotate-secretRotera signeringshemligheten - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretÅterkalla den tidigare hemligheten - POST
/v1/webhooks/{webhook_id}/resumeÅteruppta en webhook - POST
/v1/webhooks/{webhook_id}/redeliverGör nya leveranser för en period - GET
/v1/webhooks/{webhook_id}/attemptsLista leveransförsök - GET
/v1/webhooks/{webhook_id}/deliveriesLista webhookens leveranser - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Hämta en leverans med brödtexter och försök - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverLeverera en händelse igen - GET
/v1/webhook-eventsLista händelser - GET
/v1/webhook-events/{event_id}Hämta en händelse - GET
/v1/api-usageHämta API-användning - GET
/v1/api-logsLista API-anrop - GET
/v1/api-logs/{request_id}Hämta ett API-anrop - GET
/v1/appsLista OAuth-appar - POST
/v1/appsSkapa en OAuth-app - GET
/v1/apps/{app_id}Hämta en OAuth-app - DELETE
/v1/apps/{app_id}Ta bort en OAuth-app - PATCH
/v1/apps/{app_id}Uppdatera en OAuth-app - POST
/v1/apps/{app_id}/rotate-secretRotera klienthemligheten - GET
/v1/app-authorizationsLista appars auktoriseringar - DELETE
/v1/app-authorizations/{authorization_id}Återkalla en medarbetares auktorisering - GET
/v1/analytics/healthHämta panelen för kunskapens hälsa - GET
/v1/analytics/usageHämta panelen för användning - GET
/v1/analytics/contributionHämta bidragspanelen - GET
/v1/analytics/cards/{card_id}Hämta mått för ett kort - GET
/v1/audit/verifyKontrollera integriteten i organisationens granskningslogg - POST
/v1/users/importImportera användare från CSV - GET
/v1/quality/gaps/followupsLista kunskapsluckor som åtgärdas - POST
/v1/quality/gaps/followupsBörja åtgärda en kunskapslucka - PATCH
/v1/quality/gaps/followups/{followup_id}Uppdatera en kunskapslucka som åtgärdas - GET
/v1/access-requestsLista egna eller inkommande åtkomstbegäranden - GET
/v1/access-requests/{request_id}Hämta en åtkomstbegäran för en beslutsfattare - POST
/v1/access-requests/{request_id}/grantBevilja åtkomst enligt en begäran - POST
/v1/access-requests/{request_id}/denyNeka åtkomst - POST
/v1/finance/reportHämta en finansiell sammanställningsrapport - POST
/v1/finance/report/exportExportera den finansiella sammanställningsrapporten - POST
/v1/finance/invoicesLista fakturor - POST
/v1/finance/invoices/exportExportera fakturalistan - POST
/v1/finance/paymentsLista betalningar - POST
/v1/finance/payments/exportExportera betalningslistan - GET
/v1/sources/{source_id}/push-keysLista API-nycklar för en egen källa - POST
/v1/sources/{source_id}/push-keysSkapa en API-nyckel för en egen källa - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Återkalla en API-nyckel för en egen källa - GET
/v1/sources/{source_id}/push-syncsLista synkningar för en egen källa - GET
/v1/push/sources/{source_id}Kontrollera nyckeln och hämta tillståndet för en egen källa - POST
/v1/push/sources/{source_id}/syncsÖppna en synkning - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Hämta en synkning - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsLista dokumentresultat för en synkning - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeStäng en synkning - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchBekräfta dokument utan att skicka dem igen - POST
/v1/push/sources/{source_id}/documentsSkicka ett dokument (skapa eller ersätt) - POST
/v1/push/sources/{source_id}/documents/batchSkicka en batch med dokument - GET
/v1/push/sources/{source_id}/documents/{external_id}Hämta resultatet för ett dokument - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Ta bort ett dokument