Returns the pre-signed, AWS S3 URL for the specified document.
Base Request
GET /api/download/url/[docId]/[propertyXPathAndFilename]
where [docId] is the alphanumeric ID for the document and [propertyXPathAndFilename] is the XPath to the property holding the blob and the file name (for example, sysfile_blob/test.png or sysfiles_blobs/0/test.png).
Query Parameters
| Parameter | Description | Type | Required | Notes |
|---|---|---|---|---|
| expiration | The maximum number of seconds the pre-signed URL remains valid before expiring. | integer | Optional | If the specified value exceeds the global expiration value set for the Hyland Experience repository (3600 seconds, by default), the global expiration value is used. |
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The access token | Required |
Bearer [access_token]
where [access_token] is a string generated when you complete authentication (see Getting Started) |
| User-Agent | Identity of the client making the request to the server | Required |
[product]/[version]
where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0). For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website. |
| HXCS-REPOSITORY | The repository ID | Optional | Any contributed repository name. Default is default. |
| Accept | The format of the data to be returned | Optional | */* |
Sample Request
GET /api/download/url/[docId]/[propertyXPathAndFilename]?expiration=2000 Authorization: Bearer [access_token] User-Agent: MyCompanyProduct/1.0 HXCS-REPOSITORY: default Accept: */*
Response
A string value for the URL is returned.
Status Codes and Errors
The following table lists the returned status codes.
| Code | Description | Notes |
|---|---|---|
| 200 | OK | Returns the pre-signed, AWS S3 URL for the specified document. |
| 401 | Not Authorized | Authentication has failed or was not provided. |
| 403 | Not Allowed | Access permissions are invalid or missing. |
| 404 | Not Found | The document could not be found. |