Items Report Using REST API

Learn how to view the Items report for migration jobs using the DryvIQ REST API.


Overview

The Migrate Items report is available when viewing information for individual jobs and when viewing roll-up reports.  The Items report lists all items analyzed for the job(s) and the status of each item. The job overview statistics can be viewed by files or by folders, but the item statistics aggregate all items, including the files, folders, and the root folder.

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

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

List Items for a Job by Status

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

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.

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

Processed statuses include:

  • none: No processing has occurred on the item.
  • filtered: The item was filtered by DryvIQ to meet Job Filter configurations defined in your job (Job Filters).
  • skipped: The item was skipped due to a policy configuration defined in your job, such as the  Large Item Policy or Duplicate Name Policy.
  • truncated: DryvIQ modified the item to conform to the destination platform requirements, such as the Segment Transformation Policy.
  • converted: DryvIQ compressed the item into a ZIP file because it 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 unable to map permissions or the 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

GET {{url}}v1/transfers/categories?priority=all

List all items for a specific job and category

GET {{url}}v1/transfers/{{job}}/items?fields=all&audit_categories={{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

GET {{url}}v1/transfers/{{job}}/items.csv

Example Response

transferred_on,status,item_type,direction,source_id,source_name,source_path,source_bytes,source_version,source_hash,source_exists,destination_id,destination_name,destination_path,destination_bytes,destination_version,destination_hash,destination_exists,category_id,retried
2018-03-21T18:16:59+00:00,success,"",->,"",do-not-delete-many-files,"/",0,"","",True,"",destination,"/",0,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",1 - Copy - Copy - Copy (2) - Copy - Copy.txt,"/1 - Copy - Copy - Copy (2) - Copy - Copy.txt",16,"","",True,"",1 - Copy - Copy - Copy (2) - Copy - Copy.txt,"/1 - Copy - Copy - Copy (2) - Copy - Copy.txt",16,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",1 - Copy - Copy - Copy - Copy (2) - Copy.txt,"/1 - Copy - Copy - Copy - Copy (2) - Copy.txt",16,"","",True,"",1 - Copy - Copy - Copy - Copy (2) - Copy.txt,"/1 - Copy - Copy - Copy - Copy (2) - Copy.txt",16,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",1 - Copy - Copy - Copy - Copy - Copy - Copy.txt,"/1 - Copy - Copy - Copy - Copy - Copy - Copy.txt",16,"","",True,"",1 - Copy - Copy - Copy - Copy - Copy - Copy.txt,"/1 - Copy - Copy - Copy - Copy - Copy - Copy.txt",16,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",1 - Copy - Copy - Copy - Copy (2).txt,"/1 - Copy - Copy - Copy - Copy (2).txt",16,"","",True,"",1 - Copy - Copy - Copy - Copy (2).txt,"/1 - Copy - Copy - Copy - Copy (2).txt",16,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",1 - Copy - Copy - Copy - Copy.txt,"/1 - Copy - Copy - Copy - Copy.txt",16,"","",True,"",1 - Copy - Copy - Copy - Copy.txt,"/1 - Copy - Copy - Copy - Copy.txt",16,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",1 - Copy - Copy - Copy - Copy - Copy.txt,"/1 - Copy - Copy - Copy - Copy - Copy.txt",16,"","",True,"",1 - Copy - Copy - Copy - Copy - Copy.txt,"/1 - Copy - Copy - Copy - Copy - Copy.txt",16,"",""
2018-03-21T18:16:59+00:00,success,"",->,"",filetoupload.txt,"/filetoupload.txt",16,"","",True,"",filetoupload.txt,"/filetoupload.txt",16,"",""