ドキュメントAEM as a Cloud Serviceユーザーガイド

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

Last update: Fri Mar 21 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 開発者
  • 管理者
新規 Dynamic Media Prime Ultimate
新規AEM AssetsUltimate
新規AEM AssetsとEdge Delivery Servicesの統合
新規UI 拡張機能
Dynamic Media Prime Ultimateの新 能
検索のベストプラクティス
メタデータのベストプラクティス
コンテンツハブ
OpenAPI 機能を備えた Dynamic Media
AEM Assets 開発者向けドキュメント
バージョン
記事リンク
AEM 6.5
ここをクリックしてください
AEM as a Cloud Service
この記事

AEM Assets HTTP API の基本を学ぶ overview

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

NOTE
コンテンツフラグメント管理 API の最新の OpenAPI 実装が利用可能です。完全なドキュメントについては、コンテンツフラグメント管理 API を参照してください。新しい OpenAPI 実装を使用することをお勧めします。コンテンツフラグメントに関する Assets HTTP API の既存の使用法は、新しいコンテンツフラグメント管理 OpenAPI に移行する必要があります。

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

  1. API サービスドキュメント（https://[hostname]:[port]/api.json）を開きます。
  2. https://[hostname]:[server]/api/assets.json への Assets サービスリンクをクリックします。

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

NOTE
アセットやバイナリ一般（レンディションなど）のアップロードまたは更新に関連する API 呼び出しはすべて、Experience Manager as a Cloud Service デプロイメントでは廃止されています。バイナリをアップロードする場合は、代わりに、直接バイナリアップロード API を使用します。

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

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

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

NOTE
使用可能な様々な API の概要と、関連する概念のいくつかの比較について詳しくは、構造化コンテンツの配信と管理用の AEM API を参照してください。
コンテンツフラグメントおよびコンテンツフラグメントモデルの OpenAPI も利用できます。

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

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

NOTE
このコンテンツフラグメントおよびコンテンツフラグメントモデルの OpenAPI も利用できます。

フォルダーの管理 folders

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

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

プロパティ：

  • name：フォルダーの名前（拡張子を除いた URL パスの最後のセグメント）。
  • title：フォルダー名の代わりに表示されるオプションのタイトル。
NOTE
フォルダーまたはアセットの一部のプロパティは、異なるプレフィックスにマップされます。jcr:title、jcr:description、jcr:language の jcr プレフィックスは dc プレフィックスに置き換えられます。したがって、返された JSON コードで、dc:title、dc:description にはそれぞれ jcr:title、jcr:description の値が含まれています。

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

  • self：フォルダー自体へのリンク。
  • parent：親フォルダーへのリンク。
  • thumbnail（オプション）：フォルダーのサムネール画像へのリンク。

アセットの管理 assets

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

  • プロパティとメタデータ： ​アセットに関する詳細情報。
  • バイナリファイル： ​最初にアップロードされたファイル。
  • レンディション： ​複数の設定されたレンディション（様々なサイズの画像、異なるビデオエンコーディング、PDF／Adobe InDesign ファイルから抽出されたページなど）。
  • コメント（オプション）： ​ユーザーが指定した備考。

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

NOTE
このコンテンツフラグメントおよびコンテンツフラグメントモデルの OpenAPI も利用できます。

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

  • エンティティ：アセットの子はアセットのレンディションです。
  • プロパティ
  • リンク

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

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

NOTE
読みやすいように、以下の例では、完全な cURL 表記法を省略しています。この表記法は、cURL 用のスクリプトラッパーである Resty と関連があります。

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

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

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

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

  • 200 - OK（成功）
  • 404 - NOT FOUND（フォルダーが存在しないかアクセスできない）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

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

  • 新しいフォルダーの Siren 表現
  • application/www-form-urlencoded または multipart/form - data としてエンコードされた名前と値のペアのセット。これらは、HTML フォームから直接フォルダーを作成する場合に役立ちます。

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

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

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

