REST APIによるストラクチャーとテンプレートの管理

Webコンテンツストラクチャーとは、Webコンテンツの記事に含まれる情報を定義するものです。ストラクチャーにより、Webコンテンツの作成・管理がしやすくなり、コンテンツに必要な情報がすべて確実に含まれるようにします。ストラクチャーをWebコンテンツテンプレートに関連付けることができます。テンプレートは、ページ上でコンテンツ項目がどのようにレンダリングされるかを決定します。次の表は、Webコンテンツストラクチャーとテンプレートと共にLiferay DXP REST APIを使用して、利用可能なオプションをまとめたものです。

利用可能なオプション	利用不可のオプション
ストラクチャーとテンプレートの情報収集ストラクチャー権限の置換	ストラクチャーやテンプレートの作成ストラクチャーやテンプレートの削除

ここでは、いくつかの cURL コードサンプルとともに、ビルド済みのLiferay DXP Dockerイメージを使って、構造化コンテンツの管理方法について学習していきます。以下のトピックについて学習することができます。

環境のセットアップ
使用するサービスの特定
サイトストラクチャーの取得
サイトテンプレートの取得
ストラクチャー権限の取得
ストラクチャー権限の置換

環境のセットアップ

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:7.4.13-u55。

メールアドレス[email protected]_とパスワード_test_を使用して、http://localhost:8080でLiferayにサインインしてください。プロンプトが表示されたら、パスワードを _learn_に変更します。

次に、以下の手順に従います。

サンプルプロジェクトをダウンロードし、解凍します：
```
curl https://resources.learn.liferay.com/dxp/latest/en/content-authoring-and-management/web-content/developer-guide/liferay-m7b1.zip -O
```
```
unzip liferay-m7b1.zip
```
note

これらのスクリプトは基本認証を使用し、テスト用に設計されています。本番のLiferay DXP環境では、基本認証を使用しないでください。
以下の手順で環境をセットアップします。

サイトIDの特定

サイトメニュー（）を開き、［Configuration］ → ［Site Settings］に移動します。
［プラットフォーム］セクションで、［Site Configuration］をクリックします。
サイトIDの下でサイト識別子を見つけます。

ストラクチャーとテンプレートサンプルの作成

note

REST APIを使用してプログラム的にストラクチャーとテンプレートを作成することはできません。

ストラクチャーを作成するには、ストラクチャーの作成を参照してください。テンプレートを作成するには、 Webコンテンツテンプレートの作成を参照し、サンプルストラクチャーを元にテンプレートを作成します。このチュートリアルでは、1つのテキストフィールドを持つ基本的なストラクチャーを使用して、ContentStructure サービスを実演します。

単一のテキストフィールドを使用した基本的なサンプルストラクチャーです。

サンプルストラクチャーとテンプレートの特定

サイトメニュー（）を開き、［コンテンツ & データ］ → ［Webコンテンツ］に移動します。
［ストラクチャー］タブをクリックします。
IDの欄で、ストラクチャーのIDを特定します。

また、プログラム的にストラクチャーIDを特定することも可能です。詳しくは、 REST APIによるストラクチャーとテンプレートの管理をご覧ください。

使用するサービスの特定

Webコンテンツの管理には、Liferay DXP Headless Delivery API のStructuredContentサービスを使用します。このサービスとすべての異なるHTTPメソッドを識別するには、Liferay APIエクスプローラーを使用します。詳しくは、 RESTサービスの使用を参照してください。

サイトストラクチャーの取得

ContentStructures_GET_FromSite.shcURLスクリプトは、既存のサイトストラクチャーを一覧表示します。このスクリプトは、サイトIDを唯一のパラメーターとして、GET HTTPメソッドでContentStructureサービスを使用します。

   ./ContentStructures_GET_FromSite.sh 20125

パラメーター #	説明
$1	`siteId`

次のコードは、スクリプトが生成するJSON出力を示しています。このスクリプトは、サイト内のすべてのストラクチャーを返します。この例では、 id と nameで識別される単一のストラクチャーを確認できます。

   {
    "actions" : { },
    "facets" : [ ],
    "items" : [ {
        "availableLanguages" : [ "en-US" ],
        "contentStructureFields" : [ {
        "dataType" : "string",
        "inputControl" : "text",
        "label" : "Text",
        "localizable" : true,
        "multiple" : false,
        "name" : "Text86549034",
        "nestedContentStructureFields" : [ ],
        "options" : [ ],
        "predefinedValue" : "",
        "repeatable" : false,
        "required" : false,
        "showLabel" : true
        } ],
        "creator" : {
        "additionalName" : "",
        "contentType" : "UserAccount",
        "familyName" : "Bowman",
        "givenName" : "David",
        "id" : 20129,
        "name" : "David Bowman"
        },
        "dateCreated" : "2021-08-02T13:15:42Z",
        "dateModified" : "2021-08-02T13:16:57Z",
        "description" : "",
        "id" : 41837,
        "name" : "Simple Structure",
        "siteId" : 20125
    } ],
    "lastPage" : 1,
    "page" : 1,
    "pageSize" : 20,
    "totalCount" : 1
   }

