Sign in
Shortcuts

List shortcuts

List shortcuts editable/owned by the currently authenticated user.

post/rest/api/v1/listshortcuts

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

includeFieldsstring[]

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

pageSizeinteger required
cursorstring

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)

querystring

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

Example request

{
  "pageSize": 10,
  "filters": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ]
}

Response

OK

Example response

{
  "shortcuts": [
    {
      "addedRoles": [
        {
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          }
        }
      ],
      "removedRoles": [
        {
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          }
        }
      ],
      "createdBy": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      },
      "updatedBy": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      },
      "destinationDocument": {
        "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": {
              "stringValue": "someCustomValue"
            }
          }
        }
      },
      "roles": [
        {
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          }
        }
      ]
    }
  ],
  "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"
            }
          }
        }
      ],
      "groupName": "Service Cloud"
    }
  ]
}

Changes