MS OneDrive – Copy Library Item

Estimated reading: 6 minutes

MS OneDrive – Copy Library Item

Starts an asynchronous copy. Success means the request completed without an exception and the copy was started, not that the destination item exists yet. The wrapper does not expose the Location monitor URL or copied item ID. Verify the destination separately before continuing. New Name maps to name; Parent Library Id and Parent Item Id form parentReference. Conflict Behavior is sent as the @microsoft.graph.conflictBehavior query parameter; Children Only and Include All Version History are sent in the body when set.

Action details

PropertyValue
Action labelMS OneDrive – Copy Library Item
CategoryCloudTools
Apex class and methodCopyOneDriveLibraryItem.copyLibraryItem
Input typeCopyOneDriveLibraryItem.CopyOneDriveLibraryItemInput
Output typeList<CopyOneDriveLibraryItemOutput>
AuthorizationOAuth Delegated (Authorization Code) or OAuth Application (Client Credentials).
Flow automationUse an application connector configured as the Flow default.
Microsoft Graph operationPOST /v1.0/drives/{driveId}/items/{itemId}/copy for Authorization Code Flow; otherwise POST /v1.0/users/{userIdOrPrincipalName}/drives/{driveId}/items/{itemId}/copy.

Prerequisites and permissions

Configure a CloudTools Connector with Connector Type set to Microsoft 365. For delegated access, complete the current user’s Microsoft sign-in. For application access where supported, grant application permissions and administrator consent and provide the target user ID or principal name. The identity must have access to the selected drive and item.

Delegated calls require Files.ReadWrite or a supported broader write permission; application calls require Files.ReadWrite.All or Sites.ReadWrite.All. See the Microsoft operation and permissions reference.

Drive selection: For Authorization Code Flow, a populated driveId uses /drives/{driveId} and userIdOrPrincipalName is ignored. Other authorization types require userIdOrPrincipalName and use the user-scoped drive path shown above. A Library Id is a Graph drive ID and Item Id is an item within that drive; neither is a Salesforce record ID or browser URL.

Inputs

The table lists action labels, Apex field names, and Apex data types. Supply one non-null request with nonblank required text values.

InputApex fieldTypeRequiredDescription
User Id or Principal NameuserIdOrPrincipalNameStringUnless Authorization Code Flow is enabledUser id or user principal name. Ignored for Authorization Code Flow.
Library IddriveIdStringYesLibrary (drive) identifier.
Item IditemIdStringYesLibrary (drive) item identifier.
New NamenewNameStringNoNew item name.
Parent Library IdparentDriveIdStringNoParent library (drive) identifier.
Parent Item IdparentItemIdStringNoParent item identifier.
Conflict BehaviorconflictBehaviorStringNoConflict behavior (rename, fail, replace).
Children OnlychildrenOnlyBooleanNoWhether to copy only children when item is a folder.
Include All Version HistoryincludeAllVersionHistoryBooleanNoWhether to include all version history.

The global invocable input has no connectorId field. Direct subscriber Apex and Flow calls use CloudTools connector selection. This action does not resolve replacement tokens; resolve dynamic values before invocation. See Using Token Replacements.

Outputs

Returns one CloudTools operation result with success and message. It does not return a Microsoft resource. Callout failures are normally reported through exceptions; handle them in the caller. Success means copy started, not copy completed.

OutputApex fieldTypeDescription
SuccesssuccessBooleanWhether the copy started.
MessagemessageStringResult message.

Use in Flow

Add MS OneDrive – Copy Library Item in Flow Builder. Use a Microsoft 365 application connector configured as Set as default for Flow automations, supply the target user and resource IDs, and handle faults. Delegated connections are not supported for CloudTools Flow automation. This implementation processes only the first request; it is not a bulk operation.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace all identifiers and run in a context that permits callouts with a configured connector. The example supplies the user for application access; omit it for an already-authorized delegated connector.

Apptigent.CopyOneDriveLibraryItem.CopyOneDriveLibraryItemInput request =
    new Apptigent.CopyOneDriveLibraryItem.CopyOneDriveLibraryItemInput();
request.userIdOrPrincipalName = 'REPLACE_WITH_MICROSOFT_USER_ID_OR_UPN';
request.driveId = 'REPLACE_WITH_DRIVE_ID';
request.itemId = 'REPLACE_WITH_ITEM_OR_PARENT_ID';
request.newName = 'Project Files Copy';
request.parentDriveId = 'REPLACE_WITH_DESTINATION_DRIVE_ID';
request.parentItemId = 'REPLACE_WITH_DESTINATION_FOLDER_ID';

