Перейти до вмісту
Sursa Developers

Коди помилок

Усі відповіді з помилкою мають однакову структуру. Покладайтеся на статус HTTP та error.code; error.message — зрозумілий текст англійською, і він може змінюватися.

Формат помилки

{
  "detail": "…",
  "error": {
    "code": "api.cursor_invalid",
    "message": "The cursor is malformed or was issued for different filters.",
    "details": {"parameter": "cursor"},
    "request_id": "01JB7Q2M4X9V3K8T5N6P0R1S2A",
    "doc_url": "https://developers.sursa.com/errors/api.cursor_invalid"
  }
}

error.code — код із цієї сторінки; error.request_id збігається із заголовком X-Request-Id; error.doc_url веде на цю сторінку.

access_requests

analytics

announcements

answers

api

api_keys

api_logs

  • 404api_logs.not_foundзапит не знайдено в журналі API, або він старіший за 14 днів

auth

authz

  • 403authz.forbiddenпотрібен дозвіл '{permission}'
  • 400authz.group_key_invalidнеправильний ключ групи: латинські літери, цифри, '_' і '-', до 80 символів, починається з літери
  • 409authz.group_key_takenключ групи '{key}' уже використовується
  • 409authz.group_kind_immutableце вбудована група: її учасники обчислюються автоматично, їх не можна змінювати, а саму групу не можна видалити
  • 409authz.group_managed_externallyгрупою керує постачальник облікових записів (SCIM)
  • 404authz.group_not_foundгрупу не знайдено
  • 409authz.last_ownerна об’єкті має лишитися принаймні одне призначення ролі '{role}'
  • 409authz.legacy_admin_single_user_onlyроль адміністратора призначається лише користувачам, а не групам
  • 409authz.managed_by_sourceдозволами цього об’єкта керує його джерело
  • 400authz.role_key_invalidнеправильний ключ ролі: латинські літери, цифри, '_' і '-', до 64 символів, починається з літери
  • 409authz.role_key_takenключ ролі '{key}' уже використовується
  • 404authz.role_not_foundроль не знайдено
  • 400authz.role_scope_mismatchроль '{key}' не можна призначити на {object_type}
  • 409authz.role_system_immutableсистемні ролі не можна змінювати або видаляти
  • 400authz.subject_requiredпотрібен рівно один із параметрів group_id і user_id
  • 400authz.unknown_permissionневідомий дозвіл '{permission}'
  • 400authz.user_not_in_orgкористувача не знайдено в організації
  • 400authz.view_requiredроль для об’єктів має містити COLLECTION_VIEW

billing

  • 402billing.seats_exceededУсі ліцензії передплати ({purchased}) зайнято (активні користувачі та запрошення, що очікують: {reserved}). Щоб запросити більше людей, додайте ліцензії на сторінці «Billing».

cards

catalog

categories

collections

  • 403collections.admin_fieldsдля налаштувань доступу, чутливості, типових значень і налаштувань пошуку колекції потрібна роль адміністратора
  • 409collections.index_outdatedіндекс цієї колекції застарів; спершу оновіть його: PATCH /v1/collections/{name} з upgrade_index: true переіндексовує колекцію
  • 409collections.indexing_in_progressдокументи цієї колекції саме зараз індексуються; змініть налаштування пошуку, коли індексацію буде завершено
  • 400collections.invalid_nameнеправильна назва колекції: від 1 до 64 символів, латинські літери, цифри, '_' і '-'
  • 403collections.no_accessнемає доступу '{action}' до колекції '{name}'
  • 403collections.no_write_accessнемає доступу на запис до колекції '{name}'
  • 404collections.not_foundколекцію '{name}' не знайдено

comments

conversations

drafts

  • 409drafts.already_requestedзапит на публікацію цієї чернетки вже надіслано; поки він очікує на розгляд, редагування можна продовжувати
  • 409drafts.card_deletedкартку цієї чернетки видалено
  • 409drafts.card_publishedкартку опубліковано або змінено після того, як цю чернетку почато; почніть нову чернетку з опублікованої версії
  • 422drafts.content_json_invalidcontent_json має бути об’єктом із schemaVersion (рядок) і doc (об’єкт), не більше 500000 байтів
  • 409drafts.deleted_by_collaboratorінший співавтор видалив цю чернетку; щоб продовжити редагування, почніть нову чернетку
  • 409drafts.existsу вас уже є чернетка цієї картки
  • 422drafts.invalid_scopescope має бути mine, all або orphaned
  • 403drafts.not_collaboratorзмінити цю чернетку може лише співавтор або адміністратор
  • 404drafts.not_foundчернетку не знайдено
  • 409drafts.not_requestedпублікацію цієї чернетки не запитано
  • 403drafts.publish_forbiddenу вас немає дозволу на публікацію в цій колекції
  • 422drafts.scheduled_pastзапланована дата має бути в майбутньому
  • 422drafts.title_requiredпотрібен title

