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
module String Sugar Module. True
allowRestricted Boolean Retrieve all fields or filter out denied fields True

Request Example

{
    "allowRestricted": false,
    "module": "Accounts"
}

Response

The response will be an object containing the following fields:
Name Type Description
fields Array List of fields
relateFields Array List of relate fields
relateModules Array List of related modules
help Array List of functions help
rollupFields Array List of rollup fields
fieldsTypes Array List of field name/field type tuples

Response Example

{
    "fields": {
        "name": "name",
        "date_entered": "date_entered",
        "date_modified": "date_modified",
        "description": "description"
         ...
    },
    "relateFields": {
        "Activities (Activity Stream)":{
            "name": "name",
            "date_entered": "date_entered",
            "date_modified": "date_modified",
            "description": "description"
        },
        ...
    },
    "relateModules": {
        created_by_link": "Users (Created by User)",
        "modified_user_link" :"Users (Modified by User)",
        "activities": "Activities (Activity Stream)"
        ...
    },
    "help":{
        "hourOfDay": "\u003Cb\u003EhourOfDay(Date d)\u003C\/b\u003E\u003Cbr\/\u003EReturns the hour of the day (24 hour format) of a given date\/time.\u003Cbr\u003E\n ",
        "time": "\u003Cb\u003Etime(String s)\u003C\/b\u003E\u003Cbr\/\u003EReturns \u003Ci\u003Es\u003C\/i\u003E as a time value.\u003Cbr\u003E\n ",
    },
    "rollupFields": {
        "Opportunities (Opportunity)": {
            "best_case": "Best Case",
            "amount": "Amount",
             ...
        },
        ...
    },
    "fieldsTypes": {
        "name": ["name","string"],
        "date_entered": ["date_entered","date"],
        "date_modified": ["date_modified","date"],
        "description": ["description","string"],
        "created_by_link": ["created_by_link","relate"]
        ...
    }
}

Change Log

Version Change
v11_13 Added /formulaBuilder/meta POST endpoint.