v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Create crop link

Create a link to a cropped version of an asset

get/v1.0/CreateCropLink

Query parameters

Identifierstring required

The asset's <a href="https://orangedam.readme.io/docs/assets#record-id">unique identifier</a>.

LogAccessboolean required

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 required

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

TopYstring required

Enter a value between 0 and 1 to reflect the ratio of the top Y coordinate of the crop to the height of the original image. Include a “0” before the decimal. </br>Example: 0.8

LeftXstring required

Enter a value between 0 and 1 to reflect the ratio of the left X coordinate of the crop to the width of the original image. Include a “0” before the decimal. </br>Example: 0.8

BottomYstring required

Enter a value between 0 and 1 to reflect the ratio of the bottom Y coordinate of the crop to the height of the original image. Include a “0” before the decimal. </br>Example: 0.8

RightXstring required

Enter a value between 0 and 1 to reflect the ratio of the right X coordinate of the crop to the width of the original image. Include a “0” before the decimal. </br> Example: 0.8

Heightinteger required

The height in pixels of the cropped image.

Widthinteger required

The width in pixels of the cropped image.

ApplyWatermarkboolean required

Whether a watermark is applied to the bottom-right corner of the cropped image.

ExpirationDatestring

An expiration <a href="https://developer.orangelogic.com/reference/date-and-time">date</a> in the format yyyy-MM-ddTHH:mm:ss

formatstring required

The response format (XML or JSON)

dateformatstring

Specify the output <a href="https://developer.orangelogic.com/reference/date-and-time">date format</a>.

Response

200