events

  • 404events.not_foundподію не знайдено, або вона старіша за 30 днів

files

  • 410files.expiredстрок дії файлу сплив
  • 422files.infectedфайл {filename} відхилено антивірусом: {signature}
  • 422files.invalid_expiry_filterexpiry має бути одним із active, expiring, expired
  • 422files.invalid_kind_filterkind має бути одним із pdf, xlsx, csv, docx, md
  • 422files.invalid_origin_filterorigin має бути одним із answer, card, insights, list
  • 409files.no_expiryцей файл зберігається безстроково
  • 404files.not_foundфайл не знайдено
  • 409files.not_regenerable{reason}
  • 422files.preview_failedне вдається показати попередній перегляд цього файлу: {reason}
  • 404files.regeneration_requiredцей файл створено на основній адресі, і він містить відомості, яких адреса API не повертає; створіть його повторно через POST /v1/files/{file_id}/regenerate або завантажте на основній адресі
  • 409files.removedфайл уже видалено після закінчення строку дії; замість цього створіть його повторно
  • 503files.scan_unavailableантивірусна перевірка недоступна; спробуйте пізніше
  • 413files.too_largeфайл {filename} більший за ліміт завантаження {limit}
  • 415files.type_mismatchфайл {filename} не відповідає своєму типу: розширення {extension}, заявлений тип {declared}, вміст {detected}

finance

folders

  • 400folders.appearance_invalidcolor має бути одним із blue, violet, emerald, amber, orange, rose, cyan, slate; icon має бути ключем категорії або lock
  • 400folders.card_collection_mismatchкартка й папка належать до різних колекцій
  • 409folders.cycleпапку не можна перемістити в неї саму або в її вкладену папку
  • 409folders.depth_exceededглибина вкладеності папки перевищить максимум — 3
  • 404folders.not_foundпапку не знайдено
  • 400folders.parent_mismatchбатьківська папка належить до іншої колекції
  • 400folders.sibling_not_foundprev_sibling_id має бути 'first', 'last' або id сусідньої папки в цільовій батьківській папці
  • 400folders.title_invalidназва папки має містити від 1 до 200 символів

insights

internal

jobs

  • 409jobs.already_processingзавдання вже обробляється, і його більше не можна вилучити з черги
  • 409jobs.cancel_failedне вдалося вилучити завдання з черги
  • 410jobs.cancel_unsupportedзавдання поставлено в чергу до того, як з’явилася підтримка скасування; дочекайтеся його завершення
  • 422jobs.invalid_filter{reason}
  • 404jobs.not_foundзавдання не знайдено
  • 409jobs.not_queuedвилучити з черги можна лише завдання, що очікують у черзі (стан цього завдання — {status})

limits

  • 402limits.cardsОрганізація досягла ліміту карток ({limit}){plan}. Видаліть непотрібні картки або попросіть системного адміністратора підвищити ліміт.
  • 429limits.concurrent_answersв організації вже готуються відповіді: {used} (ліміт {limit}); спробуйте ще раз за кілька секунд
  • 429limits.questionsОрганізація вичерпала ліміт запитань за 24 години ({limit}){plan}. Запитання знову стануть доступні приблизно через {wait}. Якщо потрібно більше, попросіть системного адміністратора підвищити ліміт.
  • 402limits.sourcesОрганізація досягла ліміту джерел ({limit}){plan}. Видаліть непотрібні джерела або попросіть системного адміністратора підвищити ліміт.
  • 402limits.sources_instantМиттєві оновлення не входять до тарифу організації{plan}; джерело й далі оновлюється за розкладом.
  • 402limits.storageНедостатньо місця у сховищі: організація використовує {used} з {limit} ГБ{plan}, а цьому файлу потрібно ще {amount}. Видаліть непотрібні картки чи файли або попросіть системного адміністратора підвищити ліміт.
  • 402limits.usersОрганізація досягла ліміту користувачів ({limit}){plan} з урахуванням активних користувачів і запрошень, що очікують. Деактивуйте непотрібні облікові записи чи відкличте непотрібні запрошення або попросіть системного адміністратора підвищити ліміт.

notifications

oauth

  • 403oauth.operation_not_allowedця операція недоступна для токена застосунку OAuth
  • 401oauth.token_expiredстрок дії токена доступу минув; отримайте новий за допомогою токена оновлення

