[Oracle Cloud]REST APIでOCMにアセットを登録する

はじめに

この記事では、Oracle Content Management(OCM)が提供するREST APIを利用し、アセットを登録・作成する方法を紹介します。今回はREST API for Content Managementを利用します。

なお、RESTクライアントはPostmanを利用します

この記事は2023年8月時点の情報に基づき作成しました。最新の情報については、製品ドキュメントなどをご確認ください

準備

環境構築

以下チュートリアルを参考に、OCMインスタンスを作成します

続けて、コンテンツ・タイプ（ここではsampleNewsType）を定義し、アセット・リポジトリ内で利用できるように設定します。詳細は以下チュートリアルを参考にしてください

リポジトリIDを確認する

REST APIで操作するアセット・リポジトリの リポジトリID(repositoryId) を確認し、メモします。確認方法は2つあります

• WebブラウザでOCMインスタンスにアクセスし、アセット・リポジトリを開きます。その時のURLに含まれるq={"repositoryId":"xxxxxxxxxxxxxx"}のxxxxxxxxxxxxxxがリポジトリIDとなります
  

• リポジトリ管理者権限を付与されたユーザーでOCMインスタンスにアクセスし、ADMINISTRATION:コンテンツ→リポジトリから、アセット・リポジトリの編集画面を開きます。右サイトパネルを開き、APIタブを選択すると、リポジトリIDを確認できます
  

OAuthトークンを取得する

REST API for Content Managementを利用時の認証方式はいくつか提供されています。今回はOAuthトークンを利用します。OAuthトークンの取得方法は、以下製品ドキュメントをご確認ください。

また、具体的な方法は以下のQiita記事に詳しく書かれていますので、参考にしてください

2021年6月に、サービス名称が Oracle Content and Experience(略称:OCE) から Oracle Content Management(略称:OCM) に変更されました。上記Qiita記事を確認する際は、旧サービス名称を現在のサービス名称である Oracle Content Management(OCM) に読み替えてご利用ください

REST APIでアセットを登録する

デジタル・アセットを登録する

画像ファイルをデジタル・アセットとして登録します。今回は事前定義済のデジタル・アセット・タイプImageタイプとして登録します

利用するREST APIはこちら（↓）

Postmanを起動し、以下の通りに設定します

• メソッド: POST
• URI: https://<OCMインスタンスのドメイン名>/content/management/api/v1.1/items
  

Authorizationタブ

• Type: OAuth2.0
• Token: 事前に取得したOAuthトークンを指定
  

Headersタブ

• Content-Type: multipart/form-data
• X-Requested-With: XMLHttpRequest
  

Bodyタブ

• Key: file

• Value: (アセットリポジトリに登録する画像ファイルを指定)
  

• Key: item

• Value: (以下記述例参照)

itemパラメータ(json形式)の記述例

{
    "name": "web2.jpeg",
    "type": "Image",
    "repositoryId": "3416C33BDD9E40E7ACE44310584DDF03"
}

Send をクリックします。REST APIが実行され、画像ファイルがImageタイプのデジタル・アセットとして登録されます。レスポンスに含まれる "id":"xxxxxxxxxx" のxxxxxxxxxxをメモします

アセット・リポジトリをWebブラウザで開きます。先ほどREST APIで登録した画像ファイル（ここではweb2.jpeg）が表示されることを確認します

コンテンツ・アイテムを登録する

REST APIを利用し、コンテンツ・アイテムを登録します。今回は事前準備で作成したコンテンツ・タイプ sampleNewsType から、コンテンツ・アイテムを作成します。また、メディア属性フィールドには、前の手順で登録したに画像アセットを指定します

利用するREST APIはこちら（↓）

以下の通りに設定します

• メソッド: POST
• URI: https://<OCMインスタンスのURL>/content/management/api/v1.1/items

Authorizationタブ

• Type: OAuth2.0
• Token: 事前に取得したOAuthトークンを指定
  

Headersタブ

• Content-Type: application/json
• X-Requested-With: XMLHttpRequest
  

Bodyタブ
以下の入力例を参考に、json形式で入力します。なお、fields > image > idには、前の手順でメモした画像アセットの id をそのまま入力します

{
    "name": "sample news content from REST API",
    "type": "sampleNewsType",
    "repositoryId": "3416C33BDD9E40E7ACE44310584DDF03",
    "language": "ja",
    "translatable": true,
    "fields":{
        "title": "RESTAPIから作成したサンプルニュースのタイトル",
        "image":{
            "id": "CONT2C7212F692C8485F9D7227688DCDE2AD"
        },
        "body": "RESTAPIから作成したサンプルニュースの本文です"
    }
}

Send をクリックします。REST APIが実行され、コンテンツ・アイテムが作成されます

アセット・リポジトリをWebブラウザで開きます。先ほどREST APIで登録したsampleNewsTypeのコンテンツ・アイテムが表示されることを確認します

コンテンツ・アイテムを編集します。REST API実行時にfieldsで指定したタイトル(title)、画像(image)、本文(body) がそれぞれ設定されていることを確認します。

まとめ

この記事では、OCMのREST API for Content Managementを利用し、REST API経由でデジタル・アセットとコンテンツ・アイテムを登録・作成する方法を紹介しました。

引き続き、こちら（↓）のQiita記事も併せてご確認いただけると幸いです

##（参考）OCMの製品ドキュメント

• Oracle Content Management 製品ドキュメント(英語)
• Oracle Content Management 製品ドキュメント（日本語翻訳版）
  製品ドキュメントの英語原本と日本語翻訳版です。翻訳されるまでに時差がありますので、最新情報の確認は 英語版のドキュメントをご利用ください