ストラクチャーには、 contentStructureFieldsのdataTypeセクションで説明される単一のテキストフィールドがあります。ストラクチャーにさらに要素を含めると、 contentStructureFieldsの下に追加のセクションが表示されます。以下は、テキストフィールド（"dataType" : "string"）と画像フィールド（"dataType" : "image"）を持つストラクチャーのJSON出力部分です。

   {
    "actions" : { },
    "facets" : [ ],
    "items" : [ {
        "availableLanguages" : [ "en-US" ],
        "contentStructureFields" : [ {
        "dataType" : "string",
        "inputControl" : "text",
        "label" : "Text",
        "localizable" : true,
        "multiple" : false,
        "name" : "Text86549034",
        "nestedContentStructureFields" : [ ],
        "options" : [ ],
        "predefinedValue" : "",
        "repeatable" : false,
        "required" : false,
        "showLabel" : true
        }, {
        "dataType" : "image",
        "label" : "Image",
        "localizable" : true,
        "multiple" : false,
        "name" : "Image96876678",
        "nestedContentStructureFields" : [ ],
        "options" : [ ],
        "predefinedValue" : "{}",
        "repeatable" : false,
        "required" : false,
        "showLabel" : true
        } ],

サイトテンプレートの取得

ContentTemplates_GET_FromSite.shcURLスクリプトは、既存のサイトテンプレートを一覧表示します。このスクリプトは、サイトIDを唯一のパラメーターとして、GET HTTPメソッドでContentTemplateサービスを使用します。

   ./ContentTemplates_GET_FromSite.sh 20125

cURLスクリプトのパラメーター：

パラメーター #	説明
$1	`siteId`

以下は、このスクリプトが生成するJSON出力の一部です。このスクリプトは、サイト内のすべてのテンプレートを返します。この例では、 id と nameで識別される単一のテンプレートを確認できます。 contentStructureId は関連するストラクチャーIDに、 templateScript はテンプレートを記述したFreeMarker テンプレート言語に対応します。

   {
    ...
        "availableLanguages" : [ "en-US" ],
        "contentStructureId" : 41837,
        "creator" : {
        "additionalName" : "",
        "contentType" : "UserAccount",
        "familyName" : "Bowman",
        "givenName" : "David",
        "id" : 20129,
        "name" : "David Bowman"
        },
        "dateCreated" : "2021-08-02T13:24:32Z",
        "dateModified" : "2021-08-02T14:33:24Z",
        "description" : "",
        "id" : "41847",
        "name" : "Simple Template",
        "programmingLanguage" : "ftl",
        "siteId" : 20125,
        "templateScript" : "<#if (Text86549034.getData())??>\n\t${Text86549034.getData()}\n</#if>"
    } ],
    "lastPage" : 1,
    "page" : 1,
    "pageSize" : 20,
    "totalCount" : 1
   }

note

テンプレートについて詳しくは、Webコンテンツテンプレートの作成をご覧ください。

ストラクチャー権限の取得

ContentStructure_GET_Permissions.sh cURLスクリプトは、ストラクチャーの権限を一覧表示します。このスクリプトは、ストラクチャーIDを唯一のパラメーターとして、GET HTTPメソッドでContentStructureサービスを使用します。

メソッド	サービス	エンドポイント
PUT	`ContentStructure`	`/v1.0/content-structures/{contentStructureId}/permissions`

   ./ContentStructure_GET_Permissions.sh 41837

cURLスクリプトのパラメーター：

パラメーター #	説明
$1	ストラクチャー `id`

JSON出力には、itemsセクションの下に権限が含まれます。この例では、 roleNameにサンプルストラクチャーの権限を持つロールが1つだけあり、 actionIdsに権限リストがあります。

    {
    "actions" : {
        "get" : {
        "method" : "GET",
        "href" : "http://localhost:8080/o/headless-delivery/v1.0/content-structures/41837/permissions"
        },
        "replace" : {
        "method" : "PUT",
        "href" : "http://localhost:8080/o/headless-delivery/v1.0/content-structures/41837/permissions"
        }
    },
    "facets" : [ ],
    "items" : [ {
        "actionIds" : [ "DELETE", "PERMISSIONS", "UPDATE", "VIEW" ],
        "roleName" : "Owner"
    } ],
    "lastPage" : 1,
    "page" : 1,
    "pageSize" : 2,
    "totalCount" : 2
    }

note

権限の管理方法については、Webコンテンツストラクチャーとテンプレートへのアクセス許可の割り当てをご覧ください。

ストラクチャー権限の置換

PUTHTTPメソッドで、 ContentStructureサービスを使って、オリジナルのストラクチャー権限を置き換えることができます。このスクリプトの例では、構造化コンテンツ識別子 id を使用して、パワーユーザーロールの DELETE と VIEW 権限を含んでいます。

メソッド	サービス	エンドポイント
PUT	`ContentStructure`	`/v1.0/content-structures/{contentStructureId}/permissions`

   ./ContentStructure_PUT_Permissions.sh 41837

cURLスクリプトのパラメーター：

パラメーター #	説明
$1	ストラクチャー `id`

JSON出力では、 items セクションの下に、各ロールについて2つのエントリーが表示されます。

    {
    "actions" : {
        "get" : {
        "method" : "GET",
        "href" : "http://localhost:8080/o/headless-delivery/v1.0/content-structures/41837/permissions"
        },
        "replace" : {
        "method" : "PUT",
        "href" : "http://localhost:8080/o/headless-delivery/v1.0/content-structures/41837/permissions"
        }
    },
    "facets" : [ ],
    "items" : [ {
        "actionIds" : [ "DELETE", "PERMISSIONS", "UPDATE", "VIEW" ],
        "roleName" : "Owner"
    }, {
        "actionIds" : [ "DELETE", "VIEW" ],
        "roleName" : "Power User"
    } ],
    "lastPage" : 1,
    "page" : 1,
    "pageSize" : 2,
    "totalCount" : 2
    }

REST APIによるストラクチャーとテンプレートの管理

Not finding what you're looking for?