Skip to main content

SOAP API

File transfer

For file transfers, the XTM web service can accept a URL, encoded BASE64 binary information, or an MTOM file attachment:

  • URL – address of a file which can be downloaded by XTM or a client.

  • BASE64 – encoded file in BASE64 format, which is included in a web service message.

  • MTOM – file sent as an attachment.

To achieve this functionality, XTM web services work with two protocols:

  1. XML

    • Example: /projectmanager/XTMWebService.

    • MTOM disabled.

    • Possible file transfers:

      • URL – methods ended with the “URL” suffix.

      • BASE64 – methods ended with the “MTOM” suffix.

        When the MTOM option is disabled for web services, then all the methods designed for MTOM work in a standard, non-optimized way. Hence, the methods still have the “MTOM” suffix.

  2. XOP (XML – binary Optimized Packaging)

    • Example: /projectmanager/xop/XTMWebService.

    • MTOM enabled.

    • Possible file transfers:

      • URL – methods ended with the “URL” suffix.

      • MTOM – methods ended with the “MTOM” suffix.

Select MTOM to send or download a large number of files from XTM Cloud. The size of such documents sent via web services will be much less than using BASE64, and no additional encoding is required.

Select BASE64 if your integration programming language does not support MTOM (for example, PHP).