API Reference

Generate a public Share link

post
https://{OrangeLogicURL}/webapi/objectmanagement/share/createsharelink_41M9_V1

Generate a link to share one or more assets

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

When you create a Share that doesn’t require much processing time, such as when you share a single asset, Orange Logic generates the link quickly and the call response includes the link.

When Orange Logic needs time to process the request and generate the link, the response includes an access key ID. Run another call using the access key to check the link generation status and retrieve the link when it is ready.

You need the APICreateShareLink Security Function to run this API call.

Body Params
string

The name of the share. For example, “Spring collection photoshoot.”

string

A description of the share. For example, “Photos and video for review.”

assetIDs
array of strings
required

The unique IDs of the assets included in the share.

assetIDs*
string
required

The expiration date of the share, entered as a yyyy-mm-ddThh:mm:ss string.

string

The format used for all image assets included in the share. You can specify only one image format for a share.

string

The format used for all audio assets included in the share. You can specify only one audio format for a share.

string

The format used for all video assets included in the share. You can specify only one video format for a share.

string
enum

The view permissions granted to the link recipient for all containers included in the share. Recipients must have at least View Small permission to see assets. When you choose a format other than small, recipients can access all proxy formats at the level you select and smaller.

Allowed:
string

The watermark applied to all assets included in the share. When this parameter is blank, no watermark is applied.

boolean
Defaults to true

When true, assets that cannot be watermarked (such as folders) are included in the share.

boolean
Defaults to true

When true, recipients can download the shared assets. This permission is granted even if the recipient wouldn’t otherwise be able to download the asset.

boolean
Defaults to true

When true, recipients with Orange Logic accounts can see the shared assets in the search results. This permission is granted even if the recipient wouldn’t otherwise be able to find the asset.

boolean
Defaults to true

When true, recipients can edit the shared assets’ metadata. This permission is granted even if the recipient wouldn’t otherwise be able to edit the asset.

boolean
Defaults to true
  • When true, no links are included in asset metadata.
  • When false, asset metadata that is configured to be displayed as clickable links is included with active links. For example, if asset tags are shown as links, users with Orange Logic accounts can click a tag to see all the assets that share that tag.
Response

Updated 6 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago