1Move Worksheet

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

name-or-id (Required)

String

Name or ID of the Worksheet that needs to be moved.

Note: If the Worksheet name is provided, then sourceWorkbookName must also be provided in the request body.

–

by

String

Specifies whether the name-or-id parameter should be interpreted as a Worksheet name or Worksheet ID.

If by=name, provide the Worksheet name in the name-or-id parameter.

If by=id, provide the Worksheet ID in the name-or-id parameter.

The default value is name.

–

sourceWorkbookName

String

Name of the Workbook that contains the Worksheet to be moved.

–

sourceFolderName

String

Name of the folder that contains the source Workbook. If the Workbook is present in the root directory, specify [Root].

Note: If sourceFolderName is not provided, the Workbook will be treated as a root-level entity by default.

–

copyLinkedsheets

String

Specifies how linked sheets should be handled during the move operation.

COPY_ALL – Copies all linked sheets.

MOVE_ALL – Moves all linked sheets to the target location.

NONE – Does not copy or move any linked sheets.

targetWorkbookName

String

Name of the Workbook to which the Worksheet needs to be moved.

Note: Either targetWorkbookName or targetWorkbookId must be provided.

–

targetWorkbookId

String

ID of the Workbook to which the Worksheet needs to be moved.

–

targetFolderName

String

Name of the folder containing the target Workbook. If the target Workbook is present in the root directory, specify [Root].

Note: If neither targetFolderName nor targetFolderId is provided, the target Workbook will be treated as a root-level entity by default.

–

targetFolderId

String

ID of the folder containing the target Workbook.

–

copyUsedCalculatedMeasuresAndParameters

Boolean

Determines whether the calculated measures and parameters referenced in the Worksheet should be moved along with the Worksheet.

true – Calculated measures and parameters are also moved.

false – Calculated measures and parameters are excluded.

Default: false

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Parameter missing.

500

Internal Server Error