Sync Node

ID: syncNode

Syncs a node to a target location. If the node does not exist in the target location, it is created. If it is already created, it is updated. If the node was deleted or we are explicitly told to sync a delete operation, the node will be deleted at the target location.

Configuration

Property Type Required Default Description

repositoryId

text

The ID of the repository of the source node.

branchId

text

The ID of the branch of the source node.

nodeId

text

The ID of the source node.

targetRepositoryId

text

The ID of the repository of the target parent node.

targetBranchId

text

The ID of the branch of the target parent node.

targetNodeId

text

The ID of the target parent node.

delete

boolean

Whether to force deletion at the target.

asynchronous

boolean

false Whether to execute in the background.

includeAllAssociations

boolean

Whether to include optional associations along with the sync of nodes.

allowWriteToFrozenBranches

boolean

Whether to allow node to be synced to a frozen branch (ex. Your master branch is frozen when "Master Branch can ONLY be updated via Releases" is enabled)

contentIncludeRelators

boolean

true Whether to automatically include any content relator associations (along with their target nodes).

optionalAssociationsMaxDepth

integer

-1 Indicates the number of optional associations to crawl while traversing for inclusions. Any associations or nodes beyond this depth are pruned. You can use this to limit the depth of content relator associations to include. For example, a value of 2 indicates that the crawl should only crawl relator associations two levels deep.