Skip to navigation
Sigma REST APITenants{tenantOrganizationId}

Get deployed workbook in tenant org (Beta)

View as Markdown

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

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

tenantOrganizationIdstringRequired

Query parameters

parentWorkbookIdstringOptional

Unique identifier of the workbook in the parent organization. For version-tagged deployments, this can be either the source workbook ID or the version-tagged workbook ID.

deploymentPolicyIdstringOptional
The ID of the deployment policy that contains the workbook

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