Skip to navigation

Add documents to a deployment policy

View as Markdown

Add documents to a deployment policy.

Usage notes

  • Retrieve the deploymentPolicyId from the /v2/deploymentPolicies endpoint.
  • To add workbooks to a deployment policy, retrieve the relevant workbookId from the /v2/workbooks endpoint.
  • To add data models to a deployment policy, retrieve the relevant dataModelId from the /v2/datamodels endpoint.
  • To add reports to a deployment policy, retrieve the relevant reportId from the /v2/reports endpoint.
  • To add folders to a deployment policy, retrieve the relevant folder ID from the /v2/files endpoint and review the id field in the response for files with a type of folder.
  • Adding a folder deploys the documents it contains. Templates cannot be added to a deployment policy.

Usage scenarios

  • Centrally manage documents that are deployed to specific tenant organizations.
  • Deploy an entire folder of documents to tenant organizations without listing each document individually.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

deploymentPolicyIdstringRequired
Unique identifier of the deployment policy.

Request

The request body.
inodeIdslist of stringsRequired
Unique identifier of the workbook, data model, report, or folder.

Response

The response body.