Versions Compared

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.

...

Code Block
titleExample of a share object on dashboard
collapsetrue
TODO

...

Key description

content

KeyTypeOptionalityDescriptionConstraints
shareIdstring

Status
colourRed
titlerequired

id of the share (present in share link)

(a-z0-9)
objectIdstring
Status
colourRedGreen
titlerequiredoptional

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
colourRedGreen
titlerequiredoptional
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
colourRedGreen
titlerequiredoptional
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

array

object

boolean

Status
colourGreen
titleoptional

value applied to the path

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


...

Shares themselves do not have a visual representation in the application. However, the Share functions has function is available in Menu:

Then, a popup window with the generated link is shown:

...