Aspose Component
Aspose is a robust file manipulation service that can manage various document and image file formats. Use the Aspose component to create, edit, process, and convert file formats from several languages, and several platforms.
Component key: aspose
Description
Aspose is a robust file manipulation service that can manage various document and image file formats. Use the Aspose component to create, edit, process, and convert file formats from several languages, and several platforms.
Use the Aspose component to manage files and convert documents to various file types.
API Documentation: Aspose Words Cloud API Reference, Aspose PDF Cloud
Connections
Aspose Connection
In order to use the apiKey connection of Aspose, you need to provide both the client_id and client_secret from your Aspose's application. To access the Aspose's REST API, you need to create an application. To register new applications, login into the Aspose Developer Dashboard site using your Aspose Account, and go to the Applications view. Once you create a new application, Aspose will issue a client_id and client_secret.
| Input | Notes | Example |
|---|---|---|
| Aspose API Base URL | https://api.aspose.cloud | |
| Application Client ID | Client ID of your Aspose Application. | |
| Application Client Secret | Client Secret of your Aspose Application. |
Actions
Convert Cloud Storage Document
Converts a document in cloud storage to the specified format. | key: convertCloudStorageDocument
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Password | Password of protected Word document. | |
| File Name | Name of the file inside the storage | file.ext |
| Folder Name | The name of the folder in the storage. | /folder1/file.ext |
| Format | The destination format. | html |
| Load Encoding | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. | UTF-8 |
| Out Path | The path to the output document. | /folder1/file.ext |
| Storage | Original document storage. | StorageName |
{
"data": {}
}
Convert Diagram
Converts document from the request's content to the specified format. | key: convertDiagram
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| File Content | Reference of a file on a previous step to upload. | |
| File Name | Download Document Name | Diagram.ext |
{
"data": "<binary data of diagram converted>"
}
Convert HTML to PDF
Converts HTML file in storage to PDF format. | key: convertHtmlToPdf
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination Path | The destination document folder. | /dst |
| Document Name | The document name located in storage. (Note, this input is required in case you want to save the resulting file in an Aspose storage). | Diagram.ext |
| Page height | Desired page height (in px). | 10 |
| HTML File Name | Name of HTML file in ZIP. | index.html |
| Is Landscape | Is page landscaped? | false |
| Margin Bottom | Page margin bottom (in px). | 10 |
| Margin Left | Page margin left (in px). | 10 |
| Margin Right | Page margin right (in px). | 10 |
| Margin Top | Page margin top (in px). | 10 |
| Source Folder Path | Full source filename (ex. /folder1/folder2/template.zip). Note: this input is required in case you want to get the resulting file in the response. | /Folder1/Folder2 |
| Storage Name | The document storage which contains the file. | StorageName |
| Upload to Storage | Controls whetever the post-conversion file needs to be saved into an Aspose storage or not. If 'false', the resulting file will be returned into the response body. If 'true', the resulting file will be saved into an Aspose storage. | false |
| Page width | Desired page width (in px). | 10 |
{
"data": {
"Code": 200,
"Status": "OK"
}
}
Convert Local Document
Converts a document on a local drive to the specified format. | key: convertLocalDocument
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Document | The document to convert. | |
| Password | Password of protected Word document. | |
| File Name Field Value | The filename of the output document, this will be used when the resulting document has a dynamic field (filename). If it's not set, the name of the document will be used instead. | output.ext |
| Format | The destination format. | html |
| Load Encoding | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. | UTF-8 |
| Out Path | The path to the output document on a local storage. | /folder1/file.ext |
| Storage | Original document storage name. | StorageName |
{
"data": "<binary data of file converted>"
}
Convert PDF to DOC
Converts PDF document to DOC format. | key: convertPdfToDoc
| Input | Notes | Example |
|---|---|---|
| Add Return to Line End | Add return to line end. | false |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Document Name | The name of the document inside Aspose. (Note: this input is required when the file to convert is located in an Aspose storage.) | Diagram.ext |
| Password | The file password. | |
| File Content | File to convert, if missing, action will assume that the file is located in an Aspose storage. | |
| Folder Path | The Document folder | folder1 |
| Format | Allows to specify .doc or .docx file format. | html |
| Image Resolution X | Image resolution X. | 1024 |
| Image Resolution Y | Image resolution Y. | 1024 |
| Max Distance Between Text Lines | Max distance between text lines (in px). | 10 |
| Convertion Mode | Allows to control how a PDF document is converted into a word processing document. | |
| Out Path | Full resulting filename. (Note: this field is required post-conversion file needs to be saved in an Aspose storage.). | /folder1/folder2/result.docx |
| Recognize Bullets | Controls if the converter should recognize bullets or not. | false |
| Relative Horizontal Proximity | Relative horizontal proximity (in px). | 10 |
| Storage Name | Aspose's storage name to where the folder gets read or created. | StorageName |
| Upload to Storage | Controls whetever the post-conversion file needs to be saved into an Aspose storage or not. If 'false', the resulting file will be returned into the response body. If 'true', the resulting file will be saved into an Aspose storage. | false |
{
"data": {
"Code": 200,
"Status": "OK"
}
}
Convert PDF to HTML
Converts a PDF to HTML format. | key: convertPdfToHtml
| Input | Notes | Example |
|---|---|---|
| Additional Margin Width In Points | Defines width of margin that will be forcibly left around that output HTML-areas. | 10 |
| Antialiasing Processing | Defines required antialiasing measures during conversion of compound background images from PDF to HTML. | |
| Compress SVG Graphics If Any | Flag that indicates whether found SVG Graphics (if any) will be compressed (zipped) into SVGZ format during saving. | false |
| Connection | ||
| Convert Marked Content To Layers | If set to true, all elements inside a PDF marked content (layer) will be put into an HTML div with 'data-pdflayer' attribute specifying the layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content. | false |
| CSS Class Names Prefix | When PDFtoHTML converter generates result CSS's, CSS class names are generated and used in result CSS. This attribute allows forcibly set class name prefix. | prefix |
| Debug Request | Enabling this flag will log out the current request. | false |
| Default Font Name | Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used. | Arial |
| Document Name | The name of the document inside Aspose. (Note: this input is required when the file to convert in located in an Aspose storage.) | Diagram.ext |
| Format | Result document type. | html |
| File Content | File to convert, if missing, action will assume that the file is located in an Aspose storage. | |
| Fixed Layout | Flag that indicates whether the HTML is created as fixed layout. | false |
| Folder Name | The document folder | folder1 |
| Font Encoding Strategy | Defines encoding special rule to tune PDF decoding for current document. | |
| Font Saving Mode | Defines font saving mode that will be used during saving of PDF to desirable format. | |
| HTML Markup Generation Mode | Sometimes specific requirements to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirements. | WriteAllHtml |
| Image Resolution | Resolution for image rendering. | 3000 |
| Letters Positioning Method | The mode of positioning of letters in words in result HTML. | |
| Minimal Line Width | Minimal line width. | 5 |
| Out Path | Full resulting filename. (Note: this field is required post-conversion file needs to be saved in an Aspose storage.). | /folder1/folder2/result.docx |
| Pages Flow Type Depends On Viewers Screen Size | If attribute 'Split On Pages' is false, then whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such a way that result HTML will be generated in such way that flow areas that represent PDF pages in result HTML will depend on screen resolution of viewer. | false |
| Parts Embedding Mode | Defines whether referenced files (HTML, Fonts, Images, CSS) will be embedded into main HTML file or will be generated as apart binary entities. | |
| Prevent Glyphs Grouping | This attribute switch on the mode when text glyphs will not be grouped into words and string. This mode allows to keep maximum precision during positioning of glyphs on the page and it can be usted for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of Fixed Layout is set to true. | false |
| Raster Images Saving Mode | Converted PDF can contain raster images. This parameter defines how they should be handled during conversion of PDF to HTML. | |
| Remove Empty Areas On Top And Bottom | Defines whether in created HTML will be removed top and bottom empty area without any content (if any). | false |
| Save Shadowed Texts As Transparent Texts | Pdf can contain text that are shadowed by another elements (i.e by images) but can be selected to clipboard in Acrobat Reader (usually it happens when document contains images and OCRed texts extracted from it). This settins tells the converter whether we need to save such text as transparent selectable texts in result HTML to mimic behavior of Acorbat Reader (otherwise such texts are usually saved as hidden, not available for copying to clipboard). | false |
| Save Transparent Texts | Pdf can contain transparent text that can be selected to clipboard (usually it happens when document contains images and OCRed text extracted from it). This setting tells the converterw whether we need to save such texts as transparent selectable texts in result HTML. | false |
| Special Folder For All Images | The path to directory to which must be saved any images if they are encountered during saving od document as HTML. If parameter is empty or null then images will be saved together with other files linked toHTML. It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file. | /images |
| Special Folder For SVG Images | The path to directory to which must be saved any SVG images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG images will be saved together with other files linked to HTML. It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file. | /svg |
| Split CSS Into Pages | When multipage-mode selected (i.e: 'Split Into Pages' is 'true') then this attribute defines whether separate CSS-files should be created for each HTML result page. | false |
| Split Into Pages | Flag that indicates whether each page of source document will be converted into it's own target HTML document (i.e whether result HTML will be splitted into several HTML-pages). | false |
| Storage Name | Aspose's storage name to where the folder gets read or created. | StorageName |
| Try Save Text Underlining And Strikeouting In CSS | PDF itself does not contain uinderlining markers for texts. It's emulated with line situated under text. This option allows the converter to try and guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically. | false |
| Upload to Storage | Controls whetever the post-conversion file needs to be saved into an Aspose storage or not. If 'false', the resulting file will be returned into the response body. If 'true', the resulting file will be saved into an Aspose storage. | false |
| Use Z-Order | If set to true, graphics and text are added to resultant HTML document according Z-order in original PDF document. If false, all graphics are put as single-layer which may cause some unnecesary effects for overlapped objects. | false |
{
"data": {
"Code": 200,
"Status": "OK"
}
}
Copy File
Copies a file. | key: copyFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination Folder Path | Destination file path. | /dst |
| Destination Storage Name | Destination storage name. | StorageName |
| File Version ID | File version ID to download. | someVersion |
| Source Folder Path | Source file's path. e.g: '/Folder1/fole.ext or '/Bucket/Folder1/file.ext' | /Folder1/Folder2 |
| Source Storage Name | Source storage name. | StorageName |
{
"data": null
}
Copy Folder
Copies a folder. | key: copyFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination Folder Path | Destination folder path. | /dst |
| Destination Storage Name | Destination storage name. | StorageName |
| Source Folder Path | Source folder path. | /Folder1/Folder2 |
| Source Storage Name | Source storage name. | StorageName |
{
"data": null
}
Create Document
Creates a new document in cloud storage in the format, determined by the file extension. All save format extensions are supported. | key: createDocument
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| File Name | Name of the file to upload. | file.ext |
{
"data": {
"StatusCode": 200,
"Status": "OK"
}
}
Create Folder
Creates a folder. | key: createFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Folder Path | Target folder's path.The folders will be created recursively. | /Folder1/Folder2 |
| Storage Name | Aspose's storage name to where the folder gets read or created. | StorageName |
{
"data": null
}
Delete File
Deletes a file. | key: deleteFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| File Path | Path of the file including the file name and extension. e.g: /folder1/file.ext | /folder1/file.ext |
| File Version ID | File version ID to download. | someVersion |
| Storage Name | Storage name. | StorageName |
{
"data": null
}
Delete Folder
Deletes a folder. | key: deleteFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Folder Path | Target folder's path.The folders will be created recursively. | /Folder1/Folder2 |
| Recursive | Enable to delete folders, subfolders and files recursively. | false |
| Storage Name | Aspose's storage name to where the folder gets read or created. | StorageName |
{
"data": null
}
Download File
Downloads a file. | key: downloadFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| File Path | Path of the file including the file name and extension. e.g: /folder1/file.ext | /folder1/file.ext |
| File Version ID | File version ID to download. | someVersion |
| Storage Name | Storage name. | StorageName |
{
"data": "<binary data of file downloaded>",
"headers": {
"statusCode": 200
}
}
Get Diagram
Exports the document into the specified format. | key: getDiagram
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Diagram Name | The name of the diagram. | Diagram.ext |
| Folder Path | The folder path where original diagram is located. | /Folder1/Folder2 |
| Format | The destination format. | html |
{
"data": "<binary data of diagram downloaded>"
}
Get Document
Reads common information from the document. | key: getDocument
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Document Name | The filename of the input document. | file.ext |
| Folder Path | The path to the folder where the document is located. | /Folder1/Folder2 |
| Storage Name | Storage name. | StorageName |
{
"data": {
"Document": {
"Links": [
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest",
"Rel": "self"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=doc",
"Rel": "alternate",
"Type": "application/msword",
"Title": "Download as DOC"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=dot",
"Rel": "alternate",
"Type": "application/msword",
"Title": "Download as DOT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=docx",
"Rel": "alternate",
"Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Title": "Download as DOCX"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=docm",
"Rel": "alternate",
"Type": "application/vnd.ms-word.document.macroEnabled.12",
"Title": "Download as DOCM"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=dotx",
"Rel": "alternate",
"Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.template",
"Title": "Download as DOTX"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=dotm",
"Rel": "alternate",
"Type": "application/vnd.ms-word.template.macroEnabled.12",
"Title": "Download as DOTM"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=flatopc",
"Rel": "alternate",
"Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Title": "Download as FLATOPC"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=rtf",
"Rel": "alternate",
"Type": "application/rtf",
"Title": "Download as RTF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=wml",
"Rel": "alternate",
"Type": "text/xml",
"Title": "Download as WML"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=odt",
"Rel": "alternate",
"Type": "application/vnd.oasis.opendocument.text",
"Title": "Download as ODT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=ott",
"Rel": "alternate",
"Type": "application/vnd.oasis.opendocument.text-template",
"Title": "Download as OTT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=txt",
"Rel": "alternate",
"Type": "text/plain",
"Title": "Download as TXT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=mhtml",
"Rel": "alternate",
"Type": "multipart/related",
"Title": "Download as MHTML"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=epub",
"Rel": "alternate",
"Type": "application/epub+zip",
"Title": "Download as EPUB"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=pdf",
"Rel": "alternate",
"Type": "application/pdf",
"Title": "Download as PDF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=xps",
"Rel": "alternate",
"Type": "application/vnd.ms-xpsdocument",
"Title": "Download as XPS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=openxps",
"Rel": "alternate",
"Type": "application/oxps",
"Title": "Download as OPENXPS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=ps",
"Rel": "alternate",
"Type": "application/postscript",
"Title": "Download as PS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=tiff",
"Rel": "alternate",
"Type": "image/tiff",
"Title": "Download as TIFF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=png",
"Rel": "alternate",
"Type": "image/png",
"Title": "Download as PNG"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=jpeg",
"Rel": "alternate",
"Type": "image/jpeg",
"Title": "Download as JPEG"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=bmp",
"Rel": "alternate",
"Type": "image/bmp",
"Title": "Download as BMP"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=gif",
"Rel": "alternate",
"Type": "image/gif",
"Title": "Download as GIF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=emf",
"Rel": "alternate",
"Type": "image/emf",
"Title": "Download as EMF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=eps",
"Rel": "alternate",
"Type": "image/eps",
"Title": "Download as EPS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=svg",
"Rel": "alternate",
"Type": "image/svg+xml",
"Title": "Download as SVG"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=html",
"Rel": "alternate",
"Type": "text/html",
"Title": "Download as HTML"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=htmlfixed",
"Rel": "alternate",
"Type": "text/html",
"Title": "Download as HTMLFIXED"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=pcl",
"Rel": "alternate",
"Type": "application/x-pcl",
"Title": "Download as PCL"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=md",
"Rel": "alternate",
"Type": "text/markdown",
"Title": "Download as MD"
}
],
"FileName": "testPdf.docx",
"SourceFormat": "Docx",
"IsEncrypted": false,
"IsSigned": false,
"DocumentProperties": {
"Link": {
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx/documentProperties?folder=%2ftest",
"Rel": "self"
}
}
},
"RequestId": "Root=1-65dfb304-6d7ffbc37ba1bebb44f6103c"
}
}
Get Files List
Get all files and folders within a folder. | key: getFilesList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Folder Path | Target folder's path.The folders will be created recursively. | /Folder1/Folder2 |
| Storage Name | Aspose's storage name to where the folder gets read or created. | StorageName |
{
"data": {
"Value": [
{
"Name": "file1",
"Path": "path1",
"IsFolder": false,
"Size": 100,
"ModifiedDate": "2021-01-01"
},
{
"Name": "file2",
"Path": "path2",
"IsFolder": false,
"Size": 200,
"ModifiedDate": "2021-01-02"
}
]
}
}
Load Web Document
Downloads a document from the web using URL and saves it to cloud storage in the specified format. | key: loadWebDocument
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Loading Document URL | The web document URL. | https://someFileUrl.com/file.txt |
{
"data": null,
"headers": {
"statusCode": 200
}
}
Move File
Moves a file. | key: moveFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination Folder Path | Destination file path. | /dst |
| Destination Storage Name | Destination storage name. | StorageName |
| File Version ID | File version ID to download. | someVersion |
| Source Folder Path | Source file's path. e.g: '/Folder1/fole.ext or '/Bucket/Folder1/file.ext' | /Folder1/Folder2 |
| Source Storage Name | Source storage name. | StorageName |
{
"data": null
}
Move Folder
Moves a folder. | key: moveFolder
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination Folder Path | Destination folder path. | /dst |
| Destination Storage Name | Destination storage name. | StorageName |
| Source Folder Path | Source folder path. | /Folder1/Folder2 |
| Source Storage Name | Source storage name. | StorageName |
{
"data": null
}
Save Diagram As
Converts document to destination format with detailed settings and saves result to storage. | key: saveDiagramAs
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Default Font | The default font for the diagram. | Arial |
| Destination File Name | The name of the converted file. | name.ext |
| Destination Folder Path | Destination folder path. | /dst |
| Original Document Name | Name of the original document. | file.ext |
| Folder Name | Original document folder. | /Folder1/Folder2 |
| Overwrite | If true overwrite the same file name. The default value is false. | false |
{
"data": "<binary data of file downloaded>"
}
Save Document As
Converts a document in cloud storage to the specified format. | key: saveDocumentAs
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination File Name | The name of the converted file. | name.ext |
| Password | Password of protected Word document. | |
| File Name | Name of the file to convert inside your Aspose Storage. | file.ext |
| Folder Name | The name of the folder in the storage. | /folder1/file.ext |
| Format | The destination format. | html |
| Load Encoding | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. | UTF-8 |
| Save Options Data | Provide save options related to the SaveFormat provided. For all save options, please refer to this link: https://reference.aspose.cloud/words/#/op/SaveAs (Toggle 'Advanced Parameters' on and then select a SaveOptionsData object congruent to the one chosen in the 'Format' input) | |
| Storage | Original document storage name. | StorageName |
{
"data": null,
"headers": {
"statusCode": 200
}
}
Split Document
Splits a document into parts and saves them in the specified format. | key: splitDocument
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Destination File Name | Result path of the document after the operation. If this parameter is ommited then result of the operation will be saved as the source document. | name.ext |
| Document Name | The filename of the input document. | Diagram.ext |
| Password | Password of protected Word document. | |
| Folder | Original document folder | folder1 |
| Format | The format to split. | html |
| From Page | The start page from where to start the splitting process | 0 |
| Load Encoding | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. | UTF-8 |
| Storage Name | Aspose's storage name to where the folder gets read or created. | StorageName |
| To Page | The end page where to end the splitting process | 10 |
| Zip Output | Flag that indicates whether to ZIP the output. | true |
{
"data": {
"SplitResult": {
"Pages": [
{
"Href": "https://www.example.com/file_page1.ext",
"Rel": "page"
},
{
"Href": "https://www.example.com/file_page2.ext",
"Rel": "page"
}
],
"ZippedPages": {
"Href": "/test/test.docx.zip",
"Rel": "zippedpages"
},
"SourceDocument": {
"Href": "https://www.example.com/file.ext",
"Rel": "self"
}
}
},
"headers": {
"statusCode": 200
}
}
Upload File
Uploads a file. | key: uploadFile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| File Content | Reference of a file on a previous step to upload. | |
| File Path | Path of the file including the file name and extension. e.g: /folder1/file.ext | /folder1/file.ext |
| Storage Name | Storage name. | StorageName |
{
"data": null
}