Permission Level Transfer Report Using REST API

Learn how to view the permissions transferred for a migration job using the DryvIQ REST API.

On This Page

Overview Get a Download Link View the CSV in the Response Override the Truncation Limit Requesting Specific Permissions Through REST API Example Requests

Overview

When exporting the report using a REST API call, you can receive a link through the call or view the CSV data within the response.

Get a Download Link

The following request produces a response that contains an href link. Copy and paste the link into your browser to download the CSV file.

GET {{url}}v1/transfers/permissions

View the CSV in the Response

The following request produces a response that contains the report information in CSV format within the body of the message.

GET {{url}}v1/transfers/permissions.csv

Override the Truncation Limit

Since the UI export only includes one million records, you can pull the report using the API to override the truncation limit. This is done by adding the page= and limit= parameters to the GET request. This allows you to pull the full report by page if needed.

GET {{url}}v1/transfers/permissions.csv?page=#&limit=#

Required Parameters

Be sure to include both the page= and limit= parameter. If you only add the page= parameter, the report results will default to 100 and not one million.

Requesting Specific Permissions Through REST API

You can request permissions by job, user/account map, item, audit trail, or a combination of each through the REST API. Each can be passed in as a query string parameter. See the examples below for usage.

Option	Description	Quert String Parameter	Example
Transfer Item IDs	The transfer item identifier for the item located on the source platform	"item" "item_id" "transfer_item_id" "items" "item_ids" "transfer_item_ids"	`GET {{url}}/v1/transfers/permissions?items`
Include	The indicator to include all	“all”	`GET {{url}}/v1/transfers/permissions?include=all`
Security Map IDs (ID assigned to a user through the User/Account map)	The identifier assigned to the user mapped in the job leveraging the user/account map	"security_map" "security_maps" "security_map_id" "security_map_ids"	`GET {{url}}/v1/transfers/permissions?security_map_ids`
Job IDs	The identifier assigned to the job transferring the permissions and content	"job" "jobs" "job_id" "job_ids"	`GET {{url}}/v1/transfers/permissions?jobs`
audit_trail	The audit category for content	“null” (the permissions are new and haven’t been applied to the destination) “created-by” “modified-by”	`GET {{url}}/v1/transfers/permissions?audit_trail`

Example Requests

The following examples show how to use the query parameters in combination.

In this example, the permission report request is for two jobs, three users, and one specific item (such as a folder).

GET {{url}}v1/transfers/permissions?include=all&job_ids={{job_id_1}},{{job_id_2}}&security_map_ids={{user_id_1}},{{user_id_2}},{{user_id_3}}&transfer_item_ids={{transfer_item_id_1}}

In this example, the permission report request will return all transfer permission levels by security map IDs for all items for a given job.

GET {{url}}/v1/transfers/permissions?security_map_ids-all&job_ids={{job_id}}