Move Document

Move Document. This updates the path on all documents within a given source path to a new destination path, such as when moving documents between folders. Individual document moves should be made through the UpdateDocument operation instead.

PUT /content/documentlists/{documentListName}/documents/move

Error

A valid request URL is required to generate request examples

200

{
  "destPath": "<string>",
  "duplicateCount": 123,
  "messages": [
    "<string>"
  ],
  "moveCount": 123,
  "preview": true,
  "renameDuplicates": true,
  "sourcePath": "<string>",
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

documentListName · string · required

DocumentListName name where the document resides

Query Parameters

sourcePath · string

Source path

destPath · string

Destination path

renameDuplicates · boolean · default: true

Flag to rename file if duplicate filename exists in destination (defaults to true)

previewMode · boolean · default: false

Flag to denote whether to preview move operation or actually perform (defaults to false)

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

Summary information for Move operation

destPath · string | null

duplicateCount · integer<int64>

messages · string[] | null

moveCount · integer<int64>

preview · boolean

renameDuplicates · boolean

sourcePath · string | null

totalCount · integer<int64>