POST api/appformfield/keyvalue

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
FormPartId	integer	None.
Name	string	None.
Caption	string	None.
FieldName	string	None.
Visible	integer	None.
Mandatory	integer	None.
Enabled	integer	None.
PositionFrom	integer	None.
FieldTypeFrom	integer	None.
PositionTo	integer	None.
FieldTypeTo	integer	None.
DefaultValue	string	None.
DisplayFormat	string	None.
WidthFrom	integer	None.
WidthTo	integer	None.
CssClass	string	None.
CssStyles	string	None.
FieldParam	string	None.
ToolTip	string	None.
PlaceHolder	string	None.
Custom1	string	None.
Custom2	string	None.
Description	string	None.
ModulName	string	None.
FormName	string	None.
FormPartName	string	None.
PageSize	integer	Required
PageIndex	integer	Required
SortField	string	None.
SortFieldDefault	string	None.
Quicksearch	string	None.
filterIsSet	boolean	None.
TagIds	Collection of integer	None.
TagFullMatch	boolean	None.
WithTags	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "FormPartId": 1,
  "Name": "sample string 1",
  "Caption": "sample string 2",
  "FieldName": "sample string 3",
  "Visible": 1,
  "Mandatory": 1,
  "Enabled": 1,
  "PositionFrom": 1,
  "FieldTypeFrom": 1,
  "PositionTo": 1,
  "FieldTypeTo": 1,
  "DefaultValue": "sample string 4",
  "DisplayFormat": "sample string 5",
  "WidthFrom": 1,
  "WidthTo": 1,
  "CssClass": "sample string 6",
  "CssStyles": "sample string 7",
  "FieldParam": "sample string 8",
  "ToolTip": "sample string 9",
  "PlaceHolder": "sample string 10",
  "Custom1": "sample string 11",
  "Custom2": "sample string 12",
  "Description": "sample string 13",
  "ModulName": "sample string 14",
  "FormName": "sample string 15",
  "FormPartName": "sample string 16",
  "PageSize": 17,
  "PageIndex": 18,
  "SortField": "sample string 19",
  "SortFieldDefault": "sample string 20",
  "Quicksearch": "sample string 21",
  "filterIsSet": true,
  "TagIds": [
    1,
    2
  ],
  "TagFullMatch": true,
  "WithTags": true
}

application/xml, text/xml

Sample:

<AppFormFieldSelect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <PageIndex>18</PageIndex>
  <PageSize>17</PageSize>
  <Quicksearch>sample string 21</Quicksearch>
  <SortField>sample string 19</SortField>
  <SortFieldDefault>sample string 20</SortFieldDefault>
  <TagFullMatch>true</TagFullMatch>
  <TagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TagIds>
  <WithTags>true</WithTags>
  <filterIsSet>true</filterIsSet>
  <Caption>sample string 2</Caption>
  <CssClass>sample string 6</CssClass>
  <CssStyles>sample string 7</CssStyles>
  <Custom1>sample string 11</Custom1>
  <Custom2>sample string 12</Custom2>
  <DefaultValue>sample string 4</DefaultValue>
  <Description>sample string 13</Description>
  <DisplayFormat>sample string 5</DisplayFormat>
  <Enabled>1</Enabled>
  <FieldName>sample string 3</FieldName>
  <FieldParam>sample string 8</FieldParam>
  <FieldTypeFrom>1</FieldTypeFrom>
  <FieldTypeTo>1</FieldTypeTo>
  <FormName>sample string 15</FormName>
  <FormPartId>1</FormPartId>
  <FormPartName>sample string 16</FormPartName>
  <Id>1</Id>
  <Mandatory>1</Mandatory>
  <ModulName>sample string 14</ModulName>
  <Name>sample string 1</Name>
  <PlaceHolder>sample string 10</PlaceHolder>
  <PositionFrom>1</PositionFrom>
  <PositionTo>1</PositionTo>
  <ToolTip>sample string 9</ToolTip>
  <Visible>1</Visible>
  <WidthFrom>1</WidthFrom>
  <WidthTo>1</WidthTo>
</AppFormFieldSelect>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of KeyValue

Name	Description	Type	Additional information
Id		integer	Required
Value		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Value": "sample string 2"
  },
  {
    "Id": 1,
    "Value": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfKeyValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <KeyValue>
    <Id>1</Id>
    <Value>sample string 2</Value>
  </KeyValue>
  <KeyValue>
    <Id>1</Id>
    <Value>sample string 2</Value>
  </KeyValue>
</ArrayOfKeyValue>