Versions Compared

Key

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

...

Code Block
titleShare object syntax
{
    "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/values/0",
                "value": {50
            },
       "values": [    {
                "op": "add",
  50,              "path": "/content/filterGroup/10/defaultValues/values/1",
         900       "value": 900
            ]},
            {
       "nullFiltered": false        "op": "replace",
       }         "path": "/content/mapOptions/center/lat",
                "value": 52.42325659892287
            },
            {
                "op": "replace",
                "path": "/content/mapOptions/center/latlng",
                "value": 52-1.423256598922879569396972656254
            },
            {
                "op": "replace",
                "path": "/content/mapOptions/center/lngzoom",
                "value": -1.956939697265625412
            },
            {
                "op": "replaceadd",
                "path": "/content/mapOptions/zoomdefaultVisualization",
                "value": 12"areas"
            },
            {
                "op": "add",
                "path": "/content/defaultVisualizationdefaultCompareType",
                "value": "areasdominance"
            },
            {
                "op": "add",
                "path": "/content/spatialQuery/defaultCompareTypeprofile",
                "value": "dominanceair"
            },
            {
                "op": "add",
                "path": "/content/spatialQuery/unit",
                "value": "distance"
{            },
        "profile": "air",   {
                 "unitop": "distanceadd",
                    "amount": 500"path": "/content/spatialQuery/amount",
                "value": }500
            },
            {
                "op": "add",
                "path": "/content/measure/type",
                "value": {                     "type": "isoline"
             
  }             },
            {
                "op": "add",
                "path": "/content/defaultSelected/dataset",
                "value": {                     "dataset": "/rest/projects/$projectId/md/datasets?name=shops",
            },
       "ids": [    {
                    "6""op": "add",
                "path": "/content/defaultSelected/ids/0",
  ]                 }"value": "6"
             }
        ],
        "breakingChanges": [],
        "forcedRebaseCount": 0
    }
}


Code Block
titleExample of a dumped Share
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/values/0",
                    "value": {50
                },
       "values": [        {
                    50"op": "add",
                    "path": "/content/filterGroup/10/defaultValues/values/1",
      900              "value": 900
         ],       },
                 "nullFiltered":{
false                     }"op": "replace",
                },    "path": "/content/mapOptions/center/lat",
           {                     "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/profile",
                    "value": "air"
{                },
         "profile": "air",       {
                    "unitop": "distanceadd",
  
                     "amountpath": 500"/content/spatialQuery/unit",
                    }"value": "distance"
                },
                {
                    "op": "add",
                    "path": "/content/spatialQuery/measureamount",
                    "value": {500
                },
       "type": "isoline"        {
            }        "op": "add",
       },             "path": "/content/measure/type",
  {                     "opvalue": "add",isoline"
                },
                {
      "path              "op": "/content/defaultSelectedadd",
                    "valuepath": {
"/content/defaultSelected/dataset",
                       "datasetvalue": "/rest/projects/$projectId/md/datasets?name=shops",
                },
       "ids":  [       {
                    "op": "6add",
                    "path": "/content/defaultSelected/ids/0",
  ]                     }"value": "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"
            }
        ]
    }
}

Additional syntax examples

Code Block
titleExample of a share object on indicator drill
collapsetrue
{
    "id": "exb9g8wi9606ziyk",
    "name": "customersturnover_indicator_drill_on_exb9g8wi9606ziyk",
    "type": "share",
    "content": {
        "shareId": "exb9g8wi9606ziyk",
        "objectId": "kgub2fqji9khcu70iir539klh29s9mvo",
        "objectName": "customersturnover_indicator_drill_on",
        "diff": [
            {
                "op": "copy",
                "from": "/content/visualizations/areas",
                "path": "/content/visualizations/grid"
            },
            {
                "op": "copy",
                "from": "/content/visualizations/areas",
                "path": "/content/visualizations/zones"
            },
            {
                "op": "copy",
                "from": "/content/visualizations/areas",
                "path": "/content/visualizations/line"
            },
            {
                "op": "add",
                "path": "/content/scaleOptions",
                "value": {
                    "defaultDistribution": {
                        "range": [
                            1,
                            369
                        ],
                        "breaks": [
                            13,
                            44,
                            84,
                            179
                        ],
                        "displayIntervals": [
                            2,
                            3,
                            4
                        ]
                    }
                }
            }
        ],
        "breakingChanges": [],
        "forcedRebaseCount": 0
    }
}

This share object is applied on indicator. You can see it contains some copy operations, which enable the indicator visualization for grid, zones and lines. But mainly, scaleOptions object is present - and it's defaultDistribution sets the content of distribution block.

Code Block
titleExample of a share object on indicator drill
collapsetrue
{
  "id": "exb9g8wi9606ziyk",
  "name": "turnover_indicator_drill_on_exb9g8wi9606ziyk",
  "type": "share",
  "content": {
    "shareId": "exb9g8wi9606ziyk",
    "objectId": "iir539klh29s9mvo",
    "objectName": "turnover_indicator_drill_on",
    "diff":
[       {         "op": "add",
                "path": "/content/blocks/3/visualized",
                "value": false
            },
            {
                "op": "add",
                "path": "/content/blocks/3/displayValues/0/Offline",
                "value": ["Offline"
          "Offline"  },
      ]      {
},       {         "op": "add",
                "path": "/content/blocks/4/visualized",
                "value": false
            },
            {
                "op": "add",
                "path": "/content/blocks/5/visualized",
                "value": false
            },
            {
                "op": "add",
                "path": "/content/blocks/6/visualized",,
                "value": false
            }
        ],
        "breakingChanges": [],
        "forcedRebaseCount": 0
    }
}

This share object is applied on indicator drill. You can see it contains explicit disabled visalization of drill blocks. But mainly, for block 3 (categories) there is an displayValues setting which means we selected "Offline" category from the block.

Code Block
titleExample of a share object on marker selector
collapsetrue
{
    "id": "exb9g8wi9606ziyk",
    "name": "shops_marker_selector_exb9g8wi9606ziyk",
    "type": "share",
    "content": {
        "shareId": "exb9g8wi9606ziyk",
        "objectId": "nl3porml3fmg4o0a",
        "objectName": "shops_marker_selector",
        "diff": [
            {
                "op": "add",
                "path": "/content/keepFiltered/granularity",
                "value": { false
            },
            {
                "granularityop": false"add",
                    "markers": true"path": "/content/keepFiltered/markers",
                "value": }true
            },
            {
                "op": "add",
                "path": "/content/showIndicatorValuesOnMap",
                "value": false
            },
            {
                "op": "add",
                "path": "/content/clusterMarkers",
                "value": false
            }
        ],
        "breakingChanges": [],
        "forcedRebaseCount": 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


...