Syncplicity Support

Search our knowledgebase to get the help you need, today

Follow

Item report

The job overview statistics can be viewed by files or by folders but the item statistics aggregates all items including the files, folders, and the root folder.

Get the full list of items

For all jobs, list all items

GET {{url}}v1/transfers/items

Get the full list of items for this job

This request includes files and folders.

For a given job, list all files and folders

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

For a given job, list all items

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

Get the list of items by parent folder

For a given job, list all items within a folder

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

Get the list of items for this job by status (ie. flagged items)

Statuses include:

  • none[0]: No remediation flag has been applied to the item
  • success[1]: Item was moved successfully with no modifications by DataHub
  • 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 DataHub during transfer. See processed statuses section below for further details
  • remediation: DataHub could not transfer the item and it was flagged for manual remediation
  • retry: DataHub 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

To get flagged items, set the status to remediation

List all successful items for a specific job

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

Get the list of items by Processed Status

Processed status means the item was reviewed and changed by DataHub during transfer. Processed statuses include:

  • none: No processing has occurred on the item
  • filtered: Item was filtered by DataHub 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 DataHub to conform to the destination platform requirements such as Segment Transformation Policy
  • converted: Item was compressed into a zip file by DataHub 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: DataHub was not able to map permissions or owner of the item

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

Get the list of items for this 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 
  • Related: Job Status, Item Error & Warning Categories

List All Audit Categories

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

Transfer Audit Category Description

Description

ID

Access Failures

"Files and folders that have failed due to access failures."
ae073f4b34a846ca9a71eabca31f475f
Access Rule Import Failures "Failure importing access rule."
86209a22f805497283cf53d9fd5b57b1
Access Rule Warnings "Unable to apply permissions due to an incompatible or unsupported access rule."
4d4e496ae6da4aeb91ce0f9a2cbe8bb4
Conflict Failures "Files that have failed due to unresolved conflicts."
3024e963e1bf45578f6ef7c5722fea53
Conflict Warnings "Files that have a conflict copy created."
fde8507bf96243cd8409404841276484
Connectivity Failure "Files and folders that have failed due to connectivity issues with the platform provider."
9b3b464d77ab4fa5a03d097f6da9f745
Conventions Skipped "Convention skipped due to an convention mapping failure."
6266b23b8c11429fb4492855cf8375a8
Duplicate Item Failures "Files and folders that have failed because the platform does not allow duplicate names."
e92c5ec1a0f4415ba3efe79a8c78627b
Invalid Item Failures "Files and folders that are invalid in the platform provider."
480f984a7dd94343b107553dd017ca83
IO Failures "Files and folders that have failed for IO reasons."
65c5e85659284d279f6dea0c71707fc0
Item Locked Failures "Item Locked Failures"
c0fd71c583614130a2246de0912831a8
Item Locked Warnings "Files that have warnings when locked or unlocked."
c0fd71c583614130a2246de0912831a8
Item Not Found Failures "Files and folders that have failed because they were not found in the platform provider."
009fa2b7578d488695a3f0db0dc53553
License Failures "Files and folders that have failed due an unlicensed product feature."
17cd1af5358f4a5cb718c7083dbed7ca
Permission Failures "Files and folders that have failed because the authorized account does not have permission to access the resource."
a4bdd7af71f6490c817155b4d1dabe51
Policy Failures "Files and folders that have failed for violating a policy imposed by the platform provider."
9ab945f3d3524f4a9b128eb717cf20fd
Property Value Import Failures "Failure importing property values."
2215d620a6ab447c989d835a4252937d
Property Value Import Warnings "Property Value Import Warnings"
b1ca22f62c604cd7a57525e10feeb075
Property Value Warnings "Unable to transfer property values due to an invalid property map."
e52a9e0303b049cdb51e7748abb66d28
Restricted Content Skipped "Files that were skipped due to restricted content."
35b00b5a556f48828e94d66c6ee1f222
Security Identifier Warnings "Unable to apply permissions due to an invalid user or group."
e700f185cd81471caa08be63141bcc55
Unknown Failures "Files and folders that have failed for unknown reasons."
814d1fa15a974c83a8bcac10d266798b

List all transfer categories for a specific job

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

Get the items 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,"",""

 

Powered by Zendesk