SIsigmacomputing
shortcuts

Create a shortcut

Create a shortcut that surfaces an existing item in another folder or workspace without duplicating it.

Usage notes

  • A shortcut requires a parentId (the folder or workspace to place it in) and a target (the item the shortcut points to).
    • Retrieve the ID of a folder to use as a parentId by calling the /v2/files endpoint and reviewing the id field in the response for files with a type of folder.
    • Retrieve the ID of a workspace to use as a parentId by calling the /v2/workspaces endpoint.
  • The target can be a document (workbook, data model, report, dataset, or folder) or a database object (table, view, schema, database, or stored procedure).
  • You must have at least Can view access to the target document or folder, or Can use access to the target database object.

Usage scenarios

  • Deployment and embedding: Surface shared workbooks or data models in tenant workspaces or folders without exposing a central workspace to end users.
post/v2/shortcuts

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

parentIdstring required

The ID of the folder or workspace to place the shortcut in.

namestring

A name for the shortcut. Defaults to the name of the item it points to if this field is omitted.

Response

The response body.

idstring required
urlIdstring required
namestring required
parentIdstring required
parentUrlIdstring required
pathstring required
ownerIdstring nullable
createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.