Assets HTTP API assets-http-api

Assets HTTP API를 사용하면 메타데이터, 표현물 및 주석 등을 포함한 디지털 자산에 대한 CRUD(Create-Read-Update-delete) 작업을 수행할 수 있으며, 이러한 작업은 구조화된 컨텐츠와 Experience Manager 컨텐츠 조각. 에 노출되어 있습니다 /api/assets 및 는 REST API로 구현됩니다.

API에 액세스하려면:

API 응답은 일부 MIME 유형에 대한 JSON 파일이며 모든 MIME 유형에 대한 응답 코드입니다. JSON 응답은 선택 사항이며 PDF 파일과 같이 사용할 수 없습니다. 추가적인 분석 또는 작업을 위해서는 응답 코드를 사용하십시오.

다음 이후 해제 시간, 자산 및 해당 표현물은 Assets 웹 인터페이스 및 HTTP API를 통해 사용할 수 있습니다. API는 시간 은 미래의 또는 해제 시간 는 과거입니다.

데이터 모델 data-model

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

폴더 folders

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

엔티티: 폴더의 엔티티는 폴더 및 자산일 수 있는 하위 요소입니다.

속성:

링크 폴더에 세 개의 링크가 표시됩니다.

Assets assets

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

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

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

전제 조건

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

기존 폴더 및 하위 엔티티(하위 폴더 또는 자산)의 Similar 표현을 검색합니다.

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

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

응답: 반환된 엔티티의 클래스는 자산 또는 폴더입니다. 포함된 엔티티의 등록 정보는 각 엔티티의 전체 등록 정보 집합의 하위 집합입니다. 엔티티의 전체 표현을 가져오려면 클라이언트는 와 함께 링크가 가리키는 URL의 컨텐츠를 검색해야 합니다 rel 의 self.

폴더를 만듭니다 create-a-folder

새 항목 만들기 sling: OrderedFolder 를 클릭합니다. 다음과 같은 경우 * 이 노드 이름 대신 제공되면 서블릿은 매개변수 이름을 노드 이름으로 사용합니다. 요청 데이터로 허용됨 은 새 폴더의 Shanner 표현 또는 다음과 같이 인코딩된 이름-값 쌍 세트입니다 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는 두 네임스페이스 아래의 속성을 동기화하지 않습니다.

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

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

간 메타데이터 업데이트 동기화 dc 및 jcr namespace sync-metadata-between-namespaces

API 메서드는 의 메타데이터 속성을 업데이트합니다 jcr 네임스페이스. Touch-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)를 삭제합니다.

요청

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