目次

Search

  1. はじめに
  2. ビジネスエンティティサービスについて
  3. EJBビジネスエンティティサービス呼び出し
  4. REST ビジネスエンティティサービス呼び出し
  5. Data DirectorのREST API
  6. SOAPビジネスエンティティサービス呼び出し
  7. 相互参照レコードとBVT計算サービス
  8. 企業リンケージサービスのサポート
  9. データをクレンジング、分析、変換するための外部呼び出し
  10. 付録 A: REST APIを使用したレコードの追加
  11. 付録 B: REST APIを使用したファイルのアップロード
  12. 付録 C: REST APIを使用したレポートの管理

ビジネスエンティティサービスガイド

ビジネスエンティティサービスガイド

レコードへのファイルの添付

レコードへのファイルの添付

ファイルをレコードに添付する前に、そのファイルのメタデータを作成してから、そのファイルを一時ストレージにアップロードしてください。
  1. ファイルのメタデータを作成するには、ストレージタイプにTEMPを指定した[ファイルのメタデータの作成]REST APIを使用します。
    例えば、次の要求は
    Document_3.pdf
    ファイルのメタデータを作成します:
    POST http://localhost:8080/cmx/file/localhost-orcl-MDM_SAMPLE/TEMP Content-Type: application/json { "fileName": "Document_3.pdf", "fileType": "pdf", "fileContentType": "application/pdf" }
    常にTEMPストレージにファイルのメタデータを作成してください。
    [ファイルのメタデータの作成]REST APIはファイルのIDを返します。ファイルIDの形式は次のとおりです:
    <Storage Type>_<RowID>
    。RowIDは、ストレージにアップロードするファイルの行IDを表します。
    この例では、API呼び出しによって
    Document_3.pdf
    ファイルの次のIDが返されます:
    TEMP_SVR1.OJU3
    ファイルIDを使用して、ファイルのアップロード、添付、更新、ダウンロード、および削除を行うことができます。
  2. ファイルをアップロードするには、ストレージタイプにTEMPを指定した[ファイルコンテンツのアップロード]REST APIを使用します。
    例えば、次の要求はファイルをTEMPストレージにアップロードします。
    PUT http://localhost:8080/cmx/file/localhost-orcl-MDM_SAMPLE/TEMP/TEMP_SVR1.OJU3/content Content-Type: application/octet-stream <file object (upload using REST client)>
    ファイルをアップロードした後、TEMPストレージには事前設定された期間である60分間、ファイルが保存されます。事前設定された期間が終了する前に、ファイルをレコードに添付する必要があります。
  3. レコードを作成して、ファイルを新しいレコードに添付するには、[レコードの作成]REST APIを使用します。
    例えば、次の要求はレコードを作成し、ファイルIDが
    TEMP_SVR1.OJU3
    のファイルを添付します。
    POST http://localhost:8080/cmx/cs/localhost-orcl-MDM_SAMPLE/Person?systemName=Admin Content-Type: application/json { "frstNm":"John", "lstNm":"Smith", "addrLn1":"2100 Breverly Road", "addrTyp":{ "addrTyp":"Billing", "addrTypDesc":"Billing" }, "cntryCd":{ "cntryCd":"AX", "cntryDesc":"Aland" }, "attachments":{ "item":[ { "fileId":"TEMP_SVR1.OJU3" } ] } }
    ファイルをレコードに添付すると、プロセスによりファイルがデータベースに保存されます。ファイルのIDは
    DB_<RowID>
    に変更されます。ここで、DBはファイルがデータベースに保存されていることを示します。
  4. レコードに添付されたファイルを置き換えるには、ストレージタイプにDBを指定した[ファイルコンテンツのアップロード]REST APIを使用します。
    例えば、次の要求は、データベース内でファイルIDが
    DB_SVR1.OJU3
    の添付ファイルを置き換えます。
    PUT http://localhost:8080/cmx/file/localhost-orcl-MDM_SAMPLE/DB/DB_SVR1.OJU3/content Content-Type: application/octet-stream <file object (upload using REST client)>
    要求URLのストレージタイプはDBです。
  5. ファイルをレコードに添付した後、ファイルのメタデータを編集するには、ストレージタイプにDBを指定した[ファイルのメタデータの更新]REST APIを使用します。
    例えば、次の要求は、DBストレージ内でファイルID
    DB_SVR1.OJU3
    に関連付けられているファイルのメタデータを更新します。
    PUT http://localhost:8080/cmx/file/localhost-orcl-MDM_SAMPLE/DB/DB_SVR1.OJU3 Content-Type: application/json { "fileName": "Document_4.pdf", "fileType": "pdf", "fileContentType": "application/pdf" }
  6. レコードに添付されたファイルをダウンロードするには、ストレージタイプにDBを指定した[ファイルコンテンツの取得]REST APIを使用します。
    例えば、次の要求は、ファイルID
    DB_SVR1.OJU3
    に関連付けられているファイルをDBストレージからダウンロードします:
    GET http://localhost:8080/cmx/file/localhost-orcl-MDM_SAMPLE/DB/DB_SVR1.OJU3/content
  7. レコードに添付されたファイルを削除するには、ストレージタイプにDBを指定した[ファイルの削除]REST APIを使用します。
    例えば、次の要求は、ファイルID
    DB_SVR1.OJU3
    に関連付けられているファイルをDBストレージから削除します。
    DELETE http://localhost:8080/cmx/file/localhost-orcl-MDM_SAMPLE/DB/DB_SVR1.OJU3