Objektai
Error
Standartinis klaidos atsakas. detail – eilutė, objektas su code (pavyzdžiui, choose_org, org_suspended, kvietimų kodai) arba validavimo klaidų sąrašas (422). error – struktūrizuotas aprašas: kodas iš klaidų katalogo, pranešimas anglų kalba, struktūrizuota informacija ir užklausos ID.
Laukai
Klaidos pranešimas, objektas su kodu arba validavimo klaidų sąrašas.
errorErrorInfo
Naudoja
- GET
/v1/healthGauti paslaugos būseną ir versiją - GET
/v1/usersGauti organizacijos naudotojų sąrašą - POST
/v1/usersSukurti naudotoją - PATCH
/v1/users/{user_id}Atnaujinti naudotoją - GET
/v1/api-keysGauti organizacijos API raktų sąrašą - POST
/v1/api-keysSukurti API raktą - DELETE
/v1/api-keys/{key_id}Atšaukti API raktą - PATCH
/v1/api-keys/{key_id}Atnaujinti API raktą - POST
/v1/api-keys/{key_id}/rollPakeisti API raktą nauja reikšme - POST
/v1/api-keys/{key_id}/revoke-previousAtšaukti ankstesnę API rakto reikšmę - GET
/v1/auditGauti audito žurnalo įrašų sąrašą - GET
/v1/audit/actionsGauti audito žurnalo veiksmų sąrašą su įrašų skaičiais - GET
/v1/audit/export.csvEksportuoti audito žurnalą CSV formatu - GET
/v1/orgGauti organizaciją - GET
/v1/categoriesGauti dokumentų kategorijų sąrašą - POST
/v1/categoriesSukurti kategoriją - DELETE
/v1/categories/{key}Ištrinti pasirinktinę kategoriją - PATCH
/v1/categories/{key}Atnaujinti kategoriją - GET
/v1/collectionsGauti naudotojui prieinamų rinkinių sąrašą - POST
/v1/collectionsSukurti rinkinį - DELETE
/v1/collections/{name}Ištrinti rinkinį - PATCH
/v1/collections/{name}Atnaujinti rinkinį - POST
/v1/collections/{name}/reindexIndeksuoti rinkinį iš naujo - GET
/v1/collections/{name}/statsGauti rinkinio apžvalgą: statistiką, kategorijas, naujausias korteles, leidimus - GET
/v1/cardsGauti kortelių sąrašą - POST
/v1/cardsĮkelti failą kaip kortelę - GET
/v1/jobsGauti indeksavimo darbų sąrašą - GET
/v1/jobs/summaryGauti eilės suvestinę - GET
/v1/jobs/streamGauti darbų pakeitimų srautą (SSE) - GET
/v1/jobs/{job_id}Gauti darbą - DELETE
/v1/jobs/{job_id}Atšaukti eilėje laukiantį darbą - GET
/v1/cards/countSuskaičiuoti korteles - GET
/v1/cards/export.xlsxEksportuoti kortelių sąrašą į XLSX - POST
/v1/cards/bulkAtlikti masinį veiksmą su kortelėmis - GET
/v1/cards/{card_id}Gauti kortelę su jos versijomis, komentarais, lentelėmis ir įvykiais - DELETE
/v1/cards/{card_id}Ištrinti kortelę - PATCH
/v1/cards/{card_id}Atnaujinti kortelę - GET
/v1/cards-by-external-id/{external_id}Gauti kortelę pagal išorinį ID - PUT
/v1/cards-by-external-id/{external_id}Sukurti arba pakeisti kortelę pagal išorinį ID - GET
/v1/cards/{card_id}/contentGauti kortelės tekstą pagal skyrius - PUT
/v1/cards/{card_id}/contentPakeisti kortelės turinį - GET
/v1/cards/{card_id}/tables/{table_id}/rowsGauti faktų lentelės eilučių sąrašą - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Palyginti dvi kortelės versijas - GET
/v1/cards/{card_id}/usageGauti klausimų, kurių atsakymuose panaudota kortelė, sąrašą - POST
/v1/cards/{card_id}/usageĮrašyti kortelės naudojimo įvykį - POST
/v1/cards/{card_id}/reindexIndeksuoti kortelę iš naujo - DELETE
/v1/cards/{card_id}/comments/{comment_id}Ištrinti komentarą - GET
/v1/cards/{card_id}/fileAtsisiųsti kortelės originalų failą - GET
/v1/cards/{card_id}/exportEksportuoti kortelę į dokumentą - POST
/v1/cards/{card_id}/verifyPatvirtinti, kad kortelė aktuali - POST
/v1/cards/{card_id}/commentsPridėti komentarą - GET
/v1/conversationsGauti pokalbių sąrašą - GET
/v1/conversations/{conv_id}Gauti pokalbį su jo replikomis - POST
/v1/searchIeškoti rinkiniuose - POST
/v1/askGauti asistento atsakymą be srautinio perdavimo - POST
/v1/chatGauti asistento atsakymą srautu (SSE) - POST
/v1/questions/{question_id}/feedbackĮvertinti atsakymą - GET
/v1/questions/export.csvEksportuoti klausimų žurnalą į CSV - GET
/v1/questions/{question_id}Gauti išsaugotą klausimą su atsakymu - GET
/v1/questions/{question_id}/followupsGauti siūlomus tolesnius klausimus - GET
/v1/questionsGauti klausimų žurnalo sąrašą - GET
/v1/questions/{question_id}/exportEksportuoti atsakymą į dokumentą - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportEksportuoti atsakymo duomenų aibę - GET
/v1/questions/{question_id}/answer-tables/{index}/exportEksportuoti lentelę iš atsakymo teksto - POST
/v1/questions/{question_id}/refreshAtnaujinti atsakymo duomenų aibes (gyvas atsakymas) - POST
/v1/questions/{question_id}/save-cardIšsaugoti atsakymą kaip kortelę - POST
/v1/cards/textSukurti tekstinę kortelę (Markdown) - GET
/v1/filesGauti eksporto failų sąrašą - GET
/v1/files/authorsGauti failų autorių sąrašą (administratoriaus filtrui) - GET
/v1/files/{file_id}Gauti failo duomenis - DELETE
/v1/files/{file_id}Ištrinti failą - GET
/v1/files/{file_id}/downloadAtsisiųsti failą - GET
/v1/files/{file_id}/previewPeržiūrėti failą - POST
/v1/files/{file_id}/extendPratęsti failo saugojimo laikotarpį - POST
/v1/files/{file_id}/regenerateSugeneruoti failą iš naujo pagal išsaugotus parametrus - GET
/v1/tasksGauti naudotojo ar komandos užduočių sąrašą - POST
/v1/sourcesSukurti šaltinį - GET
/v1/sources/{source_id}Gauti šaltinį - DELETE
/v1/sources/{source_id}Ištrinti šaltinį - PATCH
/v1/sources/{source_id}Atnaujinti šaltinį - PATCH
/v1/sources/{source_id}/settingsAtnaujinti šaltinio nustatymus - GET
/v1/cards/{card_id}/similarGauti panašių kortelių sąrašą - GET
/v1/insights/gapsGauti žinių spragų (neatsakytų klausimų sankaupų) sąrašą - GET
/v1/permissionsGauti leidimų registrą - POST
/v1/uploadsPradėti įkėlimą dalimis - GET
/v1/uploads/{upload_id}Gauti įkėlimą - DELETE
/v1/uploads/{upload_id}Atšaukti įkėlimą - PUT
/v1/uploads/{upload_id}/parts/{n}Siųsti įkėlimo dalį - POST
/v1/uploads/{upload_id}/completeUžbaigti įkėlimą - GET
/v1/meGauti API iškvietėją - GET
/v1/me/permissionsGauti dabartinio naudotojo leidimus organizacijoje - GET
/v1/rolesGauti vaidmenų sąrašą (integruotų ir pasirinktinių) - POST
/v1/rolesSukurti pasirinktinį vaidmenį - DELETE
/v1/roles/{role_id}Ištrinti pasirinktinį vaidmenį - PATCH
/v1/roles/{role_id}Atnaujinti pasirinktinį vaidmenį - GET
/v1/groupsGauti organizacijos grupių sąrašą - POST
/v1/groupsSukurti grupę - GET
/v1/groups/{group_id}Gauti grupę su jos nariais - DELETE
/v1/groups/{group_id}Ištrinti grupę - PATCH
/v1/groups/{group_id}Pervadinti grupę - PUT
/v1/groups/{group_id}/members/{user_id}Pridėti narį į grupę - DELETE
/v1/groups/{group_id}/members/{user_id}Pašalinti narį iš grupės - GET
/v1/org/permissionsGauti leidimus organizacijoje (kas yra administratorius) - PUT
/v1/org/permissionsSuteikti vaidmenis organizacijoje - DELETE
/v1/org/permissionsAtšaukti vaidmenis organizacijoje - GET
/v1/collections/{name}/permissionsGauti rinkinio leidimus (tiesioginius ir paveldėtus) - PUT
/v1/collections/{name}/permissionsSuteikti vaidmenis rinkinyje - DELETE
/v1/collections/{name}/permissionsAtšaukti vaidmenis rinkinyje - GET
/v1/cards/{card_id}/permissionsGauti kortelės leidimus (tiesioginius ir paveldėtus) - PUT
/v1/cards/{card_id}/permissionsSuteikti vaidmenis kortelėje - DELETE
/v1/cards/{card_id}/permissionsAtšaukti vaidmenis kortelėje - GET
/v1/sources/{source_id}/permissionsGauti šaltinio leidimus (tiesioginius ir paveldėtus) - PUT
/v1/sources/{source_id}/permissionsSuteikti vaidmenis šaltinyje - DELETE
/v1/sources/{source_id}/permissionsAtšaukti vaidmenis šaltinyje - POST
/v1/users/{user_id}/offboardPašalinti naudotoją iš organizacijos - GET
/v1/collections/{name}/foldersGauti rinkinio aplankų medį - POST
/v1/collections/{name}/foldersSukurti aplanką - GET
/v1/foldersGauti visų rinkinių aplankų medžius - GET
/v1/folders/{folder_id}Gauti aplanką - DELETE
/v1/folders/{folder_id}Ištrinti aplanką ir perkelti jo turinį į aukštesnio lygio aplanką - PATCH
/v1/folders/{folder_id}Pervadinti, perkelti ar pertvarkyti aplanką - GET
/v1/folders/{folder_id}/cardsGauti aplanko kortelių sąrašą - GET
/v1/folders/{folder_id}/permissionsGauti aplanko leidimus (tiesioginius ir paveldėtus) - PUT
/v1/folders/{folder_id}/permissionsSuteikti vaidmenis aplanke - DELETE
/v1/folders/{folder_id}/permissionsAtšaukti vaidmenis aplanke - GET
/v1/catalog/servicesGauti katalogo paslaugų sąrašą - GET
/v1/catalog/services/{service_id}Gauti katalogo paslaugą - GET
/v1/catalog/services/{service_id}/iconGauti paslaugos piktogramą - GET
/v1/catalog/categoriesGauti katalogo kategorijų sąrašą - GET
/v1/catalog/spend-taxonomyGauti išlaidų ir pajamų klasifikatorių - POST
/v1/catalog/resolveSusieti pavadinimus su katalogo paslaugomis - GET
/v1/draftsGauti juodraščių sąrašą - POST
/v1/draftsSukurti juodraštį - GET
/v1/drafts/{draft_id}Gauti juodraštį - PATCH
/v1/drafts/{draft_id}Atnaujinti juodraštį - POST
/v1/drafts/{draft_id}/request-publishPrašyti paskelbti - POST
/v1/drafts/{draft_id}/approvePatvirtinti paskelbimą - GET
/v1/tagsGauti organizacijos kortelių žymų sąrašą - POST
/v1/cards/archiveĮkelti dokumentų archyvą - GET
/v1/archives/{job_id}Gauti archyvo išskleidimo darbą - GET
/v1/cards/{card_id}/verificationGauti kortelės tikrinimo bloką - POST
/v1/cards/{card_id}/verification/verifyPatikrinti kortelę - POST
/v1/cards/{card_id}/verification/unverifyPanaikinti patikimumo žymą arba priminti tikrintojui - PUT
/v1/cards/{card_id}/verification/verifiersNustatyti kortelės tikrintojus - PUT
/v1/cards/{card_id}/verification/intervalPakeisti tikrinimo tipą ir terminą - GET
/v1/verification/queueGauti tikrinimo eilę - GET
/v1/collections/{name}/trustGauti rinkinio patikimumo balą - GET
/v1/org/trustGauti organizacijos patikimumo balą - GET
/v1/announcementsGauti pranešimų sąrašą - POST
/v1/announcementsSiųsti privalomą perskaityti pranešimą - GET
/v1/announcements/{announcement_id}Gauti pranešimą - GET
/v1/announcements/{announcement_id}/statsGauti pranešimo ataskaitą - POST
/v1/announcements/{announcement_id}/remindPriminti tiems, kurie neperskaitė - GET
/v1/cards/{card_id}/threadsGauti kortelės komentarų gijų sąrašą - POST
/v1/cards/{card_id}/threadsPridėti komentarą arba atsakymą gijoje - DELETE
/v1/cards/{card_id}/threads/{comment_id}Ištrinti komentarą su jo atsakymais - PATCH
/v1/cards/{card_id}/threads/{comment_id}Redaguoti tekstą, pažymėti giją kaip išspręstą arba vėl ją atidaryti - GET
/v1/openapi-public.jsonGauti viešąją OpenAPI specifikaciją - GET
/v1/webhooksGauti organizacijos webhook galinių taškų sąrašą - POST
/v1/webhooksSukurti webhook galinį tašką - GET
/v1/webhooks/catalogGauti įvykių tipų sąrašą - GET
/v1/webhooks/{webhook_id}Gauti webhook galinį tašką - DELETE
/v1/webhooks/{webhook_id}Ištrinti webhook galinį tašką - PATCH
/v1/webhooks/{webhook_id}Atnaujinti webhook galinį tašką - POST
/v1/webhooks/{webhook_id}/testSiųsti bandomąjį įvykį - POST
/v1/webhooks/{webhook_id}/rotate-secretPakeisti pasirašymo paslaptį nauja (rotacija) - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretAtšaukti ankstesnę paslaptį - POST
/v1/webhooks/{webhook_id}/resumeVėl įjungti webhook galinį tašką - POST
/v1/webhooks/{webhook_id}/redeliverPakartotinai pristatyti laikotarpio pristatymus - GET
/v1/webhooks/{webhook_id}/attemptsGauti pristatymo bandymų sąrašą - GET
/v1/webhooks/{webhook_id}/deliveriesGauti webhook pristatymų sąrašą - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Gauti pristatymą su turiniais ir bandymais - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverPakartotinai pristatyti įvykį - GET
/v1/webhook-eventsGauti įvykių sąrašą - GET
/v1/webhook-events/{event_id}Gauti įvykį - GET
/v1/api-usageGauti API naudojimą - GET
/v1/api-logsGauti API užklausų sąrašą - GET
/v1/api-logs/{request_id}Gauti API užklausą - GET
/v1/appsGauti OAuth programų sąrašą - POST
/v1/appsSukurti OAuth programą - GET
/v1/apps/{app_id}Gauti OAuth programą - DELETE
/v1/apps/{app_id}Ištrinti OAuth programą - PATCH
/v1/apps/{app_id}Atnaujinti OAuth programą - POST
/v1/apps/{app_id}/rotate-secretPakeisti kliento paslaptį nauja (rotacija) - GET
/v1/app-authorizationsGauti programų autorizacijų sąrašą - DELETE
/v1/app-authorizations/{authorization_id}Atšaukti darbuotojo autorizaciją - GET
/v1/analytics/healthGauti žinių būklės skydelį - GET
/v1/analytics/usageGauti naudojimo skydelį - GET
/v1/analytics/contributionGauti indėlio skydelį - GET
/v1/analytics/cards/{card_id}Gauti kortelės rodiklius - GET
/v1/audit/verifyPatikrinti organizacijos audito žurnalo vientisumą - POST
/v1/users/importImportuoti naudotojus iš CSV - GET
/v1/quality/gaps/followupsGauti sprendžiamų žinių spragų sąrašą - POST
/v1/quality/gaps/followupsPradėti spręsti žinių spragą - PATCH
/v1/quality/gaps/followups/{followup_id}Atnaujinti sprendžiamą žinių spragą - GET
/v1/access-requestsGauti savo arba gautų prieigos prašymų sąrašą - GET
/v1/access-requests/{request_id}Gauti prieigos prašymą sprendimą priimančiam asmeniui - POST
/v1/access-requests/{request_id}/grantSuteikti prieigą pagal prašymą - POST
/v1/access-requests/{request_id}/denyAtsisakyti suteikti prieigą - POST
/v1/finance/reportGauti finansų suvestinės ataskaitą - POST
/v1/finance/report/exportEksportuoti finansų suvestinės ataskaitą - POST
/v1/finance/invoicesGauti sąskaitų faktūrų sąrašą - POST
/v1/finance/invoices/exportEksportuoti sąskaitų faktūrų sąrašą - POST
/v1/finance/paymentsGauti mokėjimų sąrašą - POST
/v1/finance/payments/exportEksportuoti mokėjimų sąrašą - GET
/v1/sources/{source_id}/push-keysGauti pasirinktinio šaltinio API raktų sąrašą - POST
/v1/sources/{source_id}/push-keysSukurti pasirinktinio šaltinio API raktą - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Atšaukti pasirinktinio šaltinio API raktą - GET
/v1/sources/{source_id}/push-syncsGauti pasirinktinio šaltinio sinchronizacijų sąrašą - GET
/v1/push/sources/{source_id}Patikrinti raktą ir gauti pasirinktinio šaltinio būseną - POST
/v1/push/sources/{source_id}/syncsAtidaryti sinchronizaciją - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Gauti sinchronizaciją - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsGauti sinchronizacijos dokumentų rezultatų sąrašą - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeUždaryti sinchronizaciją - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchPatvirtinti dokumentus jų nesiunčiant dar kartą - POST
/v1/push/sources/{source_id}/documentsSiųsti dokumentą (sukurti arba pakeisti) - POST
/v1/push/sources/{source_id}/documents/batchSiųsti dokumentų partiją - GET
/v1/push/sources/{source_id}/documents/{external_id}Gauti dokumento rezultatą - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Ištrinti dokumentą