API de REST para la administración de resultados id175UB30E05Z
Las siguientes API de REST están disponibles para administrar los resultados en AEM Guides.
Obtener todos los ajustes preestablecidos de salida para un mapa DITA get-output-presets-dita-map
Método de POST que recupera todos los ajustes preestablecidos de salida configurados para un mapa DITA.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:\
:operation
getalloutputs
.Nota: El valor no distingue entre mayúsculas y minúsculas.
sourcePath
Valores de respuesta:
Devuelve una matriz de objetos JSON Output Preset, cada uno de los cuales contiene los siguientes elementos:
outputName
outputType
- AEMSITE
- HTML 5
- EPUB
- PERSONALIZADO
outputTitle
ditaValPathList
targetPath
siteName
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteStrategy
pdfGenerator
- DITAOT
- FMPS
DitaValPath
ya no es compatible.Crear ajuste preestablecido de salida
Método de POST que crea un nuevo ajuste preestablecido de salida para un mapa DITA.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:
:operation
createoutput
.Nota: El valor no distingue entre mayúsculas y minúsculas.
sourcePath
outputTitle
Nota: Cuando se crea un nuevo ajuste preestablecido de salida, el sistema back-end genera un nombre único para el ajuste preestablecido de salida a partir del título dado.
outputType
- AEMSITE
- HTML 5
- EPUB
- PERSONALIZADO
Valores de respuesta:
outputName
outputTitle
.Guardar ajuste preestablecido de salida
Método de POST que guarda los cambios realizados en un ajuste preestablecido de salida.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:
:operation
saveoutput
.Nota: El valor no distingue entre mayúsculas y minúsculas.
sourcePath
outputObj
outputObj.outputName
contiene el nombre del ajuste preestablecido de salida que se va a actualizar. Para ver el formato del objeto JSON, consulte la tabla Valores de respuesta en Obtener todos los ajustes preestablecidos de salida para un mapa DITA.Valores de respuesta:
Devuelve una respuesta HTTP 200 (Correcto).
Obtener un ajuste preestablecido de salida específico
Método de POST que recupera un ajuste preestablecido de salida existente.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:
:operation
getoutput
.Nota: El valor no distingue entre mayúsculas y minúsculas.
sourcePath
outputName
Valores de respuesta:
outputName
outputType
outputTitle
ditaValPathList
targetPath
siteName
siteTitle
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteFiles
pdfGenerator
- DITAOT
- FMPS
DitaValPath
ya no es compatible.Generar salida
Método de GET que genera resultados utilizando uno o más ajustes preestablecidos de salida.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:
operation
GENERATEOUTPUT
.Nota: El valor distingue entre mayúsculas y minúsculas.
source
outputName
Valores de respuesta:
Devuelve una respuesta HTTP 200 (Correcto).
Generar salida incremental
Un método de GET AEM que genera un resultado incremental para un sitio de mediante uno o más ajustes preestablecidos de salida.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:
operation
INCREMENTALPUBLISH
.Nota: El valor distingue entre mayúsculas y minúsculas.
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"
]
}
}
- El atributo
ditamap
toma la ruta absoluta del mapa DITA que se utiliza para generar la salida. - El atributo
topics
toma una matriz de temas que se actualizan y deben volver a publicarse. - El atributo
fullMaps
contiene la ruta de los archivos de asignación (como los submapas fragmentados) que son necesarios junto con sus temas para la generación de resultados incrementales. - El atributo
maps
contiene la ruta de acceso de los archivos de asignación (para resolver referencias del espacio de claves) que se extraen en el disco sin temas. - El atributo
outputs
toma una matriz de nombres de ajustes preestablecidos de salida que se utilizan para generar el resultado.
Valores de respuesta:
Devuelve una respuesta HTTP 200 (Correcto).
Eliminar ajuste preestablecido de salida
Método de POST que elimina un ajuste preestablecido de salida.
URL de solicitud:
http://<aem-guides-server>: <port-number>/bin/publishlistener
Parámetros:
:operation
deleteoutput
.Nota: El valor no distingue entre mayúsculas y minúsculas.
sourcePath
outputName
Valores de respuesta:
Devuelve una respuesta HTTP 200 (Correcto).