Objectes
Error
Resposta d’error estàndard. detail és una cadena, un objecte amb code (per exemple choose_org, org_suspended, codis d’invitació) o una llista d’errors de validació (422). error és una descripció estructurada: un codi del catàleg d’errors, un missatge en anglès, detalls estructurats i l’ID de la sol·licitud.
Camps
Missatge d’error, un objecte amb un codi o una llista d’errors de validació.
errorErrorInfo
S’usa a
- GET
/v1/healthObtenir l’estat i la versió del servei - GET
/v1/usersLlistar els usuaris de l’organització - POST
/v1/usersCrear un usuari - PATCH
/v1/users/{user_id}Actualitzar un usuari - GET
/v1/api-keysLlistar les claus d’API de l’organització - POST
/v1/api-keysCrear una clau d’API - DELETE
/v1/api-keys/{key_id}Revocar una clau d’API - PATCH
/v1/api-keys/{key_id}Actualitzar una clau d’API - POST
/v1/api-keys/{key_id}/rollFer rotar una clau d’API - POST
/v1/api-keys/{key_id}/revoke-previousRevocar el valor anterior d’una clau d’API - GET
/v1/auditLlistar les anotacions del registre d’auditoria - GET
/v1/audit/actionsLlistar les accions del registre d’auditoria amb recomptes - GET
/v1/audit/export.csvExportar el registre d’auditoria en CSV - GET
/v1/orgObtenir l’organització - GET
/v1/categoriesLlistar les categories de documents - POST
/v1/categoriesCrear una categoria - DELETE
/v1/categories/{key}Eliminar una categoria personalitzada - PATCH
/v1/categories/{key}Actualitzar una categoria - GET
/v1/collectionsLlistar les col·leccions disponibles per a l’usuari - POST
/v1/collectionsCrear una col·lecció - DELETE
/v1/collections/{name}Eliminar una col·lecció - PATCH
/v1/collections/{name}Actualitzar una col·lecció - POST
/v1/collections/{name}/reindexReindexar una col·lecció - GET
/v1/collections/{name}/statsObtenir la visió general de la col·lecció: estadístiques, categories, entrades recents, permisos - GET
/v1/cardsLlistar les entrades - POST
/v1/cardsPujar un fitxer com a entrada - GET
/v1/jobsLlistar els treballs d’indexació - GET
/v1/jobs/summaryObtenir el resum de la cua - GET
/v1/jobs/streamTransmetre en temps real els canvis dels treballs (SSE) - GET
/v1/jobs/{job_id}Obtenir un treball - DELETE
/v1/jobs/{job_id}Cancel·lar un treball a la cua - GET
/v1/cards/countComptar les entrades - GET
/v1/cards/export.xlsxExportar la llista d’entrades a XLSX - POST
/v1/cards/bulkExecutar una acció massiva sobre entrades - GET
/v1/cards/{card_id}Obtenir una entrada amb les seves versions, comentaris, taules i esdeveniments - DELETE
/v1/cards/{card_id}Eliminar una entrada - PATCH
/v1/cards/{card_id}Actualitzar una entrada - GET
/v1/cards-by-external-id/{external_id}Obtenir una entrada per ID extern - PUT
/v1/cards-by-external-id/{external_id}Crear o substituir una entrada per ID extern - GET
/v1/cards/{card_id}/contentObtenir el text de l’entrada per seccions - PUT
/v1/cards/{card_id}/contentSubstituir el contingut d’una entrada - GET
/v1/cards/{card_id}/tables/{table_id}/rowsLlistar les files d’una taula de fets - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Comparar dues versions d’una entrada - GET
/v1/cards/{card_id}/usageLlistar les preguntes les respostes de les quals han fet servir l’entrada - POST
/v1/cards/{card_id}/usageRegistrar un esdeveniment d’ús d’una entrada - POST
/v1/cards/{card_id}/reindexReindexar una entrada - DELETE
/v1/cards/{card_id}/comments/{comment_id}Eliminar un comentari - GET
/v1/cards/{card_id}/fileBaixar el fitxer original d’una entrada - GET
/v1/cards/{card_id}/exportExportar una entrada a un document - POST
/v1/cards/{card_id}/verifyConfirmar que una entrada està al dia - POST
/v1/cards/{card_id}/commentsAfegir un comentari - GET
/v1/conversationsLlistar les converses - GET
/v1/conversations/{conv_id}Obtenir una conversa amb els seus torns - POST
/v1/searchCercar a les col·leccions - POST
/v1/askObtenir una resposta de l’assistent sense transmissió en temps real - POST
/v1/chatTransmetre en temps real una resposta de l’assistent (SSE) - POST
/v1/questions/{question_id}/feedbackValorar una resposta - GET
/v1/questions/export.csvExportar el registre de preguntes a CSV - GET
/v1/questions/{question_id}Obtenir una pregunta desada amb la seva resposta - GET
/v1/questions/{question_id}/followupsObtenir les preguntes de seguiment suggerides - GET
/v1/questionsLlistar el registre de preguntes - GET
/v1/questions/{question_id}/exportExportar una resposta a un document - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportar un conjunt de dades d’una resposta - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportar una taula del text de la resposta - POST
/v1/questions/{question_id}/refreshActualitzar els conjunts de dades d’una resposta (resposta dinàmica) - POST
/v1/questions/{question_id}/save-cardDesar una resposta com a entrada - POST
/v1/cards/textCrear una entrada de text (Markdown) - GET
/v1/filesLlistar els fitxers d’exportació - GET
/v1/files/authorsLlistar els autors dels fitxers (per al filtre de l’administrador) - GET
/v1/files/{file_id}Obtenir les dades d’un fitxer - DELETE
/v1/files/{file_id}Eliminar un fitxer - GET
/v1/files/{file_id}/downloadBaixar un fitxer - GET
/v1/files/{file_id}/previewPrevisualitzar un fitxer - POST
/v1/files/{file_id}/extendAmpliar el període de conservació d’un fitxer - POST
/v1/files/{file_id}/regenerateRegenerar un fitxer a partir dels seus paràmetres desats - GET
/v1/tasksLlistar les tasques d’un usuari o d’un equip - POST
/v1/sourcesCrear una font - GET
/v1/sources/{source_id}Obtenir una font - DELETE
/v1/sources/{source_id}Eliminar una font - PATCH
/v1/sources/{source_id}Actualitzar una font - PATCH
/v1/sources/{source_id}/settingsActualitzar la configuració d’una font - GET
/v1/cards/{card_id}/similarLlistar les entrades semblants - GET
/v1/insights/gapsLlistar les llacunes de coneixement (grups de preguntes sense resposta) - GET
/v1/permissionsLlistar el registre de permisos - POST
/v1/uploadsComençar una pujada per parts - GET
/v1/uploads/{upload_id}Obtenir una pujada - DELETE
/v1/uploads/{upload_id}Cancel·lar una pujada - PUT
/v1/uploads/{upload_id}/parts/{n}Enviar una part de la pujada - POST
/v1/uploads/{upload_id}/completeCompletar una pujada - GET
/v1/meObtenir qui fa la crida a l’API - GET
/v1/me/permissionsObtenir els permisos de l’usuari actual sobre l’organització - GET
/v1/rolesLlistar els rols (integrats i personalitzats) - POST
/v1/rolesCrear un rol personalitzat - DELETE
/v1/roles/{role_id}Eliminar un rol personalitzat - PATCH
/v1/roles/{role_id}Actualitzar un rol personalitzat - GET
/v1/groupsLlistar els grups de l’organització - POST
/v1/groupsCrear un grup - GET
/v1/groups/{group_id}Obtenir un grup amb els seus membres - DELETE
/v1/groups/{group_id}Eliminar un grup - PATCH
/v1/groups/{group_id}Canviar el nom d’un grup - PUT
/v1/groups/{group_id}/members/{user_id}Afegir un membre a un grup - DELETE
/v1/groups/{group_id}/members/{user_id}Treure un membre d’un grup - GET
/v1/org/permissionsObtenir els permisos sobre l’organització (qui és administrador) - PUT
/v1/org/permissionsConcedir rols sobre l’organització - DELETE
/v1/org/permissionsRevocar rols sobre l’organització - GET
/v1/collections/{name}/permissionsObtenir els permisos sobre una col·lecció (directes i heretats) - PUT
/v1/collections/{name}/permissionsConcedir rols sobre una col·lecció - DELETE
/v1/collections/{name}/permissionsRevocar rols sobre una col·lecció - GET
/v1/cards/{card_id}/permissionsObtenir els permisos sobre una entrada (directes i heretats) - PUT
/v1/cards/{card_id}/permissionsConcedir rols sobre una entrada - DELETE
/v1/cards/{card_id}/permissionsRevocar rols sobre una entrada - GET
/v1/sources/{source_id}/permissionsObtenir els permisos sobre una font (directes i heretats) - PUT
/v1/sources/{source_id}/permissionsConcedir rols sobre una font - DELETE
/v1/sources/{source_id}/permissionsRevocar rols sobre una font - POST
/v1/users/{user_id}/offboardDonar de baixa un usuari - GET
/v1/collections/{name}/foldersObtenir l’arbre de carpetes d’una col·lecció - POST
/v1/collections/{name}/foldersCrear una carpeta - GET
/v1/foldersObtenir els arbres de carpetes de totes les col·leccions - GET
/v1/folders/{folder_id}Obtenir una carpeta - DELETE
/v1/folders/{folder_id}Eliminar una carpeta i pujar-ne el contingut un nivell - PATCH
/v1/folders/{folder_id}Canviar el nom, moure o reordenar una carpeta - GET
/v1/folders/{folder_id}/cardsLlistar les entrades d’una carpeta - GET
/v1/folders/{folder_id}/permissionsObtenir els permisos sobre una carpeta (directes i heretats) - PUT
/v1/folders/{folder_id}/permissionsConcedir rols sobre una carpeta - DELETE
/v1/folders/{folder_id}/permissionsRevocar rols sobre una carpeta - GET
/v1/catalog/servicesLlistar els serveis del catàleg - GET
/v1/catalog/services/{service_id}Obtenir un servei del catàleg - GET
/v1/catalog/services/{service_id}/iconObtenir la icona d’un servei - GET
/v1/catalog/categoriesLlistar les categories del catàleg - GET
/v1/catalog/spend-taxonomyObtenir la taxonomia de despeses i ingressos - POST
/v1/catalog/resolveFer correspondre noms amb serveis del catàleg - GET
/v1/draftsLlistar els esborranys - POST
/v1/draftsCrear un esborrany - GET
/v1/drafts/{draft_id}Obtenir un esborrany - PATCH
/v1/drafts/{draft_id}Actualitzar un esborrany - POST
/v1/drafts/{draft_id}/request-publishSol·licitar la publicació - POST
/v1/drafts/{draft_id}/approveAprovar la publicació - GET
/v1/tagsLlistar les etiquetes de les entrades de l’organització - POST
/v1/cards/archivePujar un arxiu comprimit de documents - GET
/v1/archives/{job_id}Obtenir un treball d’extracció d’un arxiu comprimit - GET
/v1/cards/{card_id}/verificationObtenir el bloc de verificació d’una entrada - POST
/v1/cards/{card_id}/verification/verifyVerificar una entrada - POST
/v1/cards/{card_id}/verification/unverifyRetirar la confiança o recordar-ho al verificador - PUT
/v1/cards/{card_id}/verification/verifiersEstablir els verificadors d’una entrada - PUT
/v1/cards/{card_id}/verification/intervalCanviar el tipus de verificació i la data límit - GET
/v1/verification/queueObtenir la cua de verificació - GET
/v1/collections/{name}/trustObtenir el «Trust Score» (índex de confiança) d’una col·lecció - GET
/v1/org/trustObtenir el «Trust Score» (índex de confiança) de l’organització - GET
/v1/announcementsLlistar els avisos - POST
/v1/announcementsEnviar un avís de lectura obligatòria - GET
/v1/announcements/{announcement_id}Obtenir un avís - GET
/v1/announcements/{announcement_id}/statsObtenir l’informe d’un avís - POST
/v1/announcements/{announcement_id}/remindEnviar un recordatori a qui no l’ha llegit - GET
/v1/cards/{card_id}/threadsLlistar els fils de comentaris d’una entrada - POST
/v1/cards/{card_id}/threadsAfegir un comentari o una resposta en un fil - DELETE
/v1/cards/{card_id}/threads/{comment_id}Eliminar un comentari amb les seves respostes - PATCH
/v1/cards/{card_id}/threads/{comment_id}Editar el text, resoldre o reobrir un fil - GET
/v1/openapi-public.jsonObtenir l’especificació OpenAPI pública - GET
/v1/webhooksLlistar els webhooks de l’organització - POST
/v1/webhooksCrear un webhook - GET
/v1/webhooks/catalogLlistar els tipus d’esdeveniment - GET
/v1/webhooks/{webhook_id}Obtenir un webhook - DELETE
/v1/webhooks/{webhook_id}Eliminar un webhook - PATCH
/v1/webhooks/{webhook_id}Actualitzar un webhook - POST
/v1/webhooks/{webhook_id}/testEnviar un esdeveniment de prova - POST
/v1/webhooks/{webhook_id}/rotate-secretFer rotar el secret de signatura - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocar el secret anterior - POST
/v1/webhooks/{webhook_id}/resumeReprendre un webhook - POST
/v1/webhooks/{webhook_id}/redeliverReenviar els lliuraments d’un període - GET
/v1/webhooks/{webhook_id}/attemptsLlistar els intents de lliurament - GET
/v1/webhooks/{webhook_id}/deliveriesLlistar els lliuraments d’un webhook - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Obtenir un lliurament amb els cossos i els intents - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverReenviar un esdeveniment - GET
/v1/webhook-eventsLlistar els esdeveniments - GET
/v1/webhook-events/{event_id}Obtenir un esdeveniment - GET
/v1/api-usageObtenir l’ús de l’API - GET
/v1/api-logsLlistar les sol·licituds a l’API - GET
/v1/api-logs/{request_id}Obtenir una sol·licitud a l’API - GET
/v1/appsLlistar les aplicacions OAuth - POST
/v1/appsCrear una aplicació OAuth - GET
/v1/apps/{app_id}Obtenir una aplicació OAuth - DELETE
/v1/apps/{app_id}Eliminar una aplicació OAuth - PATCH
/v1/apps/{app_id}Actualitzar una aplicació OAuth - POST
/v1/apps/{app_id}/rotate-secretFer rotar el secret de client - GET
/v1/app-authorizationsLlistar les autoritzacions de les aplicacions - DELETE
/v1/app-authorizations/{authorization_id}Revocar l’autorització d’una persona treballadora - GET
/v1/analytics/healthObtenir el tauler de salut del coneixement - GET
/v1/analytics/usageObtenir el tauler d’ús - GET
/v1/analytics/contributionObtenir el tauler de contribució - GET
/v1/analytics/cards/{card_id}Obtenir les mètriques d’una entrada - GET
/v1/audit/verifyVerificar la integritat del registre d’auditoria de l’organització - POST
/v1/users/importImportar usuaris des d’un CSV - GET
/v1/quality/gaps/followupsLlistar les llacunes de coneixement en tractament - POST
/v1/quality/gaps/followupsPrendre en tractament una llacuna de coneixement - PATCH
/v1/quality/gaps/followups/{followup_id}Actualitzar una llacuna de coneixement en tractament - GET
/v1/access-requestsLlistar les sol·licituds d’accés pròpies o rebudes - GET
/v1/access-requests/{request_id}Obtenir una sol·licitud d’accés per a la persona que decideix - POST
/v1/access-requests/{request_id}/grantConcedir l’accés d’una sol·licitud - POST
/v1/access-requests/{request_id}/denyDenegar l’accés - POST
/v1/finance/reportObtenir un informe financer resumit - POST
/v1/finance/report/exportExportar l’informe financer resumit - POST
/v1/finance/invoicesLlistar les factures - POST
/v1/finance/invoices/exportExportar la llista de factures - POST
/v1/finance/paymentsLlistar els pagaments - POST
/v1/finance/payments/exportExportar la llista de pagaments - GET
/v1/sources/{source_id}/push-keysLlistar les claus d’API d’una font personalitzada - POST
/v1/sources/{source_id}/push-keysCrear una clau d’API per a una font personalitzada - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Revocar una clau d’API d’una font personalitzada - GET
/v1/sources/{source_id}/push-syncsLlistar les sincronitzacions d’una font personalitzada - GET
/v1/push/sources/{source_id}Comprovar la clau i obtenir l’estat d’una font personalitzada - POST
/v1/push/sources/{source_id}/syncsObrir una sincronització - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Obtenir una sincronització - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsLlistar els resultats dels documents d’una sincronització - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeTancar una sincronització - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirmar documents sense tornar-los a enviar - POST
/v1/push/sources/{source_id}/documentsEnviar un document (crear o substituir) - POST
/v1/push/sources/{source_id}/documents/batchEnviar un lot de documents - GET
/v1/push/sources/{source_id}/documents/{external_id}Obtenir el resultat d’un document - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Eliminar un document