DocumentationAEM GuidesAEM Guides Documentation

REST APIs for conversion workflow id175UB30E05Z

Last update: Tue Aug 06 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

The following REST APIs allows you to convert Word, HTML, and InDesign documents into DITA format.

Convert Word documents

A GET method that converts Word documents into DITA format.

Request URL:
http://<aem-guides-server>: <port-number>/bin/fmdita/conversion

Name
Type
Required
Description
operation
String
Yes
Name of the operation being called. The value of this parameter is word2dita.
Note: The value is case-insensitive.
inputFile
String
Yes
Absolute path of the source Word files in AEM repository.
destPath
String
Yes
Absolute path of the destination location where the converted DITA files will be saved.
createRev
Boolean
Yes
Specify whether a revision of the files is created ( true) at the specified destination or not ( false). This is considered only when the destination location contains an existing version of the converted files.
style2tagMap
String
Yes
Absolute path of the style mapping file that will be used for conversion.

Response values:
Returns a HTTP 200 (Successful) response.

Convert HTML documents

A GET method that converts HTML documents into DITA format.

Request URL:

http://<aem-guides-server>: <port-number>/bin/fmdita/conversion

Parameters:

Name
Type
Required
Description
operation
String
Yes
Name of the operation being called. The value of this parameter is html2dita.
Note: The value is case-insensitive.
inputFile
String
Yes
Absolute path of the source HTML files in AEM repository.
destPath
String
Yes
Absolute path of the destination location where the converted DITA files will be saved.
createRev
Boolean
Yes
Specify whether a revision of the files is created ( true) at the specified destination or not ( false). This is considered only when the destination location contains an existing version of the converted files.

Response values:

Returns a HTTP 200 (Successful) response.

Convert InDesign documents

A GET method that converts InDesign documents into DITA format.

Request URL:
http://<aem-guides-server>: <port-number>/bin/fmdita/conversion

Parameters:

Name
Type
Required
Description
operation
String
Yes
Name of the operation being called. The value of this parameter is idml2dita.
Note: The value is case-insensitive.
inputFile
String
Yes
Absolute path of the source InDesign files in AEM repository.
destPath
String
Yes
Absolute path of the destination location where the converted DITA files will be saved.
createRev
Boolean
Yes
Specify whether a revision of the files is created ( true) at the specified destination or not ( false). This is considered only when the destination location contains an existing version of the converted files.

Response values:
Returns a HTTP 200 (Successful) response.

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178