Objektit
Error
Vakiomuotoinen virhevastaus. detail on merkkijono, objekti, jossa on code (esimerkiksi choose_org, org_suspended, kutsujen koodit), tai validointivirheiden luettelo (422). error on jäsennelty kuvaus: virheluettelon koodi, englanninkielinen viesti, jäsennellyt tiedot ja pyynnön tunnus.
Kentät
Virheviesti, koodin sisältävä objekti tai validointivirheiden luettelo.
errorErrorInfo
Käytössä
- GET
/v1/healthHae palvelun tila ja versio - GET
/v1/usersListaa organisaation käyttäjät - POST
/v1/usersLuo käyttäjä - PATCH
/v1/users/{user_id}Päivitä käyttäjä - GET
/v1/api-keysListaa organisaation API-avaimet - POST
/v1/api-keysLuo API-avain - DELETE
/v1/api-keys/{key_id}Peru API-avain - PATCH
/v1/api-keys/{key_id}Päivitä API-avain - POST
/v1/api-keys/{key_id}/rollUusi API-avaimen arvo - POST
/v1/api-keys/{key_id}/revoke-previousPeru API-avaimen edellinen arvo - GET
/v1/auditListaa tarkastuslokin merkinnät - GET
/v1/audit/actionsListaa tarkastuslokin toimenpiteet ja niiden määrät - GET
/v1/audit/export.csvVie tarkastusloki CSV-tiedostona - GET
/v1/orgHae organisaatio - GET
/v1/categoriesListaa asiakirjaluokat - POST
/v1/categoriesLuo luokka - DELETE
/v1/categories/{key}Poista mukautettu luokka - PATCH
/v1/categories/{key}Päivitä luokka - GET
/v1/collectionsListaa käyttäjän käytettävissä olevat kokoelmat - POST
/v1/collectionsLuo kokoelma - DELETE
/v1/collections/{name}Poista kokoelma - PATCH
/v1/collections/{name}Päivitä kokoelma - POST
/v1/collections/{name}/reindexIndeksoi kokoelma uudelleen - GET
/v1/collections/{name}/statsHae kokoelman yleiskuva: tilastot, luokat, viimeisimmät kortit, käyttöoikeudet - GET
/v1/cardsListaa kortit - POST
/v1/cardsLataa tiedosto kortiksi - GET
/v1/jobsListaa indeksointityöt - GET
/v1/jobs/summaryHae jonon yhteenveto - GET
/v1/jobs/streamSeuraa töiden muutoksia (SSE) - GET
/v1/jobs/{job_id}Hae työ - DELETE
/v1/jobs/{job_id}Peruuta jonossa oleva työ - GET
/v1/cards/countLaske kortit - GET
/v1/cards/export.xlsxVie korttilista XLSX-tiedostoon - POST
/v1/cards/bulkSuorita korttien joukkotoimenpide - GET
/v1/cards/{card_id}Hae kortti versioineen, kommentteineen, taulukoineen ja tapahtumineen - DELETE
/v1/cards/{card_id}Poista kortti - PATCH
/v1/cards/{card_id}Päivitä kortti - GET
/v1/cards-by-external-id/{external_id}Hae kortti ulkoisella tunnuksella - PUT
/v1/cards-by-external-id/{external_id}Luo tai korvaa kortti ulkoisella tunnuksella - GET
/v1/cards/{card_id}/contentHae kortin teksti osioittain - PUT
/v1/cards/{card_id}/contentKorvaa kortin sisältö - GET
/v1/cards/{card_id}/tables/{table_id}/rowsListaa faktataulun rivit - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Vertaa kortin kahta versiota - GET
/v1/cards/{card_id}/usageListaa kysymykset, joiden vastauksissa korttia käytettiin - POST
/v1/cards/{card_id}/usageKirjaa kortin käyttötapahtuma - POST
/v1/cards/{card_id}/reindexIndeksoi kortti uudelleen - DELETE
/v1/cards/{card_id}/comments/{comment_id}Poista kommentti - GET
/v1/cards/{card_id}/fileNouda kortin alkuperäinen tiedosto - GET
/v1/cards/{card_id}/exportVie kortti asiakirjaksi - POST
/v1/cards/{card_id}/verifyVahvista, että kortti on ajan tasalla - POST
/v1/cards/{card_id}/commentsLisää kommentti - GET
/v1/conversationsListaa keskustelut - GET
/v1/conversations/{conv_id}Hae keskustelu vuoroineen - POST
/v1/searchHae kokoelmista - POST
/v1/askHae avustajan vastaus ilman virtaa - POST
/v1/chatVastaanota avustajan vastaus virtana (SSE) - POST
/v1/questions/{question_id}/feedbackArvioi vastaus - GET
/v1/questions/export.csvVie kysymysloki CSV-tiedostoon - GET
/v1/questions/{question_id}Hae tallennettu kysymys vastauksineen - GET
/v1/questions/{question_id}/followupsHae ehdotetut jatkokysymykset - GET
/v1/questionsListaa kysymysloki - GET
/v1/questions/{question_id}/exportVie vastaus asiakirjaksi - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportVie vastauksen tietojoukko - GET
/v1/questions/{question_id}/answer-tables/{index}/exportVie taulukko vastauksen tekstistä - POST
/v1/questions/{question_id}/refreshPäivitä vastauksen tietojoukot (päivittyvä vastaus) - POST
/v1/questions/{question_id}/save-cardTallenna vastaus korttina - POST
/v1/cards/textLuo tekstikortti (Markdown) - GET
/v1/filesListaa vientitiedostot - GET
/v1/files/authorsListaa tiedostojen tekijät (ylläpitäjän suodatinta varten) - GET
/v1/files/{file_id}Hae tiedoston tiedot - DELETE
/v1/files/{file_id}Poista tiedosto - GET
/v1/files/{file_id}/downloadNouda tiedosto - GET
/v1/files/{file_id}/previewEsikatsele tiedostoa - POST
/v1/files/{file_id}/extendPidennä tiedoston säilytysaikaa - POST
/v1/files/{file_id}/regenerateMuodosta tiedosto uudelleen tallennetuista parametreista - GET
/v1/tasksListaa käyttäjän tai tiimin tehtävät - POST
/v1/sourcesLuo lähde - GET
/v1/sources/{source_id}Hae lähde - DELETE
/v1/sources/{source_id}Poista lähde - PATCH
/v1/sources/{source_id}Päivitä lähde - PATCH
/v1/sources/{source_id}/settingsPäivitä lähteen asetukset - GET
/v1/cards/{card_id}/similarListaa samankaltaiset kortit - GET
/v1/insights/gapsListaa tietoaukot (vastaamattomien kysymysten ryhmät) - GET
/v1/permissionsListaa käyttöoikeusrekisteri - POST
/v1/uploadsAloita moniosainen lataus - GET
/v1/uploads/{upload_id}Hae lataus - DELETE
/v1/uploads/{upload_id}Peruuta lataus - PUT
/v1/uploads/{upload_id}/parts/{n}Lähetä latauksen osa - POST
/v1/uploads/{upload_id}/completeViimeistele lataus - GET
/v1/meHae API:n kutsuja - GET
/v1/me/permissionsHae nykyisen käyttäjän käyttöoikeudet organisaatioon - GET
/v1/rolesListaa roolit (sisäänrakennetut ja mukautetut) - POST
/v1/rolesLuo mukautettu rooli - DELETE
/v1/roles/{role_id}Poista mukautettu rooli - PATCH
/v1/roles/{role_id}Päivitä mukautettu rooli - GET
/v1/groupsListaa organisaation ryhmät - POST
/v1/groupsLuo ryhmä - GET
/v1/groups/{group_id}Hae ryhmä jäsenineen - DELETE
/v1/groups/{group_id}Poista ryhmä - PATCH
/v1/groups/{group_id}Nimeä ryhmä uudelleen - PUT
/v1/groups/{group_id}/members/{user_id}Lisää jäsen ryhmään - DELETE
/v1/groups/{group_id}/members/{user_id}Poista jäsen ryhmästä - GET
/v1/org/permissionsHae organisaation käyttöoikeudet (kuka on ylläpitäjä) - PUT
/v1/org/permissionsMääritä roolit organisaatiolle - DELETE
/v1/org/permissionsPoista roolit organisaatiosta - GET
/v1/collections/{name}/permissionsHae kokoelman käyttöoikeudet (suorat ja perityt) - PUT
/v1/collections/{name}/permissionsMääritä roolit kokoelmalle - DELETE
/v1/collections/{name}/permissionsPoista roolit kokoelmasta - GET
/v1/cards/{card_id}/permissionsHae kortin käyttöoikeudet (suorat ja perityt) - PUT
/v1/cards/{card_id}/permissionsMääritä roolit kortille - DELETE
/v1/cards/{card_id}/permissionsPoista roolit kortista - GET
/v1/sources/{source_id}/permissionsHae lähteen käyttöoikeudet (suorat ja perityt) - PUT
/v1/sources/{source_id}/permissionsMääritä roolit lähteelle - DELETE
/v1/sources/{source_id}/permissionsPoista roolit lähteestä - POST
/v1/users/{user_id}/offboardVie käyttäjän lähtöprosessi läpi - GET
/v1/collections/{name}/foldersHae kokoelman kansiopuu - POST
/v1/collections/{name}/foldersLuo kansio - GET
/v1/foldersHae kaikkien kokoelmien kansiopuut - GET
/v1/folders/{folder_id}Hae kansio - DELETE
/v1/folders/{folder_id}Poista kansio ja siirrä sen sisältö ylemmäs - PATCH
/v1/folders/{folder_id}Nimeä uudelleen, siirrä tai järjestä kansio - GET
/v1/folders/{folder_id}/cardsListaa kansion kortit - GET
/v1/folders/{folder_id}/permissionsHae kansion käyttöoikeudet (suorat ja perityt) - PUT
/v1/folders/{folder_id}/permissionsMääritä roolit kansiolle - DELETE
/v1/folders/{folder_id}/permissionsPoista roolit kansiosta - GET
/v1/catalog/servicesListaa luettelon palvelut - GET
/v1/catalog/services/{service_id}Hae luettelon palvelu - GET
/v1/catalog/services/{service_id}/iconHae palvelun kuvake - GET
/v1/catalog/categoriesListaa luettelon luokat - GET
/v1/catalog/spend-taxonomyHae kulu- ja tuloluokitus - POST
/v1/catalog/resolveYhdistä nimet luettelon palveluihin - GET
/v1/draftsListaa luonnokset - POST
/v1/draftsLuo luonnos - GET
/v1/drafts/{draft_id}Hae luonnos - PATCH
/v1/drafts/{draft_id}Päivitä luonnos - POST
/v1/drafts/{draft_id}/request-publishPyydä julkaisua - POST
/v1/drafts/{draft_id}/approveHyväksy julkaisu - GET
/v1/tagsListaa organisaation korttien tunnisteet - POST
/v1/cards/archiveLataa asiakirja-arkisto - GET
/v1/archives/{job_id}Hae arkiston purkutyö - GET
/v1/cards/{card_id}/verificationHae kortin vahvistuslohko - POST
/v1/cards/{card_id}/verification/verifyVahvista kortti - POST
/v1/cards/{card_id}/verification/unverifyPoista luottamus tai muistuta vahvistajaa - PUT
/v1/cards/{card_id}/verification/verifiersAseta kortin vahvistajat - PUT
/v1/cards/{card_id}/verification/intervalMuuta vahvistuksen tyyppiä ja eräpäivää - GET
/v1/verification/queueHae vahvistusjono - GET
/v1/collections/{name}/trustHae kokoelman Trust Score - GET
/v1/org/trustHae organisaation Trust Score - GET
/v1/announcementsListaa tiedotteet - POST
/v1/announcementsLähetä pakollinen luettava tiedote - GET
/v1/announcements/{announcement_id}Hae tiedote - GET
/v1/announcements/{announcement_id}/statsHae tiedotteen raportti - POST
/v1/announcements/{announcement_id}/remindMuistuta niitä, jotka eivät ole lukeneet - GET
/v1/cards/{card_id}/threadsListaa kortin kommenttiketjut - POST
/v1/cards/{card_id}/threadsLisää kommentti tai vastaus ketjuun - DELETE
/v1/cards/{card_id}/threads/{comment_id}Poista kommentti vastauksineen - PATCH
/v1/cards/{card_id}/threads/{comment_id}Muokkaa tekstiä, merkitse ketju ratkaistuksi tai avaa se uudelleen - GET
/v1/openapi-public.jsonHae julkinen OpenAPI-määrittely - GET
/v1/webhooksListaa organisaation webhookit - POST
/v1/webhooksLuo webhook - GET
/v1/webhooks/catalogListaa tapahtumatyypit - GET
/v1/webhooks/{webhook_id}Hae webhook - DELETE
/v1/webhooks/{webhook_id}Poista webhook - PATCH
/v1/webhooks/{webhook_id}Päivitä webhook - POST
/v1/webhooks/{webhook_id}/testLähetä testitapahtuma - POST
/v1/webhooks/{webhook_id}/rotate-secretUusi allekirjoitussalaisuus - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretPeru edellinen salaisuus - POST
/v1/webhooks/{webhook_id}/resumeJatka webhookin toimintaa - POST
/v1/webhooks/{webhook_id}/redeliverToimita jakson toimitukset uudelleen - GET
/v1/webhooks/{webhook_id}/attemptsListaa toimitusyritykset - GET
/v1/webhooks/{webhook_id}/deliveriesListaa webhookin toimitukset - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Hae toimitus runkoineen ja yrityksineen - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverToimita tapahtuma uudelleen - GET
/v1/webhook-eventsListaa tapahtumat - GET
/v1/webhook-events/{event_id}Hae tapahtuma - GET
/v1/api-usageHae API:n käyttö - GET
/v1/api-logsListaa API-pyynnöt - GET
/v1/api-logs/{request_id}Hae API-pyyntö - GET
/v1/appsListaa OAuth-sovellukset - POST
/v1/appsLuo OAuth-sovellus - GET
/v1/apps/{app_id}Hae OAuth-sovellus - DELETE
/v1/apps/{app_id}Poista OAuth-sovellus - PATCH
/v1/apps/{app_id}Päivitä OAuth-sovellus - POST
/v1/apps/{app_id}/rotate-secretUusi asiakassalaisuus - GET
/v1/app-authorizationsListaa sovellusten valtuutukset - DELETE
/v1/app-authorizations/{authorization_id}Peru työntekijän valtuutus - GET
/v1/analytics/healthHae tiedon kunnon koontinäkymä - GET
/v1/analytics/usageHae käytön koontinäkymä - GET
/v1/analytics/contributionHae osallistumisen koontinäkymä - GET
/v1/analytics/cards/{card_id}Hae kortin mittarit - GET
/v1/audit/verifyTarkista organisaation tarkastuslokin eheys - POST
/v1/users/importTuo käyttäjät CSV-tiedostosta - GET
/v1/quality/gaps/followupsListaa työn alla olevat tietoaukot - POST
/v1/quality/gaps/followupsOta tietoaukko työn alle - PATCH
/v1/quality/gaps/followups/{followup_id}Päivitä työn alla oleva tietoaukko - GET
/v1/access-requestsListaa omat tai saapuneet käyttöoikeuspyynnöt - GET
/v1/access-requests/{request_id}Hae käyttöoikeuspyyntö päättäjälle - POST
/v1/access-requests/{request_id}/grantMyönnä käyttöoikeus pyynnön perusteella - POST
/v1/access-requests/{request_id}/denyEpää käyttöoikeus - POST
/v1/finance/reportHae talouden yhteenvetoraportti - POST
/v1/finance/report/exportVie talouden yhteenvetoraportti - POST
/v1/finance/invoicesListaa laskut - POST
/v1/finance/invoices/exportVie laskulista - POST
/v1/finance/paymentsListaa maksut - POST
/v1/finance/payments/exportVie maksulista - GET
/v1/sources/{source_id}/push-keysListaa mukautetun lähteen API-avaimet - POST
/v1/sources/{source_id}/push-keysLuo API-avain mukautetulle lähteelle - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Peru mukautetun lähteen API-avain - GET
/v1/sources/{source_id}/push-syncsListaa mukautetun lähteen synkronoinnit - GET
/v1/push/sources/{source_id}Tarkista avain ja hae mukautetun lähteen tila - POST
/v1/push/sources/{source_id}/syncsAvaa synkronointi - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Hae synkronointi - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsListaa synkronoinnin asiakirjakohtaiset tulokset - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeSulje synkronointi - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchKuittaa asiakirjat lähettämättä niitä uudelleen - POST
/v1/push/sources/{source_id}/documentsLähetä asiakirja (luo tai korvaa) - POST
/v1/push/sources/{source_id}/documents/batchLähetä asiakirjaerä - GET
/v1/push/sources/{source_id}/documents/{external_id}Hae asiakirjan tulos - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Poista asiakirja