GET api/parameters?skip={skip}&take={take}&name={name}

Get all parameters.

Request Information

URI Parameters

Name	Type	Additional information
skip	integer	Default value is 0
take	integer	Default value is 50
name	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ParameterListResponseDTO

Name	Description	Type	Additional information
Id	Id uniquely identifying the paramater.	integer	None.
Category	Category to which the parameter belongs to. Parameter name is unique within a single category.	string	None.
Name	Parameter name.	string	None.
Code	Parameter code.	string	None.
Type	Parameter type.	string	None.
InputMask	Input mask for the parameter value validation on the client-side. For Selection and MultiSelection types it contains comma-separated string values.	string	None.
Enabled	Disabled parameters shouldn't be shown to the user. They represent historical and not yet enabled options.	boolean	None.
Sequence	Number representing the order of the parameter on the user interface. Use this as a sort column in gridlike input controls.	integer	None.
Description	Short description of the parameter to be displayed as a tooltip, help, or directly within the interface.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Category": "sample string 2",
    "Name": "sample string 3",
    "Code": "sample string 4",
    "Type": "sample string 5",
    "InputMask": "sample string 6",
    "Enabled": true,
    "Sequence": 8,
    "Description": "sample string 9"
  },
  {
    "Id": 1,
    "Category": "sample string 2",
    "Name": "sample string 3",
    "Code": "sample string 4",
    "Type": "sample string 5",
    "InputMask": "sample string 6",
    "Enabled": true,
    "Sequence": 8,
    "Description": "sample string 9"
  }
]

text/html

Sample:

[{"Id":1,"Category":"sample string 2","Name":"sample string 3","Code":"sample string 4","Type":"sample string 5","InputMask":"sample string 6","Enabled":true,"Sequence":8,"Description":"sample string 9"},{"Id":1,"Category":"sample string 2","Name":"sample string 3","Code":"sample string 4","Type":"sample string 5","InputMask":"sample string 6","Enabled":true,"Sequence":8,"Description":"sample string 9"}]

application/xml, text/xml

Sample:

<ArrayOfParameterListResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <ParameterListResponseDTO>
    <Category>sample string 2</Category>
    <Code>sample string 4</Code>
    <Description>sample string 9</Description>
    <Enabled>true</Enabled>
    <Id>1</Id>
    <InputMask>sample string 6</InputMask>
    <Name>sample string 3</Name>
    <Sequence>8</Sequence>
    <Type>sample string 5</Type>
  </ParameterListResponseDTO>
  <ParameterListResponseDTO>
    <Category>sample string 2</Category>
    <Code>sample string 4</Code>
    <Description>sample string 9</Description>
    <Enabled>true</Enabled>
    <Id>1</Id>
    <InputMask>sample string 6</InputMask>
    <Name>sample string 3</Name>
    <Sequence>8</Sequence>
    <Type>sample string 5</Type>
  </ParameterListResponseDTO>
</ArrayOfParameterListResponseDTO>