リクエスト

  • POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"title":"My Folder"}}'
  • POST /api/assets/* -F"name=myfolder" -F"title=My Folder"

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

  • 201 - CREATED（作成が成功した場合）
  • 409 - CONFLICT（フォルダーが存在する場合）
  • 412 - PRECONDITION FAILED（ルートコレクションが見つからないかアクセスできない場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

アセットの作成 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"}}'

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

  • 200 - OK（アセットが正常に更新された場合）
  • 404 - NOT FOUND（指定した URI でアセットが見つからなかったかアクセスできなかった場合）
  • 412 - PRECONDITION FAILED（ルートコレクションが見つからないかアクセスできない場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

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

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

リクエスト

  • POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"
  • POST /api/assets/myfolder/myasset.png/renditions/* -F"name=web-rendition" -F"file=@myRendition.png"

応答コード

  • 201 - CREATED（レンディションが正常に作成された場合）
  • 404 - NOT FOUND（指定した URI でアセットが見つからなかったかアクセスできなかった場合）
  • 412 - PRECONDITION FAILED（ルートコレクションが見つからないかアクセスできない場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

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

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

  • 200 - OK（レンディションが正常に更新された場合）
  • 404 - NOT FOUND（指定した URI でアセットが見つからなかったかアクセスできなかった場合）
  • 412 - PRECONDITION FAILED（ルートコレクションが見つからないかアクセスできない場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

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

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

  • 201 - CREATED（コメントが正常に作成された場合）
  • 404 - NOT FOUND（指定した URI でアセットが見つからなかったかアクセスできなかった場合）
  • 412 - PRECONDITION FAILED（ルートコレクションが見つからないかアクセスできない場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

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

  • X-Destination - API ソリューション範囲内の、リソースのコピー先となる新しい宛先 URI
  • X-Depth - infinity か 0 のいずれか。0 を使用すると、リソースとそのプロパティのみがコピーされ、子はコピーされません。
  • X-Overwrite - 既存の宛先にあるアセットが上書きされないようにするには、F を使用します。

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

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

  • 201 - CREATED（フォルダーやアセットが既存でない宛先にコピーされた場合）
  • 204 - NO CONTENT（フォルダーまたはアセットが既存の宛先にコピーされた場合）
  • 412 - PRECONDITION FAILED（リクエストヘッダーが不明な場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

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

  • X-Destination - API ソリューション範囲内の、リソースのコピー先となる新しい宛先 URI
  • X-Depth - infinity か 0 のいずれか。0 を使用すると、リソースとそのプロパティのみがコピーされ、子はコピーされません。
  • X-Overwrite - 既存のリソースを強制的に削除する場合は T を、既存リソースの上書きを防ぐ場合は F を使用します。

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

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

  • 201 - CREATED（フォルダーやアセットが既存でない宛先にコピーされた場合）
  • 204 - NO CONTENT（フォルダーまたはアセットが既存の宛先にコピーされた場合）
  • 412 - PRECONDITION FAILED（リクエストヘッダーが不明な場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

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

リクエスト

  • DELETE /api/assets/myFolder
  • DELETE /api/assets/myFolder/myAsset.png
  • DELETE /api/assets/myFolder/myAsset.png/renditions/original

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

  • 200 - OK（フォルダーが正常に削除された場合）
  • 412 - PRECONDITION FAILED（ルートコレクションが見つからないかアクセスできない場合）
  • 500 - INTERNAL SERVER ERROR（他に問題がある場合）

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

  • オフタイムに達すると、アセットとそのレンディションは、Assets web インターフェイスと HTTP API 経由では使用できなくなります。オンタイムが未来の場合や、オフタイムが過去の場合、API は 404 エラーを返します。

  • Assets HTTP API は、メタデータのサブセットのみを返します。名前空間はハードコードされ、これらの名前空間のみが返されます。完全なメタデータについては、アセットパス /jcr_content/metadata.json を参照してください。

  • API を使用して更新された場合、フォルダーまたはアセットの一部のプロパティは、異なるプレフィックスにマップされます。jcr:title、jcr:description、jcr:language の jcr プレフィックスは dc プレフィックスに置き換えられます。したがって、返された JSON コードで、dc:title、dc:description にはそれぞれ jcr:title、jcr:description の値が含まれています。

関連リソースの探索

Related Articles
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab