Documentação AEM Guides Documentação do AEM Guides

REST APIs para gerenciamento de saída id175UB30E05Z

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

undefined
undefined

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:

Nome

Tipo

Obrigatório

Descrição

:operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é getalloutputs.
Observação: o valor não diferencia maiúsculas de minúsculas.

sourcePath

String

Sim

Caminho absoluto do arquivo de mapa DITA.

Valores de resposta:
Retorna uma matriz de objetos Predefinição de Saída JSON, cada objeto contendo os seguintes elementos:

Elemento

Descrição

outputName

Nome da predefinição de saída. Os nomes de saída são exclusivos no escopo do mapa DITA em que estão definidos.

outputType

Tipo de saída gerado usando essa predefinição, por exemplo, AEM Site, PDF, EPUB ou outro. As opções disponíveis são:
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONALIZAR

outputTitle

Um nome descritivo para as configurações de predefinição de saída. Isso é usado para definir o valor da propriedade Nome da configuração para a predefinição de saída.

ditaValPathList

Matriz de caminhos de arquivo DITAVAL a serem usados para gerar a saída desejada.

targetPath

Caminho onde a saída é publicada ou armazenada.

siteName

(Para saída do Site AEM) Nome do Site AEM.

templatePath

(Para saída do Site AEM) Caminho do nó de modelo a ser usado para gerar a saída desejada.

searchScope

Especifique o escopo da operação de pesquisa. O valor deste parâmetro deve ser definido como local.

generateTOC

(Para saída do Site AEM) Especifique se um índice é gerado (true) ou não (false).

generateBreadcrumbs

(Para saída do Site AEM) Especifique se as navegações estruturais são geradas (true) ou não (false).

overwriteStrategy

(Para saída do Site AEM) Especifique se os arquivos no destino serão substituídos (true) ou não (false).

pdfGenerator

Especifique o mecanismo de geração de PDF a ser usado. Os valores possíveis são:
- DITAOT
- FMPS

NOTE

Não há mais suporte para o elemento 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:

Nome

Tipo

Obrigatório

Descrição

:operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é createoutput.
Observação: o valor não diferencia maiúsculas de minúsculas.

sourcePath

String

Sim

Caminho absoluto do arquivo de mapa DITA.

outputTitle

String

Sim

Um nome descritivo para as configurações de predefinição de saída. Isso é usado para definir o valor da propriedade Setting Name para a predefinição de saída.
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

String

Sim

Tipo de saída gerado usando essa predefinição, por exemplo, AEM Site, PDF, EPUB ou outro. As opções disponíveis são:
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONALIZAR

Valores de resposta:

Elemento

Descrição

outputName

Um nome exclusivo para a predefinição de saída recém-criada. Este nome é derivado do valor do parâmetro 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:

Nome

Tipo

Obrigatório

Descrição

:operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é saveoutput.
Observação: o valor não diferencia maiúsculas de minúsculas.

sourcePath

String

Sim

Caminho absoluto do arquivo de mapa DITA.

outputObj

String

Sim

Um objeto JSON que contém propriedades da predefinição de saída que está sendo atualizada. A propriedade 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:

Nome

Tipo

Obrigatório

Descrição

:operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é getoutput.
Observação: o valor não diferencia maiúsculas de minúsculas.

sourcePath

String

Sim

Caminho absoluto do arquivo de mapa DITA.

outputName

String

Sim

Nome da predefinição de saída cujos detalhes devem ser recuperados.

Valores de resposta:

Elemento

Descrição

outputName

Nome da predefinição de saída. Os nomes de saída são exclusivos no escopo do mapa DITA em que estão definidos.

outputType

Tipo de saída gerado usando essa predefinição, por exemplo, AEM Site, PDF, EPUB ou outro. As opções disponíveis são:
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONALIZAR

outputTitle

Um nome descritivo para as configurações de predefinição de saída. Isso é usado para definir o valor da propriedade Nome da configuração para a predefinição de saída.

ditaValPathList

Matriz de caminhos de arquivo DITAVAL a serem usados para gerar a saída desejada.

targetPath

Caminho onde a saída é publicada ou armazenada.

siteName

(Para saída do site AEM) Nome do site AEM.

siteTitle

(Para saída do site AEM) Título do site AEM.

templatePath

(Para saída do site AEM) Caminho do nó do modelo a ser usado para gerar a saída desejada.

searchScope

Especifique o escopo da operação de pesquisa. O valor deste parâmetro deve ser definido como local.

generateTOC

(Para saída do site AEM) Especifique se um índice é gerado (true) ou não (false).

generateBreadcrumbs

(Para saída do site AEM) Especifique se as navegações estruturais são geradas (true) ou não (false).

overwriteFiles

(Para saída do site AEM) Especifique se os arquivos no destino são substituídos (true) ou não (false).

pdfGenerator

Especifique o mecanismo de geração de PDF a ser usado. Os valores possíveis são:
- DITAOT
- FMPS

NOTE

Não há mais suporte para o elemento 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:

Nome

Tipo

Obrigatório

Descrição

operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é GENERATEOUTPUT.
Observação: o valor diferencia maiúsculas de minúsculas.

source

String

Sim

Caminho absoluto do arquivo de mapa DITA.

outputName

String

Sim

Nome da predefinição de saída(s) a ser usada para gerar saída. Várias predefinições de saída podem ser especificadas usando um delimitador de barra vertical ("|"), por exemplo `aemsite

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:

Nome

Tipo

Obrigatório

Descrição

operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é INCREMENTALPUBLISH.
Observação: o valor diferencia maiúsculas de minúsculas.

contentPath

JSON

Sim

Caminho absoluto do arquivo de mapa DITA e dos arquivos de tópico, juntamente com o nome das predefinições de saída. Use o exemplo a seguir como bloco de construção:

{
   {
   "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:

Nome

Tipo

Obrigatório

Descrição

:operation

String

Sim

Nome da operação que está sendo chamada. O valor deste parâmetro é deleteoutput.
Observação: o valor não diferencia maiúsculas de minúsculas.

sourcePath

String

Sim

Caminho absoluto do arquivo de mapa DITA.

outputName

String

Sim

Nome da predefinição de saída a ser excluída.

Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178