Item Inspection Policy Using REST API
Learn how to manage the item inspection policy for migration jobs using the DryvIQ REST API.
Table of Contents
Overview
The Item Inspection Policy allows you to control the level of tracking and reporting for content that exists on both the source and destination platforms, including content that has been configured to be excluded from transfer and content that existed on the destination before the initial transfer. This feature categorizes items for reports on the job Validation tab. The inspection policy can be set for a job through the REST API within the job transfer block with the "item_inspection_policy" parameter. Items that were ignored by the policy or not displayed because they already existed on the destination can now be seen in reports with the defined categories. All job types and transfer directions support validation.
The available inspection policy options are:
- none (default)
- all
- filtered
- flagged
- shared.
If the connection does not have access to a given folder in a hierarchy, DryvIQ cannot track and report the items.
None (Default)
None is the default inspection policy configuration. This option does not need to be configured through the REST API; it is the system default. This inspection policy will not track all items, but will offer additional tracking with performance in mind. It tracks all items on the source except filtered items (items ignored through job filters). For the destination, all content in the root (files and folders) that existed before the initial transfer will be tracked as destination-only items and reported as ignored. For sync jobs, the destination will behave like the source.
"transfer": {
"item_inspection_policy": "none",
"item_inspection_policy_next": "none"
}
All
This inspection policy tracks all content on both the source and destination, including filtered items and items that exist on the destination before the initial transfer.
"transfer": {
"item_inspection_policy": "all",
"item_inspection_policy_next": "all"
}
Filtered
This inspection policy tracks only items on the source that are excluded from transfer due to job filters. Content on the destination is not tracked for jobs that migrate in one direction from source to destination. For sync jobs, the destination will behave like the source.
"transfer": {
"item_inspection_policy": "filtered",
"item_inspection_policy_next": "filtered"
}
Flagged
This inspection policy tracks items that were flagged during transfer. It tracks only flagged content that is not in a retry status. Content on the destination is not tracked for jobs that migrate in one direction from source to destination. For sync jobs, the destination behaves like the source. This configuration is only available through the REST API.
"transfer": {
"item_inspection_policy": "flagged",
"item_inspection_policy_next": "flagged"
}
Shared
This inspection policy tracks only shared items on the source. Filtered content configured to be skipped through job policies will be tracked if it has been shared. Content on the destination is not tracked for jobs that migrate in one direction from source to destination. For sync jobs, the destination will behave like the source.
"transfer": {
"item_inspection_policy": "shared",
"item_inspection_policy_next": "shared"
}
Content Reconciliation
The content reconciliation provides a comparison of the reconciled items between the source and destination. It can help track the success of the migration. By default, it shows counts for files and folders, but you can choose to view only folders, only files, or data. It reports on the following information:
- Identified: This is the total count of items or data identified on both the source and destination, including flagged and retried items.
- Ignored destination-only items: This is the number of items ignored on the destination and the percentage of the overall content that these items make up.
- Ignored [Filter]: If filters were added to the job to exclude content, any entry for each filter is included in this section. It will identify the count of the filtered items and the percentage of the overall content that these items make up.
- Successfully matched or transferred (Including flagged and revised): This is the count of items or data that have been successfully matched or transferred between the course and destination.
Transfer Stats, By Inspection
GET {{url}}v1/transfers/{{job_id}}/stats/by_inspection