| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
Optional<Long> | ➖ | The opaque id of the user generated content. | |
inputAlias |
String | ✔️ | Link text following go/ prefix as entered by the user. | |
destinationUrl |
Optional<String> | ➖ | Destination URL for the shortcut. | |
destinationDocumentId |
Optional<String> | ➖ | Glean Document ID for the URL, if known. | |
description |
Optional<String> | ➖ | A short, plain text blurb to help people understand the intent of the shortcut. | |
unlisted |
Optional<Boolean> | ➖ | Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. | |
urlTemplate |
Optional<String> | ➖ | For variable shortcuts, contains the URL template; note, destinationUrl contains default URL. |
|
addedRoles |
List<UserRoleSpecification> | ➖ | A list of user roles added for the Shortcut. | |
removedRoles |
List<UserRoleSpecification> | ➖ | A list of user roles removed for the Shortcut. | |
permissions |
Optional<ObjectPermissions> | ➖ | N/A | |
createdBy |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
createTime |
OffsetDateTime | ➖ | The time the shortcut was created in ISO format (ISO 8601). | |
updatedBy |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
updateTime |
OffsetDateTime | ➖ | The time the shortcut was updated in ISO format (ISO 8601). | |
destinationDocument |
Optional<Document> | ➖ | N/A | |
intermediateUrl |
Optional<String> | ➖ | The URL from which the user is then redirected to the destination URL. Full replacement for https://go/. | |
viewPrefix |
Optional<String> | ➖ | 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. | |
isExternal |
Optional<Boolean> | ➖ | Indicates whether a shortcut is native or external. | |
editUrl |
Optional<String> | ➖ | The URL using which the user can access the edit page of the shortcut. | |
alias |
Optional<String> | ➖ | canonical link text following go/ prefix where hyphen/underscore is removed. | |
title |
Optional<String> | ➖ | Title for the Go Link | |
roles |
List<UserRoleSpecification> | ➖ | A list of user roles for the Go Link. |