List shortcuts

post/listshortcuts

List shortcuts editable/owned by the currently authenticated user.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

Filters, sorters, paging params required for pagination

pageSize
required
integer
cursor
string

A token specifying the position in the overall results to start at. Received from the endpoint and iterated back. Currently being used as page no (as we implement offset pagination)

Array of objects (FacetFilter)

A list of filters for the query. An AND is assumed between different filters. We support filters on Go Link name, author, department and type.

includeFields
Array of strings

Array of fields/data to be included in response that are not included by default

Items Enum: "FACETS" "PEOPLE_DETAILS"
query
string

Search query that should be a substring in atleast one of the fields (alias , inputAlias, destinationUrl, description). Empty query does not filter shortcuts.

object (SortOptions)
Responses
200

OK

Response Schema: application/json
required
object (ShortcutsPaginationMetadata)
required
Array of objects (Shortcut)

List of all shortcuts accessible to the user

Array of objects (FacetResult)
400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "includeFields": [
    • "FACETS"
    ],
  • "pageSize": 10,
  • "cursor": "string",
  • "filters": [
    • {
      • "fieldName": "type",
      • "values": [
        • {
          • "value": "Spreadsheet",
          • "relationType": "EQUALS"
          },
        • {
          • "value": "Presentation",
          • "relationType": "EQUALS"
          }
        ]
      }
    ],
  • "sort": {
    • "orderBy": "ASC",
    • "sortBy": "string"
    },
  • "query": "string"
}
Response samples
application/json
{
  • "shortcuts": [
    • {
      • "id": 0,
      • "inputAlias": "string",
      • "destinationUrl": "string",
      • "destinationDocumentId": "string",
      • "description": "string",
      • "unlisted": true,
      • "urlTemplate": "string",
      • "addedRoles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "removedRoles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "permissions": {
        • "write": {
          • "scopeType": "GLOBAL",
          • "create": true,
          • "update": true,
          • "delete": true
          }
        },
      • "createdBy": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "createTime": "2019-08-24T14:15:22Z",
      • "updatedBy": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "updateTime": "2019-08-24T14:15:22Z",
      • "destinationDocument": {
        • "id": "string",
        • "datasource": "string",
        • "connectorType": "API_CRAWL",
        • "docType": "string",
        • "content": {
          • "fullTextList": [
            • "string"
            ]
          },
        • "containerDocument": { },
        • "parentDocument": { },
        • "title": "string",
        • "url": "string",
        • "metadata": {
          • "container": "container",
          • "parentId": "JIRA_EN-1337",
          • "createTime": "2000-01-23T04:56:07.000Z",
          • "datasource": "datasource",
          • "author": {
            • "name": "name"
            },
          • "documentId": "documentId",
          • "updateTime": "2000-01-23T04:56:07.000Z",
          • "mimeType": "mimeType",
          • "objectType": "Feature Request",
          • "components": [
            • "Backend",
            • "Networking"
            ],
          • "status": [
            • "Done"
            ],
          • "customData": {
            • "someCustomField": "someCustomValue"
            }
          },
        • "sections": [
          • {
            • "title": "string",
            • "url": "string"
            }
          ]
        },
      • "intermediateUrl": "string",
      • "viewPrefix": "string",
      • "isExternal": true,
      • "editUrl": "string",
      • "alias": "string",
      • "title": "string",
      • "roles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ]
      }
    ],
  • "facetResults": [
    • {
      • "sourceName": "container_name",
      • "operatorName": "SelectMultiple",
      • "buckets": [
        • {
          • "count": 1,
          • "datasource": "jira",
          • "percentage": 5,
          • "value": {
            • "stringValue": "engineering",
            • "integerValue": 5,
            • "displayLabel": "engineering",
            • "iconConfig": {
              • "color": "#343CED",
              • "key": "person_icon",
              • "iconType": "GLYPH",
              • "name": "user"
              }
            }
          }
        ],
      • "hasMoreBuckets": false,
      • "groupName": "Service Cloud"
      }
    ],
  • "meta": {
    • "cursor": "string",
    • "hasNextPage": true,
    • "totalItemCount": 0
    }
}