Skip to end of metadata
Go to start of metadata
Contents Summary
  

Introduction

PUT /words/{name}/saveAs API lets you convert Microsoft Word document to another format with details settings. The list of supported formats are:

format Parameter ValueRequest Types
bmpBmpSaveOptions
docDocSaveOptions
docmOoxmlSaveOptions
docxOoxmlSaveOptions
dotDocSaveOptions
dotmOoxmlSaveOptions
dotxOoxmlSaveOptions
emfEmfSaveOptions
epubEpubSaveOptions
flatopc/fopcOoxmlSaveOptions
flatopc_macro/fopc_macroOoxmlSaveOptions
flatopc_template/fopc_templateOoxmlSaveOptions
flatopc_template_macro/fopc_template_macroOoxmlSaveOptions
gifGifSaveOptions
htmlHtmlSaveOptions
htmlfixedHtmlFixedSaveOptions
jpeg/jpgJpegSaveOptions
mhtml/mhtMhtmlSaveOptions
odtOdtSaveOptions
openxpsXpsSaveOptions
ottOdtSaveOptions
pclPclSaveOptions
pdfPdfSaveOptions
pngPngSaveOptions
psPsSaveOptions
rtfRich Text Format File
svgSvgSaveOptions
swfShockwave Flash Movie(removed)
text/txtTextSaveOptions
tiff/tifTiffSaveOptions
wordml/wmlWordMLSaveOptions
xamlfixedXamlFixedSaveOptions
xamlflowXamlFlowSaveOptions
xpsXpsSaveOptions

The important parameters of this API are:

Parameter NameDescriptionDefault Value
SaveFormatFormat of the output file. 
FileName

Name of the destination file.

 
DmlRenderingModeA value determining how DrawingML shapes are rendered. Fallback, DrawingML.DrawingML
DmlEffectsRenderingModeA value determining how DrawingML effects are rendered. Simplified, None, Fine.Simplified
ZipOutputA value determining zip output or not.false
ColorModeGets or sets a value determining how colors are rendered.Normal
UpdateSdtContentGets or sets a value determining whether the content of Aspose.Words.Markup.StructuredDocumentTag" is updated before saving.True
UpdateFieldsGets or sets a value determining if fields should be updated before saving the document to a fixed page format.

True

Save Options

All elements, except SaveFormat and FileName, can be omitted. If we omit an element, then the element will contain default value (default values for elements you can see in a comment after the corresponding element).

  • Request for saving images BMP:
BmpSaveOptions
  • Request for saving a document (DOC, DOT):
DocSaveOptions
  • Request for saving OOXML (DOCX, DOCM, DOTX, DOTM, FLATOPC):
OoxmlSaveOptions
  • Request for saving EMF:
EmfSaveOptions
  • Request for saving EPUB:
EpubSaveOptions
  • Request for saving GIF:
GifSaveOptions
  • Request for saving HTML:
HtmlSaveOptions
  • Request for saving fixed HTML:
HtmlFixedSaveOptions
  • Request for saving images JPEG:
JpegSaveOptions
  • Request for saving MHTML:
MhtmlSaveOptions
  • Request for saving ODT, OTT:

OdtSaveOptions
  • Request for saving PCL:

PclSaveOptions
  • Request for saving PDF:
PdfSaveOptions
  • Request for saving images PNG:
PngSaveOptions
  • Request for saving PS:
PsSaveOptions
  • Request for saving RTF:
RtfSaveOptions
  • Request for saving SVG:
SvgSaveOptions
  • Request for saving TIFF:
TiffSaveOptions
  • Request for saving TXT:
TextSaveOptions
  • Request for saving WORDML:
WordMLSaveOptions
  • Request for saving XAMLFIXED:
XamlFixedSaveOptions
  • Request for saving XAMLFLOW:
XamlFlowSaveOptions
  • Request for saving XPS (OpenXPS, XPS):
XpsSaveOptions

Type definition:

Type definition

Resource URI

Swagger UI lets you call this REST API directly from the browser. The description of the API and its parameters is also given there.

cURL Example

 Request
 Response

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of Aspose.Words SDKs along with working examples, to get you started in no time. Please check Available SDKs article to learn how to add an SDK to your project.

SDK Examples

 C#
 Java
 PHP
 Python
 Ruby
 Node.js
 Android
 Swift
 Go
Labels
  • No labels