Adobe Experience Manager Assets HTTP API assets-http-api
概觀 overview
此 Assets HTTP API允許對數位資產進行建立 — 讀取 — 更新 — 刪除(CRUD)操作，包括對中繼資料、轉譯和評論的操作，以及結構化內容使用 Experience Manager 內容片段。 它公開於 /api/assets 和實作為REST API。 內容包括 支援內容片段.
若要存取API：
- 開啟API服務檔案，位於
https://[hostname]:[port]/api.json. - 請遵循 Assets 服務連結前往
https://[hostname]:[server]/api/assets.json.
API回應是部分MIME型別的JSON檔案，以及所有MIME型別的回應代碼。 JSON回應為選用專案，可能無法用於PDF檔案等用途。 仰賴回應程式碼進行進一步分析或動作。
內容片段 content-fragments
A 內容片段 是一種特殊型別的資產。 它可用來存取結構化資料，例如文字、數字、日期等。 由於有許多差異， standard 資產（例如影像或檔案）時，處理內容片段會套用一些其他規則。
如需詳細資訊，請參閱 中的內容片段支援 Experience Manager Assets HTTP API.
資料模型 data-model
此 Assets HTTP API會顯示兩個主要元素：資料夾和資產（適用於標準資產）。 此外，它會公開自訂資料模型的更詳細元素，這些模型說明內容片段中的結構化內容。 另請參閱 內容片段資料模型 以取得進一步資訊。
資料夾 folders
資料夾與傳統檔案系統中的目錄類似。 資料夾可以只包含資產，只有資料夾或資料夾和資產。 資料夾包含下列元件：
實體：資料夾的實體是它的子元素，可以是資料夾和資產。
屬性：
name是資料夾的名稱。 這與URL路徑中沒有副檔名的最後一個區段相同。title是資料夾的選用標題，可顯示而非其名稱。
jcr 前置詞 jcr:title， jcr:description、和 jcr:language 已取代為 dc 前置詞。 因此在傳回的JSON中， dc:title 和 dc:description 包含下列專案的值： jcr:title 和 jcr:description，依序輸入。連結 資料夾會顯示三個連結：
self：連結至本身。parent：連結至上層資料夾。thumbnail：（選用）連結至資料夾縮圖影像。
Assets assets
在 Experience Manager 資產包含下列元素：
- 資產的屬性和中繼資料。
- 原本是上傳資產的二進位檔案。
- 已設定多個轉譯。 這些可能是不同大小的影像、不同編碼的視訊，或從PDF或擷取的頁面 Adobe InDesign 檔案。
- 選擇性註解。
如需內容片段中元素的相關資訊，請參閱 Experience Manager Assets HTTP API中的內容片段支援.
在 Experience Manager 資料夾包含下列元件：
- 實體：資產的子系是其轉譯。
- 屬性。
- 連結。
可用功能 available-features
此 Assets HTTP API包含下列功能：
擷取資料夾清單 retrieve-a-folder-listing
擷取現有資料夾及其子系圖元（子資料夾或資產）的Siren表示。
請求： GET /api/assets/myFolder.json
回應代碼：回應程式碼為：
- 200 — 確定 — 成功。
- 404 - NOT FOUND — 資料夾不存在或無法存取。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
回應：傳回實體的類別是資產或資料夾。 包含之圖元的屬性是每個圖元之完整屬性集的子集。 若要取得實體的完整表示法，使用者端應擷取具有的連結所指向的URL內容 rel 之 self.
建立資料夾 create-a-folder
建立 sling： OrderedFolder 於指定路徑。 如果 * 提供的不是節點名稱，而是引數名稱，此servlet會使用引數名稱作為節點名稱。 請求接受下列其中一項：
- 新資料夾的警報表示法
- 一組名稱 — 值組，編碼為
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 - PRECONDITION FAILED — 如果找不到或無法存取根集合。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
建立資產 create-an-asset
另請參閱 資產上傳 以取得關於如何建立資產的資訊。 您無法使用HTTP API建立資產。
更新資產二進位檔 update-asset-binary
另請參閱 資產上傳 以取得有關如何更新資產二進位檔的資訊。 您無法使用HTTP API更新資產二進位檔。
更新資產的中繼資料 update-asset-metadata
更新資產中繼資料屬性。 如果您更新 dc: 名稱空間中，API會更新 jcr 名稱空間。 此API不會同步兩個名稱空間下的屬性。
請求： PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"dc:title":"My Asset"}}'
回應代碼：回應程式碼為：
- 200 — 確定 — 如果資產已成功更新。
- 404 - NOT FOUND — 如果在提供的URI中找不到或無法存取資產。
- 412 - PRECONDITION FAILED — 如果找不到或無法存取根集合。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
建立資產轉譯 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 — 內部伺服器錯誤 — 如果發生其他錯誤。
更新資產轉譯 update-an-asset-rendition
更新會分別以新的二進位資料取代資產轉譯。
請求： PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png
回應代碼：回應程式碼為：
- 200 — 確定 — 如果已成功更新轉譯。
- 404 - NOT FOUND — 如果在提供的URI中找不到或無法存取資產。
- 412 - PRECONDITION FAILED — 如果找不到或無法存取根集合。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
在資產上新增註解 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 — 內部伺服器錯誤 — 如果發生其他錯誤。
複製資料夾或資產 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 — 無內容 — 若資料夾/資產已複製到現有目的地。
- 412 — 先決條件失敗 — 如果缺少請求標頭。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
行動資料夾或資產 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 — 無內容 — 若資料夾/資產已複製到現有目的地。
- 412 — 先決條件失敗 — 如果缺少請求標頭。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
刪除資料夾、資產或轉譯 delete-a-folder-asset-or-rendition
在提供的路徑刪除資源(-tree)。
請求
DELETE /api/assets/myFolderDELETE /api/assets/myFolder/myAsset.pngDELETE /api/assets/myFolder/myAsset.png/renditions/original
回應代碼：回應程式碼為：
- 200 — 確定 — 如果資料夾已成功刪除。
- 412 - PRECONDITION FAILED — 如果找不到或無法存取根集合。
- 500 — 內部伺服器錯誤 — 如果發生其他錯誤。
提示、最佳實務和限制 tips-limitations
-
在 關閉時間，資產及其轉譯無法透過 Assets 網頁介面以及透過HTTP API。 如果 準時 是未來或 關閉時間 是過去的。
-
Assets HTTP API未傳回完整的中繼資料。 系統會以硬式編碼撰寫名稱空間，而且只會傳回這些名稱空間。 如需完整的中繼資料，請參閱資產路徑
/jcr_content/metadata.json. -
使用API更新時，資料夾或資產的某些屬性會對應至不同的首碼。 此
jcr前置詞jcr:title，jcr:description、和jcr:language已取代為dc前置詞。 因此在傳回的JSON中，dc:title和dc:description包含下列專案的值：jcr:title和jcr:description，依序輸入。
另請參閱