Assets HTTP API assets-http-api

버전
문서 링크
AEM as a Cloud Service
여기 클릭
AEM 6.5
이 문서

개요 overview

Assets HTTP API를 사용하면 Experience Manager 콘텐츠 조각을 사용하여 구조화된 콘텐츠와 함께 메타데이터, 렌디션 및 댓글을 포함하여 디지털 에셋에서 CRUD(create-read-update-delete) 작업을 수행할 수 있습니다. /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 오류 메시지를 반환합니다.

CAUTION
HTTP API가 jcr 네임스페이스의 메타데이터 속성을 업데이트합니다. 그러나 Experience Manager 사용자 인터페이스는 dc 네임스페이스의 메타데이터 속성을 업데이트합니다.

콘텐츠 조각 content-fragments

콘텐츠 조각은(는) 특별한 유형의 자산입니다. 텍스트, 숫자, 날짜 등 구조화된 데이터에 액세스하는 데 사용할 수 있습니다. standard개 에셋(예: 이미지 또는 문서)에 몇 가지 차이점이 있으므로 콘텐츠 조각 처리에 몇 가지 추가 규칙이 적용됩니다.

자세한 내용은 Experience Manager Assets HTTP API의 콘텐츠 조각 지원을 참조하세요.

데이터 모델 data-model

Assets HTTP API는 표준 자산의 경우 두 개의 주요 요소, 폴더 및 자산을 노출합니다.

또한 콘텐츠 조각의 구조화된 콘텐츠를 설명하는 사용자 지정 데이터 모델에 대해 보다 자세한 요소를 노출합니다. 자세한 내용은 콘텐츠 조각 데이터 모델을 참조하세요.

폴더 folders

폴더는 기존 파일 시스템의 디렉토리와 같습니다. 다른 폴더 또는 어설션용 컨테이너입니다. 폴더에는 다음과 같은 구성 요소가 있습니다.

엔터티: 폴더의 엔터티는 폴더 및 에셋일 수 있는 하위 요소입니다.

속성:

  • name은(는) 폴더 이름입니다. 확장이 없는 URL 경로의 마지막 세그먼트와 동일합니다.
  • title은(는) 이름 대신 표시할 수 있는 폴더의 선택적 제목입니다.
NOTE
폴더 또는 에셋의 일부 속성이 다른 접두사에 매핑됩니다. jcr:title, jcr:descriptionjcr:languagejcr 접두사가 dc 접두사로 대체되었습니다. 따라서 반환된 JSON에서 dc:titledc:description에는 각각 jcr:titlejcr:description의 값이 포함됩니다.

링크 폴더에는 세 개의 링크가 있습니다.

  • self: 자체에 연결합니다.
  • parent: 상위 폴더에 연결합니다.
  • thumbnail: (선택 사항) 폴더 썸네일 이미지에 연결된 링크입니다.

자산 assets

Experience Manager 시 자산에는 다음 요소가 포함됩니다.

  • 에셋의 속성 및 메타데이터.
  • 원본 렌디션(원래 업로드된 에셋), 썸네일 및 기타 다양한 렌디션과 같은 여러 렌디션. 추가 렌디션은 크기가 다른 이미지, 비디오 인코딩이 다르거나 PDF 또는 Adobe InDesign 파일에서 추출된 페이지일 수 있습니다.
  • 선택적 주석입니다.

콘텐츠 조각의 요소에 대한 자세한 내용은 Experience Manager Assets HTTP API의 콘텐츠 조각 지원을 참조하십시오.

Experience Manager에서 폴더에 다음 구성 요소가 있습니다.

  • 엔티티: 에셋의 하위 항목이 렌디션입니다.
  • 속성.
  • 링크.

Assets HTTP API에는 다음 기능이 포함되어 있습니다.

NOTE
가독성을 위해 다음 예제에서는 전체 cURL 표기법을 생략합니다. 실제로 표기법은 cURL에 대한 스크립트 래퍼인 Resty과(와) 상호 연관성이 있습니다.

전제 조건

  • https://[aem_server]:[port]/system/console/configMgr에 액세스합니다.
  • Adobe Granite CSRF 필터(으)로 이동합니다.
  • 필터 메서드 속성에 POST, PUT, DELETE이(가) 포함되어 있는지 확인하십시오.

폴더 목록 검색 retrieve-a-folder-listing

기존 폴더 및 하위 엔티티(하위 폴더 또는 에셋)의 Siren 표현을 검색합니다.

요청: GET /api/assets/myFolder.json

응답 코드: 응답 코드는 다음과 같습니다.

  • 200 - 확인 - 성공.
  • 404 - 찾을 수 없음 - 폴더가 없거나 액세스할 수 없습니다.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

응답: 반환된 엔터티의 클래스가 에셋 또는 폴더입니다. 포함된 엔티티의 등록 정보는 각 엔티티의 전체 등록 정보 세트의 하위 집합입니다. 엔터티의 전체 표현을 가져오려면 클라이언트는 selfrel을(를) 가진 링크가 가리키는 URL의 콘텐츠를 검색해야 합니다.

