Resource: DownloadLinkPagedCollection

About this resource

This page describes how you can get a paged collection of DownloadLink items (output from maintenance jobs) that users have created. There are 4 types of download links corresponding with the maintenance job type they originate from: DownloadOrder, ExportMaintenanceJob, ContactSheet, ExportAuditJob

Properties

Property	Description	Type
items	One page of this paged collection, which is a subcollection of the complete collection.	Collection of DownloadLink items
page	The current page of this paged collection.	int32
pageSize	The current page size of this paged collection.	int32
skip	The current skip size of this paged collection.	int32
take	The current take size of this paged collection.	int32
totalCount	The total count of items in this paged collection, not just on the current page.	int64

Relations

Method	Name	Description
GET	self	Provides a link to this resource.
GET	first	A link to the first page of this paged collection.
GET	prev	A link to the previous page of this paged collection.
GET	next	A link to the next page of this paged collection.
GET	last	A link to the last page of this paged collection.

Examples

Searching for download links

The parameters are specified as http headers.

GET /downloadlinks HTTP/1.1
accept: application/hal+json
filter: CreatedOn in today
sort: createdon
page: 1
pageSize: 20

To include download links which already expired (file not available for download because of expiration), add http header.

select-downloadlink: includeExpired.

The parameters are specified as query string parameters.

GET /downloadlinks?filter=CreatedOn+in+today&sort=createdon&page=1&pagesize=10 HTTP/1.1

The parameters are specified as a combination of query string parameters and http headers.

GET /downloadlinks?filter=CreatedOn+in+today&sort=createdon HTTP/1.1
skip: 30
take: 20