Skip to content

Latest commit

 

History

History
29 lines (26 loc) · 17.5 KB

shortcut.md

File metadata and controls

29 lines (26 loc) · 17.5 KB

Shortcut

Fields

Field Type Required Description Example
id Optional[int] ➖ The opaque id of the user generated content.
input_alias str ✔️ Link text following go/ prefix as entered by the user.
destination_url Optional[str] ➖ Destination URL for the shortcut.
destination_document_id Optional[str] ➖ Glean Document ID for the URL, if known.
description Optional[str] ➖ A short, plain text blurb to help people understand the intent of the shortcut.
unlisted Optional[bool] ➖ Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
url_template Optional[str] ➖ For variable shortcuts, contains the URL template; note, destinationUrl contains default URL.
added_roles List[models.UserRoleSpecification] ➖ A list of user roles added for the Shortcut.
removed_roles List[models.UserRoleSpecification] ➖ A list of user roles removed for the Shortcut.
permissions Optional[models.ObjectPermissions] ➖ N/A
created_by Optional[models.Person] ➖ N/A {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
create_time date ➖ The time the shortcut was created in ISO format (ISO 8601).
updated_by Optional[models.Person] ➖ N/A {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
update_time date ➖ The time the shortcut was updated in ISO format (ISO 8601).
destination_document Optional[models.Document] ➖ N/A
intermediate_url Optional[str] ➖ The URL from which the user is then redirected to the destination URL. Full replacement for https://go/.
view_prefix Optional[str] ➖ The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts.
is_external Optional[bool] ➖ Indicates whether a shortcut is native or external.
edit_url Optional[str] ➖ The URL using which the user can access the edit page of the shortcut.
alias Optional[str] ➖ canonical link text following go/ prefix where hyphen/underscore is removed.
title Optional[str] ➖ Title for the Go Link
roles List[models.UserRoleSpecification] ➖ A list of user roles for the Go Link.