2114: Download terms version file
- Nick Jensen
Analytics
Fetch a specific terms version file as an HTTP download.
This endpoint works best through a browser, which means it cannot be used directly with the standard Rubiq API authentication.
Consider enabling Public authentication for this endpoint, to allow open access to file downloads.
| Endpoint ID: | 2114 | |||||||
| Method: | GET | |||||||
| URL: | /permissions/terms/{termsID}/{version}/file/{fileKey}/download | |||||||
| termsID | A GUID string identifier for the terms | |||||||
| version | A terms version string formatted as "major.minor", i.e. "1.0" or "4.7". Alternatively, the string "active" indicates the active version of these terms. This will result in an error if the terms have no active version defined. | |||||||
| fileKey | The "key" of the specific file to fetch for this version. Alternatively, the string "default" indicates the default file for this version. | |||||||
Request body: | None | |||||||
| Response body: | An HTTP binary response, ready for a browser to handle as a file download. The following headers are included:
| |||||||
| Status codes: | 200 | OK | ||||||
| 400 | Invalid request. The following subcodes may be returned:
| |||||||
| 404 | The entity or terms were not found. The following subcodes may be returned:
| |||||||