Get workbook schema

Deprecated

GET

/v2/workbooks/:workbookId/schema

The Workbook Schema API is deprecated as of December 15, 2023. This endpoint is no longer compatible with workbook layouts. Workflows that use this endpoint must be replaced with the new endpoints listed below. The components in Workbook Schema API are available through individual endpoints to minimize the retrieval of unnecessary data. - [GET v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/listworkbookpages) - [GET v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/listworkbookpageelements) - [GET v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/listworkbookqueries) - [GET v2/workbooks/{workbookId}/elements/{elementId}/query](https://help.sigmacomputing.com/reference/getelementquery)

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

includeSqlbooleanOptional

tagstringOptional

Response

The response body.

workbookIdstring

Unique identifier of the workbook.

workbookUrlIdstring

pagesmap from strings to any

sheetsmap from strings to any

variablesmap from strings to any

elementsmap from strings to any

sqlQueriesmap from strings to strings

sqlQueryErrorsmap from strings to objects

1	{
2	"workbookId": "88889999-aaaa-bbbb-cccc-ddddeeeeffff",
3	"workbookUrlId": "57a96EMo3GVJG73179MV2l",
4	"pages": {
5	"page1": "[Object Page_t]"
6	},
7	"sheets": {
8	"sheet1": "[Object Sheet_t]"
9	},
10	"variables": {
11	"variable1": "[Object Variable_t]"
12	},
13	"elements": {
14	"element1": "[Object Element_t]",
15	"element2": "[Object Element_t]"
16	},
17	"sqlQueries": {
18	"element1": "SELECT customerID, sum(AMOUNT) FROM ORDERS GROUP BY customerID"
19	},
20	"sqlQueryErrors": {
21	"element2": {
22	"message": "SQL compilation error: xxx"
23	}
24	}
25	}

$	curl https://api.sigmacomputing.com/v2/workbooks/workbookId/schema \
>	-H "Authorization: Bearer <token>"