GetSettting

GetSetting (driv_GetSetting)

This API is used to retrieve a Setting value for a given 'SettingName' (key) and AppName (optional).

At the moment of writing (Dec-2021), Settings are still in public preview. Link to microsoft documentation

Parameters

Input Parameters

Parameter	Type	Description	Required
SettingName	String	UniqueName of the Setting Definition	X
AppName	String	UniqueName of the App (Optional)

Output Properties

Property	Type	Description
Exists	Boolean	Returns true if a definition exists for 'SettingName'
ValueString	String	The string value of the Setting. (Always populated)
ValueDecimal	Decimal	The decimal value of the Setting if the Type is 'Decimal'
ValueBool	Boolean	The boolean value of the Setting if the Type is 'Boolean'
Type	Picklist	Returns the optionset value of the Setting Definition Datatype type. (String-1, Number-0, Boolean-2)
TypeName	String	Return the label of the Setting Definition Datatype
IsOverridable	Boolean	True if the Setting definition is overridable
OverridableLevel	Picklist	Returns the optionset value of the Overidable level. (AppAndOrganization-0, OrganizationOnly-1, AppOnly-2)
OverridableLevelName	String	Return the label of the Setting Definition Overridable level
ReleaseLevel	Picklist	Returns the optionset value of the Release level. (GA-0, EarlyAccess-1, Preview-2)
ReleaseLevelName	String	Return the label of the Setting Definition Release level

Usage

WebApi:

Request https://{{baseurl}}/api/data/v9.1/driv_GetSetting

{
    "SettingName" : "{{SettingName}}",
    "AppName" : "{{SettingName}}" (OPTIONAL)
}

Response

{
    "@odata.context": "https://{{baseurl}}/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.driv_GetSettingResponse",
    "Exists": true,
    "ValueString": "true",
    "ValueDecimal": null,
    "ValueBool": true,
    "Type": 2,
    "TypeName": "Boolean"
    "IsOverridable": true,
    "OverridableLevel": 0,
    "OverridableLevelName": "AppAndOrganization"
    "ReleaseLevel": 2,
    "ReleaseLevelName": "Preview"
}

Power Automate: