SIsigmacomputing
Files

Create a file

Create an empty workspace, folder, workbook, or report in Sigma.

Usage notes

  • Specify a parentId for a folder, workbook, or report to place it within another folder. Retrieve the ID 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.
  • Specify an ownerId for a folder, workbook, or report to create it on behalf of another user. Retrieve the memberId by calling the /v2/members endpoint.

Usage scenarios

  • Project onboarding: Start a new project by creating a workspace and folders to contain the workbooks for the project.
post/v2/files

Request

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

Request body

OR
OR
OR

Response

The response body.

idstring required
urlIdstring required
namestring required
type'workspace' | 'folder' | 'workbook' | 'dataset' | 'data-model' | 'sql' | 'worksheet' | 'dashboard' | 'template' | 'table' | 'symlink' | 'report' required
parentIdstring required
parentUrlIdstring required
permission'create' | 'annotate' | 'organize' | 'explore' | 'view' | 'edit' | 'apply' required
pathstring required
badgestring nullable required
isArchivedboolean required
descriptionstring
ownerIdstring nullable
parentSourceUrlIdstring

For a document deployed to a tenant organization, the urlId of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.

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.