Objets
Error
Réponse d’erreur standard. detail est une chaîne, un objet avec code (par exemple choose_org, org_suspended, des codes d’invitation) ou une liste d’erreurs de validation (422). error est une description structurée : un code du catalogue des erreurs, un message en anglais, des détails structurés et l’identifiant de requête.
Champs
Message d’erreur, objet avec un code ou liste d’erreurs de validation.
errorErrorInfo
Utilisé par
- GET
/v1/healthObtenir l’état et la version du service - GET
/v1/usersLister les utilisateurs de l’organisation - POST
/v1/usersCréer un utilisateur - PATCH
/v1/users/{user_id}Modifier un utilisateur - GET
/v1/api-keysLister les clés API de l’organisation - POST
/v1/api-keysCréer une clé API - DELETE
/v1/api-keys/{key_id}Révoquer une clé API - PATCH
/v1/api-keys/{key_id}Modifier une clé API - POST
/v1/api-keys/{key_id}/rollRenouveler une clé API - POST
/v1/api-keys/{key_id}/revoke-previousRévoquer l’ancienne valeur d’une clé API - GET
/v1/auditLister les entrées du journal d’audit - GET
/v1/audit/actionsLister les actions du journal d’audit avec leur nombre - GET
/v1/audit/export.csvExporter le journal d’audit au format CSV - GET
/v1/orgObtenir l’organisation - GET
/v1/categoriesLister les catégories de documents - POST
/v1/categoriesCréer une catégorie - DELETE
/v1/categories/{key}Supprimer une catégorie personnalisée - PATCH
/v1/categories/{key}Modifier une catégorie - GET
/v1/collectionsLister les collections accessibles à l’utilisateur - POST
/v1/collectionsCréer une collection - DELETE
/v1/collections/{name}Supprimer une collection - PATCH
/v1/collections/{name}Modifier une collection - POST
/v1/collections/{name}/reindexRéindexer une collection - GET
/v1/collections/{name}/statsObtenir la vue d’ensemble de la collection : statistiques, catégories, fiches récentes, permissions - GET
/v1/cardsLister les fiches - POST
/v1/cardsTéléverser un fichier comme fiche - GET
/v1/jobsLister les jobs d’indexation - GET
/v1/jobs/summaryObtenir la synthèse de la file - GET
/v1/jobs/streamSuivre les modifications des jobs en flux (SSE) - GET
/v1/jobs/{job_id}Obtenir un job - DELETE
/v1/jobs/{job_id}Annuler un job en file - GET
/v1/cards/countCompter les fiches - GET
/v1/cards/export.xlsxExporter la liste des fiches au format XLSX - POST
/v1/cards/bulkExécuter une action groupée sur des fiches - GET
/v1/cards/{card_id}Obtenir une fiche avec ses versions, commentaires, tableaux et événements - DELETE
/v1/cards/{card_id}Supprimer une fiche - PATCH
/v1/cards/{card_id}Modifier une fiche - GET
/v1/cards-by-external-id/{external_id}Obtenir une fiche par identifiant externe - PUT
/v1/cards-by-external-id/{external_id}Créer ou remplacer une fiche par identifiant externe - GET
/v1/cards/{card_id}/contentObtenir le texte de la fiche par section - PUT
/v1/cards/{card_id}/contentRemplacer le contenu d’une fiche - GET
/v1/cards/{card_id}/tables/{table_id}/rowsLister les lignes d’une table de faits - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Comparer deux versions d’une fiche - GET
/v1/cards/{card_id}/usageLister les questions dont les réponses ont utilisé la fiche - POST
/v1/cards/{card_id}/usageEnregistrer un événement d’utilisation de la fiche - POST
/v1/cards/{card_id}/reindexRéindexer une fiche - DELETE
/v1/cards/{card_id}/comments/{comment_id}Supprimer un commentaire - GET
/v1/cards/{card_id}/fileTélécharger le fichier original d’une fiche - GET
/v1/cards/{card_id}/exportExporter une fiche vers un document - POST
/v1/cards/{card_id}/verifyConfirmer qu’une fiche est à jour - POST
/v1/cards/{card_id}/commentsAjouter un commentaire - GET
/v1/conversationsLister les conversations - GET
/v1/conversations/{conv_id}Obtenir une conversation avec ses échanges - POST
/v1/searchRechercher dans les collections - POST
/v1/askObtenir une réponse de l’assistant sans flux - POST
/v1/chatRecevoir une réponse de l’assistant en flux (SSE) - POST
/v1/questions/{question_id}/feedbackNoter une réponse - GET
/v1/questions/export.csvExporter le journal des questions au format CSV - GET
/v1/questions/{question_id}Obtenir une question enregistrée avec sa réponse - GET
/v1/questions/{question_id}/followupsObtenir des suggestions de questions suivantes - GET
/v1/questionsLister le journal des questions - GET
/v1/questions/{question_id}/exportExporter une réponse vers un document - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExporter un jeu de données d’une réponse - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExporter un tableau du texte de la réponse - POST
/v1/questions/{question_id}/refreshActualiser les jeux de données d’une réponse (réponse dynamique) - POST
/v1/questions/{question_id}/save-cardEnregistrer une réponse comme fiche - POST
/v1/cards/textCréer une fiche texte (Markdown) - GET
/v1/filesLister les fichiers d’export - GET
/v1/files/authorsLister les auteurs des fichiers (pour le filtre de l’administrateur) - GET
/v1/files/{file_id}Obtenir les détails d’un fichier - DELETE
/v1/files/{file_id}Supprimer un fichier - GET
/v1/files/{file_id}/downloadTélécharger un fichier - GET
/v1/files/{file_id}/previewAfficher l’aperçu d’un fichier - POST
/v1/files/{file_id}/extendProlonger la durée de conservation d’un fichier - POST
/v1/files/{file_id}/regenerateRégénérer un fichier à partir de ses paramètres enregistrés - GET
/v1/tasksLister les tâches d’un utilisateur ou d’une équipe - POST
/v1/sourcesCréer une source - GET
/v1/sources/{source_id}Obtenir une source - DELETE
/v1/sources/{source_id}Supprimer une source - PATCH
/v1/sources/{source_id}Modifier une source - PATCH
/v1/sources/{source_id}/settingsModifier les réglages d’une source - GET
/v1/cards/{card_id}/similarLister les fiches similaires - GET
/v1/insights/gapsLister les lacunes de connaissances (groupes de questions sans réponse) - GET
/v1/permissionsLister le registre des permissions - POST
/v1/uploadsDémarrer un téléversement en plusieurs parties - GET
/v1/uploads/{upload_id}Obtenir un téléversement - DELETE
/v1/uploads/{upload_id}Annuler un téléversement - PUT
/v1/uploads/{upload_id}/parts/{n}Envoyer une partie du téléversement - POST
/v1/uploads/{upload_id}/completeTerminer un téléversement - GET
/v1/meObtenir l’appelant de l’API - GET
/v1/me/permissionsObtenir les permissions de l’utilisateur actuel sur l’organisation - GET
/v1/rolesLister les rôles (intégrés et personnalisés) - POST
/v1/rolesCréer un rôle personnalisé - DELETE
/v1/roles/{role_id}Supprimer un rôle personnalisé - PATCH
/v1/roles/{role_id}Modifier un rôle personnalisé - GET
/v1/groupsLister les groupes de l’organisation - POST
/v1/groupsCréer un groupe - GET
/v1/groups/{group_id}Obtenir un groupe avec ses membres - DELETE
/v1/groups/{group_id}Supprimer un groupe - PATCH
/v1/groups/{group_id}Renommer un groupe - PUT
/v1/groups/{group_id}/members/{user_id}Ajouter un membre à un groupe - DELETE
/v1/groups/{group_id}/members/{user_id}Retirer un membre d’un groupe - GET
/v1/org/permissionsObtenir les permissions sur l’organisation (qui est administrateur) - PUT
/v1/org/permissionsAttribuer des rôles sur l’organisation - DELETE
/v1/org/permissionsRetirer des rôles sur l’organisation - GET
/v1/collections/{name}/permissionsObtenir les permissions sur une collection (directes et héritées) - PUT
/v1/collections/{name}/permissionsAttribuer des rôles sur une collection - DELETE
/v1/collections/{name}/permissionsRetirer des rôles sur une collection - GET
/v1/cards/{card_id}/permissionsObtenir les permissions sur une fiche (directes et héritées) - PUT
/v1/cards/{card_id}/permissionsAttribuer des rôles sur une fiche - DELETE
/v1/cards/{card_id}/permissionsRetirer des rôles sur une fiche - GET
/v1/sources/{source_id}/permissionsObtenir les permissions sur une source (directes et héritées) - PUT
/v1/sources/{source_id}/permissionsAttribuer des rôles sur une source - DELETE
/v1/sources/{source_id}/permissionsRetirer des rôles sur une source - POST
/v1/users/{user_id}/offboardFinaliser le départ d’un utilisateur - GET
/v1/collections/{name}/foldersObtenir l’arborescence des dossiers d’une collection - POST
/v1/collections/{name}/foldersCréer un dossier - GET
/v1/foldersObtenir les arborescences de dossiers de toutes les collections - GET
/v1/folders/{folder_id}Obtenir un dossier - DELETE
/v1/folders/{folder_id}Supprimer un dossier et remonter son contenu - PATCH
/v1/folders/{folder_id}Renommer, déplacer ou changer la position d’un dossier - GET
/v1/folders/{folder_id}/cardsLister les fiches d’un dossier - GET
/v1/folders/{folder_id}/permissionsObtenir les permissions sur un dossier (directes et héritées) - PUT
/v1/folders/{folder_id}/permissionsAttribuer des rôles sur un dossier - DELETE
/v1/folders/{folder_id}/permissionsRetirer des rôles sur un dossier - GET
/v1/catalog/servicesLister les services du catalogue - GET
/v1/catalog/services/{service_id}Obtenir un service du catalogue - GET
/v1/catalog/services/{service_id}/iconObtenir l’icône d’un service - GET
/v1/catalog/categoriesLister les catégories du catalogue - GET
/v1/catalog/spend-taxonomyObtenir la classification des dépenses et des recettes - POST
/v1/catalog/resolveAssocier des noms aux services du catalogue - GET
/v1/draftsLister les brouillons - POST
/v1/draftsCréer un brouillon - GET
/v1/drafts/{draft_id}Obtenir un brouillon - PATCH
/v1/drafts/{draft_id}Modifier un brouillon - POST
/v1/drafts/{draft_id}/request-publishDemander la publication - POST
/v1/drafts/{draft_id}/approveApprouver la publication - GET
/v1/tagsLister les étiquettes des fiches de l’organisation - POST
/v1/cards/archiveTéléverser une archive de documents - GET
/v1/archives/{job_id}Obtenir un job d’extraction d’archive - GET
/v1/cards/{card_id}/verificationObtenir le bloc de validation d’une fiche - POST
/v1/cards/{card_id}/verification/verifyValider une fiche - POST
/v1/cards/{card_id}/verification/unverifyRetirer la confiance ou envoyer un rappel au valideur - PUT
/v1/cards/{card_id}/verification/verifiersDéfinir les valideurs d’une fiche - PUT
/v1/cards/{card_id}/verification/intervalChanger le type de validation et l’échéance - GET
/v1/verification/queueObtenir la file de validation - GET
/v1/collections/{name}/trustObtenir le « Trust Score » d’une collection - GET
/v1/org/trustObtenir le « Trust Score » de l’organisation - GET
/v1/announcementsLister les annonces - POST
/v1/announcementsEnvoyer une annonce à lecture obligatoire - GET
/v1/announcements/{announcement_id}Obtenir une annonce - GET
/v1/announcements/{announcement_id}/statsObtenir le rapport d’une annonce - POST
/v1/announcements/{announcement_id}/remindEnvoyer un rappel à ceux qui n’ont pas lu - GET
/v1/cards/{card_id}/threadsLister les fils de commentaires d’une fiche - POST
/v1/cards/{card_id}/threadsAjouter un commentaire ou une réponse dans un fil - DELETE
/v1/cards/{card_id}/threads/{comment_id}Supprimer un commentaire avec ses réponses - PATCH
/v1/cards/{card_id}/threads/{comment_id}Modifier le texte, marquer comme résolu ou rouvrir un fil - GET
/v1/openapi-public.jsonObtenir la spécification OpenAPI publique - GET
/v1/webhooksLister les webhooks de l’organisation - POST
/v1/webhooksCréer un webhook - GET
/v1/webhooks/catalogLister les types d’événements - GET
/v1/webhooks/{webhook_id}Obtenir un webhook - DELETE
/v1/webhooks/{webhook_id}Supprimer un webhook - PATCH
/v1/webhooks/{webhook_id}Modifier un webhook - POST
/v1/webhooks/{webhook_id}/testEnvoyer un événement de test - POST
/v1/webhooks/{webhook_id}/rotate-secretRenouveler le secret de signature - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRévoquer l’ancien secret - POST
/v1/webhooks/{webhook_id}/resumeRéactiver un webhook - POST
/v1/webhooks/{webhook_id}/redeliverEffectuer une nouvelle livraison pour une période - GET
/v1/webhooks/{webhook_id}/attemptsLister les tentatives de livraison - GET
/v1/webhooks/{webhook_id}/deliveriesLister les livraisons d’un webhook - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Obtenir une livraison avec ses corps et ses tentatives - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverLivrer de nouveau un événement - GET
/v1/webhook-eventsLister les événements - GET
/v1/webhook-events/{event_id}Obtenir un événement - GET
/v1/api-usageObtenir l’utilisation de l’API - GET
/v1/api-logsLister les requêtes à l’API - GET
/v1/api-logs/{request_id}Obtenir une requête à l’API - GET
/v1/appsLister les applications OAuth - POST
/v1/appsCréer une application OAuth - GET
/v1/apps/{app_id}Obtenir une application OAuth - DELETE
/v1/apps/{app_id}Supprimer une application OAuth - PATCH
/v1/apps/{app_id}Modifier une application OAuth - POST
/v1/apps/{app_id}/rotate-secretRenouveler le secret client - GET
/v1/app-authorizationsLister les autorisations des applications - DELETE
/v1/app-authorizations/{authorization_id}Révoquer l’autorisation d’un salarié - GET
/v1/analytics/healthObtenir le tableau de bord de santé des connaissances - GET
/v1/analytics/usageObtenir le tableau de bord d’utilisation - GET
/v1/analytics/contributionObtenir le tableau de bord des contributions - GET
/v1/analytics/cards/{card_id}Obtenir les métriques d’une fiche - GET
/v1/audit/verifyVérifier l’intégrité du journal d’audit de l’organisation - POST
/v1/users/importImporter des utilisateurs depuis un fichier CSV - GET
/v1/quality/gaps/followupsLister les lacunes de connaissances prises en charge - POST
/v1/quality/gaps/followupsPrendre en charge une lacune de connaissances - PATCH
/v1/quality/gaps/followups/{followup_id}Modifier une lacune de connaissances prise en charge - GET
/v1/access-requestsLister ses propres demandes d’accès ou les demandes reçues - GET
/v1/access-requests/{request_id}Obtenir une demande d’accès pour un décideur - POST
/v1/access-requests/{request_id}/grantAccorder l’accès à la suite d’une demande - POST
/v1/access-requests/{request_id}/denyRefuser l’accès - POST
/v1/finance/reportObtenir un rapport financier de synthèse - POST
/v1/finance/report/exportExporter le rapport financier de synthèse - POST
/v1/finance/invoicesLister les factures - POST
/v1/finance/invoices/exportExporter la liste des factures - POST
/v1/finance/paymentsLister les paiements - POST
/v1/finance/payments/exportExporter la liste des paiements - GET
/v1/sources/{source_id}/push-keysLister les clés API d’une source personnalisée - POST
/v1/sources/{source_id}/push-keysCréer une clé API pour une source personnalisée - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Révoquer une clé API d’une source personnalisée - GET
/v1/sources/{source_id}/push-syncsLister les synchronisations d’une source personnalisée - GET
/v1/push/sources/{source_id}Vérifier la clé et obtenir l’état d’une source personnalisée - POST
/v1/push/sources/{source_id}/syncsOuvrir une synchronisation - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Obtenir une synchronisation - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsLister les résultats des documents d’une synchronisation - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeFermer une synchronisation - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirmer des documents sans les envoyer de nouveau - POST
/v1/push/sources/{source_id}/documentsEnvoyer un document (créer ou remplacer) - POST
/v1/push/sources/{source_id}/documents/batchEnvoyer un lot de documents - GET
/v1/push/sources/{source_id}/documents/{external_id}Obtenir le résultat d’un document - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Supprimer un document