oauth_apps

  • 400oauth_apps.invalid{reason}
  • 400oauth_apps.invalid_redirect_uriURI перенаправлення '{uri}' не дозволено: використовуйте https, http — лише для localhost, або схему застосунку у формі зворотного домену, без фрагмента
  • 400oauth_apps.invalid_scopeневідома область доступу '{scope}'
  • 409oauth_apps.not_confidentialзастосунок публічний: він не має секрету клієнта й доступу client credentials
  • 404oauth_apps.not_foundзастосунок OAuth не знайдено
  • 409oauth_apps.too_manyорганізація вже має максимальну кількість застосунків OAuth ({max})

oauth_authorizations

org

  • 403org.deletedцю організацію видалено
  • 404org.not_foundорганізацію не знайдено
  • 403org.suspendedцю організацію призупинено: вхід закрито, дані збережено; зверніться до адміністратора

profiles

quality

query

questions

sources

tasks

  • 400tasks.invalid_scopescope має бути 'mine' або 'team'
  • 403tasks.team_forbiddenперегляд команди доступний адміністраторам і верифікаторам
  • 400tasks.user_account_requiredособисті завдання до виконання належать обліковим записам користувачів, а не ключам API

uploads

users

  • 422users.display_name_emptyвідображуване ім’я не може бути порожнім
  • 409users.email_takenкористувач із цією електронною поштою вже існує в організації
  • 400users.inactive_assignmentнеактивного користувача не можна призначити
  • 409users.last_adminв організації має лишатися принаймні один активний адміністратор
  • 409users.managed_by_scimцим обліковим записом керує ваш постачальник облікових записів (SCIM); змініть його там
  • 404users.not_foundкористувача не знайдено
  • 400users.not_in_orgкористувача не знайдено в організації
  • 400users.offboard_targetотримувачем передачі має бути активний користувач тієї самої організації, інший, ніж той, щодо кого проводиться офбординг
  • 403users.password_not_allowedцей обліковий запис входить через вашого постачальника облікових записів і не має пароля; адміністратор може додати пароль за посиланням для скидання
  • 400users.unknown_or_inactiveневідомі або неактивні користувачі: {ids}
  • 400users.update_invalid{reason}
  • 409users.username_takenкористувач із цим іменем користувача вже існує в організації

users_import

validation

verification

view_as

  • 403view_as.admin_key_requiredдля X-View-As потрібен ключ API з роллю admin
  • 400view_as.invalid_headerX-View-As має бути у вигляді <profile>[:viewer|verifier|editor] з наявним профілем
  • 403view_as.read_onlyрежим перегляду: зміни вимкнено, поки ви переглядаєте від імені іншого профілю

webhooks

  • 400webhooks.access_invalidнеправильні роль вебхука, режим вмісту, профіль доступу, колекції або теги
  • 400webhooks.auth_invalidвихідна авторизація має бути bearer з токеном або basic з іменем користувача та паролем
  • 403webhooks.collections_outside_keyцей ключ API обмежено колекціями: укажіть collection_ids вебхука, усі — з колекцій ключа
  • 404webhooks.delivery_not_foundдоставку вебхука не знайдено
  • 400webhooks.description_too_longопис вебхука довший за 200 символів
  • 409webhooks.endpoint_disabledвебхук вимкнено; спершу ввімкніть його
  • 409webhooks.event_not_permittedвебхук зараз не отримав би цю подію: його роль, профіль доступу, колекції чи теги вже цього не дозволяють, тому доставку не повторюють
  • 400webhooks.events_requiredпідпишіться принаймні на одну подію
  • 403webhooks.feature_disabledвебхуки не входять до тарифу організації
  • 400webhooks.headers_invalidнеправильні власні заголовки вебхука: не більше 10 заголовків, назви з літер, цифр і дефісів без зарезервованих назв, значення до 1024 байтів
  • 400webhooks.invalid_urlurl вебхука має бути абсолютною адресою https без облікових даних
  • 404webhooks.not_foundвебхук не знайдено
  • 400webhooks.overlap_invalidперекриття під час ротації має бути від 0 до 168 годин
  • 400webhooks.private_addressхост вебхука вказує на приватну або зарезервовану мережеву адресу
  • 400webhooks.redeliver_invalidперіод повторної доставки має бути в межах останніх 30 днів, since — раніше за until, а статуси — success, exhausted або cancelled
  • 409webhooks.too_manyорганізація може мати не більше 20 вебхуків
  • 400webhooks.unknown_eventневідома подія вебхука {type}
  • 400webhooks.unresolvableне вдається визначити адресу хоста вебхука