When exporting the report using a REST API call, you have the option of receiving a link through the call or viewing 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
Requesting Specific Permissions Through REST API
Through the REST API, you have the option to request permissions by job, user/account map, item, audit trail, or a combination of each. Each can be passed in as a query string parameter. See the examples below for usage.
Option | Description | QUERY STRING PARAMETER | Example |
|---|---|---|---|
Transfer Item ID’s | 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 ID’s | 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 ID’s | 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 with each other.
In this example, the permission report request is for 2 jobs, for 3 users and 1 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 id’s for all items for a given job
GET {{url}}/v1/transfers/permissions?security_map_ids-all&job_ids={{job_id}}