Obiecte
Error
Răspunsul standard de eroare. detail este un șir, un obiect cu code (de exemplu choose_org, org_suspended, coduri ale invitațiilor) sau o listă de erori de validare (422). error este o descriere structurată: un cod din catalogul erorilor, un mesaj în engleză, detalii structurate și ID-ul cererii.
Câmpuri
Mesajul de eroare, un obiect cu un cod sau o listă de erori de validare.
errorErrorInfo
Folosit de
- GET
/v1/healthObține starea și versiunea serviciului - GET
/v1/usersListează utilizatorii organizației - POST
/v1/usersCreează un utilizator - PATCH
/v1/users/{user_id}Actualizează un utilizator - GET
/v1/api-keysListează cheile API ale organizației - POST
/v1/api-keysCreează o cheie API - DELETE
/v1/api-keys/{key_id}Revocă o cheie API - PATCH
/v1/api-keys/{key_id}Actualizează o cheie API - POST
/v1/api-keys/{key_id}/rollReînnoiește o cheie API - POST
/v1/api-keys/{key_id}/revoke-previousRevocă valoarea anterioară a unei chei API - GET
/v1/auditListează înregistrările jurnalului de audit - GET
/v1/audit/actionsListează acțiunile din jurnalul de audit, cu numărul lor - GET
/v1/audit/export.csvExportă jurnalul de audit ca CSV - GET
/v1/orgObține organizația - GET
/v1/categoriesListează categoriile de documente - POST
/v1/categoriesCreează o categorie - DELETE
/v1/categories/{key}Șterge o categorie personalizată - PATCH
/v1/categories/{key}Actualizează o categorie - GET
/v1/collectionsListează colecțiile disponibile utilizatorului - POST
/v1/collectionsCreează o colecție - DELETE
/v1/collections/{name}Șterge o colecție - PATCH
/v1/collections/{name}Actualizează o colecție - POST
/v1/collections/{name}/reindexReindexează o colecție - GET
/v1/collections/{name}/statsObține prezentarea generală a colecției: statistici, categorii, fișe recente, permisiuni - GET
/v1/cardsListează fișele - POST
/v1/cardsÎncarcă un fișier ca fișă - GET
/v1/jobsListează joburile de indexare - GET
/v1/jobs/summaryObține rezumatul cozii - GET
/v1/jobs/streamTransmite în flux modificările joburilor (SSE) - GET
/v1/jobs/{job_id}Obține un job - DELETE
/v1/jobs/{job_id}Anulează un job aflat în coadă - GET
/v1/cards/countNumără fișele - GET
/v1/cards/export.xlsxExportă lista de fișe în XLSX - POST
/v1/cards/bulkExecută o acțiune în bloc asupra fișelor - GET
/v1/cards/{card_id}Obține o fișă cu versiunile, comentariile, tabelele și evenimentele ei - DELETE
/v1/cards/{card_id}Șterge o fișă - PATCH
/v1/cards/{card_id}Actualizează o fișă - GET
/v1/cards-by-external-id/{external_id}Obține o fișă după ID-ul extern - PUT
/v1/cards-by-external-id/{external_id}Creează sau înlocuiește o fișă după ID-ul extern - GET
/v1/cards/{card_id}/contentObține textul fișei pe secțiuni - PUT
/v1/cards/{card_id}/contentÎnlocuiește conținutul unei fișe - GET
/v1/cards/{card_id}/tables/{table_id}/rowsListează rândurile unui tabel de fapte - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Compară două versiuni ale unei fișe - GET
/v1/cards/{card_id}/usageListează întrebările ale căror răspunsuri au folosit fișa - POST
/v1/cards/{card_id}/usageÎnregistrează un eveniment de utilizare a fișei - POST
/v1/cards/{card_id}/reindexReindexează o fișă - DELETE
/v1/cards/{card_id}/comments/{comment_id}Șterge un comentariu - GET
/v1/cards/{card_id}/fileDescarcă fișierul original al unei fișe - GET
/v1/cards/{card_id}/exportExportă o fișă într-un document - POST
/v1/cards/{card_id}/verifyConfirmă că o fișă este actuală - POST
/v1/cards/{card_id}/commentsAdaugă un comentariu - GET
/v1/conversationsListează conversațiile - GET
/v1/conversations/{conv_id}Obține o conversație cu schimburile ei - POST
/v1/searchCaută în colecții - POST
/v1/askObține un răspuns al asistentului fără transmitere în flux - POST
/v1/chatTransmite în flux un răspuns al asistentului (SSE) - POST
/v1/questions/{question_id}/feedbackEvaluează un răspuns - GET
/v1/questions/export.csvExportă jurnalul întrebărilor în CSV - GET
/v1/questions/{question_id}Obține o întrebare salvată cu răspunsul ei - GET
/v1/questions/{question_id}/followupsObține sugestiile de întrebări următoare - GET
/v1/questionsListează jurnalul întrebărilor - GET
/v1/questions/{question_id}/exportExportă un răspuns într-un document - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportă un set de date al unui răspuns - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportă un tabel din textul răspunsului - POST
/v1/questions/{question_id}/refreshReîmprospătează seturile de date ale unui răspuns (răspuns dinamic) - POST
/v1/questions/{question_id}/save-cardSalvează un răspuns ca fișă - POST
/v1/cards/textCreează o fișă text (Markdown) - GET
/v1/filesListează fișierele de export - GET
/v1/files/authorsListează autorii fișierelor (pentru filtrul administratorului) - GET
/v1/files/{file_id}Obține detaliile unui fișier - DELETE
/v1/files/{file_id}Șterge un fișier - GET
/v1/files/{file_id}/downloadDescarcă un fișier - GET
/v1/files/{file_id}/previewPrevizualizează un fișier - POST
/v1/files/{file_id}/extendPrelungește perioada de păstrare a unui fișier - POST
/v1/files/{file_id}/regenerateRegenerează un fișier din parametrii lui salvați - GET
/v1/tasksListează sarcinile unui utilizator sau ale unei echipe - POST
/v1/sourcesCreează o sursă - GET
/v1/sources/{source_id}Obține o sursă - DELETE
/v1/sources/{source_id}Șterge o sursă - PATCH
/v1/sources/{source_id}Actualizează o sursă - PATCH
/v1/sources/{source_id}/settingsActualizează setările sursei - GET
/v1/cards/{card_id}/similarListează fișele similare - GET
/v1/insights/gapsListează golurile de cunoștințe (grupuri de întrebări fără răspuns) - GET
/v1/permissionsListează registrul permisiunilor - POST
/v1/uploadsÎncepe o încărcare în părți - GET
/v1/uploads/{upload_id}Obține o încărcare - DELETE
/v1/uploads/{upload_id}Anulează o încărcare - PUT
/v1/uploads/{upload_id}/parts/{n}Trimite o parte a încărcării - POST
/v1/uploads/{upload_id}/completeFinalizează o încărcare - GET
/v1/meObține apelantul API-ului - GET
/v1/me/permissionsObține permisiunile utilizatorului curent asupra organizației - GET
/v1/rolesListează rolurile (predefinite și personalizate) - POST
/v1/rolesCreează un rol personalizat - DELETE
/v1/roles/{role_id}Șterge un rol personalizat - PATCH
/v1/roles/{role_id}Actualizează un rol personalizat - GET
/v1/groupsListează grupurile organizației - POST
/v1/groupsCreează un grup - GET
/v1/groups/{group_id}Obține un grup cu membrii lui - DELETE
/v1/groups/{group_id}Șterge un grup - PATCH
/v1/groups/{group_id}Redenumește un grup - PUT
/v1/groups/{group_id}/members/{user_id}Adaugă un membru într-un grup - DELETE
/v1/groups/{group_id}/members/{user_id}Elimină un membru dintr-un grup - GET
/v1/org/permissionsObține permisiunile asupra organizației (cine este administrator) - PUT
/v1/org/permissionsAtribuie roluri asupra organizației - DELETE
/v1/org/permissionsRetrage roluri asupra organizației - GET
/v1/collections/{name}/permissionsObține permisiunile asupra unei colecții (directe și moștenite) - PUT
/v1/collections/{name}/permissionsAtribuie roluri asupra unei colecții - DELETE
/v1/collections/{name}/permissionsRetrage roluri asupra unei colecții - GET
/v1/cards/{card_id}/permissionsObține permisiunile asupra unei fișe (directe și moștenite) - PUT
/v1/cards/{card_id}/permissionsAtribuie roluri asupra unei fișe - DELETE
/v1/cards/{card_id}/permissionsRetrage roluri asupra unei fișe - GET
/v1/sources/{source_id}/permissionsObține permisiunile asupra unei surse (directe și moștenite) - PUT
/v1/sources/{source_id}/permissionsAtribuie roluri asupra unei surse - DELETE
/v1/sources/{source_id}/permissionsRetrage roluri asupra unei surse - POST
/v1/users/{user_id}/offboardExecută offboardingul unui utilizator - GET
/v1/collections/{name}/foldersObține arborele de dosare al unei colecții - POST
/v1/collections/{name}/foldersCreează un dosar - GET
/v1/foldersObține arborii de dosare ai tuturor colecțiilor - GET
/v1/folders/{folder_id}Obține un dosar - DELETE
/v1/folders/{folder_id}Șterge un dosar și mută conținutul lui un nivel mai sus - PATCH
/v1/folders/{folder_id}Redenumește, mută sau schimbă ordinea unui dosar - GET
/v1/folders/{folder_id}/cardsListează fișele unui dosar - GET
/v1/folders/{folder_id}/permissionsObține permisiunile asupra unui dosar (directe și moștenite) - PUT
/v1/folders/{folder_id}/permissionsAtribuie roluri asupra unui dosar - DELETE
/v1/folders/{folder_id}/permissionsRetrage roluri asupra unui dosar - GET
/v1/catalog/servicesListează serviciile din catalog - GET
/v1/catalog/services/{service_id}Obține un serviciu din catalog - GET
/v1/catalog/services/{service_id}/iconObține pictograma unui serviciu - GET
/v1/catalog/categoriesListează categoriile catalogului - GET
/v1/catalog/spend-taxonomyObține clasificarea cheltuielilor și a veniturilor - POST
/v1/catalog/resolveAsociază denumiri cu servicii din catalog - GET
/v1/draftsListează schițele - POST
/v1/draftsCreează o schiță - GET
/v1/drafts/{draft_id}Obține o schiță - PATCH
/v1/drafts/{draft_id}Actualizează o schiță - POST
/v1/drafts/{draft_id}/request-publishSolicită publicarea - POST
/v1/drafts/{draft_id}/approveAprobă publicarea - GET
/v1/tagsListează etichetele fișelor organizației - POST
/v1/cards/archiveÎncarcă o arhivă de documente - GET
/v1/archives/{job_id}Obține un job de extragere a unei arhive - GET
/v1/cards/{card_id}/verificationObține blocul de verificare al unei fișe - POST
/v1/cards/{card_id}/verification/verifyVerifică o fișă - POST
/v1/cards/{card_id}/verification/unverifyRetrage încrederea sau îi amintește verificatorului - PUT
/v1/cards/{card_id}/verification/verifiersSetează verificatorii unei fișe - PUT
/v1/cards/{card_id}/verification/intervalSchimbă tipul verificării și termenul - GET
/v1/verification/queueObține coada de verificare - GET
/v1/collections/{name}/trustObține scorul „Trust Score” al unei colecții - GET
/v1/org/trustObține scorul „Trust Score” al organizației - GET
/v1/announcementsListează anunțurile - POST
/v1/announcementsTrimite un anunț de citit obligatoriu - GET
/v1/announcements/{announcement_id}Obține un anunț - GET
/v1/announcements/{announcement_id}/statsObține raportul anunțului - POST
/v1/announcements/{announcement_id}/remindLe amintește celor care nu au citit - GET
/v1/cards/{card_id}/threadsListează firele de comentarii ale unei fișe - POST
/v1/cards/{card_id}/threadsAdaugă un comentariu sau un răspuns într-un fir - DELETE
/v1/cards/{card_id}/threads/{comment_id}Șterge un comentariu cu răspunsurile lui - PATCH
/v1/cards/{card_id}/threads/{comment_id}Editează textul, marchează drept rezolvat sau redeschide un fir - GET
/v1/openapi-public.jsonObține specificația OpenAPI publică - GET
/v1/webhooksListează webhookurile organizației - POST
/v1/webhooksCreează un webhook - GET
/v1/webhooks/catalogListează tipurile de evenimente - GET
/v1/webhooks/{webhook_id}Obține un webhook - DELETE
/v1/webhooks/{webhook_id}Șterge un webhook - PATCH
/v1/webhooks/{webhook_id}Actualizează un webhook - POST
/v1/webhooks/{webhook_id}/testTrimite un eveniment de test - POST
/v1/webhooks/{webhook_id}/rotate-secretReînnoiește secretul de semnare - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocă secretul anterior - POST
/v1/webhooks/{webhook_id}/resumeReia un webhook - POST
/v1/webhooks/{webhook_id}/redeliverRepetă livrările dintr-o perioadă - GET
/v1/webhooks/{webhook_id}/attemptsListează încercările de livrare - GET
/v1/webhooks/{webhook_id}/deliveriesListează livrările webhookului - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Obține o livrare cu corpurile și încercările ei - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverLivrează din nou un eveniment - GET
/v1/webhook-eventsListează evenimentele - GET
/v1/webhook-events/{event_id}Obține un eveniment - GET
/v1/api-usageObține utilizarea API-ului - GET
/v1/api-logsListează cererile API - GET
/v1/api-logs/{request_id}Obține o cerere API - GET
/v1/appsListează aplicațiile OAuth - POST
/v1/appsCreează o aplicație OAuth - GET
/v1/apps/{app_id}Obține o aplicație OAuth - DELETE
/v1/apps/{app_id}Șterge o aplicație OAuth - PATCH
/v1/apps/{app_id}Actualizează o aplicație OAuth - POST
/v1/apps/{app_id}/rotate-secretReînnoiește secretul de client - GET
/v1/app-authorizationsListează autorizările aplicațiilor - DELETE
/v1/app-authorizations/{authorization_id}Revocă autorizarea unui angajat - GET
/v1/analytics/healthObține tabloul de bord al stării cunoștințelor - GET
/v1/analytics/usageObține tabloul de bord al utilizării - GET
/v1/analytics/contributionObține tabloul de bord al contribuțiilor - GET
/v1/analytics/cards/{card_id}Obține indicatorii unei fișe - GET
/v1/audit/verifyVerifică integritatea jurnalului de audit al organizației - POST
/v1/users/importImportă utilizatori din CSV - GET
/v1/quality/gaps/followupsListează golurile de cunoștințe aflate în lucru - POST
/v1/quality/gaps/followupsPreia în lucru un gol de cunoștințe - PATCH
/v1/quality/gaps/followups/{followup_id}Actualizează un gol de cunoștințe aflat în lucru - GET
/v1/access-requestsListează cererile de acces proprii sau primite - GET
/v1/access-requests/{request_id}Obține o cerere de acces pentru un decident - POST
/v1/access-requests/{request_id}/grantAcordă accesul pe baza unei cereri - POST
/v1/access-requests/{request_id}/denyRefuză accesul - POST
/v1/finance/reportObține un raport financiar sintetic - POST
/v1/finance/report/exportExportă raportul financiar sintetic - POST
/v1/finance/invoicesListează facturile - POST
/v1/finance/invoices/exportExportă lista de facturi - POST
/v1/finance/paymentsListează plățile - POST
/v1/finance/payments/exportExportă lista de plăți - GET
/v1/sources/{source_id}/push-keysListează cheile API ale unei surse personalizate - POST
/v1/sources/{source_id}/push-keysCreează o cheie API pentru o sursă personalizată - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Revocă o cheie API a unei surse personalizate - GET
/v1/sources/{source_id}/push-syncsListează sincronizările unei surse personalizate - GET
/v1/push/sources/{source_id}Verifică cheia și obține starea unei surse personalizate - POST
/v1/push/sources/{source_id}/syncsDeschide o sincronizare - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Obține o sincronizare - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsListează rezultatele documentelor unei sincronizări - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeÎnchide o sincronizare - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirmă documente fără a le trimite din nou - POST
/v1/push/sources/{source_id}/documentsTrimite un document (creare sau înlocuire) - POST
/v1/push/sources/{source_id}/documents/batchTrimite un lot de documente - GET
/v1/push/sources/{source_id}/documents/{external_id}Obține rezultatul unui document - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Șterge un document