move

Property description

The move action type moves objects and their children with all attributes, comments, and attachments to a different space (e.g., for archival purposes).

Minimal JSON

{
  "type" : "move",
  "shallowCopyParents": true
  "spacesMappings": [
    {
      "sourceSpacePath": "space/path/1"
      "targetSpacePath": "space/path/2"
    }
}

Nested properties

Property	Description	Values	Mandatory
key	Key of the action.	string	Yes
type	move	string	Yes
spacesMappings	Array of mappings that define the original space(s) from which the objects are moved and the destination space(s).	array	Yes
childrenWorkflowStateKey	Key of the workflow state the object children will have in the new space.	string	No
parentWorkflowStateKey	Key of the workflow state the object parents will have in the new space. Used when shallowCopyParents is true.	string
shallowCopyParents	Determines whether the object parents are also moved. As the parent is not the target of this action, a blank dummy parent will be created in the target space (original parent stays in the source space). The default value is false, meaning the objects are moved to the hierarchy root.	boolean	No
targetObjectWorkflowStateKey	Key of the workflow state the object in the new space.	string	No

Space mappings nested properties

Property	Description	Values	Mandatory
sourceSpacePath	Path to the original space of the object	string	Yes
targetSpacePath	Path to the new space. If the target space already has an object of the same name, it will be replaced with the most recently moved object.	string	Yes