Aprimo DAM REST API Documentation

Resource: RecordPagedCollection

About this resource

Representation of a paged collection of Record items

Properties

Property Description Type
items One page of this paged collection, which is a subcollection of the complete collection. Collection of Record 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 Select-key Resource type 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 /records create Creates a new record.
201 Request completed successfully. The header parameter 'Location' contains the location of the new record resource. The response body is a JSON object which contains the property "id" that corresponds to the newly created record resource id.
400 Bad request (in general)
403 Insufficient permissions
POST /records/edits createdraft Creates a new record as draft

Examples

Creating a new record 
POST /records
{
	"tag": "<xml>test tag</xml>",
	"contentType": "Record",
	"classifications": {
		"addOrUpdate": [
			{
				"id": "F0962A92-8725-4FFC-9301-926FFCB6527A",
				"sortIndex": 2
			},
			{
				"id": "AB57432B-C899-40CF-BD44-802D5201973C",
				"sortIndex": 1
			}
		]
	},
	"files": {
		"master": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0",
		"addOrUpdate": [
			{
				"versions": {
					"addOrUpdate": [
						{
							"id": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0",
							"filename": "file1.png",
							"tag": "<xml>another test tag</xml>",
							"versionLabel": "this is a dummy label",
							"comment": "this is a comment"
						}
					]
				}
			},
			{
				"versions": {
					"addOrUpdate": [
						{
							"id": "NDBFNEY4REMtN0FDQS00NjE2LUJFOTgtQTkxNTk5MTJENTFG",
							"filename": "file3.png",
							"tag": "<xml>yet another test tag</xml>",
							"versionLabel": "yet another dummy label",
							"comment": "yet another comment",
							"additionalFiles": {
								"addOrUpdate": [
									{
										"id": "MkYzQjc0MTctQ0E3Ri00QUFELUEwQkQtNEIzRkQ2NzczOEY0",
										"label": "new additional file label",
										"tag": "<xml>and here yet another tag</xml>",
										"filename": "additional file name.jpg"
									}
								]
							},
							"previews": {
								"addOrUpdate": [
									{
										"id": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG",
										"label": "new file preview",
										"pageNumber": 2,
										"tag": "<xml>oh yes, one more tag</xml>"
									}
								]
							},
							"publicationItems": [
								{
									"pageNumber": 1,
									"targetFileVersionId": "C8A0DBE0-4513-4A85-B31C-E2F3D68E5CE1"
								},
								{
									"pageNumber": 2,
									"targetFileVersionId": "D166A072-2D0D-42CE-810B-3E76F64BFFBD"
								}
							]
						}
					]
				}
			},
			{
				"id": "DA75E95E-E306-4F1D-BAEB-A5980109C930",
				"watermarktype": "UseSpecified",
				"watermarkId": "CF4F6966-398D-4B26-B08B-2F5FE4809FD4"
			},
			{
				"id": "DA75E95E-E306-4F1D-BAEB-A5980109C930",
				"versions": {
					"addOrUpdate": [
						{
							"id": "D55D1DE0-7E8E-4AF7-BF78-A598010AC47D",
							"watermarktype": "None",
							"watermarkId": "00000000-0000-0000-0000-000000000000"
						}
					]
				}
			}
		]
	},
	"fields": {
		"addOrUpdate": [
			{
				"id": "6980bb9511454c4896afa48f009ac883",
				"localizedValues": [
					{
						"languageId": "00000000000000000000000000000000",
						"values": ["3240c776b7454ac19291a3cd006ea6c3", "209d7ede48004a008885a3cd006b8b8c"]
					}
				]
			}
		]
	}
}
Note: if no content type is specified, it will be assigned automatically:
  • if the record contains no files, the content type will be Record
  • if the record contains a file, the associated content type will be mapped via the content type file extension configuration settings
  • if the record contains a file but no content type mapping exists, the content type will be Asset
