Skip to navigation
Sigma REST APIFiles{inodeId}

Update a file

View as Markdown

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

inodeIdstringRequired

Request

The request body.
namestringOptional
descriptionstringOptional
ownerIdstringOptional
parentIdstringOptional
Folder ID to contain the folder or document
restorebooleanOptional

Response

The response body.
idstring
urlIdstring
namestring
typeenum
parentIdstring
parentUrlIdstring
permissionenum
pathstring
badgestring or null
isArchivedboolean
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
descriptionstringOptional
ownerIdstring or nullOptional
parentSourceUrlIdstringOptional

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.