Downloadable Files in Response Messages

In some cases, the platform API returns content as a downloadable file rather than in the payload of the response message. In all these cases, the platform uses the content-disposition header to manage this content.

When testing any of these operations, you can just run the test URL in the address bar of a browser window and you will see a File Download prompt (assuming the URL is correct and you have the appropriate permissions).

The content-disposition header is used by many operations to return information such as workflows, platform styles, export information, and metrics. Some of the operations that use this header are shown below.

This service/operation... Returns this information... In this file...
apis:
GET /api/apis/{APIID}/package API export ZIP file api-export.zip
GET /api/apis/versions/{APIVersionID}/package API version export ZIP file apiversion-export.zip
GET /api/apis/versions/{APIVersionID}/metrics/export Metrics export CSV file export.csv
GET /api/apis/versions/{APIVersionID}/txlogs/export Usage logs export CSV file apilogs.csv
apps:
GET /api/apps/{AppID}/package App export ZIP file application-export.zip
GET /api/apps/versions/{AppVersionID}/package API version export ZIP file appversion-export.zip
GET /api/apps/versions/{AppVersionID}/metrics/export Metrics export CSV file export.csv
GET /api/apps/versions/{AppVersionID}/txlogs/export Usage logs export CSV file applogs.csv
GET /api/apps/versions/{AppVersionID}/certificate App certificate certificate.cer
businesses:
GET /api/businesses/{BusinessID}/package Business export ZIP file business-export.zip

Back to top

Related Topics