サービス・コールURIおよびバージョン履歴
サービス・コールには、POST、GET、PUT、DELETEなどのHTTPSメソッドと、Uniform Resource Identifier (URI)によって識別されるリソースが含まれています。
URIは次の形式になります。
https://{host}[:port]/serviceid/api/version/resourcePathノート:
HTTPSがサポートされています。 HTTPはサポートされていません。
REST APIは、URIにバージョン番号を/x.y/フォルダの形式で含めることで、そのバージョンを識別します。ここで、xは既存の機能に対する差引的な変更や変更に対して増分され、yは、新しい機能が追加されると増分されます。 たとえば:
https://www.example.com/documents/api/1.1
カタログ・リソースには、インスタンスで現在サポートされているAPIのバージョンがリストされます。
APIの特定の実装を使用するには、URIでそのバージョンを参照する必要があります。
バージョン1.0
バージョン1.0では、基本的なフォルダ、ファイル、リソースおよびバージョン識別サービスとそのメソッドが提供されます。
バージョン1.1
バージョン1.1では、次の主要なサービスとメソッドが追加されます。
-
メタデータ・コレクションは、個々のフォルダおよびファイルに対するメタデータ値の格納と取得に使用できる、カスタム・メタデータ・フィールドを管理するための簡潔な方法です。
-
バージョン1.0で単純なユーザー文字列を参照していたサービス・リクエストとレスポンスは、現在ユーザー・オブジェクトを参照するようになっています。
次の検索リクエストが追加されました。
-
ユーザー電子メール検索
-
ユーザーのホーム・ディレクトリ内のフォルダの全文検索
-
ユーザーのホーム・ディレクトリ内のファイルの全文検索
-
ファイル・リソース・サービスには、次の追加コールが含まれます。
-
Reserve File (POST) -
Unreserve File (POST) -
Get File Thumbnail (GET) -
Get File Rendition Page Count (GET) -
Generate File Renditions (POST) -
Get File Page Rendition (GET)
ファイル・リソースでは、追加のmimeType、reservedByおよびreservationTime要素もサポートされます。
メタデータ・コレクション・リソースに、次のタスクのリクエストが追加されました。
-
メタデータ・コレクションの有効化または無効化
-
メタデータ・コレクションのフィールドの有効化または無効化
-
メタデータ・コレクション定義の取得
-
ユーザー・メタデータの取得
-
共有メタデータの取得
-
アプリケーション・リンク・メタデータの取得
-
パブリック・リンク・メタデータの取得
-
有効化または無効化されたフィールド・ステータスを示すファイルに割り当てられたメタデータ・コレクションの取得
-
有効化または無効化されたフィールド・ステータスを示すフォルダに割り当てられたメタデータ・コレクションの取得
-
メタデータ・コレクションの削除
「フォルダ・リソース」では、レスポンスに追加のcreatedbyおよびmodifiedby要素が含まれます。
「Applinksリソース」は、追加のuserLocale要素をサポートしています。
Upload File Version (POST)メソッドでは、マルチパート・リクエストでparentIDを使用する必要がなくなりました。
errorKeyフィールドがレスポンスに追加されました。
catalogカテゴリの名前がmetadata-catalogに変更されました。 catalog名は、metadata-catalogの別名として引き続きサポートされます。
Content Management REST APIのバージョン1.1では、Web Application Definition Language (WADL)定義ファイルを提供します。 Oracle JDeveloperは、このファイルをAPIとのインタフェースに使用します。
Content Management 1.1のREST APIは、レガシー版のドキュメントのREST APIです。
バージョン1.2
バージョン1.2には、バージョン1.1のすべての機能が含まれ、次の主要なサービスとそのメソッドが追加されています:
-
既存のサイトからサイトを作成するためのサイト・リソース。
-
テンプレート・リソース。テンプレートからサイトを作成します。
バージョン1.2は、ドキュメントのREST APIの進行中バージョンです。