オブジェクト

Card

フィールド

• expandedCardExpanded
• permissionsObjectPermissionList
• accessstring

  指定できる値: wholepartial

• access_contactstring

  アクセスについての問い合わせ先（access=partialの場合のみ）。

• aclobject
  フィールド

  • verifyboolean必須
  • writeboolean必須
• categorystring必須
• category_confidencenumber | null必須
• category_lockedboolean必須
• category_reviewboolean必須
• category_sourceCategorySource | null必須
• collectionstring必須
• collection_idinteger必須
• collection_titlestring
• commentsarray of CardComment
• content_jsonContentJSON | null

  最新の公開バージョンのエディターのコンテンツ。このフィールドは省略されることがあります。その場合は、下書きからエディターのコンテンツを取得してください（card_idを指定したPOST /v1/drafts）。

• editing_lockEditingLock | null

  有効な編集ロック。このフィールドは省略されることがあります。その場合、ロックを保持しているユーザーは、POST /v1/cards/{card_id}/lockが返す409 cards.lockedでわかります。

• created_atstring (date-time)必須
• days_since_verifiedinteger必須
• errorstring | null必須
• eventsarray of CardEvent
• feedback_neginteger必須
• feedback_posinteger必須
• foldersarray of CardFolderRef

  カードの一覧のみ：カードを含むフォルダー（ユーザーが参照できるもの）と、コレクションのルートからのパス。空のリストは、カードがどのフォルダーにも入っていないことを意味します。

• has_tablesboolean

  カードの一覧のみ。

• hidden_partsboolean
• idstring必須
• jobJob | null
• kindCardKind必須
• org_idinteger必須
• owner_activeboolean | null
• owner_idinteger | null必須
• owner_namestring | null必須
• pagesinteger | null必須
• parserstring | null必須

  中立的なコードで示すドキュメントのパーサー：document（ページ、見出し、表、スキャンしたページを含む完全な構造）、pdf（PDFのテキストレイヤー）、docx、xlsx、csv、markdown、html、text。リストは増えることがあります。

• partsarray of CardPart必須
• sensitiveboolean必須
• sha256string | null必須
• sizeinteger必須
• snoozed_atstring (date-time) | null
• snoozed_byinteger | null
• snoozed_untilstring | null
• source_changedboolean必須
• source_pathstring | null必須
• source_urlstring | null必須
• statusstring必須

  指定できる値: processingreadyerrorarchived

• tablesarray of CardTable
• tagsarray of string必須
• titlestring必須
• trustnumber必須
• trust_if_verifiednumber
• trust_partsTrustParts必須
• updated_atstring (date-time)必須
• verificationVerification必須
• verified_atstring (date-time) | null必須
• verified_byinteger | null必須
• verified_by_namestring | null
• verifier_idsarray of integer必須
• verifiersarray of object
  フィールド

  • activeboolean必須
  • idinteger必須
  • namestring必須
• verify_interval_daysinteger必須
• versioninteger必須
• versionsarray of CardVersion
• source_archiveArchiveSource
• created_byinteger | null
• manual_optionsobject

  手動の解析設定（プレビュー）。

• doc_kindDocKind | null

  ドキュメントの種類。種類が判定されていない場合はnull（たとえば、ドキュメントの種類が導入される前にインデックスが作成されたカード）。

• doc_kind_confidencenumber | null

  ドキュメントの種類の確信度（0〜1）。

• doc_kind_sourcestring | null

  種類を判定したもの：ルール（rules）、ユーザー（manual）、または自動分類。リストは増えることがあります：不明な値は自動分類として扱ってください。

  指定できる値: rulesmanualnull

• invoiceDocInvoiceExtraction | null

  請求書、貸方票、領収書のフィールド（これらの種類のみ。カードにだけ含まれ、一覧には含まれません）。フィールドはドキュメント全体から抽出されるため、ドキュメント全体へのアクセス権がない場合はnull。

• warningsarray of ReviewWarning

  ドキュメントの解析の警告（ReviewWarning。カードにだけ含まれ、一覧には含まれません）。

• enrichmentCardEnrichmentStatus | null

  エンリッチメントの状態（カードにだけ含まれ、一覧には含まれません）。ドキュメントの種類、請求書のフィールド、財務の記録は、インデックス作成の後にバックグラウンドで追加され、後から再計算されることがあります。準備ができるとカードに表示されます。nullは、状態が得られないことを意味します（バックグラウンドのエンリッチメントなしでインデックスが作成されたカード）。

• external_idstring | null

  インテグレーターのシステムでのカードのID。ソースから来ていないカードの中で、組織内で一意です。nullは未設定を意味します。/v1/cards-by-external-id/{external_id}は、このIDでカードを読み取り、置換します。

  length ≤ 512

• metadataMetadata

使用箇所

• GET/v1/cards/{card_id}カードをバージョン、コメント、表、イベントとともに取得する
• PATCH/v1/cards/{card_id}カードを更新する
• GET/v1/cards-by-external-id/{external_id}外部IDでカードを取得する
• POST/v1/cards/{card_id}/verifyカードが最新であることを確認する

参照元

CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult