SIsigmacomputing
Files

Update a file

Update a folder or document, such as a workbook, data model, or report.

Usage notes

  • Retrieve the inodeId by calling the /v2/files endpoint and using the id included in the response.
  • Specify a parentId to place the document within a 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.
  • To restore a deleted folder or document, set the restore parameter to true.
patch/v2/files/{inodeId}

Request

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

Path parameters

inodeIdstring required

Request body

namestring
descriptionstring
ownerIdstring
parentIdstring

Folder ID to contain the folder or document

restoreboolean

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.