폴더 만들기 create-a-folder

지정된 경로에 새 sling: OrderedFolder을(를) 만듭니다. 노드 이름 대신 *이(가) 제공되면 서블릿은 매개 변수 이름을 노드 이름으로 사용합니다. 요청으로 수락된 데이터는 새 폴더의 Siren 표시 또는 application/www-form-urlencoded 또는 multipart/ form- data(으)로 인코딩된 이름-값 쌍 집합이며, HTML 양식에서 직접 폴더를 만드는 데 유용합니다. 또한 폴더의 속성을 URL 쿼리 매개 변수로 지정할 수 있습니다.

제공된 경로의 부모 노드가 없는 경우 500 응답 코드로 API 호출이 실패합니다. 폴더가 이미 있으면 호출에서 응답 코드 409을(를) 반환합니다.

매개 변수: name은(는) 폴더 이름입니다.

요청

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

응답 코드: 응답 코드는 다음과 같습니다.

  • 201 - 작성됨 - 작성됨.
  • 409 - 충돌 - 폴더가 이미 있는 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

에셋 만들기 create-an-asset

제공된 파일을 제공된 경로에 배치하여 DAM 저장소에 에셋을 만듭니다. 노드 이름 대신 *이(가) 제공되면 서블릿은 매개 변수 이름 또는 파일 이름을 노드 이름으로 사용합니다.

매개 변수: 매개 변수는 자산 이름의 경우 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 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

자산 바이너리 업데이트 update-asset-binary

에셋의 바이너리(원래 이름으로 된 렌디션)를 업데이트합니다. 업데이트는 구성된 경우 실행할 기본 자산 처리 워크플로우를 트리거합니다.

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

응답 코드: 응답 코드는 다음과 같습니다.

  • 200 - 확인 - 에셋이 성공적으로 업데이트된 경우.
  • 404 - 찾을 수 없음 - 제공된 URI에서 에셋을 찾거나 액세스할 수 없는 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

자산 메타데이터 업데이트 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"}}'

응답 코드: 응답 코드는 다음과 같습니다.

  • 200 - 확인 - 에셋이 성공적으로 업데이트된 경우.
  • 404 - 찾을 수 없음 - 제공된 URI에서 에셋을 찾거나 액세스할 수 없는 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

dc과(와) jcr 네임스페이스 간 메타데이터 업데이트 동기화 sync-metadata-between-namespaces

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();
}
}

에셋 렌디션 만들기 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 - 작성됨 - 표현물이 성공적으로 작성된 경우.
  • 404 - 찾을 수 없음 - 제공된 URI에서 에셋을 찾거나 액세스할 수 없는 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 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 - 찾을 수 없음 - 제공된 URI에서 에셋을 찾거나 액세스할 수 없는 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

자산에 주석 추가 create-an-asset-comment

새 자산 주석을 만듭니다.

매개 변수: 댓글의 메시지 본문에는 매개 변수가 message이고 JSON 형식의 주석 데이터에는 매개 변수가 annotationData입니다.

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

응답 코드: 응답 코드는 다음과 같습니다.

  • 201 - 작성됨 - 주석이 성공적으로 생성된 경우.
  • 404 - 찾을 수 없음 - 제공된 URI에서 에셋을 찾거나 액세스할 수 없는 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 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 - 생성됨 - 폴더/에셋이 존재하지 않는 대상에 복사된 경우.
  • 204 - 콘텐츠 없음 - 폴더/에셋이 기존 대상에 복사된 경우.
  • 412 - PRECONDITION FAILED - 요청 헤더가 누락된 경우
  • 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"

URL에 /content/dam을(를) 사용하지 마십시오. 에셋을 이동하고 기존 에셋을 덮어쓰는 샘플 명령은 다음과 같습니다.

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

응답 코드: 응답 코드는 다음과 같습니다.

  • 201 - 생성됨 - 폴더/에셋이 존재하지 않는 대상에 복사된 경우.
  • 204 - 콘텐츠 없음 - 폴더/에셋이 기존 대상에 복사된 경우.
  • 412 - PRECONDITION FAILED - 요청 헤더가 누락된 경우
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

폴더, 에셋 또는 렌디션 삭제 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 - 확인 - 폴더가 성공적으로 삭제된 경우.
  • 412 - 사전 조건 실패 - 루트 컬렉션을 찾거나 액세스할 수 없는 경우.
  • 500 - 내부 서버 오류 - 다른 문제가 발생한 경우.

팁 및 제한 사항 tips-best-practices-limitations

  • HTTP API가 jcr 네임스페이스의 메타데이터 속성을 업데이트합니다. 그러나 Experience Manager 사용자 인터페이스는 dc 네임스페이스의 메타데이터 속성을 업데이트합니다.

  • Assets HTTP API는 전체 메타데이터를 반환하지 않습니다. 네임스페이스는 하드코딩되고 해당 네임스페이스만 반환됩니다. 전체 메타데이터에 대해서는 자산 경로 /jcr_content/metadata.json을(를) 참조하십시오.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2