Sign in

v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Get public link

Get an embed or download link to a single asset

get/getlink_4HZ_v1

Query parameters

RecordIDstring

The record ID of an asset.<br>This parameter <b>or</b> the Identifier parameter is required.

Identifierstring

The <a href="https://developer.orangelogic.com/reference/assets">Unique Identifier</a> of an asset.<br>This parameter <b>or</b> the RecordID parameter is required.

Formatstring

The code of the <a href="https://developer.orangelogic.com/reference/assets#formats">asset format</a> that you want to generate a link for (TRX, TR1, etc.).

StickToCurrentVersionboolean

<code>True</code>: The link will point to the current version.</br><code>False</code>: The link will always point to the most recent version of the asset.

LogViewsboolean

Whether OrangeDAM logs each view or download. Administrators can view this information in the Full logs of views and downloads. Orange Logic users with a Link account can go to the <a href="https://link.orangelogic.com/CMS4/Permalinks/2P7YOHA7V1MI" target="_blank">Full logs of views and downloads</a> article to learn more.

CreateDownloadLinkboolean

<code>True</code>: The link downloads the assets.</br><code>False</code>: The link will be an embed link.

ExpirationDatestring

An expiration date in the <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format: "YYYY-MM-DDTHH:MM:SS.SSSZ" The [<i>sss</i>] value is optional. It represents the <a href="https://en.wikipedia.org/wiki/UTC_offset" target="_blank">UTC offset</a>. Example: "2024-10-31T13:44:39.735Z"

MaxWidthinteger

The maximum width of the asset.<br>If you are generating transformations, the transformation crop or resize takes precedence over MaxWidth.

MaxHeightinteger

The maximum height of the asset.<br>If you are generating transformations, the transformation crop or resize takes precedence over MaxHeight.

FileExtensionstring

The file extension of the asset (.jpeg, .png, etc.).

ImageResizingMethod'Fit' | 'Stretch' | 'NorthwestCrop' | 'NorthCrop' | 'NortheastCrop' | 'WestCrop' | 'CenterCrop' | 'EastCrop' | 'SouthwestCrop' | 'SouthCrop' | 'SoutheastCrop' | 'OpticalCrop' | 'AICrop'

Resizes the image's aspect ratio based on <code>Maxwidth</code> and <code>MaxHeight</code>.

Transformationsstring[]

Enter a string for each transformation you want to apply to the asset. Transformations are applied in the order in which they appear in the string and take precedence over <code>Maxwidth</code> and <code>MaxHeight</code>. <br>See the <a href="https://developer.orangelogic.com/reference/transformation-example">transformation example</a> for more information.

Titlestring

Title of the asset link

namestring

The UTM name, such as utm_source or utm_campaign.

valuestring

The UTM value, such as Instagram.

{ "name": "string", "value": "string" }

CustomAccessKeystring

Enter a <a href="https://developer.orangelogic.com/reference/assets">custom access key</a> to use for the generated link. If this is not specified, the link will have a random access key.

IsVideoboolean

Set to true if the asset is a video.

Response

200

recordIDstring
identifierstring
formatstring
linkstring
maxWidthinteger
{"stackTrail":"paths:/getlink_4HZ_v1:get:responses:200:content:application/json:schema:properties:maxHeight","oasType":"schema","type":"unknown"}
expirationDatestring
fileExtensionstring
{"stackTrail":"paths:/getlink_4HZ_v1:get:responses:200:content:application/json:schema:properties:imageResizingMethod","oasType":"schema","type":"unknown"}

Example response

{
  "recordID": "2RBKT7UG4BTS",
  "identifier": "CTL531031",
  "format": "TR1",
  "link": "https://mangovations.com/AssetLink/pse8t3wh5q00rj33m441x5k561l817a7.png",
  "maxWidth": 1000,
  "expirationDate": "2028-12-31T11:59:59",
  "fileExtension": ".png"
}