ドキュメント用REST API

リクエストの送信

ドキュメント用REST APIを使用してリクエストを送信する場合は、次のガイドラインを使用してください。

URLの構造

次のURL構造を使用して、ドキュメントRESTリソースにアクセスします:

https://subdomain.domain.com[:port]/documents/api/version/resourcePath

変数の意味は次のとおりです。

subdomain.domain.com[:port] - Oracle Content Managementが実行されているホストおよびポート。
version - REST APIのバージョン(たとえば: 1.2。
resource-path - リソースを定義する相対パス。リソースの完全なリストについては、「目次」の「すべてのリストア・エンドポイント」を参照してください。

サポートされているメソッド

次の表に示すように、標準のHTTPメソッド・リクエストを使用して、Oracle Content Managementで基本的なCRUD操作(作成、読取り、更新および削除)を実行できます。

HTTPメソッド	説明
`GET`	リソースについての情報を取得し、ファイルをダウンロードし、ドキュメントのサムネイルまたはレンディションを取得し、ユーザーを取得します。
`POST`	リソースの作成、ファイルまたはフォルダへのメタデータ・コレクションの割当て、ファイルまたはフォルダ・メタデータ・コレクションへの値の割当て、ファイルまたはフォルダのコピーまたは移動、ファイル・レンディションの生成、ファイルの予約または予約解除、ファイルまたはフォルダ・バージョンのアップロード、フォルダの共有を行います。
`PUT`	リソースを更新または編集します。
`DELETE`	リソースの削除、ファイルまたはフォルダ・メタデータ・コレクションの値の削除、ユーザーの失効、コレクションの共有解除を行います。

メディア・タイプ

ドキュメント用のREST APIでは、次のメディア・タイプがサポートされています:

application/json
application/XML

次の新規フォルダの作成例のように、レスポンスにはどちらのメディア・タイプも使用できます。 REST APIの記述例では、JSONレスポンスのみが示されています。

リクエスト:

POST .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001

リクエスト本文:

{
    "name": "restFolder",
    "description": "rest folder"
}

JSONレスポンス:

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T20:54:50Z",
    "description": "rest folder",
    "errorCode": "0",
    "id": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T20:54:50Z",
    "name": "restFolder",
    "ownedBy": "{
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },

    "parentID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "type": "folder"
}

XMLレスポンス:

<?xml version="1.0" encoding="utf-8"?>
<resource>
    <childItemsCount>0</childItemsCount>
    <createdBy>
        <displayName>User AA</displayName>
        <id>U0EAA20910FAF3052ACB79E4T00000000001</id>
        <type>user</type>
    </createdBy>
    <createdTime>2014-02-21T20:56:07Z</createdTime>
    <description>rest folder 2</description>
    <errorCode>0</errorCode>
    <id>F512DA3911603E8AB84A07ACT0000000000100000001</id>
    <modifiedBy>
        <displayName>User AA</displayName>
        <id>U0EAA20910FAF3052ACB79E4T00000000001</id>
        <type>user</type>

    </modifiedBy>
    <modifiedTime>2014-02-21T20:56:07Z</modifiedTime>
    <name>restFolder2</name>
    <ownedBy>
        <displayName>User AA</displayName>
        <id>U0EAA20910FAF3052ACB79E4T00000000001</id>
        <type>user</type>
    </ownedBy>
    <parentID>FF4729683CD68C1AFB1AE87DT0000000000100000001</parentID>    
    <type>folder</type>
 </resource>

一般的なリクエスト・ヘッダー

次の表に、一般的なリクエスト・ヘッダーをいくつか示します。

ヘッダー	説明	例
Accept	レスポンス本文に推奨されるメディア・タイプをリストします。操作で特に指定されていないかぎり、レスポンス本文のメディア・タイプは`application/json`です。	`application/json` `application/xml`
認可	ユーザーを認証する方法。認可を参照してください。	`Authorization: Basic abcvZTphYmMxMjM=` `Authorization: Bearer eyJhbGciOiJ...9yoQ`
Content-Length	リクエスト本文のサイズ(バイト単位)。	`540`
Content-Type	リクエスト本文のメディア・タイプ。このヘッダーは、`POST`および`PUT`リクエストに必要です。操作で特に指定されていないかぎり、リクエスト本文のメディア・タイプは`application/json`です。	`application/json`
Accept-Language	返されるエラー・メッセージに使用される言語を設定します。これによって有効なレスポンスのテキストの言語が変更されることはありません。	`fr`