Search Results for

    Show / Hide Table of Contents

    Method ConvertFile

    ConvertFile(String, String, String, String)

    Convert a file based on a fileId.

    Declaration
    string ConvertFile(string connectionId, string fileId, string targetFormat, string originalFormat)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    System.String fileId

    The file id.

    System.String targetFormat

    The target format (e.g. "pdf")

    System.String originalFormat

    The original format (e.g. "docx")

    Returns
    Type Description
    System.String

    Return a file id.

    Remarks
    • After the MWC no longer needs the file, the file should be released (deleted) using ReleaseFile.
    Examples

    POST http://YourServerName/InfoShare/Json/File/ConvertFile

    Example for converting a file.

    {
       "connectionId": "bbf760ba-6bdb-45b6-9eec-992669fc7359",
       "fileId": "89dcf0ba-9c19-485b-bc0a-e8b5666866fa",
       "targetFormat":"pdf",
       "originalFormat":"docx
    }

    Response:

       {
           "ConvertFileResult": "77dcf0ba-9c19-485b-bc0a-e8b5666866fa"
       }
    Exceptions
    Type Condition
    ServiceException

    The connection id {connectionId} isn't valid or has expired (10008)

    ServiceException

    Verification code is needed: Verification code not yet verified (10152)

    Back to top Copyright © Kendox