ShortLinkService.getShortLink2 Method

Gets a short link from the specified long link.

Parameters

longLink

Type: String
The long link to get the short link for.

options

Type: Object

Additional parameters associated with the short link. Structure:
   categoryId         [type: String] - The ID of the category to which the short link corresponds, or NULL if the short
                      link does not correspond to a category.
   accountId          [type: String] - The ID of the account to which the short link corresponds, or NULL if the short
                      link does not correspond to a account.
   tenantId           [type: String] - The ID of the tenant to which the short link corresponds, or NULL if the short
                      link does not correspond to a tenant. Usually this is the tenant of the caller.
   fileSystemEntryId  [type: String] - The ID of the file system entry to which the short link corresponds, or NULL if the short
                      link does not correspond to a file system entry.
   timeToLive         [type: String] - A timespan-formatted string representing the amount of time the short link should be valid.
                      If not specified, the short link will never expire.

Optional: True

Return Value

Type: jQuery.Promise
A promise object that is resolved when the call is complete.

Remarks

If a category ID is specified, any existing link with the same category/account/file combination will be updated, rather than a new link being created.