Assets HTTP API assets-http-api

Assets HTTP API を使用すれば、デジタルアセット（メタデータ、レンディション、コメントのほか、Experience Manager コンテンツフラグメントを使用した構造化コンテンツも含む）に対して作成、読み取り、更新、削除（CRUD）操作を実行できます。この API は /api/assets で公開されており、REST API として実装されています。

API にアクセスするには：

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

オフタイムの経過後、アセットとそのレンディションは、Assets Web インターフェイスでも HTTP API でも使用できません。オンタイムが未来の場合、またはオフタイムが過去の場合、API は 404 エラーメッセージを返します。

データモデル data-model

Assets HTTP API は、（標準アセット用の）フォルダーとアセットの 2 つの主要な要素を公開します。

フォルダー folders

フォルダーは、従来のファイルシステムにおけるディレクトリに似ています。これらは、他のフォルダーやアサートのコンテナです。 フォルダーには、以下のコンポーネントがあります。

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

プロパティ：

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

Assets assets

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

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

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

前提条件

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

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

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

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

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

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

指定されたパスに新しい sling:OrderedFolder を作成します。ノード名の代わりに「*」が指定されている場合、サーブレットパラメーター名がノード名として使用されます。リクエストデータとして受け入れられるのは、新しいフォルダーの Siren 表現か、application/www-form-urlencoded または multipart/form-data としてエンコードされた名前と値のペアのセットで、HTML フォームから直接フォルダーを作成するのに役立ちます。さらに、フォルダーのプロパティを URL クエリパラメーターとして指定できます。

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

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

リクエスト

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

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

指定されたファイルを指定されたパスに配置して、DAM リポジトリ内にアセットを作成します。ノード名の代わりに「*」が指定されている場合、サーブレットはパラメーター名またはファイル名をノード名として使用します。

パラメーター：パラメーターは name （アセット名）と file（ファイルの参照）です。

リクエスト

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

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

アセットバイナリ（オリジナル名のレンディション）を更新します。「更新」トリガーは、デフォルトのアセット処理ワークフローが設定されている場合に実行します。

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

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

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

アセットメタデータのプロパティを更新します。dc: 名前空間内のプロパティを更新すると、API は jcr 名前空間内の同じプロパティをアップデートします。API は 2 つの名前空間内のプロパティを同期させません。

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

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

メタデータの更新を dc と jcr 名前空間の間で同期する sync-metadata-between-namespaces

API メソッドは、jcr 名前空間のメタデータプロパティを更新します。タッチ UI を使用して行われた更新により、 dc 名前空間。 dc と jcr 名前空間の間でメタデータ値を同期するには、アセットの編集時に Experience Manager を実行するようにワークフローを作成してワークフローを設定できます。ECMA スクリプトを使用して、必要なメタデータプロパティを同期します。次のサンプルスクリプトは、 dc:title と jcr:title 間でタイトル文字列を同期します。

var workflowData = workItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH")
{
 var path = workflowData.getPayload().toString();
 var node = workflowSession.getSession().getItem(path);
 var metadataNode = node.getNode("jcr:content/metadata");
 var jcrcontentNode = node.getNode("jcr:content");
if (jcrcontentNode.hasProperty("jcr:title"))
{
 var jcrTitle = jcrcontentNode.getProperty("jcr:title");
 metadataNode.setProperty("dc:title", jcrTitle.toString());
 metadataNode.save();
}
}

アセットレンディションの作成 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

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

リクエスト

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