Update a file

PATCH

/v2/files/:inodeId

PATCH

/v2/files/:inodeId

$ curl -X PATCH https://api.sigmacomputing.com/v2/files/inodeId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3   "urlId": "workspace-1234",
4   "name": "Marketing Analytics Workspace",
5   "type": "workspace",
6   "parentId": "00000000-0000-0000-0000-000000000000",
7   "parentUrlId": "root-folder",
8   "permission": "create",
9   "path": "/Marketing/Analytics",
10   "badge": "New",
11   "isArchived": false,
12   "createdBy": "user-1234abcd-5678-ef90-1234-abcdef567890",
13   "updatedBy": "user-1234abcd-5678-ef90-1234-abcdef567890",
14   "createdAt": "2024-01-15T09:30:00Z",
15   "updatedAt": "2024-04-20T14:45:00Z",
16   "description": "Workspace for marketing analytics projects and reports",
17   "ownerId": "user-7890abcd-1234-ef56-7890-abcdef123456",
18   "parentSourceUrlId": "source-doc-5678"
19 }

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.

Update a folder or document, such as a workbook, data model, or report. ### Usage notes - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-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](https://help.sigmacomputing.com/reference/list-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.

descriptionstring

ownerIdstring or null

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.