Versions Compared

Old Version 8

changes.mady.by.user Anton Šefčík

Saved on

compared with

New Version 9

changes.mady.by.user Anton Šefčík

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Share object persists the state of the application when using the Share function.

...

KeyTypeOptionalityDescriptionConstraints
shareIdstring

Status
colourRed
titlerequired

id of the share (present in share link)

(a-z0-9)
objectIdstring
Status
colourGreen
titleoptional

id of metadata object on which the share is applied

(a-z0-9)
objectNamestring
Status
colourRed
titlerequired
name of metadata object on which the share is applied(a-z0-9_-)

diff

array
Status
colourRed
titlerequired
list of changes applied on the metadata object
breakingChangesarray
Status
colourGreen
titleoptional
list of changes which used to be applied on the metadata object, but were removed because they were not appliable after update of the metadat objects
forcedRebaseCountinteger
Status
colourGreen
titleoptional
number of times the metadata object was rebasedx => 0

...

KeyTypeOptionalityDescriptionConstraints
opstring

Status
colourRed
titlerequired

type of the operation

["add", "remove", "replace", "copy", "move"]
pathstring
Status
colourRed
titlerequired
path in the json on which the operation is applied(*)
value

string 

integer

number

boolean

Status
colourGreen
titleoptional

value applied to the path

value is polymorphic - it can be of any type available in the JSON standard


itemIdstring
Status
colourGreen
titleoptional

Generated ID for an item from the most outer array in the path - itemId is used while rebasing share diffs to match existent diffs with corresponding items within master metadata object content which might have been reordered within arrays after metadata object update.

e.g. for path /content/filterGroup/10/defaultValues/values/0 the itemId is generated for the item at path /content/filterGroup/10

There are cases when item for which diff is applied does not exists in master metadata object (only in shared metadata object) - in such cases itemId attribute is not present in share diff as it is not supposed to match anything in the master metadata object.

IMPORTANT: itemId is not supposed to be modified manually via REST API.

NOTE: Mechanism described above does not cover all the cases, for example reordering items within a nested array currently produces breaking changes - the implementation is likely to improve in the future to store item IDs in share diff for items within all arrays in the path (the most outer and nested arrays instead of just the most outer one).

[a-z0-9]{32}

...