[AEM Assets]{class="badge positive" title="AEM Assetsに適用）。"}

Adobe Experience Manager Assets HTTP API を使用したデジタルアセットの管理 assets-http-api

AEM Assets HTTP API の基本を学ぶ overview

AEM Assets HTTP API を使用すると、/api/assets で使用可能な REST インターフェイスを通じて、デジタルアセットに対する CRUD（作成、読み取り、更新、削除）操作が可能になります。 これらの操作は、アセットのメタデータ、レンディションおよびコメントに適用されます。 これには、コンテンツフラグメントのサポートが含まれます。

API にアクセスするには、次の手順を実行します。

API の応答は、一部の MIME タイプに対する JSON ファイル、およびすべての MIME タイプに対する応答コードです。 JSON 応答はオプションであり、PDF ファイルなどでは利用できない場合があります。 詳細な分析やアクションを行う場合は、応答コードを利用します。

コンテンツフラグメントの管理 content-fragments

コンテンツフラグメントは、テキスト、数値および日付を保存する、構造化されたアセットです。 standard アセット（画像やドキュメントなど）とはいくつかの違いがあるので、コンテンツフラグメントの処理にはいくつかの追加ルールが適用されます。

詳しくは、​ Experience Manager Assets HTTP API でのコンテンツフラグメントのサポートを参照してください。

データモデルについて data-model

Assets HTTP API は 、主にフォルダーと標準アセットの 2つの要素を公開します。 また、コンテンツフラグメントで使用するカスタムデータモデルの詳細な要素も提供します。 詳しくは、コンテンツフラグメントのデータモデルを参照してください。 詳しくは、コンテンツフラグメントのデータモデルを参照してください。

フォルダーの管理 folders

フォルダーは、従来のファイルシステムにおけるディレクトリに似ています。 フォルダーには、アセット、サブフォルダーまたはその両方を含めることができます。 フォルダーには、以下のコンポーネントがあります。

エンティティ：フォルダーのエンティティはフォルダーの子要素で、フォルダーまたはアセットです。

プロパティ：

リンク​フォルダーは、次の 3 つのリンクを公開します。

アセットの管理 assets

Experience Manager では、アセットには次の要素が含まれています。

コンテンツフラグメントの要素については、AEM Assets HTTP API でのコンテンツフラグメントのサポートを参照してください。

Experience Manager では、フォルダーには次のコンポーネントが含まれています。

使用可能な API 操作の探索 available-features

Assets HTTP API には、以下の機能が含まれます。

フォルダーのリストの取得 retrieve-a-folder-listing

既存のフォルダーとその子エンティティ（サブフォルダーまたはアセット）の Siren 表現を取得します。

リクエスト：GET /api/assets/myFolder.json

応答コード：応答コードは次のとおりです。

応答：返されるエンティティのクラスはアセットまたはフォルダーです。 含まれるエンティティのプロパティは、各エンティティの完全なプロパティセットのサブセットです。 エンティティのすべての表現を取得するために、クライアントはリンクで参照される URL のコンテンツを self の rel で取得する必要があります。

フォルダーの作成 create-a-folder

指定されたパスに sling:OrderedFolder を作成します。 ノード名の代わりに「*」が指定されている場合、サーブレットパラメーター名がノード名として使用されます。 リクエストでは、次のいずれかを受け付けます。

また、フォルダーのプロパティを URL クエリパラメーターとして指定できます。

指定されたパスの親ノードが存在しない場合、API 呼び出しは失敗し、応答コード 500 が返されます。 フォルダーが存在する場合、呼び出しは応答コード 409 を返します。

パラメーター：name はフォルダー名です。

リクエスト

応答コード：応答コードは次のとおりです。

アセットの作成 create-an-asset

アセットの作成は、この HTTP API 経由ではサポートされていません。 アセットの作成には、アセットアップロード API を使用します。

アセットバイナリの更新 update-asset-binary

アセットバイナリの更新方法については、アセットのアップロードを参照してください。 HTTP API を使用してアセットバイナリを更新することはできません。

アセットのメタデータの更新 update-asset-metadata

この操作により、アセットのメタデータが更新されます。 dc: 名前空間のプロパティを更新すると、対応する jcr: プロパティが更新されます。 ただし、API は 2 つの名前空間のプロパティを同期しません。

リクエスト：PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"dc:title":"My Asset"}}'

応答コード：応答コードは次のとおりです。

アセットレンディションの作成 create-an-asset-rendition

アセットのレンディションを作成します。 リクエストパラメーター名が指定されない場合、ファイル名がレンディション名として使用されます。

パラメーター：パラメーターは次のとおりです。

name：レンディション名の場合。file：参照としてのレンディションのバイナリファイル。

リクエスト

応答コード

アセットレンディションの更新 update-an-asset-rendition

アセットレンディションをそれぞれ新しいバイナリデータで置き換えて更新します。

リクエスト：PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

応答コード：応答コードは次のとおりです。

アセットへのコメントの追加 create-an-asset-comment

パラメーター：パラメーターは message（コメントのメッセージ本文）と annotationData（JSON 形式の注釈データ）です。

リクエスト：POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

応答コード：応答コードは次のとおりです。

フォルダーまたはアセットのコピー copy-a-folder-or-asset

指定されたパスに存在するフォルダーまたはアセットを新しい宛先にコピーします。

リクエストヘッダー：パラメーターは次のとおりです。

リクエスト：COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

応答コード：応答コードは次のとおりです。

フォルダーまたはアセットの移動 move-a-folder-or-asset

指定されたパスのフォルダーまたはアセットを新しい宛先に移動します。

リクエストヘッダー：パラメーターは次のとおりです。

リクエスト：MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

応答コード：応答コードは次のとおりです。

フォルダー、アセットまたはレンディションの削除 delete-a-folder-asset-or-rendition

指定されたパスのリソース（ツリー）を削除します。

リクエスト

応答コード：応答コードは次のとおりです。

ベストプラクティスとメモの制限に従う tips-limitations

関連リソースの探索