List<Apptigent.CopyOneDriveLibraryItem.CopyOneDriveLibraryItemOutput> results =
    Apptigent.CopyOneDriveLibraryItem.copyLibraryItem(
        new List<Apptigent.CopyOneDriveLibraryItem.CopyOneDriveLibraryItemInput>{ request }
    );

Boolean succeeded = !results.isEmpty() && results[0].success;
System.debug(succeeded);

The example leaves exception handling, authorization setup, and presentation or persistence of the result to the calling application.

Use in a Lightning Web Component

Use copyOneDriveLibraryItem from msOneDriveConnectorLib, through MSOneDriveConnectorController. These repository c/ imports apply to an LWC in the same namespace. Complete connector authorization before use.

Connector selection limitation: The wrapper accepts a second connectorId argument, but the current controller/action path does not forward it to select the Graph connector for this operation. Calls use CloudTools default connector selection. Passing a connectorId does not guarantee that this action uses that record.

oneDriveActionExample.js

import { LightningElement } from 'lwc';
import { copyOneDriveLibraryItem, MSOneDriveObjects } from 'c/msOneDriveConnectorLib';

export default class OneDriveActionExample extends LightningElement {
    connectorId = 'REPLACE_WITH_CONNECTOR_RECORD_ID';
    result = null;
    errorMessage = '';
    isRunning = false;
    completed = false;

    async handleRun() {
        if (this.isRunning || this.completed) {
            return;
        }
        this.isRunning = true;
        this.errorMessage = '';
        try {
            const request = MSOneDriveObjects.inputs.copyOneDriveLibraryItem();
            request.userIdOrPrincipalName = 'REPLACE_WITH_MICROSOFT_USER_ID_OR_UPN';
            request.driveId = 'REPLACE_WITH_DRIVE_ID';
            request.itemId = 'REPLACE_WITH_ITEM_OR_PARENT_ID';
            request.newName = 'Project Files Copy';
            request.parentDriveId = 'REPLACE_WITH_DESTINATION_DRIVE_ID';
            request.parentItemId = 'REPLACE_WITH_DESTINATION_FOLDER_ID';
            const result = await copyOneDriveLibraryItem(request);
            if (!result?.success) {
                throw new Error('The action did not return a usable result.');
            }
            this.result = result;
            this.completed = true;
        } catch (error) {
            this.errorMessage = error.requiresInteractiveAuthorization
                ? 'Sign in to Microsoft for the connector, then try again.'
                : error.message || 'The OneDrive action failed.';
        } finally {
            this.isRunning = false;
        }
    }
}

oneDriveActionExample.html

<template>
    <lightning-button label="Run action" onclick={handleRun}
        disabled={isRunning}></lightning-button>
    <p role="alert">{errorMessage}</p>
</template>

The library resolves to one operation result with success and message.

The controller adds rawJson as a serialization of the mapped Apex object. This does not preserve Microsoft fields omitted from the model and is not an invocable Flow output.

For delegated sign-in, use getOneDriveAuthorizationState, beginOneDriveAuthorization, and createOneDriveOAuthMessageHandler. The example only reports errors. This controller path exposes structured requiresInteractiveAuthorization errors.

The example avoids repeating a completed operation. Reset completed only when starting another deliberate operation. If an error leaves the outcome uncertain, inspect the item or destination before retrying. For Copy, completed means the request returned, not that the background copy has finished.

Error handling and troubleshooting

SymptomWhat to check
Required fields errorProvide a nonempty request list with a non-null first item and the required identifiers. Supply the user for non-delegated connectors.
Authorization or access deniedCheck connector selection, Microsoft sign-in, consent, permission type, and access to the drive or item.
Resource not foundVerify driveId, itemId, and any version or permission ID. Keep related IDs associated with their source drive.
Missing fields or itemsCheck Select, item type, mapping limitations, and first-page behavior. Empty results and omitted fields are not proof that a resource does not exist.
Unexpected connectorReview the connector selection limitation above and the Microsoft 365 Flow default.
Operation rejectedInspect the Microsoft error, item state, library capability, and tenant policy. Handle exceptions or structured Result failures in the caller.
Share this Doc

MS OneDrive – Copy Library Item

Or copy link

CONTENTS

Free eBook: The Ultimate Guide to Power Platform Custom Connectors

Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot avatar
What can I help you with?

Subscribe

×
Cancel