Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • API, CLI, and SDK Documentation
  • REST API Documentation
  • Jobs Using REST API
  • Job Behaviors (REST API)

Lock Propagation Using REST API

Learn how to manage the lock propagation policy for migration jobs using the DryvIQ REST API.

Written by Andrea Harvey

Updated at May 2nd, 2025

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Insights
    Prebuilt Insights Custom Insights
  • Content
  • Accounts
  • Activity Log
  • Content Scans
  • Migrations
    Migration Jobs Migration Reports Maps Flagged Items Migration Tools
  • Connections
    Supported Platform Connections Creating Connections Connection Maintenance Connection Pools
  • Entity Types
    DryvIQ Available Entity Types Custom Entity Types Entity Type Maintenance
  • Action Sets
    Creating Action Sets Action Sets Maintenance
  • Settings
    License Performance Notifications Extensions Entity Types Settings Display Settings Configuration
  • API, CLI, and SDK Documentation
    REST API Documentation Command-line Interface SDK Development
  • POC Offering
  • Release Notes
+ More

Table of Contents

Overview Supported Platforms Example Scenario Expected Results Lock Propagation on NFS Example JSON

Overview

The lock propagation feature allows you to configure if the lock status for files on the source will transfer to the destination with the same setting, assuming the destination platform supports it. 

Options Behaviors
ignore Lock status for files on the source will not propagate to the destination.
mirror_lock Lock status for files on the source will propagate to the destination.
mirror_owner Lock owners on the source will propagate to the destination.

Only Box has full support for lock propagation mirror_owner.

Microsoft Office 365, SharePoint 2013-2016, and OneDrive for Business support reads but not writes. Therefore, lock propagation mirror_owner is fully supported only when one of these connectors are the source, and Box is the destination. 

 

Supported Platforms

  • Box
  • Office 365
  • SharePoint 2013-2016
  • OneDrive for Business

Example Scenario

  1. Create a connector for Box and Office 365.
  2. Create a new job with the specified lock propagation setting.
  3. On the source connector (i.e., Box), create a folder with one or more files and lock them.
    1. Right-click the file on Box and select the “Lock” option.
    2. Folders cannot be locked on Box.
  4. Execute the job (i.e., Box to Microsoft Office 365) and verify that the files are copied and that the file is locked on the destination side.

Expected Results

  • If the setting is ignore, no locks will be propagated. On Microsoft Office 365, there will be no green arrow on the file icon.
  • If the lock setting is mirror, the lock will propagate. On Microsoft Office 365, a green arrow will be present on the file icon indicating it is "checked-out" or locked.
  • If the lock setting is mirror_owner, the lock will propagate and be under the ownership of the account mapped from the source.

The mirror_owner setting requires Account Mapping through User-Drive Mapping.

 

Lock Propagation on NFS

DryvIQ can't unlock files on NFS, so locked files will get flagged. DryvIQ advises that you ignore these locks. When the files get checked back in, DryvIQ will migrate the file on the next job run. You also have the option of identifying the locked files through the flagged items and taking action on the file by either checking it in for the next job run or manually migrating it; however, these actions can result in an extensive flagged item report.

Example JSON

"lock_propagation" : "ignore"

Value Options: ignore (default), mirror_owner, mirror_lock

{
 "name":"Bundle X Lock Prop Ignore Test",
 "kind": "transfer",
 "transfer": {
     "audit_level": "trace",
     "lock_propagation": "ignore",
     "transfer_type": "copy",
     "source": {
       "connection": { "id": "{{cloud_connection_source}}" }
       ,
       "target":
       {"path":"/MASTER_TESTS/Lock Prop Tests"}
     },
     "destination": {
       "connection": { "id": "{{cloud_connection_destination}}" },
       "target": {
         "path": "/SAP/LB/Bundle X Lock Prop Ignore Tests"
       }
     }
 },
 "schedule": {
   "mode": "manual"
 }
}

 

behavior job migration api rest api lock lock propagation

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Connection Pools Using REST API
  • LDAP Account and Group Maps Using REST API
  • Autodesk BIM 360 (OAuth 2.0) (REST API)
  • Box Tags and Microsoft SharePoint Enterprise Keywords Using REST API

Copyright 2025 – DryvIQ, Inc.

Knowledge Base Software powered by Helpjuice

Expand