Objekty
Card
Pole
expandedCardExpandedpermissionsObjectPermissionListaccessstringPovolené hodnoty:
wholepartialaccess_contactstringNa koho se obrátit kvůli přístupu (jen když
access=partial).aclobjectPole
verifybooleanpovinnéwritebooleanpovinné
categorystringpovinnécategory_confidencenumber | nullpovinnécategory_lockedbooleanpovinnécategory_reviewbooleanpovinnécollectionstringpovinnécollection_idintegerpovinnécollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullObsah editoru poslední publikované verze. Pole může chybět; v takovém případě získejte obsah editoru z konceptu (
POST /v1/draftsscard_id).editing_lockEditingLock | nullAktivní zámek úprav. Pole může chybět; v takovém případě editor zjistí, kdo zámek drží, z
409 cards.lockedpřiPOST /v1/cards/{card_id}/lock.created_atstring (date-time)povinnédays_since_verifiedintegerpovinnéerrorstring | nullpovinnéeventsarray of CardEventfeedback_negintegerpovinnéfeedback_posintegerpovinnéfoldersarray of CardFolderRefJen seznam karet: složky, které kartu obsahují (ty, které uživatel vidí), s cestami od kořene kolekce. Prázdný seznam znamená, že karta není v žádné složce.
has_tablesbooleanJen seznam karet.
hidden_partsbooleanidstringpovinnéjobJob | nullorg_idintegerpovinnéowner_activeboolean | nullowner_idinteger | nullpovinnéowner_namestring | nullpovinnépagesinteger | nullpovinnéparserstring | nullpovinnéParser dokumentu jako neutrální kód:
document(úplná struktura: stránky, nadpisy, tabulky, naskenované stránky),pdf(textová vrstva PDF),docx,xlsx,csv,markdown,html,text. Seznam se může rozšířit.sensitivebooleanpovinnésha256string | nullpovinnésizeintegerpovinnésnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanpovinnésource_pathstring | nullpovinnésource_urlstring | nullpovinnéstatusstringpovinnéPovolené hodnoty:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringpovinnétitlestringpovinnétrustnumberpovinnétrust_if_verifiednumberupdated_atstring (date-time)povinnéverified_atstring (date-time) | nullpovinnéverified_byinteger | nullpovinnéverified_by_namestring | nullverifier_idsarray of integerpovinnéverifiersarray of objectPole
activebooleanpovinnéidintegerpovinnénamestringpovinné
verify_interval_daysintegerpovinnéversionintegerpovinnéversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectRuční nastavení parsování (náhled).
doc_kindDocKind | nullTyp dokumentu.
null, pokud typ není určen (například u karet zaindexovaných před zavedením typů dokumentů).doc_kind_confidencenumber | nullMíra jistoty typu dokumentu, od 0 do 1.
doc_kind_sourcestring | nullCo typ určilo: pravidla (
rules), uživatel (manual), nebo automatická klasifikace. Seznam se může rozšířit: neznámou hodnotu považujte za automatickou klasifikaci.Povolené hodnoty:
rulesmanualnullinvoiceDocInvoiceExtraction | nullPole faktury, dobropisu nebo účtenky (jen u těchto typů a jen v kartě, ne v seznamu).
null, pokud nemáte přístup k celému dokumentu, protože pole se vytěžují z celého dokumentu.warningsarray of ReviewWarningUpozornění k parsování dokumentu (
ReviewWarning; jen v kartě, ne v seznamu).enrichmentCardEnrichmentStatus | nullStav obohacení (jen v kartě, ne v seznamu). Typ dokumentu, pole faktury a finanční záznamy se doplňují na pozadí po indexování a později je lze přepočítat; v kartě se objeví, jakmile jsou připravené.
nullznamená, že stav není k dispozici (karta byla zaindexována bez obohacení na pozadí).external_idstring | nullID karty v systému integrátora. V organizaci je jedinečné mezi kartami, které nepocházejí ze zdrojů;
nullznamená, že není nastaveno./v1/cards-by-external-id/{external_id}podle něj kartu čte a nahrazuje.length ≤ 512
metadataMetadata
Používá
- GET
/v1/cards/{card_id}Získat kartu s verzemi, komentáři, tabulkami a událostmi - PATCH
/v1/cards/{card_id}Aktualizovat kartu - GET
/v1/cards-by-external-id/{external_id}Získat kartu podle externího identifikátoru - POST
/v1/cards/{card_id}/verifyPotvrdit, že je karta aktuální
Součást
CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult