About this resource
Representation of a download agreement, a policy that users need to accept before they can download content.
Properties
| Property | Description | Type |
|---|---|---|
| createdOn | Gets the creation datetime in UTC time. | datetime |
| enabled | Is the download agreement enabled. | boolean |
| id | Gets the Id of this download agreement. | int32 |
| modifiedOn | Gets the last modification datetime in UTC time. | datetime |
Relations
| Method | Name | Select-key | Resource type | Description |
|---|---|---|---|---|
| GET | self | Provides a link to this resource. | ||
| GET | contents | select-DownloadAgreement: contents | DownloadAgreementContentCollection | Collection of download agreement's content. |
| GET | usergroups | select-DownloadAgreement: usergroups | DownloadAgreementUserGroupCollection | Collection of download agreement's user groups. |
| GET | classifications | select-DownloadAgreement: classifications | DownloadAgreementClassificationCollection | Collection of download agreement's classifications. |
Actions
| Method | Action | Description | Response codes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PUT /downloadagreement/{downloadAgreementId} | edit | Edits an existing download agreement. |
|
||||||||
| DELETE /downloadagreement/{downloadAgreementId} | delete | Deletes an existing download agreement. |
|
Examples
Searching for a single download agreement
GET /downloadagreement/1
Editing a download agreement
All properties are optional. If not provided, they will not be updated.
It is not necessary to update the download agreement content in every language at once, only the languages that need to be updated. The other languages will remain unchanged.
Content in a specific language can't be removed, but it's possible to set it to an empty string. When updating the English title and terms of use, they can't be empty.
All properties are optional. If not provided, they will not be updated.
It is not necessary to update the download agreement content in every language at once, only the languages that need to be updated. The other languages will remain unchanged.
Content in a specific language can't be removed, but it's possible to set it to an empty string. When updating the English title and terms of use, they can't be empty.
PUT /downloadagreement/1
{
"enabled": true,
"classifications": {
"addOrUpdate": [
"44b9340f-18ed-4469-9ab1-b19d0091a6c2",
"7baa7250-cc6f-4a06-b2b5-218afd2355e7"
],
"remove": [
"e96c90ec-8555-4c48-ad45-7938f72a0797",
"b09d1874-d632-49ce-ab4b-2495677bcc70"
]
},
"userGroups": {
"addOrUpdate": [
"301d3f2b-d952-4c1a-b017-74480f0f92d2",
"502dbb18-960c-4520-bb79-7e5629b54427"
],
"remove": [
"21d41eb183234b0cbe7b6a9c898b1de1",
"17f67315-3a72-4736-906a-442fb477718c"
]
},
"contents": {
"addOrUpdate": [
{
"languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
"title": "Download agreement title in English ",
"termsOfUse": "Terms of use in English"
},
{
"languageId": "5EC55442-1CAC-4734-A0ED-E1D01CD1E49F",
"title": "Titolo dell'accordo di download in italiano",
"termsOfUse": "Termini di utilizzo in italiano"
}
]
}
}
Deleting a download agreement
DELETE /downloadagreement/1