[Cloud, WebCenter] REST API Now Supports Metadata in DOCS

原文はこちら。
https://blogs.oracle.com/webcenter/entry/rest_api_now_supports_metadata

---

（Victor Owuorによるエントリです）

Oracle Documents Cloud Service (DoCS) が簡単にクラウドアプリケーションを構築するためのプラットフォームとすることを我々のゴールとしています。これを可能にするため、DoCSのユーザーエクスペリエンスをみなさんのアプリケーション内に組み込むためのフレームワークを提供していますし、DoCSを呼び出すためのREST APIを提供しています。これらを使えば、みなさまが作成されたアプリケーションのユーザーインターフェースでDoCSの機能を使うことができます。今回、REST APIがメタデータをサポートしたことを発表でき、うれしく思っています。
不動産リストのサイトのためのアセット管理をするアプリケーションにアプリケーションを例にして、メタデータを説明していきます。このアプリケーションはDoCS内の関連アセットを管理し、別々に描画するUIでこうしたアセットを使えるようにしています。ご想像の通り、アプリケーションにはアプリケーションにリスト表示される不動産の様々なイメージ画像を格納する必要があります。例えば、正面画像やいろいろな部屋の写真などがあるかもしれません。また、資産に関する追加説明情報を付ける必要があるかもしれません。この追加説明情報こそがメタデータとして参照しようとするものです。

アプリケーションには各不動産の住所を付ける必要があるかもしれません。住所には以下の情報が含まれています。

• 番地
• 市区町村
• 州
• 国

これらの情報はDoCSのメタデータフィールドと呼ばれます。関連フィールドはメタデータ・コレクションにまとめられます。アプリケーションは複数のコレクションを定義し、各フォルダやドキュメントをこうしたコレクションに関連づけることができます。例えば、addressコレクションに加えて、売り出し中の不動産を、以下のフィールドを含むforsaleコレクションと関連づけることになるかもしれません。

• 売価
• 地税
• 以前の売価

対して、賃貸物件の場合は、以下のフィールドを含むfor-rentコレクションと関連づけることになるかもしれません。

• 賃貸価格
• リース期間

DoCSを使うと管理者が簡単にメタデータ・コレクションやコレクション内にフィールドを定義することができます。上記の例の場合、管理者は以下の方法でaddressコレクションを定義します。

POST …/metadata/Address?fields=Street,City,State

addressコレクションを変更して、以下のようにcountryを含めることも簡単にできます。

PUT …/metadata/Address?addFields=Country

collectionとcollectionのフィールドを定義したら、以下のようにしてコレクションをフォルダやドキュメントに割り当てることができます。

POST …/folders/{folder id}/metadata/Address
POST …/files/{file id}/metadata/Address

当然ながら、フォルダやドキュメントに対してコントリビュータ権限を持つユーザーだけがcollectionを割り当てることができます。
collectionを割り当てると、ユーザはcollectionの各フィールドに値を設定することができます。

POST …/folders/{folder id}/metadata?collection=Address&Zip=55347&City=Minneapolis
POST …/files/{file id}/metadata?collection=Address&Zip=55347&City=Minneapolis

フォルダに割り当てられたcollectionsと値はサブフォルダとフォルダ内のドキュメントが継承します。継承された値は、アイテムのメタデータのフィールドに対して特定の値を割り当てることでオーバーライドできます。
以前文書に割り当てたメタデータの値を取得できなければ、メタデータプロパティに価値はありません。以下のようなシンプルな呼び出し方で、メタデータの値を取得することができます。

GET …/folders/{folder id}/metadata
GET …/files/{file id}/metadata

この呼出しで、HTTPレスポンスの中にJSON形式でメタデータが返ってきます。以下はメタデータのレスポンスの例です。

{
  "errorCode": "0",
  "idList": "{file id}",
  "metadata": {
    "Address": {
      "City": "Minneapolis",
      "State": "Minnesota",
      "Street": "9560 Dogwood Circle"
    },
    "Description": {
      "Color": "Red",
      "Type": "Single Family"
    }
  },
  "type": "file"
}

メタデータの機能に関する詳細は、以下のドキュメントをご覧ください。

Oracle® Cloud Developing for Oracle Documents Cloud Service
Metadata Collection Resource
https://docs.oracle.com/cloud/latest/documentcs_welcome/WCCCD/GUID-1EC33747-53E0-4162-AD2B-9533E9F2FAD4.htm#WCCCD-GUID-1EC33747-53E0-4162-AD2B-9533E9F2FAD4