用于输出管理的REST API id175UB30E05Z
以下REST API可用于管理AEM Guides中的输出。
获取DITA映射的所有输出预设 get-output-presets-dita-map
一种POST方法,可检索为DITA映射配置的所有输出预设。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
:operation
getalloutputs
.注意: 该值不区分大小写。
sourcePath
响应值:
返回一个JSON输出预设对象数组,每个对象包含以下元素:
outputName
outputType
- AEMSITE
- HTML5
- ePub
- 自定义
outputTitle
ditaValPathList
targetPath
siteName
templatePath
searchScope
local
。generateTOC
generateBreadcrumbs
overwriteStrategy
pdfGenerator
- DITAOT
- FMPS
DitaValPath
元素。创建输出预设
一种为DITA映射创建新的输出预设的POST方法。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
:operation
createoutput
.注意: 该值不区分大小写。
sourcePath
outputTitle
注意: 创建新的输出预设时,后端系统从给定的标题中为输出预设驱动一个唯一的名称。
outputType
- AEMSITE
- HTML5
- ePub
- 自定义
响应值:
outputName
outputTitle
参数的值。保存输出预设
一种POST方法,用于保存输出预设中所做的更改。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
:operation
saveoutput
.注意: 该值不区分大小写。
sourcePath
outputObj
outputObj.outputName
属性包含要更新的输出预设的名称。 有关JSON对象的格式,请参阅获取DITA映射的所有输出预设中的 响应值 表。响应值:
返回HTTP 200 (Successful)响应。
获取特定的输出预设
一种POST方法,可检索现有的输出预设。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
:operation
getoutput
。注意: 该值不区分大小写。
sourcePath
outputName
响应值:
outputName
outputType
- AEMSITE
- HTML5
- ePub
- 自定义
outputTitle
ditaValPathList
targetPath
siteName
siteTitle
templatePath
searchScope
local
。generateTOC
generateBreadcrumbs
overwriteFiles
pdfGenerator
- DITAOT
- FMPS
DitaValPath
元素。生成输出
一种使用一个或多个输出预设生成输出的GET方法。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
operation
GENERATEOUTPUT
.注意: 该值区分大小写。
source
outputName
响应值:
返回HTTP 200 (Successful)响应。
生成增量输出
使用一个或多个输出预设为AEM Site生成增量输出的GET方法。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
operation
INCREMENTALPUBLISH
。注意: 该值区分大小写。
contentPath
{
{
"ditamap":
"/content/dam/sample/sample.ditamap",
"topics": [
"/content/dam/sample/topic1.xml",
"/content/dam/sample/topic2.xml"
],
"fullMaps": [
"/content/dam/sample/submap.ditamap"
],
"maps": [
"/content/dam/sample/keyspace.ditamap"
],
"outputs": [
"aemsite"
]
}
}
ditamap
属性采用用于生成输出的DITA映射的绝对路径。topics
属性采用一系列已更新且需要重新发布的主题。fullMaps
属性包含增量输出生成所需的映射文件\(如分块子映射\)的路径及其主题。maps
属性包含映射文件的路径\(用于解析密钥空间引用\),这些文件是在没有主题的磁盘上提取的。outputs
属性采用用于生成输出的输出预设名称数组。
响应值:
返回HTTP 200 (Successful)响应。
删除输出预设
一种删除输出预设的POST方法。
请求URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener
参数:
:operation
deleteoutput
.注意: 该值不区分大小写。
sourcePath
outputName
响应值:
返回HTTP 200 (Successful)响应。