GET api/parameters/values/default/{parameterId}?departmentId={departmentId}
Get the default parameter value, when adding a new parameter value. If there is no value specified, only the parameter data is returned.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
parameterId |
Parameter ID. |
integer |
Required |
departmentId |
Department ID. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ParameterValueDefaultDTOName | Description | Type | Additional information |
---|---|---|---|
Type |
Parameter type. Supported values: Boolean, Numeric, String, Selection, MultiSelection, DateTime. |
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. |
Value |
Parameter value. |
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
{ "Type": "sample string 1", "InputMask": "sample string 2", "RemoteSelectionURL": "sample string 3", "Description": "sample string 4", "Value": "sample string 5", "ValidFrom": "2025-06-26T02:36:27.560742+00:00", "ValidTo": "2025-06-26T02:36:27.560742+00:00" }
text/html
{"Type":"sample string 1","InputMask":"sample string 2","RemoteSelectionURL":"sample string 3","Description":"sample string 4","Value":"sample string 5","ValidFrom":"2025-06-26T02:36:27.560742+00:00","ValidTo":"2025-06-26T02:36:27.560742+00:00"}
application/xml, text/xml
<ParameterValueDefaultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs"> <Description>sample string 4</Description> <InputMask>sample string 2</InputMask> <RemoteSelectionURL>sample string 3</RemoteSelectionURL> <Type>sample string 1</Type> <ValidFrom>2025-06-26T02:36:27.560742+00:00</ValidFrom> <ValidTo>2025-06-26T02:36:27.560742+00:00</ValidTo> <Value>sample string 5</Value> </ParameterValueDefaultDTO>