Параметры

Простой параметр (SimpleValueParameterDto)

Простой параметр - это параметр значение которого задается константой.

 1     {
 2       "defaultValue": "Значение по умолчанию",
 3       "value": "Значение",
 4       "isMultiselect": false,
 5       "isEmptyValuePossible": false,
 6       "isDisableable": false,
 7       "isDisabled": false,
 8       "dataControlOptions": null,
 9       "id": 1,
10       "name": "Простой параметр",
11       "discriminator": "SimpleValueParameterDto"
12     }

Свойство	Описание
id	Идентификатор параметра
name	Наименование параметра
isMultiselect	Признак, что параметр может иметь множественное значение
isEmptyValuePossible	Признак, что параметр может иметь пустое значение
isDisableable	Признак, что параметр может быть отключён
IsDisabled	Признак, что параметр отключен
DataControlOptions	Настройки элемента управления (контрола) параметром DataControlOptionsDto
value	Значение параметра, если isMultiselect == true, то в значении может быть массив значений.
defaultValue	Значение параметра по умолчанию

Типизированный параметр (TypedValueParameterDto)

Типизированный параметр - это параметр значение которого задается типизированной константой.

 1     {
 2       "dataType": "String",
 3       "defaultValue": "Значение по умолчанию",
 4       "value": "Значение",
 5       "isMultiselect": false,
 6       "isEmptyValuePossible": false,
 7       "isDisableable": false,
 8       "isDisabled": false,
 9       "dataControlOptions": null,
10       "id": 1,
11       "name": "Типизированный параметр",
12       "discriminator": "TypedValueParameterDto"
13     }

Ключевое отличие типизированного параметра от простого заключается в строгой типизации значения, если для простого параметра не важно что в значение будет: строка, число, дата, то для типизированного важно.

Свойство	Описание
dataType	Тип данных значений параметра

Остальные свойства TypedValueParameterDto такие же как в SimpleValueParameterDto за исключением dataType.

Параметр на справочнике (DictionaryParameterDto)

Параметр на справочнике - это параметр значения которого берутся из атрибута справочника.

 1     {
 2       "dictionaryId": 0,
 3       "sortingOptions": null,
 4       "displayValueOptions": null,
 5       "options": {
 6         "groupingOptions": null,
 7         "groupingMethod": "Default",
 8         "sortingOptions": null,
 9         "rootElement": null,
10         "virtualElements": null,
11         "displayValueOptions": null,
12         "dictionaryId": 8237,
13         "filter": null,
14         "selection": null,
15         "hierarchyId": null
16       },
17       "attributeValues": null,
18       "defaultValue": [],
19       "value": null,
20       "isMultiselect": false,
21       "isEmptyValuePossible": true,
22       "isDisableable": false,
23       "isDisabled": false,
24       "dataControlOptions": null,
25       "id": 2,
26       "name": "Ремонты",
27       "discriminator": "DictionaryParameterDto"
28     }

Свойство	Описание
options	Настройки справочника для параметра DictionaryOptionsDto
attributeValues	Значения атрибута справочника, которые будут использоваться в качестве значений (вместо value) DictionaryAttributeParameterValueDto

Свойства dictionaryId, sortingOptions, displayValueOptions являются устаревшими.
Остальные свойства DictionaryParameterDto такие же как в SimpleValueParameterDto.

Вычислимый параметр

Вычислимый параметр - это параметр значение которых вычисляется по выражению.

1. Вычисление значения параметра поддерживается только для SimpleValueParameterDto.
2. Выражение описывается в свойстве параметра DefaultValue или Value.
3. Выражение ДОЛЖНО начинаться с символа '=', например "=1+2".
4. Тип данных параметра определяется по результату вычисления, поэтому нет смысла использовать TypedValueParameterDto.

Пример описания параметра с вычислением даты завтрашнего дня.

1 {
2    "id": 1,
3    "name": "Завтра",
4    "IsDisabled": true,
5    "defaultValue": "=Now()+1",    
6    "discriminator": "SimpleValueParameterDto"
7 }

Пример описания параметра с вычислением числа.

1 {
2    "id": 1,
3    "name": "Число",
4    "IsDisabled": true,
5    "defaultValue": "=1 + 2.3",    
6    "discriminator": "SimpleValueParameterDto"
7 }

Пример описания параметра с вычислением строки.

1 {
2    "id": 1,
3    "name": "Строка",
4    "IsDisabled": true,
5    "defaultValue": "=('ab' + 'cd')",    
6    "discriminator": "SimpleValueParameterDto"
7 }