Assets HTTP API

概覽

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

若要存取API:

1. 在https://[hostname]:[port]/api.json開啟API服務檔案。
2. 遵循導向https://[hostname]:[server]/api/assets.json的Assets服務連結。

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

在關閉時間之後，資產及其轉譯無法透過Assets網頁介面和HTTP API使用。 如果準時為將來或非時間為過去，則API會傳回404錯誤訊息。

內容片段

內容片段是特殊的資產類型。 它可用來存取結構化資料，例如文字、數字、日期等。 由於standard資產（例如影像或檔案）有幾項差異，因此其他一些規則適用於處理內容片段。

如需詳細資訊，請參閱Experience Manager資產HTTP API🔗中的內容片段支援。

資料模型

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

此外，也會針對描述內容片段中結構化內容的自訂資料模型，公開更詳細的元素。 如需詳細資訊，請參閱內容片段資料模型。

資料夾

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

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

屬性:

• name 是資料夾的名稱。這與URL路徑中沒有副檔名的最後一個區段相同。
• title 是資料夾的選用標題，可顯示該標題而非其名稱。

​​LinksFolders公開三個連結：

• self:連結到自己。
• parent:連結至父資料夾。
• thumbnail:（選用）連結至資料夾縮圖影像。

資產

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

• 資產的屬性和中繼資料。
• 多個轉譯，例如原始轉譯（原本上傳的資產）、縮圖和各種其他轉譯。 其他轉譯可能是不同大小的影像、不同的視訊編碼，或從PDF或Adobe InDesign檔案擷取的頁面。
• 可選注釋。

如需內容片段中元素的相關資訊，請參閱Experience Manager資產HTTP API🔗中的內容片段支援。

在Experience Manager中，資料夾具有以下元件：

• 實體：資產的子項即為其轉譯。
• 屬性.
• 連結.

Assets HTTP API包含下列功能：

• 擷取資料夾清單。
• 建立資料夾。
• 建立資產。
• 更新資產二進位檔。
• 更新資產中繼資料。
• 建立資產轉譯。
• 更新資產轉譯。
• 建立資產註解。
• 複製資料夾或資產。
• 移動資料夾或資產。
• 刪除資料夾、資產或轉譯。

必備條件

• 存取 https://[aem_server]:[port]/system/console/configMgr.
• 導覽至​AdobeGranite CSRF篩選器。
• 確定屬性​篩選方法​包含：POST、PUT、DELETE。

檢索清單的資料夾

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

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

回應代碼:回應代碼為：

• 200 — 好 — 成功。
• 404 — 找不到 — 資料夾不存在或無法存取。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

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

建立資料夾

建立新的sling:OrderedFolder。 如果提供*而非節點名稱，則servlet將參數名稱用作節點名稱。 接受為請求資料是新資料夾的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 — 建立 — 成功建立時。
• 409 — 衝突 — 如果資料夾已存在。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

建立資產

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

參數:參數是 name 用於資產名稱和 file 檔案參考。

要求

• POST /api/assets/myFolder/myAsset.png -H"Content-Type: image/png" --data-binary "@myPicture.png"
• POST /api/assets/myFolder/* -F"name=myAsset.png" -F"file=@myPicture.png"

回應代碼:回應代碼為：

• 201 — 已建立 — 如果資產已成功建立。
• 409 — 衝突 — 如果資產已存在。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

更新資產二進位檔

更新資產的二進位檔（名稱為原始的轉譯）。 更新會觸發預設資產處理工作流程來執行（如果已設定）。

請求: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: image/png" --data-binary @myPicture.png

回應代碼:回應代碼為：

• 200 — 確定 — 如果資產已成功更新。
• 404 — 找不到 — 如果在提供的URI中找不到或存取資產。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

更新資產中繼資料

更新資產中繼資料屬性。 如果您更新dc:命名空間中的任何屬性，API會更新jcr命名空間中的相同屬性。 API不會同步兩個命名空間下的屬性。

請求: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"jcr:title":"My Asset"}}'

回應代碼:回應代碼為：

• 200 — 確定 — 如果資產已成功更新。
• 404 — 找不到 — 如果在提供的URI中找不到或存取資產。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

在dc和jcr命名空間之間同步中繼資料更新

API方法會更新jcr命名空間中的中繼資料屬性。 使用用戶介面進行的更新更改了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();
}
}

建立資產轉譯

為資產建立新的資產轉譯。 如果未提供請求參數名稱，則會將檔案名稱用作格式副本名稱。

參數:參數用 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 — 已建立 — 如果已成功建立轉譯。
• 404 — 找不到 — 如果在提供的URI中找不到或存取資產。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

更新資產轉譯

更新會分別以新的二進位資料取代資產轉譯。

請求: PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

回應代碼:回應代碼為：

• 200 — 確定 — 如果已成功更新轉譯。
• 404 — 找不到 — 如果在提供的URI中找不到或存取資產。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

在資產上新增註解

建立新資產註解。

參數:參數適 message 用於註解的訊息內文，以 annotationData 及JSON格式的附註資料。

請求: POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

回應代碼:回應代碼為：

• 201 — 已建立 — 如果已成功建立注釋。
• 404 — 找不到 — 如果在提供的URI中找不到或存取資產。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

複製資料夾或資產

複製提供路徑中可用的資料夾或資產，以前往新目的地。

請求標題:參數為：

• X-Destination - API解決方案範圍內的新目標URI，可將資源複製到。
• X-Depth - infinity 或 0。使用0只會複製資源及其屬性，而不會複製其子項。
• X-Overwrite — 使 F 用防止覆寫現有目的地的資產。

請求: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

回應代碼:回應代碼為：

• 201 — 已建立 — 如果資料夾/資產已複製至非現有目的地。
• 204 — 無內容 — 如果資料夾/資產已複製至現有目的地。
• 412 — 先決條件失敗 — 如果缺少請求標題。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

移動資料夾或資產

將指定路徑的資料夾或資產移至新目的地。

請求標題:參數為：

• X-Destination - API解決方案範圍內的新目標URI，可將資源複製到。
• X-Depth - infinity 或 0。使用0只會複製資源及其屬性，而不會複製其子項。
• X-Overwrite — 使用強 T 制刪除現有資源或 F 防止覆寫現有資源。

請求: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

請勿在URL中使用/content/dam。 移動資產並覆寫現有資產的範例命令如下：

curl -u admin:admin -X MOVE https://[aem_server]:[port]/api/assets/source/file.png -H "X-Destination: http://[aem_server]:[port]/api/assets/destination/file.png" -H "X-Overwrite: T"

回應代碼:回應代碼為：

• 201 — 已建立 — 如果資料夾/資產已複製至非現有目的地。
• 204 — 無內容 — 如果資料夾/資產已複製至現有目的地。
• 412 — 先決條件失敗 — 如果缺少請求標題。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

刪除資料夾、資產或轉譯

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

要求

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

回應代碼:回應代碼為：

• 200 — 確定 — 如果已成功刪除資料夾。
• 412 - PINCEPORATE FAILED — 如果找不到或存取根集合。
• 500 — 內部伺服器錯誤 — 如果有其他問題。

提示和限制

• HTTP API會更新命名空間中 的中繼資料 jcr 屬性。不過，Experience Manager用戶介面會更新dc命名空間中的元資料屬性。

• 資產HTTP API不會傳回完整的中繼資料。 命名空間會以硬式編碼撰寫，且只會傳回那些命名空間。 如需完整中繼資料，請參閱資產路徑/jcr_content/metadata.json。