Disabling validation and rules. It may be necessary to create a record and skip running the validation and rules. To accomplish this you will need to following information in the header. The client_id can be supplied in the Bearer authentication token or in the header (example below) 
disable-validations: true,
disable-rules: true,
client-id: Client Id needs to match the accessCode in the .validationAndRuleDisablingRules system setting. "disableValidation" and/or "disableRules" in that setting 
also needs to be set to true.
Creating a new draft record
Upload token value should be specified twice: in master and in version id.
POST /records
{  
   "status":"draft",
   "files":{  
      "master":"MDJkMmY4ZGQ1YjFlNDQxMjgwOTFhODMzMDBkZGEzMjM=",
      "addOrUpdate":[  
         {  
            "versions":{  
               "addOrUpdate":[  
                  {  
                     "id":"MDJkMmY4ZGQ1YjFlNDQxMjgwOTFhODMzMDBkZGEzMjM=",
                     "filename":"testFile.txt",
                     "tag":"<xml>another test tag</xml>",
                     "versionLabel":"this is a dummy label",
                     "comment":"this is a comment"
                  }
               ]
            }
         }
      ]
   }
}
Creating a duplicate of a record
The id of the record you want to duplicate is specified as a HTTP header.
Additionally, you can specify in the header if you only want to copy the latest version of the master file, and if you want to copy only the manual previews of the original file version(s) and have the automatically generated previews recreated through a maintenance job (see more information after the example).
Before saving the duplicate, you can edit it using the request body described in Editing a record. 
POST /records
copyFrom: 20362A92-8725-4F2C-9301-926FFCB6521A
copyFromLatestVersion: true
recreateAutomaticPreviews: true
          
