Get deployed workbook in tenant org (Beta)

GET

/v2/tenants/:tenantOrganizationId/workbooks

Retrieve the workbook ID for a workbook deployed to a tenant organization for a given parent workbook and deployment policy.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
The parent workbook must be part of the specified deployment policy.
The workbook must be deployed to the specified tenant organization.
Retrieve the tenantOrganizationId by calling the /v2/tenants endpoint.
Retrieve the deploymentPolicyId by calling the /v2/deploymentPolicies endpoint.
Retrieve the parentWorkbookId by calling the /v2/deploymentPolicies/{deploymentPolicyId}/files endpoint and using the workbookId included in the response.
For version-tagged deployment policies, you may pass either the source workbook ID or the version-tagged workbook ID as the parentWorkbookId.

Retrieve the workbook ID for a workbook deployed to a tenant organization for a given parent workbook and deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - The parent workbook must be part of the specified deployment policy. - The workbook must be deployed to the specified tenant organization. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint. - Retrieve the **deploymentPolicyId** by calling the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint. - Retrieve the **parentWorkbookId** by calling the [/v2/deploymentPolicies/{deploymentPolicyId}/files](https://help.sigmacomputing.com/reference/list-inodes-for-deployment) endpoint and using the `workbookId` included in the response. - For version-tagged deployment policies, you may pass either the source workbook ID or the version-tagged workbook ID as the **parentWorkbookId**.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

tenantOrganizationIdstringRequired

Query parameters

parentWorkbookIdstringOptional

deploymentPolicyIdstringOptional

Response

The response body.

workbookIdstring

Unique identifier of the workbook deployed to the tenant organization

workbookUrlstring

URL to access the workbook in the tenant organization

$	curl -G https://api.sigmacomputing.com/v2/tenants/tenantOrganizationId/workbooks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d deploymentPolicyId=dp-987f6543-e21b-45d6-b789-123456789abc \
>	-d parentWorkbookId=wb-123e4567-e89b-12d3-a456-426614174000

1	{
2	"workbookId": "wb-765e4321-b98a-21d3-c654-426614174999",
3	"workbookUrl": "https://app.sigmacomputing.com/orgs/org-9f8b7c6d5e4a3b2c/workbooks/wb-765e4321-b98a-21d3-c654-426614174999"
4	}