POST
api/v1/getformfield?formFieldId={formFieldId}&createdBy={createdBy}&clientId={clientId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formFieldId | integer |
Required |
|
createdBy | integer |
Required |
|
clientId | integer |
Required |
Response Information
Description:
Return type: FormField
Response Formats
application/json, text/json
{ "Id": 1, "FormGUID": "ad8d14b1-3c58-42f8-a51b-c2c5df94f8a3", "GroupName": "sample string 3", "FieldType": "sample string 4", "Code": "sample string 5", "FieldName": "sample string 6", "Caption": "sample string 7", "Placeholder": "sample string 8", "IsRequired": true, "RequiredMessage": "sample string 10", "MinLength": 1, "MaxLength": 1, "Min": 1, "Max": 1, "SortOrder": 1, "CSS": "sample string 11", "HideCondition": "sample string 12", "ListId": 1, "IsFilter": true, "IsActive": true, "IsLogicalDeleted": true, "CreatedOn": "2025-06-18T11:58:39.9031343+00:00", "CreatedBy": 17, "ModifiedOn": "2025-06-18T11:58:39.9031343+00:00", "ModifiedBy": 1, "IsPriceAttribute": true, "IsVariantBased": true, "IsInteger": true, "Tooltip": "sample string 21" }
text/html
{"Id":1,"FormGUID":"ad8d14b1-3c58-42f8-a51b-c2c5df94f8a3","GroupName":"sample string 3","FieldType":"sample string 4","Code":"sample string 5","FieldName":"sample string 6","Caption":"sample string 7","Placeholder":"sample string 8","IsRequired":true,"RequiredMessage":"sample string 10","MinLength":1,"MaxLength":1,"Min":1,"Max":1,"SortOrder":1,"CSS":"sample string 11","HideCondition":"sample string 12","ListId":1,"IsFilter":true,"IsActive":true,"IsLogicalDeleted":true,"CreatedOn":"2025-06-18T11:58:39.9031343+00:00","CreatedBy":17,"ModifiedOn":"2025-06-18T11:58:39.9031343+00:00","ModifiedBy":1,"IsPriceAttribute":true,"IsVariantBased":true,"IsInteger":true,"Tooltip":"sample string 21"}
application/xml, text/xml
<FormField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.CatalogDesign"> <CSS>sample string 11</CSS> <Caption>sample string 7</Caption> <Code>sample string 5</Code> <CreatedBy>17</CreatedBy> <CreatedOn>2025-06-18T11:58:39.9031343+00:00</CreatedOn> <FieldName>sample string 6</FieldName> <FieldType>sample string 4</FieldType> <FormGUID>ad8d14b1-3c58-42f8-a51b-c2c5df94f8a3</FormGUID> <GroupName>sample string 3</GroupName> <HideCondition>sample string 12</HideCondition> <Id>1</Id> <IsActive>true</IsActive> <IsFilter>true</IsFilter> <IsInteger>true</IsInteger> <IsLogicalDeleted>true</IsLogicalDeleted> <IsPriceAttribute>true</IsPriceAttribute> <IsRequired>true</IsRequired> <IsVariantBased>true</IsVariantBased> <ListId>1</ListId> <Max>1</Max> <MaxLength>1</MaxLength> <Min>1</Min> <MinLength>1</MinLength> <ModifiedBy>1</ModifiedBy> <ModifiedOn>2025-06-18T11:58:39.9031343+00:00</ModifiedOn> <Placeholder>sample string 8</Placeholder> <RequiredMessage>sample string 10</RequiredMessage> <SortOrder>1</SortOrder> <Tooltip>sample string 21</Tooltip> </FormField>