DITA 맵에서 사용할 REST API id175UB30E05Z
다음 REST API를 사용하면 AEM Guides에서 DITA 맵으로 작업할 수 있습니다.
종속 항목이 있는 DITA 맵 다운로드
맵 및 주제에 사용되는 참조된 주제, 하위 맵, 이미지 및 DTD와 같은 모든 종속 항목이 있는 DITA 맵을 다운로드하는 GET 메서드입니다.
요청 URL: http://<aem-guides-server>: <port-number>/bin/fmdita/exportditamap
매개 변수: |이름|유형|필수|설명| -------- ------------------- |ditamap|문자열|예|AEM 저장소의 DITA 맵 파일의 절대 경로.| |baseline|문자열|아니요|버전이 지정된 콘텐츠를 검색하는 데 사용되는 기준선의 제목입니다.
참고: 값은 대/소문자를 구분합니다. |
응답 값: 내용이 응답의 출력 스트림에 기록되는 .zip 파일입니다.
종속 항목이 있는 DITA 맵에 대한 내보내기 시작
맵 및 주제에 사용되는 참조된 주제, 하위 맵, 이미지 및 DTD와 같은 모든 종속 항목이 있는 DITA 맵에 대한 내보내기를 시작하는 POST 메서드입니다. 상태는 나중에 쿼리할 수 있으며 완료되면 다운로드 URL을 검색할 수 있습니다.
요청 URL: http://<aem-guides-server>: <port-number>/bin/dxml/비동기-내보내기
매개 변수: |이름|유형|필수|설명| -------- ------------------- |ditamap|문자열|예|AEM 저장소의 DITA 맵 파일의 절대 경로.| |baseline|문자열|아니요|버전이 지정된 콘텐츠를 검색하는 데 사용되는 기준선의 제목입니다.
참고: 값은 대/소문자를 구분합니다.| |flatFS|부울|아니요|(선택 사항) true로 설정하면 파일의 플랫 구조가 ZIP 파일에 반환됩니다. 예를 들어 DITA 맵이 여러 폴더의 콘텐츠를 참조하는 경우 참조된 모든 파일을 단일 폴더로 가져옵니다. 이름이 같은 파일이 있는 경우 숫자 접미사를 추가하여 해당 파일의 이름을 바꿉니다. 플랫 폴더 구조에서 파일의 새 위치를 기반으로 업데이트되므로 모든 참조 (DITA 맵 및 주제)가 자동으로 처리됩니다. false로 설정하면 폴더 구조가 ZIP 파일에서 그대로 유지됩니다. DITA 맵이 여러 위치의 파일을 참조하는 경우 이러한 모든 위치도 ZIP 파일에 생성됩니다. ZIP 파일을 복원하면 대상 위치에 정확한 폴더 구조가 생성됩니다.
이 매개 변수의 기본값은 false입니다.|
응답 값: |요소|설명| ------------------ |status|수행된 작업의 반환 상태입니다. 가능한 옵션은 시작, 실패, 진행 중, 성공, 누락, 삭제입니다.| |jobId|작업의 고유 ID입니다. 나중에 상태를 쿼리하는 데 사용할 수 있습니다.| |errorMessage|실패 시 작업의 오류 메시지 (상태가 실패, 누락 또는 삭제됨인 경우).| |filePath|ZIP의 파일 경로입니다. 작업이 완료되고 상태가 성공인 경우에만 표시됩니다. ZIP 파일을 다운로드하는 데 사용할 수 있습니다.|
쿼리 내보내기 DITA 맵 상태
모든 종속 항목이 있는 DITA 맵에 대한 내보내기 상태를 검색하는 GET 메서드입니다. 상태가 STARTED 또는 INPROGRESS인 경우 완료될 때까지 간격을 두고 폴링할 수 있습니다(성공 또는 오류 발생).
요청 URL: http://<aem-guides-server>: <port-number>/bin/dxml/비동기-내보내기
매개 변수
|이름|유형|필수|설명| -------- ------------------- |jobId|문자열|예|내보내기 작업이 시작되면 작업 ID가 검색됩니다.|
응답 값: |요소|설명| ------------------ |status|내보내기 작업의 상태입니다. 가능한 옵션은 시작, 실패, 진행 중, 성공, 누락, 삭제입니다.| |jobId|작업의 고유 ID입니다. 나중에 상태를 쿼리하는 데 사용할 수 있습니다.| |errorMessage|실패 시 작업에 대한 오류 메시지 (상태가 실패, 누락 또는 삭제됨인 경우).| |filePath|ZIP의 파일 경로입니다. 작업이 완료되고 상태가 성공인 경우에만 표시됩니다. ZIP 파일을 다운로드하는 데 사용할 수 있습니다.|