Oggetti
Error
Risposta di errore standard. detail è una stringa, un oggetto con code (ad esempio choose_org, org_suspended, codici degli inviti) o un elenco di errori di convalida (422). error è una descrizione strutturata: un codice dal catalogo degli errori, un messaggio in inglese, dettagli strutturati e l’ID della richiesta.
Campi
Messaggio di errore, un oggetto con un codice o un elenco di errori di convalida.
errorErrorInfo
Usato da
- GET
/v1/healthOttenere lo stato e la versione del servizio - GET
/v1/usersElencare gli utenti dell’organizzazione - POST
/v1/usersCreare un utente - PATCH
/v1/users/{user_id}Aggiornare un utente - GET
/v1/api-keysElencare le chiavi API dell’organizzazione - POST
/v1/api-keysCreare una chiave API - DELETE
/v1/api-keys/{key_id}Revocare una chiave API - PATCH
/v1/api-keys/{key_id}Aggiornare una chiave API - POST
/v1/api-keys/{key_id}/rollRuotare una chiave API - POST
/v1/api-keys/{key_id}/revoke-previousRevocare il valore precedente di una chiave API - GET
/v1/auditElencare le voci del registro di audit - GET
/v1/audit/actionsElencare le azioni del registro di audit con i conteggi - GET
/v1/audit/export.csvEsportare il registro di audit in CSV - GET
/v1/orgOttenere l’organizzazione - GET
/v1/categoriesElencare le categorie dei documenti - POST
/v1/categoriesCreare una categoria - DELETE
/v1/categories/{key}Eliminare una categoria personalizzata - PATCH
/v1/categories/{key}Aggiornare una categoria - GET
/v1/collectionsElencare le raccolte disponibili per l’utente - POST
/v1/collectionsCreare una raccolta - DELETE
/v1/collections/{name}Eliminare una raccolta - PATCH
/v1/collections/{name}Aggiornare una raccolta - POST
/v1/collections/{name}/reindexReindicizzare una raccolta - GET
/v1/collections/{name}/statsOttenere la panoramica della raccolta: statistiche, categorie, schede recenti, permessi - GET
/v1/cardsElencare le schede - POST
/v1/cardsCaricare un file come scheda - GET
/v1/jobsElencare i job di indicizzazione - GET
/v1/jobs/summaryOttenere il riepilogo della coda - GET
/v1/jobs/streamTrasmettere in streaming le modifiche ai job (SSE) - GET
/v1/jobs/{job_id}Ottenere un job - DELETE
/v1/jobs/{job_id}Annullare un job in coda - GET
/v1/cards/countContare le schede - GET
/v1/cards/export.xlsxEsportare l’elenco delle schede in XLSX - POST
/v1/cards/bulkEseguire un’azione in blocco sulle schede - GET
/v1/cards/{card_id}Ottenere una scheda con versioni, commenti, tabelle ed eventi - DELETE
/v1/cards/{card_id}Eliminare una scheda - PATCH
/v1/cards/{card_id}Aggiornare una scheda - GET
/v1/cards-by-external-id/{external_id}Ottenere una scheda tramite ID esterno - PUT
/v1/cards-by-external-id/{external_id}Creare o sostituire una scheda tramite ID esterno - GET
/v1/cards/{card_id}/contentOttenere il testo della scheda per sezioni - PUT
/v1/cards/{card_id}/contentSostituire il contenuto di una scheda - GET
/v1/cards/{card_id}/tables/{table_id}/rowsElencare le righe di una tabella dei fatti - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Confrontare due versioni di una scheda - GET
/v1/cards/{card_id}/usageElencare le domande le cui risposte hanno usato la scheda - POST
/v1/cards/{card_id}/usageRegistrare un evento di utilizzo di una scheda - POST
/v1/cards/{card_id}/reindexReindicizzare una scheda - DELETE
/v1/cards/{card_id}/comments/{comment_id}Eliminare un commento - GET
/v1/cards/{card_id}/fileScaricare il file originale di una scheda - GET
/v1/cards/{card_id}/exportEsportare una scheda in un documento - POST
/v1/cards/{card_id}/verifyConfermare che una scheda è aggiornata - POST
/v1/cards/{card_id}/commentsAggiungere un commento - GET
/v1/conversationsElencare le conversazioni - GET
/v1/conversations/{conv_id}Ottenere una conversazione con i suoi turni - POST
/v1/searchCercare nelle raccolte - POST
/v1/askOttenere una risposta dell’assistente senza streaming - POST
/v1/chatTrasmettere in streaming una risposta dell’assistente (SSE) - POST
/v1/questions/{question_id}/feedbackValutare una risposta - GET
/v1/questions/export.csvEsportare il registro delle domande in CSV - GET
/v1/questions/{question_id}Ottenere una domanda salvata con la sua risposta - GET
/v1/questions/{question_id}/followupsOttenere le domande successive suggerite - GET
/v1/questionsElencare il registro delle domande - GET
/v1/questions/{question_id}/exportEsportare una risposta in un documento - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportEsportare un set di dati di una risposta - GET
/v1/questions/{question_id}/answer-tables/{index}/exportEsportare una tabella dal testo della risposta - POST
/v1/questions/{question_id}/refreshAggiornare i set di dati di una risposta (risposta dinamica) - POST
/v1/questions/{question_id}/save-cardSalvare una risposta come scheda - POST
/v1/cards/textCreare una scheda di testo (Markdown) - GET
/v1/filesElencare i file di esportazione - GET
/v1/files/authorsElencare gli autori dei file (per il filtro dell’amministratore) - GET
/v1/files/{file_id}Ottenere i dettagli di un file - DELETE
/v1/files/{file_id}Eliminare un file - GET
/v1/files/{file_id}/downloadScaricare un file - GET
/v1/files/{file_id}/previewVisualizzare l’anteprima di un file - POST
/v1/files/{file_id}/extendProlungare il periodo di conservazione di un file - POST
/v1/files/{file_id}/regenerateRigenerare un file dai suoi parametri salvati - GET
/v1/tasksElencare le attività di un utente o di un team - POST
/v1/sourcesCreare una fonte - GET
/v1/sources/{source_id}Ottenere una fonte - DELETE
/v1/sources/{source_id}Eliminare una fonte - PATCH
/v1/sources/{source_id}Aggiornare una fonte - PATCH
/v1/sources/{source_id}/settingsAggiornare le impostazioni di una fonte - GET
/v1/cards/{card_id}/similarElencare le schede simili - GET
/v1/insights/gapsElencare le lacune di conoscenza (gruppi di domande senza risposta) - GET
/v1/permissionsElencare il registro dei permessi - POST
/v1/uploadsAvviare un caricamento in parti - GET
/v1/uploads/{upload_id}Ottenere un caricamento - DELETE
/v1/uploads/{upload_id}Annullare un caricamento - PUT
/v1/uploads/{upload_id}/parts/{n}Inviare una parte del caricamento - POST
/v1/uploads/{upload_id}/completeCompletare un caricamento - GET
/v1/meOttenere informazioni su chi effettua la chiamata all’API - GET
/v1/me/permissionsOttenere i permessi dell’utente corrente sull’organizzazione - GET
/v1/rolesElencare i ruoli (predefiniti e personalizzati) - POST
/v1/rolesCreare un ruolo personalizzato - DELETE
/v1/roles/{role_id}Eliminare un ruolo personalizzato - PATCH
/v1/roles/{role_id}Aggiornare un ruolo personalizzato - GET
/v1/groupsElencare i gruppi dell’organizzazione - POST
/v1/groupsCreare un gruppo - GET
/v1/groups/{group_id}Ottenere un gruppo con i suoi membri - DELETE
/v1/groups/{group_id}Eliminare un gruppo - PATCH
/v1/groups/{group_id}Rinominare un gruppo - PUT
/v1/groups/{group_id}/members/{user_id}Aggiungere un membro a un gruppo - DELETE
/v1/groups/{group_id}/members/{user_id}Rimuovere un membro da un gruppo - GET
/v1/org/permissionsOttenere i permessi sull’organizzazione (chi è amministratore) - PUT
/v1/org/permissionsConcedere ruoli sull’organizzazione - DELETE
/v1/org/permissionsRevocare ruoli sull’organizzazione - GET
/v1/collections/{name}/permissionsOttenere i permessi su una raccolta (diretti ed ereditati) - PUT
/v1/collections/{name}/permissionsConcedere ruoli su una raccolta - DELETE
/v1/collections/{name}/permissionsRevocare ruoli su una raccolta - GET
/v1/cards/{card_id}/permissionsOttenere i permessi su una scheda (diretti ed ereditati) - PUT
/v1/cards/{card_id}/permissionsConcedere ruoli su una scheda - DELETE
/v1/cards/{card_id}/permissionsRevocare ruoli su una scheda - GET
/v1/sources/{source_id}/permissionsOttenere i permessi su una fonte (diretti ed ereditati) - PUT
/v1/sources/{source_id}/permissionsConcedere ruoli su una fonte - DELETE
/v1/sources/{source_id}/permissionsRevocare ruoli su una fonte - POST
/v1/users/{user_id}/offboardEseguire l’offboarding di un utente - GET
/v1/collections/{name}/foldersOttenere l’albero delle cartelle di una raccolta - POST
/v1/collections/{name}/foldersCreare una cartella - GET
/v1/foldersOttenere gli alberi delle cartelle di tutte le raccolte - GET
/v1/folders/{folder_id}Ottenere una cartella - DELETE
/v1/folders/{folder_id}Eliminare una cartella e portarne il contenuto al livello superiore - PATCH
/v1/folders/{folder_id}Rinominare, spostare o riordinare una cartella - GET
/v1/folders/{folder_id}/cardsElencare le schede di una cartella - GET
/v1/folders/{folder_id}/permissionsOttenere i permessi su una cartella (diretti ed ereditati) - PUT
/v1/folders/{folder_id}/permissionsConcedere ruoli su una cartella - DELETE
/v1/folders/{folder_id}/permissionsRevocare ruoli su una cartella - GET
/v1/catalog/servicesElencare i servizi del catalogo - GET
/v1/catalog/services/{service_id}Ottenere un servizio del catalogo - GET
/v1/catalog/services/{service_id}/iconOttenere l’icona di un servizio - GET
/v1/catalog/categoriesElencare le categorie del catalogo - GET
/v1/catalog/spend-taxonomyOttenere la tassonomia di spese e ricavi - POST
/v1/catalog/resolveAssociare nomi ai servizi del catalogo - GET
/v1/draftsElencare le bozze - POST
/v1/draftsCreare una bozza - GET
/v1/drafts/{draft_id}Ottenere una bozza - PATCH
/v1/drafts/{draft_id}Aggiornare una bozza - POST
/v1/drafts/{draft_id}/request-publishRichiedere la pubblicazione - POST
/v1/drafts/{draft_id}/approveApprovare la pubblicazione - GET
/v1/tagsElencare i tag delle schede dell’organizzazione - POST
/v1/cards/archiveCaricare un archivio di documenti - GET
/v1/archives/{job_id}Ottenere un job di estrazione di un archivio - GET
/v1/cards/{card_id}/verificationOttenere il blocco di verifica di una scheda - POST
/v1/cards/{card_id}/verification/verifyVerificare una scheda - POST
/v1/cards/{card_id}/verification/unverifyRevocare l’affidabilità o sollecitare il verificatore - PUT
/v1/cards/{card_id}/verification/verifiersImpostare i verificatori di una scheda - PUT
/v1/cards/{card_id}/verification/intervalModificare il tipo di verifica e la scadenza - GET
/v1/verification/queueOttenere la coda di verifica - GET
/v1/collections/{name}/trustOttenere il “Trust Score” (indice di affidabilità) di una raccolta - GET
/v1/org/trustOttenere il “Trust Score” (indice di affidabilità) dell’organizzazione - GET
/v1/announcementsElencare le comunicazioni - POST
/v1/announcementsInviare una comunicazione di lettura obbligatoria - GET
/v1/announcements/{announcement_id}Ottenere una comunicazione - GET
/v1/announcements/{announcement_id}/statsOttenere il report di una comunicazione - POST
/v1/announcements/{announcement_id}/remindSollecitare chi non ha letto - GET
/v1/cards/{card_id}/threadsElencare le discussioni di commenti di una scheda - POST
/v1/cards/{card_id}/threadsAggiungere un commento o una risposta in una discussione - DELETE
/v1/cards/{card_id}/threads/{comment_id}Eliminare un commento con le sue risposte - PATCH
/v1/cards/{card_id}/threads/{comment_id}Modificare il testo, risolvere o riaprire una discussione - GET
/v1/openapi-public.jsonOttenere la specifica OpenAPI pubblica - GET
/v1/webhooksElencare i webhook dell’organizzazione - POST
/v1/webhooksCreare un webhook - GET
/v1/webhooks/catalogElencare i tipi di evento - GET
/v1/webhooks/{webhook_id}Ottenere un webhook - DELETE
/v1/webhooks/{webhook_id}Eliminare un webhook - PATCH
/v1/webhooks/{webhook_id}Aggiornare un webhook - POST
/v1/webhooks/{webhook_id}/testInviare un evento di test - POST
/v1/webhooks/{webhook_id}/rotate-secretRuotare il segreto di firma - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocare il segreto precedente - POST
/v1/webhooks/{webhook_id}/resumeRiprendere un webhook - POST
/v1/webhooks/{webhook_id}/redeliverRipetere le consegne di un periodo - GET
/v1/webhooks/{webhook_id}/attemptsElencare i tentativi di consegna - GET
/v1/webhooks/{webhook_id}/deliveriesElencare le consegne di un webhook - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Ottenere una consegna con i corpi e i tentativi - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverConsegnare di nuovo un evento - GET
/v1/webhook-eventsElencare gli eventi - GET
/v1/webhook-events/{event_id}Ottenere un evento - GET
/v1/api-usageOttenere l’utilizzo dell’API - GET
/v1/api-logsElencare le richieste API - GET
/v1/api-logs/{request_id}Ottenere una richiesta API - GET
/v1/appsElencare le app OAuth - POST
/v1/appsCreare un’app OAuth - GET
/v1/apps/{app_id}Ottenere un’app OAuth - DELETE
/v1/apps/{app_id}Eliminare un’app OAuth - PATCH
/v1/apps/{app_id}Aggiornare un’app OAuth - POST
/v1/apps/{app_id}/rotate-secretRuotare il segreto client - GET
/v1/app-authorizationsElencare le autorizzazioni delle app - DELETE
/v1/app-authorizations/{authorization_id}Revocare l’autorizzazione di un dipendente - GET
/v1/analytics/healthOttenere la dashboard dello stato di salute della conoscenza - GET
/v1/analytics/usageOttenere la dashboard di utilizzo - GET
/v1/analytics/contributionOttenere la dashboard dei contributi - GET
/v1/analytics/cards/{card_id}Ottenere le metriche di una scheda - GET
/v1/audit/verifyVerificare l’integrità del registro di audit dell’organizzazione - POST
/v1/users/importImportare utenti da CSV - GET
/v1/quality/gaps/followupsElencare le lacune di conoscenza prese in carico - POST
/v1/quality/gaps/followupsPrendere in carico una lacuna di conoscenza - PATCH
/v1/quality/gaps/followups/{followup_id}Aggiornare una lacuna di conoscenza presa in carico - GET
/v1/access-requestsElencare le proprie richieste di accesso o quelle in arrivo - GET
/v1/access-requests/{request_id}Ottenere una richiesta di accesso per chi decide - POST
/v1/access-requests/{request_id}/grantConcedere l’accesso in base a una richiesta - POST
/v1/access-requests/{request_id}/denyNegare l’accesso - POST
/v1/finance/reportOttenere un report finanziario di sintesi - POST
/v1/finance/report/exportEsportare il report finanziario di sintesi - POST
/v1/finance/invoicesElencare le fatture - POST
/v1/finance/invoices/exportEsportare l’elenco delle fatture - POST
/v1/finance/paymentsElencare i pagamenti - POST
/v1/finance/payments/exportEsportare l’elenco dei pagamenti - GET
/v1/sources/{source_id}/push-keysElencare le chiavi API di una fonte personalizzata - POST
/v1/sources/{source_id}/push-keysCreare una chiave API per una fonte personalizzata - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Revocare una chiave API di una fonte personalizzata - GET
/v1/sources/{source_id}/push-syncsElencare le sincronizzazioni di una fonte personalizzata - GET
/v1/push/sources/{source_id}Verificare la chiave e ottenere lo stato di una fonte personalizzata - POST
/v1/push/sources/{source_id}/syncsAprire una sincronizzazione - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Ottenere una sincronizzazione - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsElencare i risultati dei documenti di una sincronizzazione - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeChiudere una sincronizzazione - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfermare i documenti senza inviarli di nuovo - POST
/v1/push/sources/{source_id}/documentsInviare un documento (creare o sostituire) - POST
/v1/push/sources/{source_id}/documents/batchInviare un batch di documenti - GET
/v1/push/sources/{source_id}/documents/{external_id}Ottenere il risultato di un documento - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Eliminare un documento