Get public link

get

https://{OrangeLogicURL}/webapi/objectmanagement/share/getlink_4HZ_v1

Get an embed or download link to a single asset

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Here is an example call using sample values for each of the query parameters described in the table below.

Example call

https://mangovations.com/webapi/objectmanagement/share/getlink_4HZ_v1?Identifier=CTL531031&Format=TR1&StickToCurrentVersion=true&LogViews=true&CreateDownloadLink=true&ExpirationDate=2024-12-31T11%3A59%3A59&MaxWidth=1000&FileExtension=.png

Query Params

RecordID

string

The record ID of an asset.
This parameter or the Identifier parameter is required.

Identifier

string

The Unique Identifier of an asset.
This parameter or the RecordID parameter is required.

Format

string

The code of the asset format that you want to generate a link for (TRX, TR1, etc.).

StickToCurrentVersion

boolean

True: The link will point to the current version.
False: The link will always point to the most recent version of the asset.

LogViews

boolean

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 Full logs of views and downloads article to learn more.

CreateDownloadLink

boolean

True: The link downloads the assets.
False: The link will be an embed link.

ExpirationDate

string

An expiration date in the ISO 8601 format: "YYYY-MM-DDTHH:MM:SS.SSSZ" The [sss] value is optional. It represents the UTC offset. Example: "2024-10-31T13:44:39.735Z"

MaxWidth

int32

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

MaxHeight

int32

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

FileExtension

string

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

ImageResizingMethod

string

enum

Resizes the image's aspect ratio based on Maxwidth and MaxHeight.

Transformations

array of strings

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 Maxwidth and MaxHeight.
See the transformation example for more information.

Transformations

Title

string

Title of the asset link

TrackingParameters

object

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

CustomAccessKey

string

Enter a custom access key to use for the generated link. If this is not specified, the link will have a random access key.

IsVideo

boolean

Set to true if the asset is a video.

Response

200200