Resource: DownloadAgreementPagedCollection

About this resource

Representation of a paged collection of DownloadAgreement items

Properties

Property	Description	Type
items	One page of this paged collection, which is a subcollection of the complete collection.	Collection of DownloadAgreement 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.

Actions

Method

Action

Description

Response codes

POST /downloadAgreements/search

search

Returns applicable download agreements (if any) for given search criteria

POST /downloadAgreements

add

Create a download agreement

201	Request completed successfully. The header parameter 'Location' contains the location of the new download agreement resource. The response body is a JSON object which contains the property "id" that corresponds to the newly created download agreement resource id.
400	Bad request (in general)
403	Insufficient permissions

Examples

Searching for download agreements

The parameters are specified as HTTP headers.

GET /downloadagreements HTTP/1.1
accept: application/hal+json
sort: modifiedOn
page: 1
pageSize: 20

The parameters are specified as query string parameters.

GET /downloadagreements?filter=sort=createdon&page=1&pagesize=10 HTTP/1.1

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

GET /downloadagreements?filter=sort=createdon HTTP/1.1
page: 1
pageSize: 20

Searching for download agreements for record ids

The record ids are specified as body content.

POST /downloadagreements/search HTTP/1.1
{
    "recordIds": ["21D41EB1-8323-4B0C-BE7B-6A9C898B1DE1", "CEC3DFC2-4E30-4A69-AA92-2398A3D96C13"]
}

Creating a download agreement In order to create a new download agreement, you must specify at least one user group and provide an English title and terms of use for it. Values for the download agreement content in English can't be empty.

Classifications to which this download agreement will be applicable are optional. By default the agreement applies to all content.

Currently, only one download agreement is allowed in the system. A subsequent call to create a download agreement without deleting the previous one will lead to a failed request.

POST /downloadagreements
{
  "enabled": true,
  "userGroups": {
      "addOrUpdate": [
          "21D41EB1-8323-4B0C-BE7B-6A9C898B1DE1",
          "CEC3DFC2-4E30-4A69-AA92-2398A3D96C13"
      ]
  },
  "classifications": {
      "addOrUpdate": [
          "5D57CE75-2A5E-4A41-A6C9-B15D010B32A1",
          "5b9b9fe0f1294448b2cab18e00e1187b"
      ]
  },
  "contents": {
      "addOrUpdate": [
          {
              "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
              "title": "Download agreement title in English",
              "termsOfUse": "Actual download agreement text in English "
          },
          {
              "languageId": "691A7C86-57DC-4330-A512-C616DB954D6A",
              "title": "Endbenutzer-Lizenzvertrag (Download agreement)",
              "termsOfUse": "Some download agreement in German."
          }
      ]
  }
}