Download File from Subform

    This API downloads a file from a file upload, image, audio, video, or signature field of a specific subform record of a ManageEngine AppCreator application.

    You can get the subform record's ID by using the Get Record APIs.

    Request URL

    https://<base_url>/api/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>/<subform_link_name>.<field_link_name>/<subform_record_ID>/download

    Request method

    GET

    Header

    KeyValueDescription
    AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.

    OAuth scope

    scope=ZohoCreator.report.READ

    where,

    base_urlthe base URL of your AppCreator account
    For example, the base URL is either  https://host_name:port_number (learn more) or appcreatordemo.manageengine.com (hostname of the server where ManageEngine AppCreator is running).
    account_owner_namethe username of the AppCreator account's owner
    app_link_namethe link name of the target application
    report_link_namethe link name of the target report
    record_IDthe ID of the main form record
    subform_link_namethe link name of the target subform
    field_link_namethe link name of the target file upload, image, audio, video, or signature field, which is present in the subform
    subform_record_IDthe ID of the target subform record, which can be found using the Get Record API
    Possible Errors

    Refer to this page for the list of error codes and messages.

    Sample Request

    Copiedcurl "https://appcreatordemo.manageengine.com/api/v2/jason18/zylker-store/report/All_Orders/3888834000000114050/Line_Items.Product_Manual/3888834000000104037/download"
    -X GET
    -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

    This sample request will download the file present in the Product_Manual field of (subform) record with ID 3888834000000104037, which is present in the Line Items subform of the record with ID 3888834000000114050, which is displayed in the Inventory Report of the Zylker Store application.

    Sample Response

    If the request is a success, the target file will be downloaded.

    Back to Top