Aprimo DAM REST API Documentation

Route	Description	Parameters
/	Root of the API
/accesslist/{accessListId}	Read a single access list	accessListId : id of the content type
/accesslists	Read a collection of accessLists
/additionalfile/{additionalFileId}	Read a single additional file	additionalFileId : id of the file version
/additionalfile/{additionalFileId}/filepreviews	Read all previews of an additional file	additionalFileId : id of the additional file
/additionalfile/{additionalFileId}/filePreviews/{filePreviewId}	Read preview of an additional file	additionalFileId : id of the additional file filePreviewId : id of the additional file preview
/additionalfile/{additionalFileId}/preview		additionalFileId :
/additionalfile/{additionalFileId}/publiclink		additionalFileId :
/annotation/{annotationId}	Read a single annotation	annotationId : id of the annotation
/annotations	Read a collection of annotations
/CalculatedPermission/{CalculatedPermissionName}	Read a single calculated permission by its name	calculatedPermissionName : name of the permission
/calculatedpermissions	Read a collection of calculated permissions	names :
/classification	Read a single classification using a unique field and its value	fieldName : name of the unique field fieldValue : Value of the field. If a numeric field value is specified, make sure to enter this value as a Culture Invariant string.
/classification	Read a single classification by namePath	namePath : namePath of the classification
/classification/{classificationId}	Read a single classification by id	classificationId : id of the classification
/classification/{classificationId}/ancestors	Read all the parents of a classification	classificationId : id of the classification
/classification/{classificationId}/children	Read all the children of a classification	classificationId : id of the classification
/classification/{classificationId}/classificationtreepermission	Read all the permissions on a classification	classificationId : id of the classification
/classification/{classificationId}/classificationtreepermissions	Read the classification tree permissions of a classification	classificationId : id of the classification
/classification/{classificationId}/downloadpermissions	Read the download permissions of the classification	classificationId : id of the classification
/classification/{classificationId}/field/{fieldId}	Read a single field of a classification	classificationId : id of the classification fieldId : id of the field
/classification/{classificationId}/fields	Read all fields of a classification	classificationId : id of the classification
/classification/{classificationId}/followerclassifications	Read the list of follower classifications for the classification	classificationId : id of the classification
/classification/{classificationId}/image	Read the image of a classification	classificationId : id of the classification
/classification/{classificationId}/parent	Read the parent of a classification	classificationId : id of the classification
/classification/{classificationId}/recordpermissions	Read the record permissions of a classification	classificationId : id of the classification
/classification/{classificationId}/slaveclassifications	Read the list of slave classifications for the classification	classificationId : id of the classification
/classifications	Read a collection of classifications
/collection/{collectionId}	Read a single collection	collectionId : id of the collection
/collection/{collectionId}/comment/{commentId}	Read a comment on the collection	collectionId : id of the collection commentId : id of the comment
/collection/{collectionId}/comments	Read the comments of the collection	collectionId : id of the collection
/collection/{collectionId}/comments/status	Gets the count of unread comments of a collection.	collectionId : Id of the collection
/collection/{collectionId}/permissions	Read the permissions of the collection	collectionId : id of the collection
/collection/{collectionId}/records	Read the records of the collection	collectionId : id of the collection
/collections	Read a collection of collections
/ContentType	Read a single content type by name	name : The name of the content type
/contenttype/{contentTypeId:guid}	Read a single content type	contentTypeId : id of the content type
/contenttype/{contentTypeId:guid}/parent	Read the parent of a record	contentTypeId : id of the content type
/contenttypes	Read a collection of content types
/contenttypes/info	Read a collection of content types basic info
/counters	Show all counters
/csp
/download	Retrieve binary content of a file using secure download token	token : Reference token to the file
/downloadlink/{downloadLinkId}	Read a single download link	downloadLinkId : id of the download link
/downloadlink/{downloadLinkId}/targets	Read all targets of a download link	downloadLinkId : id of the download link
/downloadlinks	Read a collection of download links
/fielddefinition/{fieldDefinitionId}	Read a single field definition	fieldDefinitionId : id of the field definition
/fielddefinitions	Read a collection of field definitions
/fieldgroup/{fieldGroupId}	Read a single field group	fieldGroupId : id of the field group
/fieldgroup/{fieldGroupId}/createdby	Get a user that created the field group	fieldGroupId : id of the field group
/fieldgroup/{fieldGroupId}/members	Get the members of the field group	fieldGroupId : id of the field group
/fieldgroup/{fieldGroupId}/modifiedby	Get a user that last modified the field group	fieldGroupId : id of the field group
/fieldgroups	Read a collection of field groups
/file/{fileId}	Read a file	fileId : id of the file
/file/{fileId}/field/{fieldId}	Read a single field of a file	fileId : id of the file fieldId : id of the field
/file/{fileId}/fields	Read all fields of a file	fileId : id of the file
/file/{fileId}/fileversions	Read all file versions of a file	fileId : id of the file
/file/{fileId}/image/preview	Read the preview of this file	fileId : id of the file
/file/{fileId}/image/thumbnail	Read the thumbnail of this file	fileId : id of the file
/file/{fileId}/latestversion	Read the latest file version	fileId : id of the file
/file/{fileId}/watermark	Read the watermark of a file	fileId : id of the file
/filepreview/{filePreviewId}	Read the preview of a file	filePreviewId : id of the file preview
/filepreview/{filePreviewId}/image/preview	Read the preview from a filepreview	filePreviewId : id of the filepreview
/filepreview/{filePreviewId}/image/thumbnail	Read the thumbnail from a filepreview	filePreviewId : id of the filepreview
/filetype/{fileTypeId}	Read a single file type	fileTypeId : id of the file type
/filetype/{fileTypeId}/image/icon	Read the icon of the filetype	fileTypeId : id of the filetype
/filetype/{fileTypeId}/image/thumbnail	Read the thumbnail of the filepreview of a filetype	fileTypeId : id of the filetype
/filetypes	Read a collection of file types
/fileversion/{fileVersionId}	Read a single file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/additionalfiles	Read all additional files of a file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/duplicateinfo	Read the full duplicate info for the file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/filepreviews	Read all previews of a fileversion	fileVersionId : id of the fileversion
/fileversion/{fileVersionId}/filetype	Read the file type for file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/image/preview	Read the preview of the filepreview of a fileversion	fileVersionId : id of the fileversion
/fileversion/{fileVersionId}/image/thumbnail	Read the thumbnail of the filepreview of a fileversion	fileVersionId : id of the fileversion
/fileversion/{fileVersionId}/linkedversions/{linkedVersionType}	Read the publications the <paramref name="fileVersionId" /> is used in	fileVersionId : id of the file version linkedVersionType : The type of link
/fileversion/{fileVersionId}/masterfilepreview	Read the master filepreview of a file version	fileVersionId : id of the fileversion
/fileversion/{fileVersionId}/permissions	Read the permissions on a file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/publiclinks		fileVersionId :
/fileversion/{fileVersionId}/publicuris	Read the public uris for the file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/renditions	Read all renditions of a file version	fileVersionId : id of the file version
/fileversion/{fileVersionId}/watermark	Read the watermark of a file version	fileVersionId : id of the file version
/imageoverlay/{imageOverlayId}		imageOverlayId :
/imageoverlay/{imageOverlayId}/classifications	Read all classifications of an image overlay	imageOverlayId : id of the image overlay
/imageoverlay/{imageOverlayId}/usergroups	Read all ImageOverlay user groups of a ImageOverlay	imageOverlayId : id of the ImageOverlay
/imageoverlays
/info
/language/{languageId}	Read a single language	languageId : id of the language
/language/{languageId}/image	Read the image of a language	languageId : id of the language
/language/{languageId}/synonyms	Shortcut to download the exported list of synonyms	languageId : id of the language
/languages	Read a collection of languages
/maintenancejob/{maintenanceJobId}	Read a single maintenance job	maintenanceJobId : id of the maintenance job
/maintenancejob/{maintenanceJobId}/target/{maintenanceTargetId}	Reads a single maintenance target	maintenanceJobId : id of the maintenance job maintenanceTargetId : id of the maintenance target
/maintenancejob/{maintenanceJobId}/targets	Read all targets of a maintenance job	maintenanceJobId : id of the maintenance job
/maintenancejobs	Read all maintenance jobs.
/order/{orderId}	Read a single order	orderId : id of the order
/order/{orderId}/target/{orderTargetId}	Read a single order	orderId : id of the order orderTargetId : id of the order target
/order/{orderId}/targets	Read all targets of an order	orderId : id of the order
/orders	Read a collection of users
/permission/{permissionName}	Read a single permission by its name	permissionName : namePath of the classification
/permissions	Read a collection of permissions
/publiclink/{publicLinkId}	Read a single file type	publicLinkId : id of the public link
/publiclinks/domain
/publiclinks/domain/tlsstatus
/publicuri/{publicUriId}	Read a single file type	publicUriId : id of the public link
/record	Read a single record using a unique field and its value	fieldName : Name of the unique field fieldValue : Value of the field. If a numeric field value is specified, make sure to enter this value as a Culture Invariant string.
/record	Read a single record using a file id	fileId : Value of the file id
/record/{objectId}/trail	Read the audit trail of an object, with optional type filter	objectId : filter :
/record/{objectId}/trail/entry/{entryId}	Reads audit particular entry	objectId : entryId :
/record/{recordId}	Read a single record	recordId : id of the record
/record/{recordId}/classification/{classificationId}	Read a single record classification of a record	recordId : id of the record classificationId : id of the target classification (not the id of record classification)
/record/{recordId}/classifications	Read all record classifications of a record	recordId : id of the record
/record/{recordId}/duplicateinfo	Read the full duplicate info for the latest file version of the record	recordId : id of the record newFileName :
/record/{recordId}/field/{fieldId}	Read a single field of a record	recordId : id of the record fieldId : id of the field
/record/{recordId}/field/{fieldId}/listvalues	Read a single field of a record	recordId : id of the record fieldId : id of the field
/record/{recordId}/fields	Read all fields of a record	recordId : id of the record
/record/{recordId}/files	Read all files of a record	recordId : id of the record
/record/{recordId}/image/preview	Read the preview of a record	recordId : id of the record
/record/{recordId}/image/preview/download	Shortcut to download the binary content of related preview	recordId : id of the record
/record/{recordId}/image/thumbnail	Read the thumbnail of a record	recordId : id of the record
/record/{recordId}/image/thumbnail/download	Shortcut to download the binary content of related thumbnail	recordId : id of the record
/record/{recordId}/locks	Get locks by record id	recordId : id of the record
/record/{recordId}/masterfile	Read the masterfile of a record	recordId : id of the record
/record/{recordId}/masterfilelatestversion	Read the latest version of the masterfile of a record	recordId : id of the record
/record/{recordId}/permissions	Read all the permissions on a record	recordId : id of the record
/record/edits/{editToken}		editToken :
/record/operations/checkout	Returns status of download order created after check out
/records	Read a collection of records
/rendition/{renditionId}	Read a single rendition	renditionId : id of the file version
/rendition/{renditionId}/publiclinks	Read the public links for the rendition	renditionId : id of the rendition
/rule/{ruleId}	Read a single rule	ruleId : id of the rule
/rule/{ruleId}/actions	Get the actions of the rule	ruleId : id of the rule
/rule/{ruleId}/conditions	Get the conditions of the rule	ruleId : id of the rule
/rule/{ruleId}/createdby	Get a user that created the rule	ruleId : id of the rule
/rule/{ruleId}/modifiedby	Get a user that last modified the rule	ruleId : id of the rule
/rules	Read a collection of rules
/searchindex	Returns search index status
/setting/{settingName}	Read a single setting More info	settingName : name of the setting scope : scope of the setting scopeId : id within the scope
/settingcategories	Read a collection of setting categories resource.
/settingcategory/{settingcategoryId}	Read a single setting category resource.	settingcategoryId : id of the setting category
/settingdefinition/{settingdefinitionId}	Read a single settingdefinition resource.	settingdefinitionId : id of the settingdefinition
/settingdefinitions	Read a collection of settingdefinitions resource.
/settings	Read a collection of settings	names :
/statistics	Get the statistics
/subscription	Read a single subscription by its objectId, userId and type	objectId : subscribed record userId : Subscribed user subscriptionType : Type of subscription
/subscription/{objectId:guid}	Read a single subscription	subscriptionId : The id of the subscription
/subscriptions	Read the subscribed users	objectId : subscribed record subscriptionType : Type of subscription objectType : Type of object
/supportedversions	Read all supported versions of the API
/supportedversions/{version}	Read the details of single supported version	version : version of the API
/translation	Reads a single translation by its key.	studio : studio name for the translation module : module name for the translation name : name of the element that should be translated
/translation/{translationId}	Reads a single translation.	translationId : id of the translation
/translations	Reads all translations.
/uniquekeyindex	Returns search index status
/user/{userId}	Read a single user	userId : id of the user
/user/{userId}/field/{fieldId}	Read a single field of a user	userId : id of the user fieldId : id of the field
/user/{userId}/fields	Read all fields of a user	userId : id of the user
/user/{userId}/image	Read the picture of this user	userId : id of the user
/user/{userId}/memberships	Read all fields of a user	userId : id of the user
/user/{userId}/permissions	Read all permissions of a user	userId : id of the user
/usergroup/{userGroupId}	Read a single user group	userGroupId : id of the user group
/usergroup/{userGroupId}/permissions	Read all permissions of a userGroup	userGroupId : id of the userGroup
/usergroups	Read all user groups
/users	Read a collection of users
/watermark/{watermarkId}	Read a single watermark.	watermarkId : id of the watermark
/watermark/{watermarkId}/image	Read the image of a watermark.	watermarkId : id of the watermark
/watermarks	Read all watermarks.