List documents for a deployment policy

GET

/v2/deploymentPolicies/:deploymentPolicyId/files

Usage notes

Retrieve the deploymentPolicyId from the /v2/deploymentPolicies endpoint.
If the user associated with the API key does not have access to the document, the inode field is null.
The inode field is one of workbook, dataModel, report, or folder. Use the type field to determine which shape is returned and which ID field is present.
Folders are returned as a single entry. The documents they contain are not listed individually.

Usage scenarios

Review and audit documents deployed to specific tenant organizations.

List documents for a deployment policy ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint. - If the user associated with the API key does not have access to the document, the `inode` field is `null`. - The `inode` field is one of `workbook`, `dataModel`, `report`, or `folder`. Use the `type` field to determine which shape is returned and which ID field is present. - Folders are returned as a single entry. The documents they contain are not listed individually. ### Usage scenarios - Review and audit documents deployed to specific tenant organizations.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

deploymentPolicyIdstringRequired

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPageTokenstringOptional

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.

1	{
2	"entries": [
3	{
4	"inodeId": "string",
5	"inode": null,
6	"deploymentPolicyId": "string"
7	}
8	],
9	"nextPageToken": "string"
10	}