本文へスキップ
Sursa Developers

PATCH/v1/cards/{card_id}

カードを更新する

update_card

認証

AuthorizationヘッダーでAPIキーを送信します：Authorization: Bearer <キー>。

パスパラメーター

  • card_idstring必須

ヘッダーパラメーター

  • Idempotency-Keystring

    書き込みを安全に再試行するためのキー：1〜255文字の印字可能なASCII文字で、論理的な操作ごとにUUID v4を使うことを推奨します。同じキーで24時間以内に再試行しても操作は再実行されず、保存済みのレスポンス（ステータス、ヘッダー、ボディ）がIdempotency-Replayed: trueヘッダー付きで返されます。同じキーでメソッド、パス、Content-Type、ボディのいずれかが異なる場合は409 api.idempotency_mismatchを返し、最初のリクエストがまだ実行中の場合は409 api.idempotency_in_progressをRetry-After: 1付きで返します。5xxまたは429のレスポンスの後はキーが解放され、再試行で操作がもう一度実行されます。キーの有効範囲は、組織と呼び出し元（APIキー、ユーザー、カスタムソースのソースキー）の組み合わせです。

    length ≥ 1, length ≤ 255

  • X-View-Asstring

    adminロールのAPIキー専用です。データプロファイル<profile>[:viewer|verifier|editor]（例：employee:viewer）としてリクエストを実行します。インストールキーではこのヘッダーを使えません（403）。

Cookieパラメーター

  • kb_view_asstring

    セッションの「View as」モードのCookie。POST /auth/view-asで設定し、DELETE /auth/view-asで解除します。

リクエストボディ

application/json

オブジェクト：CardUpdate

  • external_idstring | null

    カードのexternal_idを設定または変更します。""またはnullで削除されます。組織のほかのカードがこの値を使っている場合、リクエストは409 cards.external_id_takenを返します。ソースのカードのexternal_idは変更されません（409 cards.managed_by_source）。

    length ≤ 512

  • metadataMetadataPatch
  • titlestring | null
  • owner_idinteger | null
  • verifier_idsarray of integer | null
  • verify_interval_daysinteger | null

    ≥ 1, ≤ 3650

  • tagsarray of string | null
  • statusstring | null
  • source_urlstring | null
  • categorystring | null
  • sensitiveboolean | null
  • table_categoriesmap of object | null

レスポンス

200成功時のレスポンス

レスポンスヘッダー

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

  • Idempotency-Replayed

    trueは、このIdempotency-Keyの保存済みのレスポンスが再送されたことを示します：操作は再実行されていません。

application/json

オブジェクト：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
400リクエストが無効です：パラメーターの値またはオブジェクトの状態により、この操作を実行できません（`detail`はメッセージ）。

レスポンスヘッダー

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

401認証情報が送信されていない（セッションCookieもAPIキーもない）か、キーが見つかりません。

レスポンスヘッダー

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

403この操作は許可されていません：ロールの権限が足りない、コレクションやカードへのアクセス権がない、リクエストが「View as」モードで実行されている、または組織が停止中か削除済みです（`detail`は`code: org_suspended | org_deleted`を持つオブジェクト）。

レスポンスヘッダー

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

404オブジェクトが存在しないか、アクセスできません。APIは、アクセスが制限されたオブジェクトの存在を明かしません。

レスポンスヘッダー

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

422バリデーションエラー：ボディまたはパラメーターがスキーマに一致しない（`detail`はバリデーションエラーのリスト）、またはパラメーターの値が範囲外です（`detail`はメッセージ）。

レスポンスヘッダー

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

429リクエストが多すぎる（`api.rate_limited`）、組織の1分・1日・1か月のクォータを使い切った（`api.quota_exceeded`。`error.details`には`quota`、`limit`、`reset_at`が含まれます）、組織の上限に達した、または回答サービスが混雑しています（`answers.engine_busy`）。`Retry-After`ヘッダーの時間だけ待ってください。

レスポンスヘッダー

  • Retry-After

    リクエストを再試行するまでに待つ秒数。

  • RateLimit-Policy

    適用中の制限。IETFのドラフトdraft-ietf-httpapi-ratelimit-headersの形式で、"<name>";q=<quota>;w=<window in seconds>の項目をカンマで区切って並べます。keyはAPIキーのリクエストレートです（クォータはバースト、ウィンドウはバーストが完全に回復するまでの時間。セッションではuser、認証情報がない場合はip）。minute、day、monthは、UTCの暦の上での1分・1日・1か月ごとの組織のクォータです。

  • RateLimit

    RateLimit-Policyの各制限の残り："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policyのうち最も厳しい項目（残りのリクエスト数が最も少ない項目）の上限。

  • X-RateLimit-Remaining

    最も厳しい制限での残りのリクエスト数。

  • X-RateLimit-Reset

    最も厳しい制限がリセットされるまでの秒数。

application/json

オブジェクト：Error

エラーコード

すべてのリクエストに共通のコードに加えて、このエンドポイントがerror.codeで返すことのあるコード。

安全な再試行

POSTとPATCHのたびにIdempotency-Keyヘッダー（UUIDなど）を送信してください。24時間以内に同じキーで再試行すると、リクエストをもう一度実行せずに、保存済みのレスポンスが返ります。

レート制限

レスポンスには、RateLimitヘッダーとRateLimit-Policyヘッダー、以前のX-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetが含まれます。429レスポンスにはRetry-After（秒）が含まれます。その時間だけ待ってから再試行してください。

← cards · APIリファレンス