Move Article

Overview

  • This API moves existing article from their parent folder (i.e. source folder) to another folder (destination folder).
  • There must be only one destination folder articles can not be moved to different folders.

Permissions

  • For shared article, 'View Folder' permission on article's parent folder.
  • For shared article, 'Edit Article' permission on the destination folder
  • For personal article, user must be owner of the article being moved.
  • For personal article, the destination folder must be another personal folder of the requesting user.

Precondition

  • Article being moved must not be checked out in any of its language.
  • Article's parent folder id must be different from the destination folder id.
  • Destination folder id supplied in the request body must exist.
  • Article's parent folder must belong to the same department as the destination folder ( i.e. moving article across departments is not allowed).
SecurityoAuthUser
Request
path Parameters
ID
required
string

The comma separated Ids of the articles on which operation is performed. Numeric Id format is supported for article Id.

Examples:
Providing numeric article ids.
202200000002268,202200000002269
query Parameters
resolveNameConflicts
boolean

Parameter to specify to resolve name conflicts in any language between the article names of the articles being moved and articles residing in the destination folder.

Example: resolveNameConflicts=true
Request Body schema: application/json
required
object (Folder)
required
object (language)

Language passed in the request must be assigned to user.

Responses
201

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Preconditions failed

500

Internal server error

post/articles/{ID}/move
Request samples
application/json
{
  • "folder": {
    },
  • "language": {
    }
}
Response samples
application/json

Required query parameter is missing

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}