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 dumped project settingsShare
collapsetrue
{
    "url": "/rest/projects/yufqzxkbiecj7jot/md/shares/m1nfjgsglwlcxvlf",
    "dumpTime": "2020-12-08T08:06:10Z",
    "version": "1",
    "content": {
        "id": "m1nfjgsglwlcxvlf",
        "name": "catchment_area_view_m1nfjgsglwlcxvlf",
        "type": "share",
        "content": {
            "shareId": "m1nfjgsglwlcxvlf",
            "objectId": "o31q6691gdtj3vng",
            "objectName": "catchment_area_view",
            "diff": [
                {
                    "op": "add",
                    "path": "/content/filterGroup/10/defaultValues",
                    "value": {
                        "values": [
                            50,
                            900
                        ],
                        "nullFiltered": false
                    }
                },
                {
                    "op": "replace",
                    "path": "/content/mapOptions/center/lat",
                    "value": 52.42325659892287
                },
                {
                    "op": "replace",
                    "path": "/content/mapOptions/center/lng",
                    "value": -1.9569396972656254
                },
                {
                    "op": "replace",
                    "path": "/content/mapOptions/zoom",
                    "value": 12
                },
                {
                    "op": "add",
                    "path": "/content/defaultVisualization",
                    "value": "areas"
                },
                {
                    "op": "add",
                    "path": "/content/defaultCompareType",
                    "value": "dominance"
                },
                {
                    "op": "add",
                    "path": "/content/spatialQuery",
                    "value": {
                        "profile": "air",
                        "unit": "distance",
                        "amount": 500
                    }
                },
                {
                    "op": "add",
                    "path": "/content/measure",
                    "value": {
                        "type": "isoline"
                    }
                },
                {
                    "op": "add",
                    "path": "/content/defaultSelected",
                    "value": {
                        "dataset": "/rest/projects/$projectId/md/datasets?name=shops",
                        "ids": [
                            "6"
                        ]
                    }
                }
            ],
            "breakingChanges": [],
            "forcedRebaseCount": 0
        },
        "accessInfo": {
            "createdAt": "2020-12-07T15:35:51Z",
            "createdBy": "/rest/accounts/00ubfu7fdyIoFKxXm0h7"
        },
        "links": [
            {
                "rel": "self",
                "href": "/rest/projects/yufqzxkbiecj7jot/md/shares/m1nfjgsglwlcxvlf"
            }
        ]
    }
}

...

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

...