GET api/parameters/values/{id}

Get parameter value by ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Valid parameter value ID.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

GetParameterValueDTO
NameDescriptionTypeAdditional information
Id

Parameter value ID.

 integer

None.
ParameterId

ID of the parameter that the parameter value belongs to.

 integer

None.
CategoryId

Category ID to which the parameter value belongs to.

 string

None.
CategoryName

Category name to which the parameter value belongs to.

 string

None.
Level

Level that the parameter value belongs to.

 ParameterLevel

None.
DepartmentId

Department ID to which the department-level parameter value belongs to.

 string

None.
DepartmentName

Department name to which the department-level parameter value belongs to.

 string

None.
Name

Parameter name.

 string

None.
Type

Parameter type. Supported values: Boolean, Numeric, String, Selection, MultiSelection, DateTime.

 string

None.
Code

Parameter code.

 string

None.
Value

Parameter value.

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

Short description of the parameter to be displayed as a tooltip, help, or directly within the interface.

 string

None.
ValidFrom

The beginning date (inclusively) when the parameter starts being valid. For non-inclusive intervals add or subtract some infinitesimal value (e.g. 1 millisecond). Use the default C# DateTime format, i.e. {YYYY}-{MM}-{DD}T{HH}:{mm}:{ss}.{fff}

 date

None.
ValidTo

The ending date (inclusively) when the parameter starts being valid. For non-inclusive intervals add or subtract some infinitesimal value (e.g. 1 millisecond). /// Use the default C# DateTime format, i.e. {YYYY}-{MM}-{DD}T{HH}:{mm}:{ss}.{fff}

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "ParameterId": 2,
  "CategoryId": "sample string 3",
  "CategoryName": "sample string 4",
  "Level": 1,
  "DepartmentId": "sample string 5",
  "DepartmentName": "sample string 6",
  "Name": "sample string 7",
  "Type": "sample string 8",
  "Code": "sample string 9",
  "Value": "sample string 10",
  "InputMask": "sample string 11",
  "RemoteSelectionURL": "sample string 12",
  "Description": "sample string 13",
  "ValidFrom": "2025-06-26T02:36:27.6232323+00:00",
  "ValidTo": "2025-06-26T02:36:27.6232323+00:00"
}

text/html

Sample: 
{"Id":1,"ParameterId":2,"CategoryId":"sample string 3","CategoryName":"sample string 4","Level":1,"DepartmentId":"sample string 5","DepartmentName":"sample string 6","Name":"sample string 7","Type":"sample string 8","Code":"sample string 9","Value":"sample string 10","InputMask":"sample string 11","RemoteSelectionURL":"sample string 12","Description":"sample string 13","ValidFrom":"2025-06-26T02:36:27.6232323+00:00","ValidTo":"2025-06-26T02:36:27.6232323+00:00"}

application/xml, text/xml

Sample: 
<GetParameterValueDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <CategoryId>sample string 3</CategoryId>
  <CategoryName>sample string 4</CategoryName>
  <Code>sample string 9</Code>
  <DepartmentId>sample string 5</DepartmentId>
  <DepartmentName>sample string 6</DepartmentName>
  <Description>sample string 13</Description>
  <Id>1</Id>
  <InputMask>sample string 11</InputMask>
  <Level>Global</Level>
  <Name>sample string 7</Name>
  <ParameterId>2</ParameterId>
  <RemoteSelectionURL>sample string 12</RemoteSelectionURL>
  <Type>sample string 8</Type>
  <ValidFrom>2025-06-26T02:36:27.6232323+00:00</ValidFrom>
  <ValidTo>2025-06-26T02:36:27.6232323+00:00</ValidTo>
  <Value>sample string 10</Value>
</GetParameterValueDTO>