ドキュメントの送信（POST）

以下を使用してドキュメントを POST できます。

  • /claim/v1/claims/{claimId}/documents
  • (ContactManager) /contact/v1/contacts/{contactId}/documents
    • ContactManager では、「vendor」タグのある連絡先にのみドキュメントを POST できます。

FormData オブジェクト

ほとんどの Cloud API リソースでは、JSON テキストの単一文字列を使用した本文として要求オブジェクトが作成されます。ただし、この形式はドキュメントにとって十分に堅牢ではありません。ドキュメントを操作する際、呼び出し元アプリケーションで送信が必要なデータは、2 つのセットのデータ（ドキュメントのメタデータとドキュメントの内容）です。これを実現するために、FormData オブジェクトを使用します。

FormData は業界標準のインターフェイスであり、これによってオブジェクトをキー／値のペアのセットとして構築します。呼び出し元アプリケーションが POST /documents 呼び出しを構築しているとき、要求オブジェクトは以下のキーを持つ FormData オブジェクトでなければなりません。

  • metadata：値は JSON 文字列であり、これによってドキュメントのメタデータを特定します
  • content：値はドキュメントの内容（およびフォーマットはドキュメントの種類に応じて異なる）

ドキュメントの POST への 2 つのアプローチ

呼び出し元アプリケーションがドキュメントを作成する方法は 2 つあります。

  1. /documents エンドポイントを使用して、ドキュメントのメタデータと内容の両方を ClaimCenter に POST します。このアプローチでは、以下の処理が行われます。
    • ClaimCenter が独自の連携ポイントでドキュメントを文書管理システムに追加します。
    • 文書管理システムで作成された値をドキュメントのメタデータに保存する役割を、連携ポイントは果たします（ドキュメントの DocUID など）。
  2. ドキュメントを文書管理システムに直接追加し、ドキュメントのメタデータを ClaimCenter に POST します。このアプローチでは、以下の処理が行われます。
    • 文書管理システムから発生した必須情報（ドキュメントの DocUID など）を POST /documents 呼び出しでメタデータに提供する必要があります。

最少作成条件

ドキュメントの POST 時には、以下の条件があります。

  • metadata JSON には以下のフィールドを含める必要があります。
    • name
    • status（DocumentStatusType タイプリストからのタイプコード）
    • type（DocumentType タイプリストからのタイプコード）
  • content の値は必須ではありません。例えば、ドキュメントが物理的な紙であり文書管理システムに存在しない場合、または呼び出し元アプリケーションが文書管理システムに直接ドキュメントを追加している場合、内容を省略することが適切である可能性があります。

ドキュメントの POST の例

以下は、クレーム cc:102 に対応する「Property Assessment Report.pdf」ファイルを ClaimCenter 経由で POST する例です。

POST /claim/v1/claims/cc:102/documents

Metadata:
{
    "data": {
        "attributes": {
            "name": "Property Assessment Report",
            "status": {
                "code": "draft"
            },
            "type": {
                "code": "letter_received"			
            }
        }
    }
}

Contents:
<contents of "Property Assessment Report.pdf" file>

Postman を使用したドキュメントの送信（POST）

このタスクについて

Postman から、FormData オブジェクトを使用してドキュメントを POST できます。その場合、Postman 呼び出しで参照するメタデータとコンテンツを別々のファイルに保存する必要があります。

注: すべての POST /documents エンドポイントは、メタデータを文字列またはファイルとして受信する機能をサポートしています。ただし、Postman には既知の問題があり、メタデータを文字列として保存できません。そのため、Postman を使用する場合、メタデータはファイルとしてのみ送信できます。これについては、以下の手順で説明します（Postman 以外のクライアントアプリケーションは、文字列とファイルの両方をサポートしている可能性があります）。

手順

  1. FormData オブジェクトに必要なファイルを確認します。これには、以下が含まれます。

    • メタデータを格納する JSON ファイル（ファイル拡張子が .json でなければなりません）

    • コンテンツを含むドキュメントファイル
  2. Postman で、［Launchpad］タブの右側の［+］をクリックして、新しい要求を開始します。
  3. ［Untitled Request］ラベルの下で、［POST］を選択します。
  4. ［Enter request URL］フィールドに、サーバーとエンドポイントの URL を入力します。
    • 例えば、ローカルマシン上の ClaimCenter インスタンス上のクレームにドキュメントを POST するには、「http://localhost:8080/cc/rest/claim/v1/claims/{claimId}/documents」と入力します。
  5. ［権限］タブで、必要に応じて権限情報を指定します。
  6. 要求ペイロードを指定します。
    1. タブの先頭行（［パラメータ］で始まる行）の［本文］をクリックします。
    2. ラジオボタンの行で［form-data］を選択します。
    3. 1 行目の［キー］に「metadata」と入力します。
    4. 「metadata」セルの外側をクリックします。その後、マウスポインタをセルの右側に合わせます。ドロップダウンリストが開きます。値を［テキスト］から［ファイル］に変更します。
    5. ［値］で、［ファイルの選択］ボタンをクリックし、メタデータを含んでいる JSON ファイルを参照します。
    6. 2 行目の［キー］に「content」と入力します。
    7. 「content」セルの外側をクリックします。その後、マウスポインタをセルの右側に合わせます。ドロップダウンリストが開きます。値を［テキスト］から［ファイル］に変更します。
    8. ［値］で、［ファイルの選択］ボタンをクリックし、ドキュメントコンテンツを含んでいるファイルを参照します。
  7. ［送信］をクリックします。応答ペイロードが要求ペイロードの下に表示されます。