GET api/Products/GetProductsCustomFields/{id}

Gets custom fields for product

Request Information

URI Parameters

Name	Description	Type	Additional information
id	product id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of GetProductsCustomFieldResult

Name	Description	Type	Additional information
Id	Unique identifier	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 the field in ticket detail	boolean	None.
FieldType	Product field type	ProductFieldTypeEnum	None.
HintText	Text that should be shown as a hint for filling the field	string	None.
Index	Field order	integer	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.
ProductId	The product id	integer	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	The items only if type is custom and CustomFieldType is DropDown	Collection of ProductsCustomFieldItemResult	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "CustomFieldTitle": "sample string 2",
    "CustomFieldType": 1,
    "Description": "sample string 3",
    "DoNotShowInTicket": true,
    "FieldType": 1,
    "HintText": "sample string 5",
    "Index": 6,
    "MaxLength": 1,
    "MinLength": 1,
    "PleaseSelect": true,
    "ProductId": 8,
    "Required": true,
    "ShowInSelect": true,
    "Items": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Index": 3
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Index": 3
      }
    ]
  },
  {
    "Id": 1,
    "CustomFieldTitle": "sample string 2",
    "CustomFieldType": 1,
    "Description": "sample string 3",
    "DoNotShowInTicket": true,
    "FieldType": 1,
    "HintText": "sample string 5",
    "Index": 6,
    "MaxLength": 1,
    "MinLength": 1,
    "PleaseSelect": true,
    "ProductId": 8,
    "Required": true,
    "ShowInSelect": true,
    "Items": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Index": 3
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Index": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetProductsCustomFieldResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <GetProductsCustomFieldResult>
    <CustomFieldTitle>sample string 2</CustomFieldTitle>
    <CustomFieldType>DropDown</CustomFieldType>
    <Description>sample string 3</Description>
    <DoNotShowInTicket>true</DoNotShowInTicket>
    <FieldType>Description</FieldType>
    <HintText>sample string 5</HintText>
    <Id>1</Id>
    <Index>6</Index>
    <Items>
      <ProductsCustomFieldItemResult>
        <Id>1</Id>
        <Index>3</Index>
        <Title>sample string 2</Title>
      </ProductsCustomFieldItemResult>
      <ProductsCustomFieldItemResult>
        <Id>1</Id>
        <Index>3</Index>
        <Title>sample string 2</Title>
      </ProductsCustomFieldItemResult>
    </Items>
    <MaxLength>1</MaxLength>
    <MinLength>1</MinLength>
    <PleaseSelect>true</PleaseSelect>
    <ProductId>8</ProductId>
    <Required>true</Required>
    <ShowInSelect>true</ShowInSelect>
  </GetProductsCustomFieldResult>
  <GetProductsCustomFieldResult>
    <CustomFieldTitle>sample string 2</CustomFieldTitle>
    <CustomFieldType>DropDown</CustomFieldType>
    <Description>sample string 3</Description>
    <DoNotShowInTicket>true</DoNotShowInTicket>
    <FieldType>Description</FieldType>
    <HintText>sample string 5</HintText>
    <Id>1</Id>
    <Index>6</Index>
    <Items>
      <ProductsCustomFieldItemResult>
        <Id>1</Id>
        <Index>3</Index>
        <Title>sample string 2</Title>
      </ProductsCustomFieldItemResult>
      <ProductsCustomFieldItemResult>
        <Id>1</Id>
        <Index>3</Index>
        <Title>sample string 2</Title>
      </ProductsCustomFieldItemResult>
    </Items>
    <MaxLength>1</MaxLength>
    <MinLength>1</MinLength>
    <PleaseSelect>true</PleaseSelect>
    <ProductId>8</ProductId>
    <Required>true</Required>
    <ShowInSelect>true</ShowInSelect>
  </GetProductsCustomFieldResult>
</ArrayOfGetProductsCustomFieldResult>