{
	"tag": "<xml>some tag</xml>",
	"contentType": "Record",
	"classifications": {
		"addOrUpdate": [
			{
				"id": "F0962A92-8725-4FFC-9301-926FFCB6527A",
				"sortIndex": 2
			},
			{
				"id": "AB57432B-C899-40CF-BD44-802D5201973C",
				"sortIndex": 1
			}
		],
		"remove": [
			{
				"id": "1A5842C2-3204-41F9-9527-D7E2F293131E"
			},
			{
				"id": "D78B9DA1-A1E2-4DBE-8E2A-8F8FA62667F5"
			},
			{
				"id": "09F59FE8-CD01-43FB-8B17-146C0AAB7A6A"
			}
		]
	},
	"files": {
		"master": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0",
		"addOrUpdate": [
			{
				"versions": {
					"addOrUpdate": [
						{
							"id": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0",
							"filename": "file1.png",
							"tag": "<xml>some other tag</xml>",
							"versionLabel": "this is a dummy label",
							"comment": "this is a comment for file with fields update"
						}
					]
				},
				"fields": {
					"addOrUpdate": [
						{
							"id": "cddb3052c3694f3496efec4e1fdda338",
							"localizedValues": [
								{
									"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc",
									"value": "some text in English"
								},
								{
									"languageId": "b0d62a54c4384e86945ea4b1009ed109",
									"value": "some text in Dutch"
								}
							]
						}
					],
					"remove": [
						{
							"id": "b75af862c30a496698ac6bdd7a86618f"
						}
					]
				}
			},
			{
				"id": "72728492-E0C1-4695-B2AA-6FE17E96FDF5",
				"versions": {
					"addOrUpdate": [
						{
							"id": "EAE049FC-F7CB-49D0-87B2-D0A0E8B79774",
							"filename": "file3.png",
							"tag": "<xml>yet another tag</xml>",
							"versionLabel": "yet another dummy label",
							"comment": "yet another comment",
							"additionalFiles": {
								"addOrUpdate": [
									{
										"id": "MkYzQjc0MTctQ0E3Ri00QUFELUEwQkQtNEIzRkQ2NzczOEY0",
										"label": "new additional file label",
										"tag": "<xml>and here yet another tag</xml>",
										"filename": "new filename.jpg"
									}
								],
								"remove": [
									{
										"id": "148BA512-5618-2246-8D94-72589D721B0Y"
									}
								]
							},
							"Previews": {
								"master": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG",
								"addOrUpdate": [
									{
										"id": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG",
										"name": "new file preview",
										"pageNumber": 2,
										"tag": "<xml>oh yes, one more tag</xml>"
									}
								],
								"remove": [
									{
										"id": "AAEC425A-CA87-4495-B10D-CBA97776E9AA"
									}
								]
							},
							"publicationItems": [
								{
									"pageNumber": 1,
									"targetFileVersionId": "C8A0DBE0-4513-4A85-B31C-E2F3D68E5CE1"
								},
								{
									"pageNumber": 2,
									"targetFileVersionId": "D166A072-2D0D-42CE-810B-3E76F64BFFBD"
								}
							]
						}
					],
					"remove": [
						{
							"id": "318BA544-7453-4527-8D97-23589D721D9C"
						},
						{
							"id": "B1137AEC-16DF-4E6C-96CF-007D74263530"
						}
					]
				}
			},
			{
				"id": "DA75E95E-E306-4F1D-BAEB-A5980109C930",
				"watermarktype": "UseSpecified",
				"watermarkId": "CF4F6966-398D-4B26-B08B-2F5FE4809FD4"
			},
			{
				"id": "DA75E95E-E306-4F1D-BAEB-A5980109C930",
				"versions": {
					"addOrUpdate": [
						{
							"id": "D55D1DE0-7E8E-4AF7-BF78-A598010AC47D",
							"watermarktype": "None",
							"watermarkId": "00000000-0000-0000-0000-000000000000"
						}
					]
				}
			}
		]
	},
	"fields": {
		"addOrUpdate": [
			{
				"id": "b149288b81d741d8b721a3cd0069b113",
				"localizedValues": [
					{
						"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc",
						"value": "some text in English"
					},
					{
						"languageId": "b0d62a54c4384e86945ea4b1009ed109",
						"value": "some text in Dutch"
					}
				]
			},
			{
				"id": "6980bb9511454c4896afa48f009ac883",
				"localizedValues": [
					{
						"languageId": "00000000000000000000000000000000",
						"values": ["3240c776b7454ac19291a3cd006ea6c3", "209d7ede48004a008885a3cd006b8b8c"]
					}
				]
			},
			{
				"id": "4d29b74f7ad2435294b9a49700a4ac3f",
				"localizedValues": [
					{
						"languageId": "00000000000000000000000000000000",
						"parents": [
							{
								"recordId": "8c19b5cb663b4f3ea4d7a3cd0069b4a8"
							}
						],
						"children": [
							{
								"recordId": "7c0040fd01b64c3485bda3cd0069b377"
							},
							{
								"recordId": "98e9cd4e992f496ba3aea3cd0069b3b3"
							}
						]
					}
				]
			}
		],
		"remove": [
			{
				"id": "b149288b81d741d8b721a3cd0069b113"
			}
		]
	}
}
If the header recreateAutomaticPreviews is set to true, only the manual previews and thumbnails of the original file version(s) will be copied. The automatically generated previews and thumbnails will not be copied to the new record; a maintenance job will be submitted to regenerate them.
Keep in mind, if the original file version had an automatically generated master preview, the master preview of the copied item will be the first image generated by that maintenance job.

For a more detailed example of values that can be provided when creating records, see: Editing a record
See also: Immediate propagation for record updates
Duplicating a record as draft
If header makeFileNamesUnique is set to True, then all file version file names will be updated - Copy {index} will be added to make file names unique across system, i.e. original Copy, original Copy 1, original Copy 2 and so on. If header makeFileNamesUnique is set to False (default value), then all file version file names will be same as in original record. If header usePreviewsFromSource is set to True, then for created in-memory duplicate record, we will update URI's for all Previews\Thumbnails\Additional Files to its matching pairs from original record.
You can also specify the copyRelationshipField header which allows to relate original record and the copy via record link field with OneParentManyChildren Link Type. In the copy the original record will be set as parent in that field.
POST /records/edits

copyFrom: 41f8115dd9714b27b5d8b7f1c1285d07
makeFileNamesUnique: true
usePreviewsFromSource: true
copyRelationshipField: Name of Record Link Field