Метод «Создание нового класса»

Endpoint: POST {hostname}/dh-datamodel-service/api/v3/models/object-classes

Метод позволяет создать новый класс.

Более подробное описание метода находится в yaml файле «datamodel_service», который расположен в папке с документацией.

Маппинг параметров запроса

Входящие параметры Способ передачи параметров Требования к заполнению
description Body Описание класса модели. Значение согласно описанию в зависимости от потребностей клиента
name Body Наименование класса модели. Значение согласно описанию в зависимости от потребностей клиента
objectClass Body Название класса объекта. Значение согласно описанию в зависимости от потребностей клиента
rootObjectClass Body Название базового класса объекта. Значение согласно описанию в зависимости от потребностей клиента
allowedSourceObjectClasses:
· documents
· folders
· collections
· items
· objects
Body Список классов объектов, доступных для связывания со стороны Источника данным классом связи
allowedTargetObjectClasses:
· documents
· folders
· collections
· items
· objects
Body Список классов объектов, доступных для связывания со стороны Приемника данным классом связи
creatable Body Возможность создания экземпляров класса объекта. Значение согласно описанию в зависимости от потребностей клиента
isUpdateProtected Body Признак того, что объект защищен от обновления

Пример запроса:

curl --location 'https://docshouse-docs.k8s.lan.lanit.ru/api/v3/models/object-classes' \
  -header 'accept: */*' \
  -header 'Content-Type: application/json' \
  -data '{
  "objectClass": "jgRR4bnSaoGgtlenGS4abRSxVouvpzyn-oyVWqN-LNoseWn05n9MfzXwWh8_w-9gw061sFZ5iMBJUb32MhkKEsFvgFFCQO",
  "name": "string",
  "rootObjectClass": "FOLDER",
  "description": "string",
  "creatable": true,
  "isUpdateProtected": true
}'