Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
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.

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

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

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"

Code Block
GET {{url}}/v1/transfers/permissions?items

Include

The indicator to include all

“all”

Code Block
GET {{url}}/v1/transfers/permissions?include=all

Security Map ID’s
(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"

Code Block
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"

Code Block
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”

Code Block
GET {{url}}/v1/transfers/permissions?audit_trail

Example Requests

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

...