Flagged Items Using REST API

Learn how to view flagged items for migration jobs using the DryvIQ REST API.


Overview

Each item is a package, consisting of the media itself, version history, author, sharing, and any other metadata. DryvIQ ensures all pieces of the item package are transferred to the destination to preserve data integrity. If DryvIQ can't transfer an item, the item is set to retry. By default, DryvIQ will attempt to reconcile items that are in pending/retry status three times. Depending on your job configuration, this may occur with the defined schedule, or you can start the job manually. When an item is in a "flagged" status, DryvIQ has made all attempts to transfer the file without success, requiring manual remediation. These items can be retried or ignored on subsequent job runs. If an item is retried and successfully transferred, the item will be removed from the flagged items.

List All Flagged Items

Use this request to list all items with a flagged status for all jobs. After review, items can be set to retry or be ignored on subsequent job runs.

GET {{url}}v1/transfers/items/flagged

Set Single Item to Retry or Ignore

When an item is flagged, you can reset its status to either “retry” or “ignore” on the next job run.

Set Flagged Item for Retry

PATCH {{url}}v1/transfers/items/{{item_id}}?retry=1

Set Flagged Item to Ignore

PATCH {{url}}v1/transfers/items/{{item_id}}?ignore=1

Set Multiple Items to Retry or Ignore

When items are flagged, you can reset their status to either “retry” or “ignore” for the next job run using the same filter options available for viewing those items.

Set Flagged Items for Retry

PATCH {{url}}v1/transfers/items?parent={{parentId}}&retry

Set Flagged Items to Ignore

PATCH {{url}}v1/transfers/items?id={{itemId}},{{itemId}},{{itemId}}&ignore

Set Flagged Items to Ignore

PATCH {{url}}v1/transfers/items?jobs={{jobId}}&ignore

Set Flagged Items to Ignore

PATCH {{url}}v1/transfers/{{jobdid}}/items?ignore

List All Items Set to Retry or Ignore

The following requests will list all items from all jobs that are set for retry or to be ignored on subsequent runs.

List All Items Set to Retry

GET {{url}}v1/transfers/items?status=retry

List All Items Set to Ignore

GET {{url}}v1/transfers/items?status=skipped

Show All Items for Remediation

GET {{url}}v1/transfers/{{job}}/items?status=remediation&include=all

Show All System Error Categories

When issues occur during transfer, DryvIQ categorizes the issues based on the error and flags the items for manual remediation. This allows you to identify areas for review.

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

Create Custom Error Category by Audit Type

DryvIQ allows you to create a custom error category by audit type. For example, you could group several error codes to develop a broader category to ignore.

POST {{url}}v1/transfers/categories
{
   "name": "Unknown",
   "description": "Items with unknown errors",
   "filter": {
       "rules": [{
           "text": "[audit_type]=5001",
           "type": "filter_context"
       }]
   },
   "action": "retry",
   "max_retry": 3
}

Create Custom Error Category by Event Type

DryvIQ allows you to create a custom error category by event type. For example, you could group several events, such as rename and update, to create a broader category to retry.

POST {{url}}v1/transfers/categories
{
   "name": "Event Type Rename",
   "description": "The event source of the original transfer operation = Rename",
   "filter": {
       "rules": [{
           "text": "[event_type]=rename",
           "type": "filter_context"
       }]
   },
   "action": "retry",
   "max_retry": 3
}