syncData

Property description

The syncData action type copies and synchronizes data between spaces and applications.

For example, we have two spaces. Space 1 is private and has working documents, Space 2 is public. You can use this action to copy all objects meeting specific criteria from Space 1 to Space 2.

Minimal JSON

{
  "key": "",
  "type": "syncData",
  "targetSpacePath": "",
  "targetApplicationKey": ""
}

Nested properties

Property	Description	Values	Mandatory
key	Key of the action.	string	Yes
type	syncData	string	Yes
targetSpacePath	Path of the target space, e.g., Main Space/Personal Space 1.	string	Yes
targetApplicationKey	Key of the target application, e.g., core_business_glossary_app.	string	Yes
attributeTypeMappings	Specifies how attribute types are mapped during the sync.	array	No
copyObjectOnly	Determines whether only objects without their children are copied and synced.	boolean	No
excludeAttachmentCategories	Excludes specified attachment categories from being synced.	array of strings	No
exportTemplate	Specifies the Word Export Template used for the target application. If not specified, the template used by the original will be set as the default.	json	No
objectTypeMappings	Specifies how object types are mapped during the sync.	array	No
relationTypeMappings	Specifies how relation types are mapped during the sync.	array	No
userRelationTypeMappings	Specifies how user relation types are mapped during the sync.	array	No
workflowStateMappings	Specifies how workflow states are mapped during the sync.	array	No

Example mappings

No mapping

• Source: N/A
• Target: N/A
• Result: Copied 1:1 (no change). Targets are the same type or have the same value as the source, e.g.:
  • The value from the core_description attribute on an object in [Space A] is copied to core_description on the corresponding object in [Space B].
  • Objects of the Document object type are copied as Document objects.
  • Users who were set as Owners remain Owners.

attributeTypeMappings

• Source: Description (core_description)
• Target: Content (core_documentation_content)
• Result: Value from the Description attribute type in [Space A] is copied to Content attribute type in [Space B].

objectTypeMappings

• Source: Document (core_documentation_document)
• Target: Example (cust_app_objectTypeA)
• Result: Objects in [Space A] that are of the Document object types, are transformed to Example object types in [Space B].

relationTypeMappings

• Source: Related (core_isRelated)
• Target: Contains (cust_contains)
• Result: Objects that had the Related relation in [Space A], are now connected via the Contains relation in [Space B].

userRelationTypeMappings

• Source: Owner (core_owner)
• Target: Steward (core_steward)
• Result: Users who were Owners in [Space A] are now Stewards in [Space B].

workflowStateMappings

• Source: Draft (core_draft)
• Target: Approved (core_approved)
• Result: Objects in the Draft state in [Space A] are now Approved in [Space B].