Assets HTTP API assets-http-api

Assets HTTP API可針對數位資產（包括中繼資料、轉譯和註解），以及使用的結構化內容，執行建立 — 讀取 — 更新 — 刪除(CRUD)操作 Experience Manager 內容片段。 在 /api/assets 並實作為REST API。

若要存取API:

API回應是某些MIME類型的JSON檔案，也是所有MIME類型的回應代碼。 JSON回應為選用，例如PDF檔案可能無法使用。 請仰賴回應程式碼進行進一步分析或動作。

在 關閉時間，資產及其轉譯無法透過 Assets 網頁介面和透過HTTP API。 若 準時 是未來或 關閉時間 是過去。

資料模型 data-model

Assets HTTP API會公開兩個主要元素、資料夾和資產（適用於標準資產）。

資料夾 folders

資料夾與傳統檔案系統中的目錄類似。 它們是其他資料夾或聲明的容器。 資料夾具有下列元件：

實體:資料夾的實體是其子元素，可以是資料夾和資產。

屬性:

連結 資料夾會公開三個連結：

Assets assets

在Experience Manager中，資產包含下列元素：

在 Experience Manager 資料夾具有下列元件：

Assets HTTP API包含下列功能：

必備條件

檢索資料夾清單 retrieve-a-folder-listing

檢索現有資料夾及其子實體（子資料夾或資產）的Siren表示。

要求: GET /api/assets/myFolder.json

回應代碼:回應代碼為：

回應:傳回的實體類別為資產或資料夾。 包含實體的屬性是每個實體的全部屬性集的子集。 為了取得實體的完整表示法，用戶端應擷取連結所指向之URL的內容，該連結具有 rel of self.

建立資料夾 create-a-folder

建立新 sling: OrderedFolder 在給定的路徑。 若 * 提供的servlet不是節點名稱，而是使用參數名稱作為節點名稱。 「接受為請求」資料是新資料夾的Siren表示，或是一組名稱值對，編碼為 application/www-form-urlencoded 或 multipart/ form- data，適合直接從HTML表單建立資料夾。 此外，資料夾的屬性可指定為URL查詢參數。

API呼叫會以 500 回應代碼（如果提供路徑的父節點不存在）。 呼叫會傳回回應代碼 409 如果資料夾已存在。

參數: name 是資料夾名稱。

要求

回應代碼:回應代碼為：

建立資產 create-an-asset

將提供的檔案放置在提供的路徑中，以便在DAM存放庫中建立資產。 若 * 提供的servlet而不是節點名稱，該servlet將參數名稱或檔案名用作節點名稱。

參數:參數為 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不會同步兩個命名空間下的屬性。

要求: 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

刪除提供路徑上的資源(-tree)。

要求

回應代碼:回應代碼為：