REST APIs para gerenciamento de saída id175UB30E05Z
As APIs REST a seguir estão disponíveis para gerenciar saídas no AEM Guides.
Obter todas as predefinições de saída para um mapa DITA get-output-presets-dita-map
Um método POST que recupera todas as predefinições de saída configuradas para um mapa DITA.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
:operation
getalloutputs
.Observação: o valor não diferencia maiúsculas de minúsculas.
sourcePath
Valores de resposta:
Retorna uma matriz de objetos Predefinição de Saída JSON, cada objeto contendo os seguintes elementos:
outputName
outputType
- AEMSITE
- HTML5
- EPUB
- PERSONALIZAR
outputTitle
ditaValPathList
targetPath
siteName
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteStrategy
pdfGenerator
- DITAOT
- FMPS
DitaValPath
.Criar predefinição de saída
Um método POST que cria uma nova predefinição de saída para um mapa DITA.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
:operation
createoutput
.Observação: o valor não diferencia maiúsculas de minúsculas.
sourcePath
outputTitle
Observação: quando uma nova predefinição de saída é criada, o sistema back-end direciona um nome exclusivo para a predefinição de saída do título fornecido.
outputType
- AEMSITE
- HTML5
- EPUB
- PERSONALIZAR
Valores de resposta:
outputName
outputTitle
.Salvar predefinição de saída
Um método POST que salva as alterações feitas em uma predefinição de saída.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
:operation
saveoutput
.Observação: o valor não diferencia maiúsculas de minúsculas.
sourcePath
outputObj
outputObj.outputName
contém o nome da predefinição de saída que deve ser atualizada. Para o formato do objeto JSON, consulte a tabela Valores de resposta em Obter todas as predefinições de saída para um mapa DITA.Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).
Obter uma predefinição de saída específica
Um método POST que recupera uma predefinição de saída existente.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
:operation
getoutput
.Observação: o valor não diferencia maiúsculas de minúsculas.
sourcePath
outputName
Valores de resposta:
outputName
outputType
- AEMSITE
- HTML5
- EPUB
- PERSONALIZAR
outputTitle
ditaValPathList
targetPath
siteName
siteTitle
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteFiles
pdfGenerator
- DITAOT
- FMPS
DitaValPath
.Gerar saída
Um método GET que gera saída usando uma ou mais predefinições de saída.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
operation
GENERATEOUTPUT
.Observação: o valor diferencia maiúsculas de minúsculas.
source
outputName
Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).
Gerar saída incremental
Um método GET que gera saída incremental para um site AEM usando uma ou mais predefinições de saída.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
operation
INCREMENTALPUBLISH
.Observação: o valor diferencia maiúsculas de 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"
]
}
}
- O atributo
ditamap
usa o caminho absoluto do mapa DITA usado para gerar a saída. - O atributo
topics
pega uma matriz de tópicos que são atualizados e precisam ser republicados. - O atributo
fullMaps
contém o caminho dos arquivos de mapa (como submapas fragmentados) que são necessários junto com seus tópicos para geração de saída incremental. - O atributo
maps
contém o caminho dos arquivos de mapa (para resolver referências de espaço-chave) que são extraídos no disco sem tópicos. - O atributo
outputs
usa uma matriz de nomes predefinidos de saída que são usados para gerar a saída.
Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).
Excluir predefinição de saída
Um método POST que exclui uma predefinição de saída.
Solicitar URL:
http://<aem-guides-server>: <número-porta>/bin/publishlistener
Parâmetros:
:operation
deleteoutput
.Observação: o valor não diferencia maiúsculas de minúsculas.
sourcePath
outputName
Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).