Item Report Using REST API

List all Items

Use the following call to list all items for all jobs.

GET {{url}}v1/transfers/items

List all Items for a job

GET {{url}}v1/transfers/{{job}}/items?fields=all

List all files and folders for a specific job

GET {{url}}v1/transfers/items?jobs={{job}}&fields=all

List Items by Parent Folder

For a given job, this call returns all items within a folder.

List Items for a Job by Status 

Statuses for REST API calls include:

  • none[0]: No remediation flag has been applied to the item.

  • success[1]: Item was moved successfully with no modifications by DryvIQ.

  • skipped: Item was skipped due to a policy configuration defined in your job such as Large Item Policy or Duplicate Name Policy.

  • processed[2]: Item was reviewed and changed by DryvIQ during transfer. See processed statuses section below for further details.

  • remediation: DryvIQ could not transfer the item and it was flagged for manual remediation. This is the status you would use to get all flagged items.

  • retry: DryvIQ could not transfer the item and flagged it for retry. Default retry attempts is set to 3.

  • pending: Item has not finished transferring to the destination. If a job is paused or canceled, an item could go to a pending status as well.

List Items by Processed Status

Processed status means the item was reviewed and changed by DryvIQ during transfer.

Processed statuses include:

  • none: No processing has occurred on the item.

  • filtered: Item was filtered by DryvIQ to meet Job Filter configurations defined in your job (Job Filters).

  • skipped: Item was skipped due to a policy configuration defined in your job such as Large Item Policy or Duplicate Name Policy.

  • truncated: Item was modified by DryvIQ to conform to the destination platform requirements such as Segment Transformation Policy.

  • converted: Item was compressed into a zip file by DryvIQ because the item is not supported on the destination (Restricted Content).

  • conflict_copy: A copy of the item was created due to the policy configuration defined in your job (Conflict Policy).

  • access_rules: Permissions were applied to an item (Permissions Import).

  • metadata: Metadata was applied to an item (Metadata Import).

  • unmapped: DryvIQ was not able to map permissions or owner of the item.

List Items for a Job by Transfer Audit Category

  • Failed: Indicates the job audit log has captured one or more error entries.

  • Warning: Indicates the job audit log has captured one or more warning entries.

List all audit categories

List all items for a specific job and category

Get items for a Job formatted as CSV

All of the previous parameters can be added to this URL.

List all items for a specific job in .csv format

Example Response

 

 

 

DryvIQ Platform Version: 5.9.2
Release Date: December 17, 2024