GET api/parameters/{id}

Get parameter by ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Valid parameter ID.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

ParameterResponseDTO
NameDescriptionTypeAdditional information
Id

Id uniquely identifying the paramater.

 integer

None.
CategoryId

Parameter category ID.

 integer

None.
CategoryName

Parameter category name.

 string

None.
Name

Parameter name.

 string

None.
Code

Parameter code.

 string

None.
TypeId

Parameter type ID.

 integer

None.
TypeName

Parameter type name.

 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.
RemoteSelectionURL

URL for the parameter type RemoteSelection, used to bind the selection DDL to the remote endpoint.

 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,
  "CategoryId": 2,
  "CategoryName": "sample string 3",
  "Name": "sample string 4",
  "Code": "sample string 5",
  "TypeId": 6,
  "TypeName": "sample string 7",
  "InputMask": "sample string 8",
  "RemoteSelectionURL": "sample string 9",
  "Enabled": true,
  "Sequence": 11,
  "Description": "sample string 12"
}

text/html

Sample: 
{"Id":1,"CategoryId":2,"CategoryName":"sample string 3","Name":"sample string 4","Code":"sample string 5","TypeId":6,"TypeName":"sample string 7","InputMask":"sample string 8","RemoteSelectionURL":"sample string 9","Enabled":true,"Sequence":11,"Description":"sample string 12"}

application/xml, text/xml

Sample: 
<ParameterResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <CategoryId>2</CategoryId>
  <CategoryName>sample string 3</CategoryName>
  <Code>sample string 5</Code>
  <Description>sample string 12</Description>
  <Enabled>true</Enabled>
  <Id>1</Id>
  <InputMask>sample string 8</InputMask>
  <Name>sample string 4</Name>
  <RemoteSelectionURL>sample string 9</RemoteSelectionURL>
  <Sequence>11</Sequence>
  <TypeId>6</TypeId>
  <TypeName>sample string 7</TypeName>
</ParameterResponseDTO>