About this resource
Storage class for download links in ADAM.
Properties
| Property | Description | Type |
|---|---|---|
| createdOn | Gets the creation datetime in UTC time. | datetime |
| deliveredFiles | Gets a list of download links to the files generated by the order or maintenance job. | Collection of string items |
| description | Gets the description of a download link. | string |
| errorDescription | Get the user friendly error description from download link. | string |
| failedRecordsCount | Gets the count of records for which there were errors when processing of any requested files. | int32 |
| failedTargetsCount | Gets the count of failed targets. | int32 |
| id | Gets the Id of this maintenance job. | guid |
| status | Gets the status of this download link. | string (values: pending, success, failed, partiallyfailed, executing, cancelled, scheduled, queued, asyncpending, asyncexecuting) |
| succeededRecordsCount | Gets the count of records for which all requested files were successfully processed. | int32 |
| title | Gets the title of a download link. | string |
| type | Gets the type of download link. | string |
Relations
| Method | Name | Select-key | Resource type | Description |
|---|---|---|---|---|
| GET | self | Provides a link to this resource. | ||
| GET | targets | select-DownloadLink: targets | DownloadLinkTargetCollection | Gets a collection of all the targets to be processed by this download link. |
| GET | createdby | select-DownloadLink: createdby | User | Gets or sets the user that created this resource. |
Examples
Reading a download link without embedded resources (targets)
GET /downloadlink/b6d2400e-ffce-489b-9e08-7324c9378206 HTTP/1.1 accept: application/hal+json
In case of hal+json, all subresources (targets) are represented as links to these resources.
{
"_links": {
"targets": {
"href": "/downloadlink/11489c63d7ac42da916ba4e901008807/targets",
"select-key": "targets"
},
"self": {
"href": "/downloadlink/11489c63-d7ac-42da-916b-a4e901008807"
}
},
"createdOn": "2015-08-03T15:31:43.633",
"id": "11489c63d7ac42da916ba4e901008807",
"status": "Pending",
"type": "DownloadOrder",
"deliveredFiles" : ["someFilePath1"],
"title": "file3.png",
"description": "Download for web"
}
GET /downloadlink/b6d2400e-ffce-489b-9e08-7324c9378206 HTTP/1.1 accept: application/json
In case of json, all subresources (targets) are returned as null values.
{
"targets": null,
"createdOn": "2015-08-03T15:31:43.633",
"id": "11489c63d7ac42da916ba4e901008807",
"status": "Pending",
"type": "ExportMaintenanceJob",
"deliveredFiles" : ["https://tenant.aprimo.com/api/core/download?token=aaEdw-pxG7OsCNORW"],
"title": "Exported metadata of file3.png",
"description": "Export metadata"
}
Reading a download link with embedded resources (targets)
GET /downloadlink/e8a98a7a0ac1440ba538ad44011948d5 HTTP/1.1 accept: application/hal+json select-downloadlink: targets
Read a download link and embed targets.
{
"createdOn": "2015-08-03T15:31:43.633",
"id": "11489c63d7ac42da916ba4e901008807",
"status": "Pending",
"type": "ContactSheet",
"deliveredFiles" : ["someFilePath1"],
"title": "Contact sheet of 1 item",
"description": "Export contact sheet"
"_embedded": {
"targets": {
"_links": {
"self": {
"href": "https://tenant.aprimo.com/api/core/downloadlink/e8a98a7a0ac1440ba538ad44011948d5/targets"
}
},
"items": [
{
"_links": {
"self": {
"href": "https://tenant.aprimo.com/api/core/downloadlink/e8a98a7a0ac1440ba538ad44011948d5/target/e7117807489947cd99b227159b9d0741"
}
},
"recordId": "796de42e712a4ff7a871ad3200c6b9b5",
"fileVersionId": "fcfb891859474a9f91e1ad3200c6c1a8",
"id": "e7117807489947cd99b227159b9d0741",
"status": "Succeeded"
}]
}
}
}