POST api/Products/EditProductCustomField
Edits the product custom field
Request Information
URI Parameters
None.
Body Parameters
EditProductCustomFieldPostName | Description | Type | Additional information |
---|---|---|---|
Id |
Product custom field id |
integer |
None. |
CustomFieldTitle |
Custom field title, the field is used only if the type is custom |
string |
None. |
CustomFieldType |
Custom field type, the field is used only if the type is custom |
CustomFieldTypeEnum |
None. |
Description |
Description |
string |
None. |
DoNotShowInTicket |
the field will not show in ticket |
boolean |
None. |
HintText |
Text that should be shown as a hint for filling the field |
string |
None. |
MaxLength |
Fills only if custom field type is ID, maximum length of text |
integer |
None. |
MinLength |
Fills only if custom field type is ID, minimum length of text |
integer |
None. |
PleaseSelect |
True if the field should have "please select" option |
boolean |
None. |
Required |
True if the field is required |
boolean |
None. |
ShowInSelect |
If true, the value of the field will be shown in autocomplete |
boolean |
None. |
Items |
Items for dropdown |
Collection of ProductsCustomFieldItemPost |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": 1, "CustomFieldTitle": "Field", "CustomFieldType": 6, "Description": null, "DoNotShowInTicket": false, "HintText": null, "MaxLength": null, "MinLength": null, "PleaseSelect": false, "Required": false, "ShowInSelect": true, "Items": null }
application/xml, text/xml
Sample:
<EditProductCustomFieldPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts"> <CustomFieldTitle>Field</CustomFieldTitle> <CustomFieldType>CheckBox</CustomFieldType> <Description i:nil="true" /> <DoNotShowInTicket>false</DoNotShowInTicket> <HintText i:nil="true" /> <Id>1</Id> <Items i:nil="true" /> <MaxLength i:nil="true" /> <MinLength i:nil="true" /> <PleaseSelect>false</PleaseSelect> <Required>false</Required> <ShowInSelect>true</ShowInSelect> </EditProductCustomFieldPost>
Response Information
Resource Description
IHttpActionResultNone.