GET api/documentgeneration/searchmergefields?partialName={partialName}

Search Merge Fields Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
partialName	The partial name value supplied with the request.	string	Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of MergeFunctionMetadataDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Label	The label value.	string	None.
Image	The image value.	string	None.
ScreenTip	The screen tip value.	string	None.
SuperTip	The super tip value.	string	None.
ReturnType	The return type value.	string	None.
FunctionHandler	The function handler value.	string	None.
MenuGroup	The menu group value.	string	None.
CompulsoryParameters	Indicates whether compulsory parameters is true.	boolean	None.
FieldTypes	The collection of field types.	Collection of EnumDataContract	None.
Controls	The collection of controls.	Collection of MergeFunctionParameterControlDataContract	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Label": "sample string 2",
    "Image": "sample string 3",
    "ScreenTip": "sample string 4",
    "SuperTip": "sample string 5",
    "ReturnType": "sample string 6",
    "FunctionHandler": "sample string 7",
    "MenuGroup": "sample string 8",
    "CompulsoryParameters": true,
    "FieldTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Controls": [
      {
        "Label": "sample string 1",
        "Description": "sample string 2",
        "Default": "sample string 3",
        "ControlType": 4
      },
      {
        "Label": "sample string 1",
        "Description": "sample string 2",
        "Default": "sample string 3",
        "ControlType": 4
      }
    ]
  },
  {
    "Name": "sample string 1",
    "Label": "sample string 2",
    "Image": "sample string 3",
    "ScreenTip": "sample string 4",
    "SuperTip": "sample string 5",
    "ReturnType": "sample string 6",
    "FunctionHandler": "sample string 7",
    "MenuGroup": "sample string 8",
    "CompulsoryParameters": true,
    "FieldTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Controls": [
      {
        "Label": "sample string 1",
        "Description": "sample string 2",
        "Default": "sample string 3",
        "ControlType": 4
      },
      {
        "Label": "sample string 1",
        "Description": "sample string 2",
        "Default": "sample string 3",
        "ControlType": 4
      }
    ]
  }
]