Syncplicity Support

Search our knowledgebase to get the help you need, today

Submit a request
Follow

Preserve shared links policy

For several platforms, there is an option to share files and folders via a link. The preserved shared links policy determines whether "domain" or "anyone" links are transferred from the source to the destination. Permission Preservation must be configured in your job for Shared Links to be transferred

Related: 

Supported Platforms

The following platforms support shared links. 

  • Box
  • Dropbox
  • SharePoint Online (Office 365/OneDrive for Business Online)
  • G-Suite

Related: 

Terms

Anyone / Anonymous: Links that can be shared with anyone

Box: open
Dropbox: public
Google: anyone
SharePoint: anonymous

Domain: Links that can be shared only within your organization or enterprise

Box: company
Dropbox: team_only
Google: domain
SharePoint: organizational

Feature Support

DataHub handles shared links differently per platform. The following list defines different ways DataHub handles shared links.   

READ/VIEW RIGHTS UNSAFE-ONLY : Links will be transferred as "View" only.

READ/VIEW AND WRITE/EDIT : Both "read" and "edit" links can be transferred.

SUPPORTED : Feature is fully supported by the Platform and DataHub.

ANYONE LINKS UNSAFE-ONLY : Anyone / Anonymous are links that can be shared with anyone.

NOT SUPPORTED : Feature is available by the Platform but not supported by DataHub.

NOT APPLICABLE : Feature is not supported by the Platform.

Refer to the table below to see how DataHub handles shared links for each platform that supports this feature. 

 

Box

DropBox

SharePoint Online

G-Suite

Number of Links

 1 link per file or folder 1 link per file or folder multiple links per file or folder Max 2 links; anonymous and/or a domain
Rights
READ/VIEW RIGHTS UNSAFE-ONLY
READ/VIEW RIGHTS UNSAFE-ONLY
READ/VIEW AND WRITE/EDIT
READ/VIEW AND WRITE/EDIT
Expiration Date
SUPPORTED
SUPPORTED
ANYONE LINKS UNSAFE-ONLY
READ/VIEW RIGHTS UNSAFE-ONLY
Link Passwords
NOT SUPPORTED
NOT SUPPORTED
NOT APPLICABLE
NOT APPLICABLE
Disable Download
NOT SUPPORTED
NOT SUPPORTED
NOT APPLICABLE
NOT APPLICABLE

Example JSON - DataHub API

Required: Permission Preservation Policy must be enabled to transfer Shared Links successfully

Configuration Options

  • true: Transfer shared links on files and folders from source to the destination
  • false: Do not transfer shared links on files and folders from source to the destination (default)
"permissions": {
            "policy": "add",
            "links": true,
            "failures": "exceptions"

Example - Shared Links Basic Job

POST {{url}}v1/jobs

{
    "name":"Shared Links Example",
    "kind": "transfer",
    "transfer": {
        "transfer_type": "copy",
        "large_item": "skip",
        "batch_mode": "always",
        "timestamps": "true",
        "tags": "none",
        "permissions": {
            "policy": "add",
            "links": true,
            "failures": "exceptions"
        },
        "segment_transform": true,
        "preserve_owners": true,
        "duplicate_names": "rename",
        "empty_containers": "create",
        "versioning": {
            "preserve": "native",
            "select": "all"
        },
        "source": {
            "connection": { "id": "{{cloud_connection_source}}" },
            "target": {
                "path": "/sourcePath"
            }
        },
        "destination": {
            "connection": { "id": "{{cloud_connection_destination}}" },
            "target": {
                "path": "/destinationPath"
            }
        }
    },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 2,
        "on_failure": 2
    },
    "category": {
        "name": "Report | Shared Link Jobs"
   }
}

Example - Shared Links with Permissions Import

POST {{url}}v1/jobs

{
  "name":"Shared Links with Permissions Import",
  "kind": "transfer",
  "transfer": {
    "audit_level": "trace",
    "transfer_type": "copy",
    "permissions": {
      "policy": "add",
      "failures": "exceptions",
      "links": true,
      "import": {
        "source": {
          "text": {
            ["delimiter"]: ",", //optional, defaults to comma
            "target": {
              "path": "/permissions_import.csv"
            }
          }
        },
        "output": {
          "format": "text"
        }
      }
    },
    "source": {
      "connection": {
        "id": "{{nfs_connection}}"
      },
      "target": {
        "path":"/"
      }
    },
    "destination": {
      "connection": {
        "id": "{{cloud_connection}}"
      },
      "target": {
        "path": "/destinationPath"
      }
    }
  },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 2,
        "on_failure": 2
    },
    "category": {
        "name": "Report | Shared Link Jobs"
   }
}
Powered by Zendesk