Метод «Создать атрибут»¶
Endpoint: POST {hostname}/dh-datamodel-service/api/models/property-set/{propertySetId}/properties
Метод позволяет создать отдельный атрибут.
Более подробное описание метода находится в yaml файле «datamodel_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| propertySetId | Path | Идентификатор набора атрибутов (id), полученный методом GET {hostname}/dh-datamodel-service/api/models/property-set |
| description | Body | Описание. Значение согласно описанию в зависимости от потребностей клиента |
| name | Body | Наименование. Значение согласно описанию в зависимости от потребностей клиента |
| type | Body | Тип данных. Значение согласно описанию в зависимости от потребностей клиента |
| code | Body | Системное наименование. Значение согласно описанию в зависимости от потребностей клиента |
| setability | Body | Мощность поля. Тип изменяемости свойства. Значение согласно описанию в зависимости от потребностей клиента |
| persistenceType | Body | Признак, определяющий значение данного свойства в БД |
| cardinality | Body | Мощность поля. Значение согласно описанию в зависимости от потребностей клиента |
| defaultValue | Body | Значение свойства по умолчанию. Значение согласно описанию в зависимости от потребностей клиента |
| validationExpression · id · name · expression · description · example |
Body | Модель записи регулярного выражения. Значение согласно описанию в зависимости от потребностей клиента |
| ordinal | Body | Порядок свойства при передаче другим системам. Значение согласно описанию в зависимости от потребностей клиента |
| isRequired | Body | Требование обязательности свойства. Значение согласно описанию в зависимости от потребностей клиента |
| isHidden | Body | Свойство скрытое. Значение согласно описанию в зависимости от потребностей клиента |
| isOrderable | Body | Возможность сортировки по полю. Значение согласно описанию в зависимости от потребностей клиента |
| isSearchable | Body | Возможность поиска объекта. Значение согласно описанию в зависимости от потребностей клиента |
| linkObjectClass | Body | Тип связанного объекта. Значение согласно описанию в зависимости от потребностей клиента |
| isVerifiable | Body | Требование проверки значения поля с использованием регулярного выражения. Значение согласно описанию в зависимости от потребностей клиента |
| isPrivate | Body | Признак персональных данных. Значение согласно описанию в зависимости от потребностей клиента |
| isUpdateProtected | Body | Признак того, что объект защищен от обновления |
| isFederalSearchable | Body | Признак доступности для индексации в dh-federal-seacrh-service |
Пример запроса:
curl --location 'https://docshouse-test.k8s.lan.lanit.ru/dh-gateway-api-service/dh-datamodel-service/api/models/property-set/76d0b8fc-763a-4041-8221-b86d84a49e82/properties' \
-header 'accept: */*' \
-header 'Content-Type: application/json' \
-data '{
"code": "295316",
"name": "Атрибут 932518",
"type": "TEXT",
"description": "Описание атрибута",
"setability": "READ_ONLY",
"persistenceType": "NOT_PERSISTENT",
"cardinality": "SINGLE",
"isRequired": true,
"isHidden": true,
"isOrderable": true,
"isSearchable": true,
"isPrivate": true,
"defaultValue": {},
"validationExpression": {
"name": "string",
"expression": "string",
"description": "string",
"example": "string"
},
"ordinal": 1,
"linkObjectClass": "string",
"isVerifiable": true,
"isUpdateProtected": true,
"isFederalSearchable": false
}'