Overview

Retrieve metadata needed by the Formula Builder field

Summary

The request will return all the fields, related fields, related modules, functions help and rollup fields of a given module

Request Arguments

Name Type Description Required
mapMeta Array Metadata for generating the map True
provider String Map Provider True
recordsMeta Array Records locations metadata True

Request Example

    {
        "mapMeta": {
          "mapType": "r",
          "mapZoom": 11,
          "mapBounds": {
            "center": {
              "latitude": 39.96771001916813,
              "longitude": -82.9779822248355,
              "altitude": 0,
              "altitudeReference": -1
            },
            "width": 1.23046875,
            "height": 0.4236286330070982,
            "crs": {
              "id": "LatLon",
              "bounds": [
                90,
                180,
                -90,
                -180
              ]
            },
            "bounds": [
              40.17952433567168,
              -82.3627478498355,
              39.75589570266458,
              -83.5932165998355
            ]
          },
          "fromDirections": false,
          "mapExpanded": false
        },
        "recordsMeta": [
          {
            "id": "c1986960-79e2-11ec-9810-0242ac140008",
            "date_entered": "2022-01-20T11:18:55+00:00",
            "date_modified": "2022-01-26T13:18:11+00:00",
            "deleted": false,
            "parent_id": "951ba700-7931-11ec-a8e5-0242ac140008",
            "parent_type": "Accounts",
            "parent_name": "X-Sell Holdings",
            "parent_user_name": "Max Jensen",
            "address": "464 S High St, Columbus, OH 43215, United States",
            "status": "COMPLETED",
            "postalcode": "43215",
            "country": "United States",
            "latitude": 39.9526062012,
            "longitude": -82.9988021851,
            "geocoded": true,
            "my_favorite": false,
            "_acl": {
              "fields": {}
            },
            "_erased_fields": [],
            "_module": "Geocode"
          }
        ],
        "provider": "bing",
        "generationType": "map"
      }

Response

The response will be a string of data which has been encoded using Base64 encoding.

Change Log

Version Change
v11_16 Added /maps/generateMap POST endpoint.