GET api/CustomForms/GetCustomFormsForTicket/{id}

Gets custom forms for the Ticket.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ticket id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of GetCustomFormForTicketResult

Name	Description	Type	Additional information
Id	The custom form id	integer	None.
Disabled	If true the custom form is disabled	boolean	None.
Name	The custom form's name	string	None.
Description	The custom form's description	string	None.
CustomLayout	If true the custom form has defined custom layout template in LayoutTemplate property	boolean	None.
LayoutTemplate	Html layout template	string	None.
Fields	The custom form's fields	Collection of GetCustomFormFieldResult	None.
ServiceId	The service id is filed if custom form is related to the service	integer	None.
CategoryItemId	The category item id is filed if custom form is related to the service	integer	None.
CategoryItemName	The category item name is filed if custom form is related to the service	string	None.
ShowInEditModeInDefault	The custom form should be shown in edit mode by default	boolean	None.
AnOperatorCanEditAfterClosingTheTicket	The custom form can be edited after closing the ticket	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Disabled": true,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "CustomLayout": true,
    "LayoutTemplate": "sample string 6",
    "Fields": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "Type": 1,
        "Required": true,
        "Items": [
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          },
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          }
        ],
        "AddPleaseSelect": true,
        "RequiredWhenFinished": true,
        "AllowEditingByOperatorsOnly": true,
        "PlaceHolderText": "sample string 8",
        "RegularExpression": "sample string 9",
        "Disabled": true,
        "DateType": 1
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "Type": 1,
        "Required": true,
        "Items": [
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          },
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          }
        ],
        "AddPleaseSelect": true,
        "RequiredWhenFinished": true,
        "AllowEditingByOperatorsOnly": true,
        "PlaceHolderText": "sample string 8",
        "RegularExpression": "sample string 9",
        "Disabled": true,
        "DateType": 1
      }
    ],
    "ServiceId": 1,
    "CategoryItemId": 1,
    "CategoryItemName": "sample string 7",
    "ShowInEditModeInDefault": true,
    "AnOperatorCanEditAfterClosingTheTicket": true
  },
  {
    "Id": 1,
    "Disabled": true,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "CustomLayout": true,
    "LayoutTemplate": "sample string 6",
    "Fields": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "Type": 1,
        "Required": true,
        "Items": [
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          },
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          }
        ],
        "AddPleaseSelect": true,
        "RequiredWhenFinished": true,
        "AllowEditingByOperatorsOnly": true,
        "PlaceHolderText": "sample string 8",
        "RegularExpression": "sample string 9",
        "Disabled": true,
        "DateType": 1
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "Type": 1,
        "Required": true,
        "Items": [
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          },
          {
            "Id": 1,
            "Title": "sample string 2",
            "Disabled": true,
            "Index": 4,
            "DefaultValueBoolean": true,
            "CustomFormFieldItemParentId": 1,
            "CustomFormFieldParentId": 1
          }
        ],
        "AddPleaseSelect": true,
        "RequiredWhenFinished": true,
        "AllowEditingByOperatorsOnly": true,
        "PlaceHolderText": "sample string 8",
        "RegularExpression": "sample string 9",
        "Disabled": true,
        "DateType": 1
      }
    ],
    "ServiceId": 1,
    "CategoryItemId": 1,
    "CategoryItemName": "sample string 7",
    "ShowInEditModeInDefault": true,
    "AnOperatorCanEditAfterClosingTheTicket": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetCustomFormForTicketResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <GetCustomFormForTicketResult>
    <AnOperatorCanEditAfterClosingTheTicket>true</AnOperatorCanEditAfterClosingTheTicket>
    <CategoryItemId>1</CategoryItemId>
    <CategoryItemName>sample string 7</CategoryItemName>
    <CustomLayout>true</CustomLayout>
    <Description>sample string 4</Description>
    <Disabled>true</Disabled>
    <Fields>
      <GetCustomFormFieldResult>
        <AddPleaseSelect>true</AddPleaseSelect>
        <AllowEditingByOperatorsOnly>true</AllowEditingByOperatorsOnly>
        <DateType>DateTime</DateType>
        <Description>sample string 3</Description>
        <Disabled>true</Disabled>
        <Id>1</Id>
        <Items>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
        </Items>
        <PlaceHolderText>sample string 8</PlaceHolderText>
        <RegularExpression>sample string 9</RegularExpression>
        <Required>true</Required>
        <RequiredWhenFinished>true</RequiredWhenFinished>
        <Title>sample string 2</Title>
        <Type>DropDown</Type>
      </GetCustomFormFieldResult>
      <GetCustomFormFieldResult>
        <AddPleaseSelect>true</AddPleaseSelect>
        <AllowEditingByOperatorsOnly>true</AllowEditingByOperatorsOnly>
        <DateType>DateTime</DateType>
        <Description>sample string 3</Description>
        <Disabled>true</Disabled>
        <Id>1</Id>
        <Items>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
        </Items>
        <PlaceHolderText>sample string 8</PlaceHolderText>
        <RegularExpression>sample string 9</RegularExpression>
        <Required>true</Required>
        <RequiredWhenFinished>true</RequiredWhenFinished>
        <Title>sample string 2</Title>
        <Type>DropDown</Type>
      </GetCustomFormFieldResult>
    </Fields>
    <Id>1</Id>
    <LayoutTemplate>sample string 6</LayoutTemplate>
    <Name>sample string 3</Name>
    <ServiceId>1</ServiceId>
    <ShowInEditModeInDefault>true</ShowInEditModeInDefault>
  </GetCustomFormForTicketResult>
  <GetCustomFormForTicketResult>
    <AnOperatorCanEditAfterClosingTheTicket>true</AnOperatorCanEditAfterClosingTheTicket>
    <CategoryItemId>1</CategoryItemId>
    <CategoryItemName>sample string 7</CategoryItemName>
    <CustomLayout>true</CustomLayout>
    <Description>sample string 4</Description>
    <Disabled>true</Disabled>
    <Fields>
      <GetCustomFormFieldResult>
        <AddPleaseSelect>true</AddPleaseSelect>
        <AllowEditingByOperatorsOnly>true</AllowEditingByOperatorsOnly>
        <DateType>DateTime</DateType>
        <Description>sample string 3</Description>
        <Disabled>true</Disabled>
        <Id>1</Id>
        <Items>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
        </Items>
        <PlaceHolderText>sample string 8</PlaceHolderText>
        <RegularExpression>sample string 9</RegularExpression>
        <Required>true</Required>
        <RequiredWhenFinished>true</RequiredWhenFinished>
        <Title>sample string 2</Title>
        <Type>DropDown</Type>
      </GetCustomFormFieldResult>
      <GetCustomFormFieldResult>
        <AddPleaseSelect>true</AddPleaseSelect>
        <AllowEditingByOperatorsOnly>true</AllowEditingByOperatorsOnly>
        <DateType>DateTime</DateType>
        <Description>sample string 3</Description>
        <Disabled>true</Disabled>
        <Id>1</Id>
        <Items>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
          <GetCustomFormFieldItemResult>
            <CustomFormFieldItemParentId>1</CustomFormFieldItemParentId>
            <CustomFormFieldParentId>1</CustomFormFieldParentId>
            <DefaultValueBoolean>true</DefaultValueBoolean>
            <Disabled>true</Disabled>
            <Id>1</Id>
            <Index>4</Index>
            <Title>sample string 2</Title>
          </GetCustomFormFieldItemResult>
        </Items>
        <PlaceHolderText>sample string 8</PlaceHolderText>
        <RegularExpression>sample string 9</RegularExpression>
        <Required>true</Required>
        <RequiredWhenFinished>true</RequiredWhenFinished>
        <Title>sample string 2</Title>
        <Type>DropDown</Type>
      </GetCustomFormFieldResult>
    </Fields>
    <Id>1</Id>
    <LayoutTemplate>sample string 6</LayoutTemplate>
    <Name>sample string 3</Name>
    <ServiceId>1</ServiceId>
    <ShowInEditModeInDefault>true</ShowInEditModeInDefault>
  </GetCustomFormForTicketResult>
</ArrayOfGetCustomFormForTicketResult>