Skip to main content

Aspose Component

Aspose

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, Asopse 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 Applicaitons view. Once you create a new application, Aspose will issue a client_id and client_secret.

Actions​

Convert Cloud Storage Document​

Converts a document in cloud storage to the specified format. | key: convertCloudStorageDocument

Output Example Payload​

{
  "data": {}
}

Convert Diagram​

Converts document from the request's content to the specified format. | key: convertDiagram

Output Example Payload​

{
  "data": "<binary data of diagram converted>"
}

Convert HTML to PDF​

Converts HTML file in storage to PDF format. | key: convertHtmlToPdf

Output Example Payload​

{
  "data": {
    "Code": 200,
    "Status": "OK"
  }
}

Convert Local Document​

Converts a document on a local drive to the specified format. | key: convertLocalDocument

Output Example Payload​

{
  "data": "<binary data of file converted>"
}

Convert PDF to DOC​

Converts PDF document to DOC format. | key: convertPdfToDoc

Output Example Payload​

{
  "data": {
    "Code": 200,
    "Status": "OK"
  }
}

Convert PDF to HTML​

Converts a PDF to HTML format. | key: convertPdfToHtml

Output Example Payload​

{
  "data": {
    "Code": 200,
    "Status": "OK"
  }
}

Copy File​

Copies a file. | key: copyFile

Output Example Payload​

{
  "data": null
}

Copy Folder​

Copies a folder. | key: copyFolder

Output Example Payload​

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

Output Example Payload​

{
  "data": {
    "StatusCode": 200,
    "Status": "OK"
  }
}

Create Folder​

Creates a folder. | key: createFolder

Output Example Payload​

{
  "data": null
}

Delete File​

Deletes a file. | key: deleteFile

Output Example Payload​

{
  "data": null
}

Delete Folder​

Deletes a folder. | key: deleteFolder

Output Example Payload​

{
  "data": null
}

Download File​

Downloads a file. | key: downloadFile

Output Example Payload​

{
  "data": "<binary data of file downloaded>",
  "headers": {
    "statusCode": 200
  }
}

Get Diagram​

Exports the document into the specified format. | key: getDiagram

Output Example Payload​

{
  "data": "<binary data of diagram downloaded>"
}

Get Document​

Reads common information from the document. | key: getDocument

Output Example Payload​

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

Output Example Payload​

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

Output Example Payload​

{
  "data": null,
  "headers": {
    "statusCode": 200
  }
}

Move File​

Moves a file. | key: moveFile

Output Example Payload​

{
  "data": null
}

Move Folder​

Moves a folder. | key: moveFolder

Output Example Payload​

{
  "data": null
}

Save Diagram As​

Converts document to destination format with detailed settings and saves result to storage. | key: saveDiagramAs

Output Example Payload​

{
  "data": "<binary data of file downloaded>"
}

Save Document As​

Converts a document in cloud storage to the specified format. | key: saveDocumentAs

Output Example Payload​

{
  "data": null,
  "headers": {
    "statusCode": 200
  }
}

Split Document​

Splits a document into parts and saves them in the specified format. | key: splitDocument

Output Example Payload​

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

Output Example Payload​

{
  "data": null
}