Обекти
Error
Стандартен отговор с грешка. detail е низ, обект с code (например choose_org, org_suspended, кодове на покани) или списък с грешки при валидиране (422). error е структурирано описание: код от каталога на грешките, съобщение на английски, структурирани подробности и ID на заявката.
Полета
Съобщение за грешка, обект с код или списък с грешки при валидиране.
errorErrorInfo
Използва се в
- GET
/v1/healthПолучаване на състоянието и версията на услугата - GET
/v1/usersСписък на потребителите на организацията - POST
/v1/usersСъздаване на потребител - PATCH
/v1/users/{user_id}Актуализиране на потребител - GET
/v1/api-keysСписък на API ключовете на организацията - POST
/v1/api-keysСъздаване на API ключ - DELETE
/v1/api-keys/{key_id}Анулиране на API ключ - PATCH
/v1/api-keys/{key_id}Актуализиране на API ключ - POST
/v1/api-keys/{key_id}/rollПреиздаване на API ключ - POST
/v1/api-keys/{key_id}/revoke-previousАнулиране на предишната стойност на API ключ - GET
/v1/auditСписък на записите в одитния дневник - GET
/v1/audit/actionsСписък на действията в одитния дневник с броя им - GET
/v1/audit/export.csvЕкспорт на одитния дневник като CSV - GET
/v1/orgПолучаване на организацията - GET
/v1/categoriesСписък на категориите документи - POST
/v1/categoriesСъздаване на категория - DELETE
/v1/categories/{key}Изтриване на персонализирана категория - PATCH
/v1/categories/{key}Актуализиране на категория - GET
/v1/collectionsСписък на колекциите, достъпни за потребителя - POST
/v1/collectionsСъздаване на колекция - DELETE
/v1/collections/{name}Изтриване на колекция - PATCH
/v1/collections/{name}Актуализиране на колекция - POST
/v1/collections/{name}/reindexПовторно индексиране на колекция - GET
/v1/collections/{name}/statsПолучаване на обзора на колекцията: статистика, категории, последни карти, права - GET
/v1/cardsСписък на картите - POST
/v1/cardsКачване на файл като карта - GET
/v1/jobsСписък на заданията за индексиране - GET
/v1/jobs/summaryПолучаване на обобщението на опашката - GET
/v1/jobs/streamПоток с промените в заданията (SSE) - GET
/v1/jobs/{job_id}Получаване на задание - DELETE
/v1/jobs/{job_id}Отмяна на задание в опашката - GET
/v1/cards/countПреброяване на картите - GET
/v1/cards/export.xlsxЕкспорт на списъка с карти в XLSX - POST
/v1/cards/bulkИзпълнение на групово действие с карти - GET
/v1/cards/{card_id}Получаване на карта с версиите, коментарите, таблиците и събитията ѝ - DELETE
/v1/cards/{card_id}Изтриване на карта - PATCH
/v1/cards/{card_id}Актуализиране на карта - GET
/v1/cards-by-external-id/{external_id}Получаване на карта по външен идентификатор - PUT
/v1/cards-by-external-id/{external_id}Създаване или замяна на карта по външен идентификатор - GET
/v1/cards/{card_id}/contentПолучаване на текста на картата по раздели - PUT
/v1/cards/{card_id}/contentЗамяна на съдържанието на карта - GET
/v1/cards/{card_id}/tables/{table_id}/rowsСписък на редовете на таблица с факти - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Сравняване на две версии на карта - GET
/v1/cards/{card_id}/usageСписък на въпросите, в чиито отговори е използвана картата - POST
/v1/cards/{card_id}/usageЗаписване на събитие за използване на карта - POST
/v1/cards/{card_id}/reindexПовторно индексиране на карта - DELETE
/v1/cards/{card_id}/comments/{comment_id}Изтриване на коментар - GET
/v1/cards/{card_id}/fileИзтегляне на оригиналния файл на карта - GET
/v1/cards/{card_id}/exportЕкспорт на карта в документ - POST
/v1/cards/{card_id}/verifyПотвърждаване, че картата е актуална - POST
/v1/cards/{card_id}/commentsДобавяне на коментар - GET
/v1/conversationsСписък на разговорите - GET
/v1/conversations/{conv_id}Получаване на разговор с репликите му - POST
/v1/searchТърсене в колекциите - POST
/v1/askПолучаване на отговор на асистента без поточно предаване - POST
/v1/chatПоток с отговора на асистента (SSE) - POST
/v1/questions/{question_id}/feedbackОценка на отговор - GET
/v1/questions/export.csvЕкспорт на дневника на въпросите в CSV - GET
/v1/questions/{question_id}Получаване на записан въпрос с отговора му - GET
/v1/questions/{question_id}/followupsПолучаване на предложените следващи въпроси - GET
/v1/questionsСписък на въпросите от дневника - GET
/v1/questions/{question_id}/exportЕкспорт на отговор в документ - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportЕкспорт на набор от данни от отговор - GET
/v1/questions/{question_id}/answer-tables/{index}/exportЕкспорт на таблица от текста на отговора - POST
/v1/questions/{question_id}/refreshОпресняване на наборите от данни на отговор (жив отговор) - POST
/v1/questions/{question_id}/save-cardЗаписване на отговор като карта - POST
/v1/cards/textСъздаване на текстова карта (Markdown) - GET
/v1/filesСписък на файловете за експорт - GET
/v1/files/authorsСписък на авторите на файлове (за филтъра на администратора) - GET
/v1/files/{file_id}Получаване на данните за файл - DELETE
/v1/files/{file_id}Изтриване на файл - GET
/v1/files/{file_id}/downloadИзтегляне на файл - GET
/v1/files/{file_id}/previewПреглед на файл - POST
/v1/files/{file_id}/extendУдължаване на срока на съхранение на файл - POST
/v1/files/{file_id}/regenerateПовторно генериране на файл от записаните му параметри - GET
/v1/tasksСписък на задачите на потребител или екип - POST
/v1/sourcesСъздаване на източник - GET
/v1/sources/{source_id}Получаване на източник - DELETE
/v1/sources/{source_id}Изтриване на източник - PATCH
/v1/sources/{source_id}Актуализиране на източник - PATCH
/v1/sources/{source_id}/settingsАктуализиране на настройките на източник - GET
/v1/cards/{card_id}/similarСписък на сходните карти - GET
/v1/insights/gapsСписък на пропуските в знанията (групи от въпроси без отговор) - GET
/v1/permissionsСписък на правата от регистъра - POST
/v1/uploadsЗапочване на качване на части - GET
/v1/uploads/{upload_id}Получаване на качване - DELETE
/v1/uploads/{upload_id}Отмяна на качване - PUT
/v1/uploads/{upload_id}/parts/{n}Изпращане на част от качване - POST
/v1/uploads/{upload_id}/completeЗавършване на качване - GET
/v1/meПолучаване на извикващия API - GET
/v1/me/permissionsПолучаване на правата на текущия потребител върху организацията - GET
/v1/rolesСписък на ролите (вградени и персонализирани) - POST
/v1/rolesСъздаване на персонализирана роля - DELETE
/v1/roles/{role_id}Изтриване на персонализирана роля - PATCH
/v1/roles/{role_id}Актуализиране на персонализирана роля - GET
/v1/groupsСписък на групите на организацията - POST
/v1/groupsСъздаване на група - GET
/v1/groups/{group_id}Получаване на група с членовете ѝ - DELETE
/v1/groups/{group_id}Изтриване на група - PATCH
/v1/groups/{group_id}Преименуване на група - PUT
/v1/groups/{group_id}/members/{user_id}Добавяне на член към група - DELETE
/v1/groups/{group_id}/members/{user_id}Премахване на член от група - GET
/v1/org/permissionsПолучаване на правата върху организацията (кой е администратор) - PUT
/v1/org/permissionsПрисвояване на роли върху организацията - DELETE
/v1/org/permissionsОтнемане на роли върху организацията - GET
/v1/collections/{name}/permissionsПолучаване на правата върху колекция (преки и наследени) - PUT
/v1/collections/{name}/permissionsПрисвояване на роли върху колекция - DELETE
/v1/collections/{name}/permissionsОтнемане на роли върху колекция - GET
/v1/cards/{card_id}/permissionsПолучаване на правата върху карта (преки и наследени) - PUT
/v1/cards/{card_id}/permissionsПрисвояване на роли върху карта - DELETE
/v1/cards/{card_id}/permissionsОтнемане на роли върху карта - GET
/v1/sources/{source_id}/permissionsПолучаване на правата върху източник (преки и наследени) - PUT
/v1/sources/{source_id}/permissionsПрисвояване на роли върху източник - DELETE
/v1/sources/{source_id}/permissionsОтнемане на роли върху източник - POST
/v1/users/{user_id}/offboardИзвеждане на потребител - GET
/v1/collections/{name}/foldersПолучаване на дървото с папки на колекция - POST
/v1/collections/{name}/foldersСъздаване на папка - GET
/v1/foldersПолучаване на дърветата с папки на всички колекции - GET
/v1/folders/{folder_id}Получаване на папка - DELETE
/v1/folders/{folder_id}Изтриване на папка с преместване на съдържанието ѝ едно ниво нагоре - PATCH
/v1/folders/{folder_id}Преименуване, преместване или пренареждане на папка - GET
/v1/folders/{folder_id}/cardsСписък на картите в папка - GET
/v1/folders/{folder_id}/permissionsПолучаване на правата върху папка (преки и наследени) - PUT
/v1/folders/{folder_id}/permissionsПрисвояване на роли върху папка - DELETE
/v1/folders/{folder_id}/permissionsОтнемане на роли върху папка - GET
/v1/catalog/servicesСписък на услугите в каталога - GET
/v1/catalog/services/{service_id}Получаване на услуга от каталога - GET
/v1/catalog/services/{service_id}/iconПолучаване на иконата на услуга - GET
/v1/catalog/categoriesСписък на категориите в каталога - GET
/v1/catalog/spend-taxonomyПолучаване на класификацията на разходите и приходите - POST
/v1/catalog/resolveСъпоставяне на имена с услуги от каталога - GET
/v1/draftsСписък на черновите - POST
/v1/draftsСъздаване на чернова - GET
/v1/drafts/{draft_id}Получаване на чернова - PATCH
/v1/drafts/{draft_id}Актуализиране на чернова - POST
/v1/drafts/{draft_id}/request-publishЗаявка за публикуване - POST
/v1/drafts/{draft_id}/approveОдобряване на публикуването - GET
/v1/tagsСписък на етикетите на картите в организацията - POST
/v1/cards/archiveКачване на архив с документи - GET
/v1/archives/{job_id}Получаване на задание за разархивиране на архив - GET
/v1/cards/{card_id}/verificationПолучаване на блока за проверка на карта - POST
/v1/cards/{card_id}/verification/verifyПроверка на карта - POST
/v1/cards/{card_id}/verification/unverifyПремахване на доверието или напомняне на проверяващия - PUT
/v1/cards/{card_id}/verification/verifiersЗадаване на проверяващите на карта - PUT
/v1/cards/{card_id}/verification/intervalПромяна на типа и крайния срок на проверката - GET
/v1/verification/queueПолучаване на опашката за проверка - GET
/v1/collections/{name}/trustПолучаване на индекса на доверие (Trust Score) на колекция - GET
/v1/org/trustПолучаване на индекса на доверие на организацията - GET
/v1/announcementsСписък на съобщенията - POST
/v1/announcementsИзпращане на съобщение „Задължително за прочитане“ - GET
/v1/announcements/{announcement_id}Получаване на съобщение - GET
/v1/announcements/{announcement_id}/statsПолучаване на отчета за съобщение - POST
/v1/announcements/{announcement_id}/remindНапомняне на онези, които не са прочели - GET
/v1/cards/{card_id}/threadsСписък на нишките с коментари на карта - POST
/v1/cards/{card_id}/threadsДобавяне на коментар или отговор в нишка - DELETE
/v1/cards/{card_id}/threads/{comment_id}Изтриване на коментар с отговорите му - PATCH
/v1/cards/{card_id}/threads/{comment_id}Редактиране на текста, маркиране като решена или повторно отваряне на нишка - GET
/v1/openapi-public.jsonПолучаване на публичната OpenAPI спецификация - GET
/v1/webhooksСписък на уебхуковете на организацията - POST
/v1/webhooksСъздаване на уебхук - GET
/v1/webhooks/catalogСписък на типовете събития - GET
/v1/webhooks/{webhook_id}Получаване на уебхук - DELETE
/v1/webhooks/{webhook_id}Изтриване на уебхук - PATCH
/v1/webhooks/{webhook_id}Актуализиране на уебхук - POST
/v1/webhooks/{webhook_id}/testИзпращане на тестово събитие - POST
/v1/webhooks/{webhook_id}/rotate-secretСмяна на тайната за подписване - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretАнулиране на предишната тайна - POST
/v1/webhooks/{webhook_id}/resumeВъзобновяване на уебхук - POST
/v1/webhooks/{webhook_id}/redeliverПовторна доставка на доставките за период - GET
/v1/webhooks/{webhook_id}/attemptsСписък на опитите за доставка - GET
/v1/webhooks/{webhook_id}/deliveriesСписък на доставките на уебхук - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Получаване на доставка с телата и опитите - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverПовторна доставка на събитие - GET
/v1/webhook-eventsСписък на събитията - GET
/v1/webhook-events/{event_id}Получаване на събитие - GET
/v1/api-usageПолучаване на използването на API - GET
/v1/api-logsСписък на API заявките - GET
/v1/api-logs/{request_id}Получаване на API заявка - GET
/v1/appsСписък на OAuth приложенията - POST
/v1/appsСъздаване на OAuth приложение - GET
/v1/apps/{app_id}Получаване на OAuth приложение - DELETE
/v1/apps/{app_id}Изтриване на OAuth приложение - PATCH
/v1/apps/{app_id}Актуализиране на OAuth приложение - POST
/v1/apps/{app_id}/rotate-secretСмяна на тайната на клиента - GET
/v1/app-authorizationsСписък на оторизациите на приложения - DELETE
/v1/app-authorizations/{authorization_id}Анулиране на оторизация на служител - GET
/v1/analytics/healthПолучаване на таблото за здравето на знанията - GET
/v1/analytics/usageПолучаване на таблото за използването - GET
/v1/analytics/contributionПолучаване на таблото за приноса - GET
/v1/analytics/cards/{card_id}Получаване на показателите на карта - GET
/v1/audit/verifyПроверка на целостта на одитния дневник на организацията - POST
/v1/users/importИмпорт на потребители от CSV - GET
/v1/quality/gaps/followupsСписък на пропуските в знанията, поети за работа - POST
/v1/quality/gaps/followupsПоемане на пропуск в знанията за работа - PATCH
/v1/quality/gaps/followups/{followup_id}Актуализиране на пропуск в знанията, поет за работа - GET
/v1/access-requestsСписък на собствените или входящите заявки за достъп - GET
/v1/access-requests/{request_id}Получаване на заявка за достъп от вземащия решение - POST
/v1/access-requests/{request_id}/grantПредоставяне на достъп по заявка - POST
/v1/access-requests/{request_id}/denyОтказ на достъп - POST
/v1/finance/reportПолучаване на обобщен финансов отчет - POST
/v1/finance/report/exportЕкспорт на обобщения финансов отчет - POST
/v1/finance/invoicesСписък на фактурите - POST
/v1/finance/invoices/exportЕкспорт на списъка с фактури - POST
/v1/finance/paymentsСписък на плащанията - POST
/v1/finance/payments/exportЕкспорт на списъка с плащания - GET
/v1/sources/{source_id}/push-keysСписък на API ключовете на собствен източник - POST
/v1/sources/{source_id}/push-keysСъздаване на API ключ за собствен източник - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Анулиране на API ключ на собствен източник - GET
/v1/sources/{source_id}/push-syncsСписък на синхронизациите на собствен източник - GET
/v1/push/sources/{source_id}Проверка на ключа и получаване на състоянието на собствен източник - POST
/v1/push/sources/{source_id}/syncsОтваряне на синхронизация - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Получаване на синхронизация - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsСписък на резултатите за документите от синхронизация - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeЗатваряне на синхронизация - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchПотвърждаване на документи без повторното им изпращане - POST
/v1/push/sources/{source_id}/documentsИзпращане на документ (създаване или замяна) - POST
/v1/push/sources/{source_id}/documents/batchИзпращане на пакет документи - GET
/v1/push/sources/{source_id}/documents/{external_id}Получаване на резултата за документ - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Изтриване на документ