PUT api/parameters/{id}

Updates a parameter by ID. Parameter name cannot be equal to an existing template name within the category.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Existing parameter ID.	integer	Required

Body Parameters

Parameter data to update.

ParameterRequestDTO

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.	ParameterCategoryDTO	None.
Name	User-friendly parameter name.	string	None.
Code	Programmer-friendly parameter code.	string	None.
Type	Parameter type. Supported values: Boolean, Numeric, String, Selection, MultiSelection, DateTime.	ParameterTypeDTO	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.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Category": 0,
  "Name": "sample string 2",
  "Code": "sample string 3",
  "Type": 0,
  "InputMask": "sample string 4",
  "RemoteSelectionURL": "sample string 5",
  "Enabled": true,
  "Sequence": 7,
  "Description": "sample string 8"
}

text/html

Sample:

{"Id":1,"Category":0,"Name":"sample string 2","Code":"sample string 3","Type":0,"InputMask":"sample string 4","RemoteSelectionURL":"sample string 5","Enabled":true,"Sequence":7,"Description":"sample string 8"}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ParameterRequestDTO'.

Response Information

Resource Description

None.