Restore a workbook to a previous version

POST

/v2/workbooks/:workbookId/restoreVersion

POST

/v2/workbooks/:workbookId/restoreVersion

$ curl -X POST https://api.sigmacomputing.com/v2/workbooks/workbookId/restoreVersion \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "version": 1.1
> }'

200Successful

1 {
2   "workbookId": "string",
3   "workbookUrlId": "string",
4   "name": "string",
5   "url": "string",
6   "path": "string",
7   "latestVersion": 1.1,
8   "ownerId": "string",
9   "createdBy": "string",
10   "updatedBy": "string",
11   "createdAt": "2024-01-15T09:30:00Z",
12   "updatedAt": "2024-01-15T09:30:00Z",
13   "isArchived": true,
14   "tags": [
15     {
16       "versionTagId": "string",
17       "name": "string",
18       "sourceWorkbookVersion": 1.1,
19       "taggedWorkbookId": "string",
20       "workbookTaggedAt": "2024-01-15T09:30:00Z"
21     }
22   ],
23   "description": "string",
24   "taggedSourceUrlId": "string"
25 }

Restore a workbook to a previous version. Restoring publishes a new version with the same contents as the version restored and does not delete or overwrite any versions created.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve available version numbers by calling the /v2/workbooks/{workbookId}/version-history endpoint.

Restore a workbook to a previous version. Restoring publishes a new version with the same contents as the version restored and does not delete or overwrite any versions created. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve available **version** numbers by calling the [/v2/workbooks/{workbookId}/version-history](https://help.sigmacomputing.com/reference/get-version-history) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Request

The request body.

versiondoubleRequired

The document version to restore the workbook to.

Response

The response body.

workbookIdstring

Unique identifier of the workbook.

workbookUrlIdstring

namestring

urlstring

pathstring

latestVersiondouble

ownerIdstring

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.

isArchivedbooleanOptional

tagslist of objectsOptional

descriptionstringOptional

taggedSourceUrlIdstringOptional

For a workbook deployed to a tenant organization by a deployment policy with a version tag, the urlId of the original source workbook in the parent organization. Only present when includeTaggedSourceUrlId=true is included in the request.