Polynom Web API

AllPartSizes

AllPartSizes.IsAvailable

Возвращает результат проверки наличия вкладки "Все размеры" у группы объектов (проверка наличия у группы объектов хотя бы одной таблицы конструктора компонентов).

Request

POST /api/v1/all-part-sizes/is-available

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы элементов.

Responses

Status Code	Type	Description	Samples
200	boolean	OK

AllPartSizes.GetClassInfo

Возвращает информацию о классе изделий.

Request

POST /api/v1/all-part-sizes/get-class-info

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор изделия.

Responses

Status Code	Type	Description	Samples
200	IGetClassInfoResponse	OK

AssortmentInstances

AssortmentInstances.Get

Возвращает экземпляры сортамента по идентификаторам материала и типоразмера. Указывать сортамент не требуется, т.к. типоразмер привязывается к конкретному сортаменту.

Request

POST /api/v1/assortment-instances/get

Parameters

Name	Type	Default	Notes
body	IGetAssortmentInstanceRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IAssortmentInstance[]	OK

AssortmentInstances.Count

Возвращает количество экземпляров сортамента по идентификаторам типоразмера (через кол-во экземпляров связей типа "Типоразмеры связан с... Экземпляры сортаментов")

Request

POST /api/v1/assortment-instances/count

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор типоразмера.

Responses

Status Code	Type	Description	Samples
200	integer	OK

AssortmentInstances.Create

Создает экземпляр сортамента для указанного материала и типоразмера

Request

POST /api/v1/assortment-instances/create

Parameters

Name	Type	Default	Notes
body	ICreateAssortmentInstanceRequest		Идентификатор типоразмера.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Assortments

Assortments.GetByMaterial

Возвращает сортаменты по идентификаторам материала.

Request

POST /api/v1/assortments/get-by-material

Parameters

Name	Type	Default	Notes
body	IGetAssortmentRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Assortments.GetPath

Возвращает путь к каталогу с идентификатором Sortament.

Request

POST /api/v1/assortments/get-path

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

Assortments.LinkToMaterials

Устанавливает связь между сортаментом и материалами

Request

POST /api/v1/assortments/link-to-materials

Parameters

Name	Type	Default	Notes
body	ILinkMaterialsRequest		Запрос создания связи материалов и сортаментов.

Responses

Status Code	Type	Description	Samples
200		OK

Assortments.Create

Создает сортамент в указанной группе

Request

POST /api/v1/assortments/create

Parameters

Name	Type	Default	Notes
body	ICreateAssortmentRequest		Запрос создания сортамента.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

BackgroundTask

BackgroundTask.GetAll

Возвращает список фоновых задач

Request

POST /api/v1/background-task/get-all

Responses

Status Code	Type	Description	Samples
200	BackgroundTaskInfo[]	OK

BackgroundTask.AddRightForReference

Добавляет новое право для указанного справочника

Request

POST /api/v1/background-task/add-right-for-reference

Parameters

Name	Type	Default	Notes
body	IAddRightRequest		Параметры запроса

Responses

Status Code	Type	Description	Samples
200		OK

BackgroundTask.RemoveRightForReference

Удаляет право для указанного справочника

Request

POST /api/v1/background-task/remove-right-for-reference

Parameters

Name	Type	Default	Notes
body	IRemoveRightRequest		Параметры запроса

Responses

Status Code	Type	Description	Samples
200		OK

BackgroundTask.Cancel

Отменяет фоновую задачу

Request

POST /api/v1/background-task/cancel

Parameters

Name	Type	Default	Notes
body	ICancelBackgroundTaskRequest		Идентификатор фоновой задачи

Responses

Status Code	Type	Description	Samples
200		OK

BackgroundTask.SubscribeOnStructureItem

Подписывает на события элемента структуры

Request

POST /api/v1/background-task/subscribe-on-structure-item

Parameters

Name	Type	Default	Notes
body	IdentifierRequest		Идентификатор элемента структуры

Responses

Status Code	Type	Description	Samples
200		OK

ClassificationObject

ClassificationObject.UpdateClassId

Изменяет идентификатор класса у каталога или группы.

Request

POST /api/v1/classification-object/update-class-id

Parameters

Name	Type	Default	Notes
body	IUpdateClassIdRequest		Запрос изменения названия класса.

Responses

Status Code	Type	Description	Samples
200		OK

ClassificationObject.GetById

Возвращает данные объекта классификации.

Request

POST /api/v1/classification-object/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject	OK

ClassificationObject.GetByUid

Возвращает данные объекта классификации по его идентификатору.

Request

POST /api/v1/classification-object/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос на получение объекта.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject	OK

ClassificationObject.GetByLocation

Возвращает данные объекта классификации по его строке расположения.

Request

POST /api/v1/classification-object/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения объекта.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject	OK

ClassificationObject.GetLocation

Возвращает строку расположения объекта классификации.

Request

POST /api/v1/classification-object/get-location

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200	string	OK

ClassificationObject.GetLocations

Возвращает список строк расположения объектов классификации.

Request

POST /api/v1/classification-object/get-locations

Parameters

Name	Type	Default	Notes
body	IGetLocationsRequest		Список идентификаторов объектов.

Responses

Status Code	Type	Description	Samples
200	IGetLocationsResponse	OK

ClassificationObject.GetExtraLocations

Возвращает строки дополнительных расположений элемента.

Request

POST /api/v1/classification-object/get-extra-locations

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200	array	OK

ClassificationObject.GetParentGroups

Возвращает список родительских групп множественно классифицированного объекта.

Request

POST /api/v1/classification-object/get-parent-groups

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject[]	OK

ClassificationObject.GetMultiClassificationPaths

Возвращает пути, в которые мультиклассифицирован объект.

Request

POST /api/v1/classification-object/get-multi-classification-paths

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	array	OK

ClassificationObject.GetMultiClassificationElements

Возвращает оригинальный элемент и его множественные классификации.

Request

POST /api/v1/classification-object/get-multi-classification-elements

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента или множественно-классифицированного объекта.

Responses

Status Code	Type	Description	Samples
200	ILinkedElement	OK

ClassificationObject.GetAccessRights

Возвращает права для указанных элементов классификации.

Request

POST /api/v1/classification-object/get-access-rights

Parameters

Name	Type	Default	Notes
body	IAccessRightsRequest		Идентификаторы объектов классификации.

Responses

Status Code	Type	Description	Samples
200	IClassificationAccessRight[]	OK

Common

Common.GetAbout

Возвращает данные о сборке сервера и базы данных.

Request

POST /api/v1/common/get-about

Responses

Status Code	Type	Description	Samples
200	IAboutResponse	OK

Common.GetAppServerConfiguration

Возвращает данные о сервере приложений.

Request

POST /api/v1/common/get-app-server-configuration

Responses

Status Code	Type	Description	Samples
200	IAppServerConfiguration	OK

Concept

Concept.GetById

Возвращает понятие по идентификатору.

Request

POST /api/v1/concept/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Запрос понятия по идентификатору.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

Concept.GetByUid

Возвращает понятие по Guid.

Request

POST /api/v1/concept/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос понятия по Guid.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

Concept.GetByCode

Возвращает понятие по его коду.

Request

POST /api/v1/concept/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeRequest		Запрос понятия по коду.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

Concept.GetByAbsoluteCode

Возвращает понятие по его полному коду.

Request

POST /api/v1/concept/get-by-absolute-code

Parameters

Name	Type	Default	Notes
body	IGetByAbsoluteCodeRequest		Запрос понятия по полному коду.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

Concept.GetConceptAsOwn

Возвращает понятие для назначения как собственного.

Request

POST /api/v1/concept/get-concept-as-own

Parameters

Name	Type	Default	Notes
body	IGetConceptAsOwnRequest		Запрос понятия для назначения его как собственного.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

Concept.GetAll

Возвращает список понятий.

Request

POST /api/v1/concept/get-all

Parameters

Name	Type	Default	Notes
body	IGetAllConceptsRequest		Запрос списка понятий.

Responses

Status Code	Type	Description	Samples
200	IConceptPaginatedList	OK

Concept.GetPropertySources

Возвращает коллекцию собственных определений свойств данного понятия.

Request

POST /api/v1/concept/get-property-sources

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос собственных свойств понятия.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Concept.GetAppointers

Возвращает коллекцию элементов, на которые назначено данное понятие.

Request

POST /api/v1/concept/get-appointers

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос элементов, на которые назначено понятие.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Concept.GetSubConcepts

Возвращает непосредственных потомков данного понятия.

Request

POST /api/v1/concept/get-sub-concepts

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос потомков данного понятия.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Concept.GetConceptPropertySources

Возвращает коллекцию всех источников свойств в понятии.

Request

POST /api/v1/concept/get-concept-property-sources

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос источников свойств понятия.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Concept.GetAllSuperConcepts

Возвращает коллекцию всех супер-понятий.

Request

POST /api/v1/concept/get-all-super-concepts

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос супер-понятий.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Concept.GetAllSubConcepts

Возвращает коллекцию всех понятий-потомков.

Request

POST /api/v1/concept/get-all-sub-concepts

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос понятий-потомков.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Concept.GetStatistic

Возвращает статистику.

Request

POST /api/v1/concept/get-statistic

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос статистики.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject	OK

Concept.GetByConceptAppointer

Возвращает понятия каталога/группы.

Request

POST /api/v1/concept/get-by-concept-appointer

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос понятия каталога/группы.

Responses

Status Code	Type	Description	Samples
200	IAppointedConceptsResponse	OK

Concept.AddAppointedConcept

Назначает понятие на каталог/группу.

Request

POST /api/v1/concept/add-appointed-concept

Parameters

Name	Type	Default	Notes
body	IAddAppointedConceptRequest		Запрос назначения понятия.

Responses

Status Code	Type	Description	Samples
200	IAppointedConceptsResponse	OK

Concept.RemoveAppointedConcept

Удаляет назначенное понятие у каталога/группы.

Request

POST /api/v1/concept/remove-appointed-concept

Parameters

Name	Type	Default	Notes
body	IRemoveAppointedConceptRequest		Запрос удаления понятия.

Responses

Status Code	Type	Description	Samples
200		OK

Concept.SetOrderDirection

Изменяет порядок отображения понятий.

Request

POST /api/v1/concept/set-order-direction

Parameters

Name	Type	Default	Notes
body	ISetOrderDirectionConceptRequest		Запрос изменения порядка отображения понятий.

Responses

Status Code	Type	Description	Samples
200	IAppointedConceptsResponse	OK

Concept.SetInheritable

Устанавливает назначаемому понятию признак "Наследуемое".

Request

POST /api/v1/concept/set-inheritable

Parameters

Name	Type	Default	Notes
body	ISetInheritableConceptRequest		Запрос установки признака.

Responses

Status Code	Type	Description	Samples
200		OK

Concept.SetMandatory

Устанавливает назначаемому понятию признак "Обязательное для объектов".

Request

POST /api/v1/concept/set-mandatory

Parameters

Name	Type	Default	Notes
body	ISetMandatoryConceptRequest		Запрос установки признака.

Responses

Status Code	Type	Description	Samples
200		OK

Concept.SetDisabled

Устанавливает назначаемому понятию признак "Отключенное".

Request

POST /api/v1/concept/set-disabled

Parameters

Name	Type	Default	Notes
body	ISetDisabledConceptRequest		Запрос установки признака.

Responses

Status Code	Type	Description	Samples
200		OK

Concept.UpdatePositions

Изменяет порядок собственных понятий.

Request

POST /api/v1/concept/update-positions

Parameters

Name	Type	Default	Notes
body	IAppointedConceptsOrderRequest		Запрос на изменение порядка назначенных понятий.

Responses

Status Code	Type	Description	Samples
200		OK

Concept.Create

Создаёт новое понятие.

Request

POST /api/v1/concept/create

Parameters

Name	Type	Default	Notes
body	ICreateConceptRequest		Запрос создания понятия.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

ConceptPropertySource

ConceptPropertySource.GetByConcept

Возвращает список всех источников свойств в понятии.

Request

POST /api/v1/concept-property-source/get-by-concept

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос поиска объекта.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource[]	OK

ConceptPropertySource.GetById

Возвращает свойство понятия по идентификатору.

Request

POST /api/v1/concept-property-source/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Запрос поиска объекта.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.GetByAbsoluteCode

Возвращает свойство понятия по полному коду.

Request

POST /api/v1/concept-property-source/get-by-absolute-code

Parameters

Name	Type	Default	Notes
body	IGetByAbsoluteCodeRequest		Запрос поиска объекта.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.GetByCode

Возвращает свойство понятия по коду определения свойства.

Request

POST /api/v1/concept-property-source/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeConceptPropertySourceRequest		Запрос поиска свойства понятия по коду.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.GetByUid

Возвращает свойство понятия по Guid.

Request

POST /api/v1/concept-property-source/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос на получение объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.GetAutoGeneratedNamePreview

Возвращает сгенерированное автоматически имя свойства. Такое имя будет у свойства, если отключить флаг IsNameManuallySet.

Request

POST /api/v1/concept-property-source/get-auto-generated-name-preview

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос поиска объекта.

Responses

Status Code	Type	Description	Samples
200	string	OK

ConceptPropertySource.Create

Создает пустое свойство понятия.

Request

POST /api/v1/concept-property-source/create

Parameters

Name	Type	Default	Notes
body	ICreateConceptPropertySourceRequest		Объект запроса создания свойства понятия.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.Update

Редактирует свойство понятия.

Request

POST /api/v1/concept-property-source/update

Parameters

Name	Type	Default	Notes
body	IUpdateConceptPropertySourceRequest		Запрос редактирования свойства понятия.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.Delete

Удаляет свойство из понятия.

Request

POST /api/v1/concept-property-source/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Запрос удаления объекта.

Responses

Status Code	Type	Description	Samples
200		OK

ConceptPropertySource.SetDisplayName

Устанавливает отображаемое имя свойства понятия.

Request

POST /api/v1/concept-property-source/set-display-name

Parameters

Name	Type	Default	Notes
body	ISetDisplayNameConceptPropertySourceRequest		Объект запроса установки отображаемого имени.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.SetDefaultMeasureUnitForAllValues

Устанавливает единицы измерения по умолчанию для всех значений свойства понятия.

Request

POST /api/v1/concept-property-source/set-default-measure-unit-for-all-values

Parameters

Name	Type	Default	Notes
body	ISetDefaultMeasureUnitForAllValuesConceptPropertySourceRequest		Объект запроса установки единиц измерения.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.SetFormula

Устанавливает формулу во владельце свойства понятия.

Request

POST /api/v1/concept-property-source/set-formula

Parameters

Name	Type	Default	Notes
body	ISetFormulaConceptPropertySourceRequest		Запрос установки формулы.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

ConceptPropertySource.SetIsUnique

Устанавливает уникальность свойства понятия.

Request

POST /api/v1/concept-property-source/set-is-unique

Parameters

Name	Type	Default	Notes
body	ISetIsUniqueConceptPropertySourceRequest		Объект запроса установки уникальности.

Responses

Status Code	Type	Description	Samples
200	IConceptPropertySource	OK

Document

Document.GetTemplate

Возвращает шаблон для заполнения свойств документа.

Request

POST /api/v1/document/get-template

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы документов.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

Document.GetById

Возвращает документ.

Request

POST /api/v1/document/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор документа.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Document.GetByUid

Возвращает документ по его идентификатору.

Request

POST /api/v1/document/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Document.GetByLocation

Возвращает документ.

Request

POST /api/v1/document/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Document.GetDefaultLocation

Возвращает строку расположения документа.

Request

POST /api/v1/document/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор документа.

Responses

Status Code	Type	Description	Samples
200	string	OK

Document.GetByDocumentGroup

Возвращает документы, находящиеся в группе документов.

Request

POST /api/v1/document/get-by-document-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы документов.

Responses

Status Code	Type	Description	Samples
200	IDocument[]	OK

Document.GetByElementGroup

Возвращает собственные документы группы элементов.

Request

POST /api/v1/document/get-by-element-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы элементов.

Responses

Status Code	Type	Description	Samples
200	IDocument[]	OK

Document.GetByElement

Возвращает собственные документы элемента.

Request

POST /api/v1/document/get-by-element

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IDocument[]	OK

Document.GetUsages

Возвращает группы и элементы, в которых используется документ.

Request

POST /api/v1/document/get-usages

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор документа.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject[]	OK

Document.Create

Создаёт новый документ.

Request

POST /api/v1/document/create

Parameters

Name	Type	Default	Notes
body	ICreateDocumentRequest		Запрос создания документа.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Document.CreateWithValues

Создаёт новый документ с параметрами.

Request

POST /api/v1/document/create-with-values

Parameters

Name	Type	Default	Notes
body	ICreateDocumentWithValuesRequest		Запрос создания документа с параметрами.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Document.Update

Обновляет документ.

Request

POST /api/v1/document/update

Parameters

Name	Type	Default	Notes
body	IUpdateDocumentRequest		Запрос обновления документа.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Document.LinkDocumentOwners

Привязывает документ к владельцам.

Request

POST /api/v1/document/link-document-owners

Parameters

Name	Type	Default	Notes
body	ILinkDocumentOwnersRequest		Запрос привязки документа к владельцам.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject[]	OK

Document.UnlinkDocumentOwners

Отвязывает документ от владельцев.

Request

POST /api/v1/document/unlink-document-owners

Parameters

Name	Type	Default	Notes
body	IUnlinkDocumentOwnersRequest		Запрос отвязки документа от владельцев.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject[]	OK

Document.Delete

Удаляет документ.

Request

POST /api/v1/document/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор удаляемого документа.

Responses

Status Code	Type	Description	Samples
200		OK

Document.DeleteMany

Удаляет список документов.

Request

POST /api/v1/document/delete-many

Parameters

Name	Type	Default	Notes
body	IDeleteManyRequest		Идентификаторы удаляемых документов.

Responses

Status Code	Type	Description	Samples
200	IDeleteManyResponse	OK

DocumentCatalog

DocumentCatalog.GetById

Возвращает каталог документов.

Request

POST /api/v1/document-catalog/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор каталога документов.

Responses

Status Code	Type	Description	Samples
200	IDocumentCatalog	OK

DocumentCatalog.GetByUid

Возвращает каталог документов по его идентификатору.

Request

POST /api/v1/document-catalog/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IDocumentCatalog	OK

DocumentCatalog.GetByLocation

Возвращает каталог документов.

Request

POST /api/v1/document-catalog/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IDocumentCatalog	OK

DocumentCatalog.GetDefaultLocation

Возвращает строку расположения каталога документов.

Request

POST /api/v1/document-catalog/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор каталога документов.

Responses

Status Code	Type	Description	Samples
200	string	OK

DocumentCatalog.GetByReference

Возвращает каталог документов справочника.

Request

POST /api/v1/document-catalog/get-by-reference

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	IDocumentCatalog	OK

DocumentCatalog.Update

Изменяет данные о каталоге документов.

Request

POST /api/v1/document-catalog/update

Parameters

Name	Type	Default	Notes
body	IUpdateDocumentCatalogRequest		Каталог документов.

Responses

Status Code	Type	Description	Samples
200	IDocumentCatalog	OK

DocumentGroup

DocumentGroup.GetById

Возвращает группу документов.

Request

POST /api/v1/document-group/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы документов

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup	OK

DocumentGroup.GetByUid

Возвращает группу документов по ее идентификатору.

Request

POST /api/v1/document-group/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup	OK

DocumentGroup.GetByLocation

Возвращает группу документов.

Request

POST /api/v1/document-group/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup	OK

DocumentGroup.GetDefaultLocation

Возвращает строку расположения группы документов.

Request

POST /api/v1/document-group/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор группы документов.

Responses

Status Code	Type	Description	Samples
200	string	OK

DocumentGroup.GetByGroup

Возвращает группы, находящиеся внутри указанной группы документов.

Request

POST /api/v1/document-group/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы документов.

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup[]	OK

DocumentGroup.GetByCatalog

Возвращает группы, находящиеся внутри каталога документов.

Request

POST /api/v1/document-group/get-by-catalog

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор каталога документов.

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup[]	OK

DocumentGroup.GetStatistics

Возвращает статистику группы документов.

Request

POST /api/v1/document-group/get-statistics

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы документов.

Responses

Status Code	Type	Description	Samples
200	IGroupStatistics	OK

DocumentGroup.GetAssortmentsDocumentsPath

Возвращает путь до группы документов на сортаменты.

Request

POST /api/v1/document-group/get-assortments-documents-path

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

DocumentGroup.GetMaterialsDocumentsPath

Возвращает путь до группы документов на материалы.

Request

POST /api/v1/document-group/get-materials-documents-path

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

DocumentGroup.GetMaterialsAssortmentsDocumentsPath

Возвращает путь до группы документов на ТУ для материалов и сортаментов.

Request

POST /api/v1/document-group/get-materials-assortments-documents-path

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

DocumentGroup.Create

Создаёт новую группу документов.

Request

POST /api/v1/document-group/create

Parameters

Name	Type	Default	Notes
body	ICreateDocumentGroupRequest		Параметры создания группы документов.

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup	OK

DocumentGroup.Update

Изменяет данные о группе документов.

Request

POST /api/v1/document-group/update

Parameters

Name	Type	Default	Notes
body	IUpdateDocumentGroupRequest		Группа документов.

Responses

Status Code	Type	Description	Samples
200	IDocumentGroup	OK

DocumentGroup.Delete

Удаляет группу документов.

Request

POST /api/v1/document-group/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор группы документов.

Responses

Status Code	Type	Description	Samples
200		OK

DocumentOwner

DocumentOwner.LinkDocuments

Привязывает документ к объекту-владельцу.

Request

POST /api/v1/document-owner/link-documents

Parameters

Name	Type	Default	Notes
body	ILinkDocumentsRequest		Запрос привязки документа.

Responses

Status Code	Type	Description	Samples
200	IOwnedDocument[]	OK

DocumentOwner.UnlinkDocuments

Удаляет связь между документом и объектом-владельцем.

Request

POST /api/v1/document-owner/unlink-documents

Parameters

Name	Type	Default	Notes
body	IUnlinkDocumentsRequest		Запрос удаления связи.

Responses

Status Code	Type	Description	Samples
200	IOwnedDocument[]	OK

Element

Element.GetTemplate

Возвращает шаблон для заполнения свойств элемента.

Request

POST /api/v1/element/get-template

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы элементов

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerContainer	OK

Element.GetById

Возвращает элемент.

Request

POST /api/v1/element/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Element.GetByUid

Возвращает элемент по его идентификатору.

Request

POST /api/v1/element/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Element.GetByLocation

Возвращает элементы группы.

Request

POST /api/v1/element/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения элемента.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Element.GetDefaultLocation

Возвращает строку расположения элемента.

Request

POST /api/v1/element/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	string	OK

Element.GetByGroup

Возвращает элементы группы.

Request

POST /api/v1/element/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Element.GetByDocument

Возвращает элементы, в которых используется документ.

Request

POST /api/v1/element/get-by-document

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор документа.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Element.GetByViewpoint

Возвращает элементы, в которых используется представление.

Request

POST /api/v1/element/get-by-viewpoint

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор представления.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Element.GetLinkDefEndForSortMat

Возвращает конец определения связи для материала/сортамента.

Request

POST /api/v1/element/get-link-def-end-for-sort-mat

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор материала/сортамента.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinitionEnd	OK

Element.GetLinkedElementsLocations

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

Request

POST /api/v1/element/get-linked-elements-locations

Parameters

Name	Type	Default	Notes
body	IGetLinkedElementsLocationsRequest		Запрос списка расположений.

Responses

Status Code	Type	Description	Samples
200	array	OK

Element.LinkElementsToViewpoint

Привязывает элементы к представлению.

Request

POST /api/v1/element/link-elements-to-viewpoint

Parameters

Name	Type	Default	Notes
body	ILinkElementsToViewpointRequest		Запрос привязки элементов.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Element.UnlinkElementsFromViewpoint

Отвязывает элемент от представления.

Request

POST /api/v1/element/unlink-elements-from-viewpoint

Parameters

Name	Type	Default	Notes
body	IUnlinkElementsFromViewpointRequest		Запрос открепления элемента.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Element.Create

Создаёт новый элемент.

Request

POST /api/v1/element/create

Parameters

Name	Type	Default	Notes
body	ICreateElementRequest		Запрос создания элемента справочника.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Element.CreateWithValues

Создаёт новый элемент с параметрами.

Request

POST /api/v1/element/create-with-values

Parameters

Name	Type	Default	Notes
body	ICreateElementWithValuesRequest		Запрос создания элемента с параметрами.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Element.Update

Редактирует элемент.

Request

POST /api/v1/element/update

Parameters

Name	Type	Default	Notes
body	IUpdateElementRequest		Запрос редактирования элемента.

Responses

Status Code	Type	Description	Samples
200	IDocument	OK

Element.Delete

Удаляет элемент.

Request

POST /api/v1/element/delete

Parameters

Name	Type	Default	Notes
body	IDeleteElementRequest		Запрос удаления элемента.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

Element.DeleteMany

Удаляет элементы.

Request

POST /api/v1/element/delete-many

Parameters

Name	Type	Default	Notes
body	IDeleteManyElementsRequest		Идентификаторы удаляемых элементов.

Responses

Status Code	Type	Description	Samples
200	IDeleteManyElementsResponse	OK

ElementCatalog

ElementCatalog.GetById

Возвращает каталог элементов.

Request

POST /api/v1/element-catalog/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор каталога.

Responses

Status Code	Type	Description	Samples
200	IElementCatalog	OK

ElementCatalog.GetByUid

Возвращает каталог элементов по его идентификатору.

Request

POST /api/v1/element-catalog/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IElementCatalog	OK

ElementCatalog.GetByLocation

Возвращает каталог элементов.

Request

POST /api/v1/element-catalog/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IElementCatalog	OK

ElementCatalog.GetDefaultLocation

Возвращает строку расположения каталога элементов.

Request

POST /api/v1/element-catalog/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор каталога элементов.

Responses

Status Code	Type	Description	Samples
200	string	OK

ElementCatalog.GetByReference

Возвращает каталоги элементов справочника.

Request

POST /api/v1/element-catalog/get-by-reference

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	IElementCatalog[]	OK

ElementCatalog.Create

Создаёт новый каталог элементов.

Request

POST /api/v1/element-catalog/create

Parameters

Name	Type	Default	Notes
body	ICreateElementCatalogRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElementCatalog	OK

ElementCatalog.Update

Изменяет данные о каталоге элементов.

Request

POST /api/v1/element-catalog/update

Parameters

Name	Type	Default	Notes
body	IUpdateElementCatalogRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElementCatalog	OK

ElementCatalog.Delete

Удаляет каталог элементов.

Request

POST /api/v1/element-catalog/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор каталога элементов.

Responses

Status Code	Type	Description	Samples
200		OK

ElementGroup

ElementGroup.GetById

Возвращает группу элементов

Request

POST /api/v1/element-group/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы элементов

Responses

Status Code	Type	Description	Samples
200	IElementGroup	OK

ElementGroup.GetByUid

Возвращает группу элементов по ее идентификатору.

Request

POST /api/v1/element-group/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IElementGroup	OK

ElementGroup.GetByLocation

Возвращает группу элементов.

Request

POST /api/v1/element-group/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IElementGroup	OK

ElementGroup.GetDefaultLocation

Возвращает строку расположения каталога элементов.

Request

POST /api/v1/element-group/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор группы элементов.

Responses

Status Code	Type	Description	Samples
200	string	OK

ElementGroup.GetByGroup

Возвращает группы, находящиеся внутри указанной группы элементов.

Request

POST /api/v1/element-group/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы элементов

Responses

Status Code	Type	Description	Samples
200	IElementGroup[]	OK

ElementGroup.GetByCatalog

Возвращает группы, находящиеся внутри каталога элементов

Request

POST /api/v1/element-group/get-by-catalog

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор каталога элементов

Responses

Status Code	Type	Description	Samples
200	IElementGroup[]	OK

ElementGroup.GetStatistics

Возвращает статистику группы элементов

Request

POST /api/v1/element-group/get-statistics

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы элементов

Responses

Status Code	Type	Description	Samples
200	IGroupStatistics	OK

ElementGroup.Create

Создаёт новую группу элементов

Request

POST /api/v1/element-group/create

Parameters

Name	Type	Default	Notes
body	ICreateElementGroupRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElementGroup	OK

ElementGroup.Update

Изменяет данные о группе элементов

Request

POST /api/v1/element-group/update

Parameters

Name	Type	Default	Notes
body	IUpdateElementGroupRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElementGroup	OK

ElementGroup.Delete

Удаляет группу элементов

Request

POST /api/v1/element-group/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор группы элементов

Responses

Status Code	Type	Description	Samples
200		OK

EventLog

EventLog.GetRoot

Возвращает корневой элемент журнала событий.

Request

POST /api/v1/event-log/get-root

Responses

Status Code	Type	Description	Samples
200	IEventLogRoot	OK

EventLog.GetSessionRecordsGroup

Возвращает данные записи события о сессии.

Request

POST /api/v1/event-log/get-session-records-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор записи.

Responses

Status Code	Type	Description	Samples
200	ISessionRecordsGroup	OK

EventLog.GetSessionRecords

Возвращает записи о сессии журнала событий.

Request

POST /api/v1/event-log/get-session-records

Responses

Status Code	Type	Description	Samples
200	ISessionRecordsGroup[]	OK

EventLog.GetTransactionRecordsGroup

Возвращает данные записи события о транзакции.

Request

POST /api/v1/event-log/get-transaction-records-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор записи.

Responses

Status Code	Type	Description	Samples
200	ITransactionRecordsGroup	OK

EventLog.GetTransactionRecords

Возвращает записи о транзакции журнала событий.

Request

POST /api/v1/event-log/get-transaction-records

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Родительский элемент журнала событий.

Responses

Status Code	Type	Description	Samples
200	ITransactionRecordsGroup	OK

EventLog.GetEventRecord

Возвращает данные записи события действия.

Request

POST /api/v1/event-log/get-event-record

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор записи.

Responses

Status Code	Type	Description	Samples
200	IEventRecord	OK

EventLog.GetEventRecords

Возвращает записи о пользовательском действии журнала событий.

Request

POST /api/v1/event-log/get-event-records

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Родительский элемент журнала событий.

Responses

Status Code	Type	Description	Samples
200	IEventRecord[]	OK

EventLog.Clear

Очищает журнала событий.

Request

POST /api/v1/event-log/clear

Responses

Status Code	Type	Description	Samples
200		OK

Favorites

Favorites.GetById

Возвращает избранный элемент.

Request

POST /api/v1/favorites/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор избранного элемента.

Responses

Status Code	Type	Description	Samples
200	IClassifiableObject	OK

Favorites.GetByGroup

Возвращает объекты, находящиеся внутри указанной группы избранного.

Request

POST /api/v1/favorites/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы избранного.

Responses

Status Code	Type	Description	Samples
200	IFavoritesItem[]	OK

Favorites.GetByCatalog

Возвращает объекты, находящиеся внутри каталога избранного.

Request

POST /api/v1/favorites/get-by-catalog

Responses

Status Code	Type	Description	Samples
200	IFavoritesItem[]	OK

Favorites.IsInFavorites

Возвращает результат проверки нахождения элемента в избранном.

Request

POST /api/v1/favorites/is-in-favorites

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос проверки нахождения в избранном.

Responses

Status Code	Type	Description	Samples
200	boolean	OK

Favorites.MoveToGroup

Перемещает группу или объект в требуемую группу.

Request

POST /api/v1/favorites/move-to-group

Parameters

Name	Type	Default	Notes
body	IMoveToRequest		Запрос перемещения объекта.

Responses

Status Code	Type	Description	Samples
200		OK

Favorites.Add

Добавляет объект в избранное.

Request

POST /api/v1/favorites/add

Parameters

Name	Type	Default	Notes
body	IAddToRequest		Запрос на добавление объекта в избранное.

Responses

Status Code	Type	Description	Samples
200	IFavoritesItem	OK

Favorites.AddMany

Добавляет объекты на панель избранного.

Request

POST /api/v1/favorites/add-many

Parameters

Name	Type	Default	Notes
body	IAddManyToRequest		Запрос на добавление объектов в избранное.

Responses

Status Code	Type	Description	Samples
200	IFavoritesItem[]	OK

Favorites.Remove

Удаляет объект или группу из каталога избранного.

Request

POST /api/v1/favorites/remove

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор удаляемого объекта.

Responses

Status Code	Type	Description	Samples
200		OK

Favorites.RemoveMany

Удаляет элементы и группы из каталога избранного.

Request

POST /api/v1/favorites/remove-many

Parameters

Name	Type	Default	Notes
body	IRemoveManyRequest		Запрос удаления элементов и групп.

Responses

Status Code	Type	Description	Samples
200		OK

FavoritesCatalog

FavoritesCatalog.GetById

Возвращает каталог избранного.

Request

POST /api/v1/favorites-catalog/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор каталога избранного.

Responses

Status Code	Type	Description	Samples
200	IFavoritesCatalog	OK

FavoritesCatalog.GetByUid

Возвращает каталог избранного по его идентификатору.

Request

POST /api/v1/favorites-catalog/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IFavoritesCatalog	OK

FavoritesCatalog.Get

Возвращает каталог избранного.

Request

POST /api/v1/favorites-catalog/get

Responses

Status Code	Type	Description	Samples
200	IFavoritesCatalog	OK

FavoritesCatalog.Export

Осуществляет экспорт избранного в xml.

Request

POST /api/v1/favorites-catalog/export

Responses

Status Code	Type	Description	Samples
200		OK

FavoritesCatalog.Import

Осуществляет импорт избранного из xml.

Request

POST /api/v1/favorites-catalog/import

Parameters

Name	Type	Default	Notes
file			Загружаемый файл.

Responses

Status Code	Type	Description	Samples
200	IImportFavoritesResponse	OK

FavoritesGroup

FavoritesGroup.GetById

Возвращает группу избранного.

Request

POST /api/v1/favorites-group/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы избранного.

Responses

Status Code	Type	Description	Samples
200	IFavoritesGroup	OK

FavoritesGroup.GetByUid

Возвращает группу каталога избранного по уникальному идентификатору.

Request

POST /api/v1/favorites-group/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IFavoritesGroup	OK

FavoritesGroup.GetAll

Возвращает группы каталога избранного.

Request

POST /api/v1/favorites-group/get-all

Responses

Status Code	Type	Description	Samples
200	IFavoritesGroup[]	OK

FavoritesGroup.GetByGroup

Возвращает группы, находящиеся внутри указанной группы избранного.

Request

POST /api/v1/favorites-group/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы избранного.

Responses

Status Code	Type	Description	Samples
200	IFavoritesGroup[]	OK

FavoritesGroup.Create

Создает новую группу избранного.

Request

POST /api/v1/favorites-group/create

Parameters

Name	Type	Default	Notes
body	ICreateFavoritesGroupRequest		Запрос создания новой группы избранного.

Responses

Status Code	Type	Description	Samples
200	IFavoritesGroup	OK

FavoritesGroup.Update

Обновляет свойства группы избранного.

Request

POST /api/v1/favorites-group/update

Parameters

Name	Type	Default	Notes
body	IUpdateFavoritesGroupRequest		Запрос обновления группы избранного.

Responses

Status Code	Type	Description	Samples
200	IFavoritesGroup	OK

FavoritesGroup.Delete

Удаляет группу избранного.

Request

POST /api/v1/favorites-group/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор удаляемой группы.

Responses

Status Code	Type	Description	Samples
200		OK

FavoritesGroup.DeleteMany

Удаляет группы избранного.

Request

POST /api/v1/favorites-group/delete-many

Parameters

Name	Type	Default	Notes
body	IDeleteManyRequest		Запрос удаления групп.

Responses

Status Code	Type	Description	Samples
200		OK

File

File.GetById

Возвращает элемент.

Request

POST /api/v1/file/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IFile	OK

File.GetByUid

Возвращает файл по его идентификатору.

Request

POST /api/v1/file/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IFile	OK

File.GetNameById

Возвращает имя временного файла в хранилище для скачивания файла.

Request

POST /api/v1/file/get-name-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор файла.

Responses

Status Code	Type	Description	Samples
200	string	OK

File.GetByDocument

Возвращает файлы, принадлежащие документу.

Request

POST /api/v1/file/get-by-document

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор документа.

Responses

Status Code	Type	Description	Samples
200	IFile[]	OK

File.AddToDocument

Добавляет файл документу.

Request

POST /api/v1/file/add-to-document

Parameters

Name	Type	Default	Notes
body	IAddToDocumentRequest		Запрос добавления файла документу.

Responses

Status Code	Type	Description	Samples
200		OK

File.GetByTicket

Возвращает файлы, принадлежащие заявке.

Request

POST /api/v1/file/get-by-ticket

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор заявки.

Responses

Status Code	Type	Description	Samples
200	IFile[]	OK

File.AddToTicket

Добавляет файл заявке.

Request

POST /api/v1/file/add-to-ticket

Parameters

Name	Type	Default	Notes
body	IAddToTicketRequest		Запрос добавления файла заявке.

Responses

Status Code	Type	Description	Samples
200		OK

File.Rename

Изменяет имя файла документа.

Request

POST /api/v1/file/rename

Parameters

Name	Type	Default	Notes
body	IRenameFileRequest		Запрос редактирования файла.

Responses

Status Code	Type	Description	Samples
200		OK

File.Replace

Заменяет содержимое файла документа.

Request

POST /api/v1/file/replace

Parameters

Name	Type	Default	Notes
body	IReplaceRequest		Запрос замены файла.

Responses

Status Code	Type	Description	Samples
200		OK

File.Upload

Загружает файл во временное хранилище.

Request

POST /api/v1/file/upload

Responses

Status Code	Type	Description	Samples
200	string	OK

File.Download

Возвращает содержимое файла из временного хранилища по имени файла.

Request

POST /api/v1/file/download

Parameters

Name	Type	Default	Notes
body	IDownloadFileRequest		Параметры запроса загрузки файла.

Responses

Status Code	Type	Description	Samples
200		OK

File.Delete

Удаляет файл по идентификатору.

Request

POST /api/v1/file/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор файла.

Responses

Status Code	Type	Description	Samples
200		OK

Formula

Formula.GetById

Возвращает элемент.

Request

POST /api/v1/formula/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IFormula	OK

Formula.GetByUid

Возвращает формулу по ее идентификатору.

Request

POST /api/v1/formula/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IFormula	OK

Formula.GetByCode

Возвращает формулу по ее коду.

Request

POST /api/v1/formula/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeRequest		Код объекта.

Responses

Status Code	Type	Description	Samples
200	IFormula	OK

Formula.GetByFormulaAppointer

Возвращает формулы каталога/группы.

Request

POST /api/v1/formula/get-by-formula-appointer

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор каталога/группы.

Responses

Status Code	Type	Description	Samples
200	IContractAppointedFormula[]	OK

Formula.GetRecent

Возвращает список ранее использованных формул.

Request

POST /api/v1/formula/get-recent

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор целевого свойства формулы.

Responses

Status Code	Type	Description	Samples
200	IFormula[]	OK

Formula.AddToFormulaAppointer

Добавляет назначаемую формулу на квалификатор свойства для каталога/группы.

Request

POST /api/v1/formula/add-to-formula-appointer

Parameters

Name	Type	Default	Notes
body	IAddAppointedFormulaRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IContractAppointedFormula[]	OK

Formula.EvaluateProperty

Возвращает значение вычисляемого свойства.

Request

POST /api/v1/formula/evaluate-property

Parameters

Name	Type	Default	Notes
body	IEvaluatePropertyFormulaRequest		Запрос получения значения вычисляемого свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyValue	OK

Formula.Delete

Удаляет назначенную формулу.

Request

POST /api/v1/formula/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор назначенной формулы.

Responses

Status Code	Type	Description	Samples
200		OK

License

License.GetAll

Возвращает список лицензий пользователя.

Request

POST /api/v1/license/get-all

Responses

Status Code	Type	Description	Samples
200	ILicense[]	OK

License.Release

Освобождает лицензию пользователя.

Request

POST /api/v1/license/release

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор лицензии.

Responses

Status Code	Type	Description	Samples
200		OK

Link

Link.GetById

Возвращает связь.

Request

POST /api/v1/link/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор связи.

Responses

Status Code	Type	Description	Samples
200	ILink	OK

Link.GetByElement

Возвращает связи элемента.

Request

POST /api/v1/link/get-by-element

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	ILink[]	OK

Link.GetLinkedElements

Возвращает связанные элементы.

Request

POST /api/v1/link/get-linked-elements

Parameters

Name	Type	Default	Notes
body	ILinkedElementsRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkedElement[]	OK

LinkDefinition

LinkDefinition.GetById

Возвращает определение связи.

Request

POST /api/v1/link-definition/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор определения связи.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinition	OK

LinkDefinition.GetByUid

Возвращает определение связи по его идентификатору.

Request

POST /api/v1/link-definition/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinition	OK

LinkDefinition.GetByCode

Возвращает определение связи по его коду.

Request

POST /api/v1/link-definition/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeRequest		Код объекта.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinition	OK

LinkDefinition.GetByAbsoluteCode

Возвращает определение связи по его полному коду.

Request

POST /api/v1/link-definition/get-by-absolute-code

Parameters

Name	Type	Default	Notes
body	IGetByAbsoluteCodeRequest		Код объекта.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinition	OK

LinkDefinition.GetByLinkDefinitionEnd

Возвращает определение связи по его концу.

Request

POST /api/v1/link-definition/get-by-link-definition-end

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор конца определения связи.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinition	OK

LinkDefinition.GetPath

Возвращает путь до указанного определения связи / конца определения связи.

Request

POST /api/v1/link-definition/get-path

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор определения связи / конца определения связи.

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

LinkDefinition.GetComparingConditionDefinitions

Возвращает условия совместимости для определения связи.

Request

POST /api/v1/link-definition/get-comparing-condition-definitions

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор определения связи.

Responses

Status Code	Type	Description	Samples
200	IComparingConditionDefinition[]	OK

LinkDefinition.GetCompareOperationsMetadata

Возвращает список доступных операций для условия совместимости.

Request

POST /api/v1/link-definition/get-compare-operations-metadata

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор условия совместимости.

Responses

Status Code	Type	Description	Samples
200	ICompareOperationMetadata[]	OK

LinkDefinition.GetCompabilityConditionsByCode

Возвращает условия совместимости по коду типа связи.

Request

POST /api/v1/link-definition/get-compability-conditions-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeRequest		Код объекта.

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

LinkDefinition.CheckElementExistInScope

Проверяет вхождение владельца свойств в область связи.

Request

POST /api/v1/link-definition/check-element-exist-in-scope

Parameters

Name	Type	Default	Notes
body	ICheckElementExistInScopeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	boolean	OK

LinkDefinition.AddPropertyQualifier

Добавляет свойство для конца условия совместимости.

Request

POST /api/v1/link-definition/add-property-qualifier

Parameters

Name	Type	Default	Notes
body	IEditPropertyQualifiersRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ISearchPropertyQualifier	OK

LinkDefinition.RemovePropertyQualifier

Удаляет свойство у конца условия совместимости.

Request

POST /api/v1/link-definition/remove-property-qualifier

Parameters

Name	Type	Default	Notes
body	IEditPropertyQualifiersRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

LinkDefinition.CreateLinkDefGroup

Создаёт новую группу определений связей.

Request

POST /api/v1/link-definition/create-link-def-group

Parameters

Name	Type	Default	Notes
body	ICreateLinkDefGroupRequest		Запрос создания новой группы определений связей.

Responses

Status Code	Type	Description	Samples
200	IClassifiableObject	OK

LinkDefinition.CreateLinkDefinition

Создаёт определение связи.

Request

POST /api/v1/link-definition/create-link-definition

Parameters

Name	Type	Default	Notes
body	ICreateLinkDefinitionRequest		Запрос создания определения связи.

Responses

Status Code	Type	Description	Samples
200	ILinkDefinition	OK

LinkDefinition.CreateComparingConditionDefinition

Создаёт новое условие совместимости для определения связи.

Request

POST /api/v1/link-definition/create-comparing-condition-definition

Parameters

Name	Type	Default	Notes
body	ICreateComparingConditionDefinitionRequest		Запрос создания нового условия совместимости для определения связи.

Responses

Status Code	Type	Description	Samples
200	IComparingConditionDefinition[]	OK

LinkDefinition.UpdateComparingConditionDefinition

Редактирует условие совместимости для определения связи.

Request

POST /api/v1/link-definition/update-comparing-condition-definition

Parameters

Name	Type	Default	Notes
body	IUpdateComparingConditionDefinitionRequest		Запрос редактирования условия совместимости для определения связи.

Responses

Status Code	Type	Description	Samples
200	IComparingConditionDefinition[]	OK

LinkDefinition.DeleteLinkDefinition

Удаляет определение связи.

Request

POST /api/v1/link-definition/delete-link-definition

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор определения связи.

Responses

Status Code	Type	Description	Samples
200		OK

LinkDefinition.DeleteComparingConditionDefinition

Удаляет условие совместимости.

Request

POST /api/v1/link-definition/delete-comparing-condition-definition

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор условия совместимости.

Responses

Status Code	Type	Description	Samples
200		OK

LinkInstance

LinkInstance.GetByUid

Возвращает экземпляр связи по его идентификатору.

Request

POST /api/v1/link-instance/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	ILinkInstance	OK

LinkInstance.GetById

Возвращает экземпляр связи.

Request

POST /api/v1/link-instance/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор экземпляра связи.

Responses

Status Code	Type	Description	Samples
200	ILinkInstance	OK

LinkInstance.AddConcepts

Добавляет собственные понятия экземпляру связи.

Request

POST /api/v1/link-instance/add-concepts

Parameters

Name	Type	Default	Notes
body	IAddConceptsRequest		Запрос добавления собственных понятий экземпляру связи.

Responses

Status Code	Type	Description	Samples
200		OK

LinkInstance.AddProperties

Добавляет собственные свойства экземпляру связи.

Request

POST /api/v1/link-instance/add-properties

Parameters

Name	Type	Default	Notes
body	IAddPropertiesRequest		Запрос добавления собственных свойств экземпляру связи.

Responses

Status Code	Type	Description	Samples
200		OK

LinkInstance.RemoveConcept

Удаляет собственное понятие экземпляра связи.

Request

POST /api/v1/link-instance/remove-concept

Parameters

Name	Type	Default	Notes
body	IDeleteConceptRequest		Запрос удаления собственного понятия экземпляра связи.

Responses

Status Code	Type	Description	Samples
200		OK

LinkInstance.RemoveProperties

Удаляет собственные свойства экземпляра связи.

Request

POST /api/v1/link-instance/remove-properties

Parameters

Name	Type	Default	Notes
body	IDeletePropertiesRequest		Запрос удаления собственных свойств экземпляра связи.

Responses

Status Code	Type	Description	Samples
200		OK

LinkInstance.CreateLinkElements

Создает связь элементов.

Request

POST /api/v1/link-instance/create-link-elements

Parameters

Name	Type	Default	Notes
body	ILinkElementsRequest		Запрос создания связи элементов.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

LinkInstance.CreateLinkMaterialsAssortments

Создает связь материалов и сортаментов (с указанием документа).

Request

POST /api/v1/link-instance/create-link-materials-assortments

Parameters

Name	Type	Default	Notes
body	ILinkMaterialsAssortmentsRequest		Запрос создания связи материалов и сортаментов.

Responses

Status Code	Type	Description	Samples
200		OK

LinkInstance.DeleteLinks

Удаляет связи элементов.

Request

POST /api/v1/link-instance/delete-links

Parameters

Name	Type	Default	Notes
body	IDeleteLinksRequest		Запрос удаления связи элементов.

Responses

Status Code	Type	Description	Samples
200		OK

Login

Login.StorageDefinitions

Возвращает список хранилищ

Request

GET /api/v1/login/storage-definitions

Responses

Status Code	Type	Description	Samples
200	IStorageDefinition[]	OK

Login.CurrentUserInfo

Возвращает данные авторизованного пользователя

Request

GET /api/v1/login/current-user-info

Responses

Status Code	Type	Description	Samples
200	IUser	OK

Login.CurrentStorageInfo

Возвращает данные авторизованного пользователя

Request

GET /api/v1/login/current-storage-info

Responses

Status Code	Type	Description	Samples
200	IStorageInfo	OK

Login.SsoInfo

Возвращает данные об ОСА

Request

GET /api/v1/login/sso-info

Responses

Status Code	Type	Description	Samples
200	ISsoSettingsResponse	OK

Login.SignIn

Авторизация пользователя

Request

POST /api/v1/login/sign-in

Parameters

Name	Type	Default	Notes
body	ISignInRequest

Responses

Status Code	Type	Description	Samples
200	IAuthResponse	OK

Login.SignInBySystem

Системная авторизация пользователя.

Request

POST /api/v1/login/sign-in-by-system

Parameters

Name	Type	Default	Notes
body	ISignInBySystemRequest

Responses

Status Code	Type	Description	Samples
200	IAuthResponse	OK

Login.UpdateToken

Обновление токена доступа.

Request

PATCH /api/v1/login/update-token

Parameters

Name	Type	Default	Notes
body	string

Responses

Status Code	Type	Description	Samples
200	IAuthResponse	OK
401	ProblemDetails	Unauthorized

Login.SignOut

Выход из системы

Request

DELETE /api/v1/login/sign-out

Responses

Status Code	Type	Description	Samples
200		OK

Materials

Materials.GetByAssortment

Возвращает материалы по идентификаторам сортамента.

Request

POST /api/v1/materials/get-by-assortment

Parameters

Name	Type	Default	Notes
body	IGetMaterialRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

Materials.GetPath

Возвращает путь к каталогу с идентификатором Materials.

Request

POST /api/v1/materials/get-path

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

Materials.LinkToAssortments

Устанавливает связь между материалом и сортаментами.

Request

POST /api/v1/materials/link-to-assortments

Parameters

Name	Type	Default	Notes
body	ILinkAssortmentsRequest		Запрос создания связи материалов и сортаментов.

Responses

Status Code	Type	Description	Samples
200		OK

Materials.Create

Создает материал в указанной группе.

Request

POST /api/v1/materials/create

Parameters

Name	Type	Default	Notes
body	ICreateMaterial		Запрос создания связи материалов и сортаментов.

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Measure

Measure.GetAll

Возвращает всю доступную информацию о единицах измерения.

Request

POST /api/v1/measure/get-all

Parameters

Name	Type	Default	Notes
body	IGetAllMeasureRequest		Запрос получения всех единиц измерения.

Responses

Status Code	Type	Description	Samples
200	IAllMeasurement	OK

MeasureEntity

MeasureEntity.GetById

Возвращает измеряемую величину по ее идентификатору. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-entity/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdMeasureEntityRequest		Запрос поиска измеряемой величины по идентификатору.

Responses

Status Code	Type	Description	Samples
200	IMeasureEntity	OK

MeasureEntity.GetByUid

Возвращает измеряемую величину по ее идентификатору. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-entity/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidMeasureEntityRequest		Запрос поиска измеряемой величины по Guid.

Responses

Status Code	Type	Description	Samples
200	IMeasureEntity	OK

MeasureEntity.GetByCode

Возвращает измеряемую величину по ее коду. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-entity/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeMeasureEntityRequest		Запрос поиска измеряемой величины по коду.

Responses

Status Code	Type	Description	Samples
200	IMeasureEntity	OK

MeasureEntity.GetAll

Возвращает все измеряемые величины. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-entity/get-all

Parameters

Name	Type	Default	Notes
body	IGetAllMeasureEntityRequest		Запрос поиска всех измеряемых величин.

Responses

Status Code	Type	Description	Samples
200	IMeasureEntity[]	OK

MeasureEntity.Create

Создаёт новую измеряемую величину.

Request

POST /api/v1/measure-entity/create

Responses

Status Code	Type	Description	Samples
200	IMeasureEntity	OK

MeasureEntity.Update

Изменяет существующую измеряемую величину.

Request

POST /api/v1/measure-entity/update

Parameters

Name	Type	Default	Notes
body	IUpdateMeasureEntityRequest		Запрос на изменение измеряемой величины.

Responses

Status Code	Type	Description	Samples
200	IMeasureEntity	OK

MeasureEntity.Delete

Удаляет измеряемую величину.

Request

POST /api/v1/measure-entity/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200		OK

MeasureUnit

MeasureUnit.GetById

Возвращает единицу измерения по ее идентификатору. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-unit/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdMeasureUnitRequest		Идентификатор единицы измерения.

Responses

Status Code	Type	Description	Samples
200	IMeasureUnit	OK

MeasureUnit.GetByCode

Возвращает единицу измерения по ее коду. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-unit/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeMeasureUnitRequest		Запрос единицы измерения по коду.

Responses

Status Code	Type	Description	Samples
200	IMeasureUnit	OK

MeasureUnit.GetByEntity

Возвращает список единиц измерения указанной измеряемой величины. При наличии идентификатора хранилища запрос пройдет без авторизации. При отсутствии идентификатор хранилища запрос будет выполнен с авторизацией или, если хранилище единственное, без нее с автоматическим выбором единственного хранилища.

Request

POST /api/v1/measure-unit/get-by-entity

Parameters

Name	Type	Default	Notes
body	IGetByEntityMeasureUnitRequest		Запрос списка единиц измерения.

Responses

Status Code	Type	Description	Samples
200	IMeasureUnit[]	OK

MeasureUnit.Create

Создает единицу измерения для указанной измеряемой величины.

Request

POST /api/v1/measure-unit/create

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Запрос создания единицы измерения.

Responses

Status Code	Type	Description	Samples
200	IMeasureUnit	OK

MeasureUnit.Update

Редактирует единицу измерения.

Request

POST /api/v1/measure-unit/update

Parameters

Name	Type	Default	Notes
body	IUpdateMeasureUnitRequest		Запрос на редактирование.

Responses

Status Code	Type	Description	Samples
200	IMeasureUnit	OK

MeasureUnit.Delete

Удаляет единицу измерения.

Request

POST /api/v1/measure-unit/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Запрос удаления единицы измерения.

Responses

Status Code	Type	Description	Samples
200	IMeasureUnit	OK

OwnedDocument

OwnedDocument.GetByElementGroup

Возвращает все документы группы элементов.

Request

POST /api/v1/owned-document/get-by-element-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы элементов.

Responses

Status Code	Type	Description	Samples
200	IOwnedDocument[]	OK

OwnedDocument.GetByElement

Возвращает все документы элемента.

Request

POST /api/v1/owned-document/get-by-element

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IOwnedDocument[]	OK

Permission

Permission.GetAll

Возвращает все доступные разрешения.

Request

POST /api/v1/permission/get-all

Responses

Status Code	Type	Description	Samples
200	IPermission[]	OK

Permission.GetById

Возвращает разрешение по идентификатору.

Request

POST /api/v1/permission/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор.

Responses

Status Code	Type	Description	Samples
200	IPermission	OK

Permission.GetByLogin

Возвращает разрешения для пользователя.

Request

POST /api/v1/permission/get-by-login

Responses

Status Code	Type	Description	Samples
200	IPermission[]	OK

Permission.GetItemsById

Возвращает список элементов указанного разрешения.

Request

POST /api/v1/permission/get-items-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор разрешения.

Responses

Status Code	Type	Description	Samples
200	IPermissionItem[]	OK

Permission.Create

Создает новое разрешение.

Request

POST /api/v1/permission/create

Responses

Status Code	Type	Description	Samples
200	IPermission	OK

Permission.Update

Изменяет существующее разрешение.

Request

POST /api/v1/permission/update

Parameters

Name	Type	Default	Notes
body	IUpdatePermissionRequest		Запрос на редактирование разрешения.

Responses

Status Code	Type	Description	Samples
200	IPermission	OK

Permission.Delete

Удаляет разрешение.

Request

POST /api/v1/permission/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Запрос удаления разрешения.

Responses

Status Code	Type	Description	Samples
200	IPermission	OK

PropertyDefinition

PropertyDefinition.GetById

Возвращает описание свойства.

Request

POST /api/v1/property-definition/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор описания свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionWithItems	OK

PropertyDefinition.GetByUid

Возвращает описание свойства по его идентификатору.

Request

POST /api/v1/property-definition/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionWithItems	OK

PropertyDefinition.GetByCode

Возвращает описание свойства по его коду.

Request

POST /api/v1/property-definition/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeRequest		Код объекта.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionWithItems	OK

PropertyDefinition.GetByAbsoluteCode

Возвращает описание свойства по его полному коду.

Request

POST /api/v1/property-definition/get-by-absolute-code

Parameters

Name	Type	Default	Notes
body	IGetByAbsoluteCodeRequest		Полный код объекта.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinition	OK

PropertyDefinition.GetByGroup

Возвращает объекты, находящиеся внутри указанной группы описаний свойств.

Request

POST /api/v1/property-definition/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы описаний свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinition[]	OK

PropertyDefinition.Create

Создает новое описание свойства.

Request

POST /api/v1/property-definition/create

Parameters

Name	Type	Default	Notes
body	ICreatePropertyDefinitionRequest		Запрос создания нового описания свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinition	OK

PropertyDefinition.Update

Редактирует определение свойства.

Request

POST /api/v1/property-definition/update

Parameters

Name	Type	Default	Notes
body	IUpdatePropertyDefinitionRequest		Запрос создания нового описания свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinition	OK

PropertyDefinition.AddItem

Добавляет новый пункт перечисления в определение свойства с типом "Перечислимое" или "Множество".

Request

POST /api/v1/property-definition/add-item

Parameters

Name	Type	Default	Notes
body	IAddItemRequest		Запрос добавления пункта перечисления.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinition.RemoveItem

Удаляет пункт перечисления из определения свойства с типом "Перечислимое" или "Множество".

Request

POST /api/v1/property-definition/remove-item

Parameters

Name	Type	Default	Notes
body	IRemoveItemRequest		Запрос удаления пункта перечисления.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinition.AddColumn

Добавляет новый столбец в табличное определение свойства.

Request

POST /api/v1/property-definition/add-column

Parameters

Name	Type	Default	Notes
body	IAddColumnRequest		Запрос добавления столбца.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinition.RemoveColumn

Удаляет столбец из табличного определения свойства.

Request

POST /api/v1/property-definition/remove-column

Parameters

Name	Type	Default	Notes
body	IRemoveColumnRequest		Запрос удаления столбца.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinition.UpdateColumn

Редактирует столбец в табличном определении свойства.

Request

POST /api/v1/property-definition/update-column

Parameters

Name	Type	Default	Notes
body	IUpdateColumnRequest		Запрос редактирования столбца.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinition.GetMoveToGroup

Возвращает признак того, может ли группа или объект быть перемещен в требуемую группу.

Request

POST /api/v1/property-definition/get-move-to-group

Parameters

Name	Type	Default	Notes
body	IGetMoveToGroupPropertyDefinitionGroupRequest		Запрос проверки возможности перемещения.

Responses

Status Code	Type	Description	Samples
200	boolean	OK

PropertyDefinition.SetMoveToGroup

Перемещает объект или группу в требуемую группу.

Request

POST /api/v1/property-definition/set-move-to-group

Parameters

Name	Type	Default	Notes
body	ISetMoveToGroupPropertyDefinitionGroupRequest		Запрос перемещения.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinition.GetUsage

Возвращает информацию об использовании определения свойства.

Request

POST /api/v1/property-definition/get-usage

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор определения свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionUsage	OK

PropertyDefinition.Delete

Удаление определение свойства.

Request

POST /api/v1/property-definition/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Запрос удаления описания свойства.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinitionCatalog

PropertyDefinitionCatalog.GetById

Возвращает каталог определений свойств.

Request

POST /api/v1/property-definition-catalog/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор каталога определений свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionCatalog	OK

PropertyDefinitionCatalog.GetByUid

Возвращает каталог определений свойств по его идентификатору.

Request

POST /api/v1/property-definition-catalog/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionCatalog	OK

PropertyDefinitionCatalog.Get

Возвращает каталог определений свойств.

Request

POST /api/v1/property-definition-catalog/get

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionCatalog	OK

PropertyDefinitionGroup

PropertyDefinitionGroup.GetById

Возвращает группу описаний свойств.

Request

POST /api/v1/property-definition-group/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы описаний свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionGroup	OK

PropertyDefinitionGroup.GetByUid

Возвращает группу описаний свойств по ее идентификатору.

Request

POST /api/v1/property-definition-group/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionGroup	OK

PropertyDefinitionGroup.GetAllInCatalog

Возвращает группы каталога описаний свойств.

Request

POST /api/v1/property-definition-group/get-all-in-catalog

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionGroup[]	OK

PropertyDefinitionGroup.GetByGroup

Возвращает группы, находящиеся внутри указанной группы описаний свойств.

Request

POST /api/v1/property-definition-group/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы описаний свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionGroup[]	OK

PropertyDefinitionGroup.Create

Создает новую группу описаний свойств.

Request

POST /api/v1/property-definition-group/create

Parameters

Name	Type	Default	Notes
body	ICreatePropertyDefinitionGroupRequest		Запрос создания новой группы описаний свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionGroup	OK

PropertyDefinitionGroup.Update

Редактирует группу описаний свойств.

Request

POST /api/v1/property-definition-group/update

Parameters

Name	Type	Default	Notes
body	IUpdatePropertyDefinitionGroupRequest		Запрос обновления группы описаний свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionGroup	OK

PropertyDefinitionGroup.Delete

Удаляет группу описаний свойств.

Request

POST /api/v1/property-definition-group/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор удаляемой группы.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyDefinitionGroup.DeleteMany

Удаляет группы описаний свойств.

Request

POST /api/v1/property-definition-group/delete-many

Parameters

Name	Type	Default	Notes
body	IDeleteManyPropertyDefinitionGroupsRequest		Запрос удаления групп.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner

PropertyOwner.GetById

Возвращает владельца свойств.

Request

POST /api/v1/property-owner/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

PropertyOwner.GetByUid

Возвращает владельца свойств по его идентификатору.

Request

POST /api/v1/property-owner/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

PropertyOwner.GetByLocation

Возвращает свойства владельца свойств по строке расположения.

Request

POST /api/v1/property-owner/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

PropertyOwner.GetProperty

Возвращает свойство владельца свойств.

Request

POST /api/v1/property-owner/get-property

Parameters

Name	Type	Default	Notes
body	IGetPropertyRequest		Запрос свойства владельца свойств.

Responses

Status Code	Type	Description	Samples
200	IPropertyResponse	OK

PropertyOwner.GetProperties

Возвращает владельца свойств.

Request

POST /api/v1/property-owner/get-properties

Parameters

Name	Type	Default	Notes
body	IGetPropertiesRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

PropertyOwner.GetByGroup

Постранично возвращает элементы группы.

Request

POST /api/v1/property-owner/get-by-group

Parameters

Name	Type	Default	Notes
body	IGetPropertiesByGroupRequest		Запрос страницы.

Responses

Status Code	Type	Description	Samples
200	IGetPropertiesByGroupResponse	OK

PropertyOwner.Realizes

Проверяет реализацию контрактов у владельца свойств.

Request

POST /api/v1/property-owner/realizes

Parameters

Name	Type	Default	Notes
body	IRealizesRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IGetPropertiesByGroupResponse	OK

PropertyOwner.GetLinkedPropertyPreview

Возвращает значение связанного свойства для предпросмотра.

Request

POST /api/v1/property-owner/get-linked-property-preview

Parameters

Name	Type	Default	Notes
body	IGetLinkedPropertyRequest		Запрос смены значений свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyValueContainer	OK

PropertyOwner.GetTileImage

Возвращает изображение предварительного просмотра для элемента структуры.

Request

POST /api/v1/property-owner/get-tile-image

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента структуры.

Responses

Status Code	Type	Description	Samples
200	string	OK

PropertyOwner.GetBinaryPropertyValue

Возвращает имя временного файла в хранилище для скачивания значения бинарного свойства.

Request

POST /api/v1/property-owner/get-binary-property-value

Parameters

Name	Type	Default	Notes
body	IGetPropertyRequest		Запрос получения значения свойства.

Responses

Status Code	Type	Description	Samples
200	string	OK

PropertyOwner.ReevaluateGroupFormulas

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

Request

POST /api/v1/property-owner/reevaluate-group-formulas

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.ReevaluateElementFormulas

Перевычисляет все поля элемента по формулам и возвращает владельца свойств.

Request

POST /api/v1/property-owner/reevaluate-element-formulas

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

PropertyOwner.SetPropertyValues

Устанавливает значения свойств владельца свойств.

Request

POST /api/v1/property-owner/set-property-values

Parameters

Name	Type	Default	Notes
body	ISetPropertyValuesRequest		Запрос изменения значений свойств.

Responses

Status Code	Type	Description	Samples
200	ISetPropertyValuesResponse	OK

PropertyOwner.AddTablePropertyRow

Добавляет новую строку в табличное свойство.

Request

POST /api/v1/property-owner/add-table-property-row

Parameters

Name	Type	Default	Notes
body	IAddTablePropertyRowRequest		Запрос добавления строки в табличное свойство.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.RemoveTablePropertyRow

Удаляет указанную строку из табличного свойства.

Request

POST /api/v1/property-owner/remove-table-property-row

Parameters

Name	Type	Default	Notes
body	IRemoveTablePropertyRowRequest		Запрос удаления строки из табличного свойства.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.ReplaceTablePropertyRow

Изменяет позицию строки в табличном свойстве.

Request

POST /api/v1/property-owner/replace-table-property-row

Parameters

Name	Type	Default	Notes
body	IReplaceTablePropertyRowRequest		Запрос изменения позиции строки в табличном свойстве

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.SetTablePropertyValues

Устанавливает значения свойств таблицы.

Request

POST /api/v1/property-owner/set-table-property-values

Parameters

Name	Type	Default	Notes
body	ISetTablePropertyValuesRequest		Запрос изменения значений табличного свойства.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.SetLinkedPropertyValues

Устанавливает значения связанных свойств владельца свойств.

Request

POST /api/v1/property-owner/set-linked-property-values

Parameters

Name	Type	Default	Notes
body	ISetLinkedPropertyValuesRequest		Запрос смены значений свойств.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.SetFormulaPropertyValues

Устанавливает формулы для вычисления свойств владельца свойств.

Request

POST /api/v1/property-owner/set-formula-property-values

Parameters

Name	Type	Default	Notes
body	ISetFormulaPropertyValueRequest		Запрос смены значений свойств.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.SetExternalFormula

Вычисляет значение свойства по формуле, заданной для группы.

Request

POST /api/v1/property-owner/set-external-formula

Parameters

Name	Type	Default	Notes
body	ISetExternalFormulaRequest		Запрос вычисления значения свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyResponse	OK

PropertyOwner.UploadBinaryPropertyValue

Загружает файл во временное хранилище.

Request

POST /api/v1/property-owner/upload-binary-property-value

Parameters

Name	Type	Default	Notes
file			Файл.

Responses

Status Code	Type	Description	Samples
200	string	OK

PropertyOwner.AddManyOwnProperties

Добавляет собственные свойства объекту.

Request

POST /api/v1/property-owner/add-many-own-properties

Parameters

Name	Type	Default	Notes
body	IAddManyToRequest		Запрос добавления собственных свойств объекту.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.AddManyOwnConcepts

Добавляет собственные понятия объекту.

Request

POST /api/v1/property-owner/add-many-own-concepts

Parameters

Name	Type	Default	Notes
body	IAddManyToRequest		Запрос добавления собственных понятий объекту.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.RemoveManyOwnProperties

Удаляет собственные свойства объекта.

Request

POST /api/v1/property-owner/remove-many-own-properties

Parameters

Name	Type	Default	Notes
body	IRemoveManyOwnPropertiesRequest		Запрос удаления собственных свойств объекта.

Responses

Status Code	Type	Description	Samples
200		OK

PropertyOwner.RemoveManyOwnConcepts

Удаляет собственные понятия объекта.

Request

POST /api/v1/property-owner/remove-many-own-concepts

Parameters

Name	Type	Default	Notes
body	IRemoveManyOwnConceptsRequest		Запрос удаления собственных понятий объекта.

Responses

Status Code	Type	Description	Samples
200		OK

RecentItem

RecentItem.Get

Возвращает содержимое списка недавних объектов.

Request

POST /api/v1/recent-item/get

Responses

Status Code	Type	Description	Samples
200	IElement[]	OK

RecentItem.Create

Добавляет объект в список недавних.

Request

POST /api/v1/recent-item/create

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200		OK

RecentItem.Delete

Удаляет объект из списка недавних.

Request

POST /api/v1/recent-item/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200		OK

Reference

Reference.GetById

Возвращает справочник.

Request

POST /api/v1/reference/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	IReference	OK

Reference.GetByUid

Возвращает справочник по его идентификатору.

Request

POST /api/v1/reference/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IReference	OK

Reference.GetByLocation

Возвращает справочник.

Request

POST /api/v1/reference/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IReference	OK

Reference.GetDefaultLocation

Возвращает строку расположения справочника.

Request

POST /api/v1/reference/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	string	OK

Reference.GetOwnerReference

Возвращает справочник-владелец для указанного объекта.

Request

POST /api/v1/reference/get-owner-reference

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest

Responses

Status Code	Type	Description	Samples
200	IReference	OK

Reference.GetAll

Возвращает все справочники.

Request

POST /api/v1/reference/get-all

Responses

Status Code	Type	Description	Samples
200	IReference[]	OK

Reference.GetEntries

Возвращает каталоги и группы справочника с включенной опцией «Быстрый доступ».

Request

POST /api/v1/reference/get-entries

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	IClassifiableObject[]	OK

Reference.Create

Создаёт новый справочник.

Request

POST /api/v1/reference/create

Parameters

Name	Type	Default	Notes
body	ICreateReferenceRequest		Наименование справочника.

Responses

Status Code	Type	Description	Samples
200	IReference	OK

Reference.Update

Изменяет данные о справочнике.

Request

POST /api/v1/reference/update

Parameters

Name	Type	Default	Notes
body	IUpdateReferenceRequest		Параметры запроса обновления справочника.

Responses

Status Code	Type	Description	Samples
200	IReference	OK

Reference.Delete

Удаляет справочник.

Request

POST /api/v1/reference/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200		OK

RestrictedList

RestrictedList.GetById

Возвращает ограничительный перечень по идентификатору объекта.

Request

POST /api/v1/restricted-list/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор объекта.

Responses

Status Code	Type	Description	Samples
200	IRestrictedList	OK

RestrictedList.GetByCode

Возвращает ограничительный перечень по коду объекта.

Request

POST /api/v1/restricted-list/get-by-code

Parameters

Name	Type	Default	Notes
body	IGetByCodeRequest		Запрос ограничительного перечня по коду.

Responses

Status Code	Type	Description	Samples
200	IRestrictedList	OK

RestrictedList.GetByUser

Возвращает список ограничительных перечней для текущего пользователя.

Request

POST /api/v1/restricted-list/get-by-user

Parameters

Name	Type	Default	Notes
body	IGetByUserRestrictedListRequest		Запрос списка ограничительных перечней.

Responses

Status Code	Type	Description	Samples
200	IRestrictedListPaginatedList	OK

RestrictedList.GetAll

Возвращает все ограничительные перечни с учетом запроса.

Request

POST /api/v1/restricted-list/get-all

Parameters

Name	Type	Default	Notes
body	IGetAllRestrictedListRequest		Объект запроса ограничительных перечней.

Responses

Status Code	Type	Description	Samples
200	IRestrictedListPaginatedList	OK

RestrictedList.GetRoleItems

Возвращает список ролей ограничительного перечня.

Request

POST /api/v1/restricted-list/get-role-items

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

RestrictedList.GetRoleItem

Возвращает роль ограничительного перечня.

Request

POST /api/v1/restricted-list/get-role-item

Parameters

Name	Type	Default	Notes
body	IGetRoleItemRestrictedListRequest		Запрос роли ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200	IRestrictedListRole	OK

RestrictedList.GetOwners

Возвращает коллекцию объектов и документов, входящих в ограничительный перечень.

Request

POST /api/v1/restricted-list/get-owners

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

RestrictedList.GetStatistics

Возвращает статистику.

Request

POST /api/v1/restricted-list/get-statistics

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200	IIdentifiableObject[]	OK

RestrictedList.GetByGroupPropertyOwner

Возвращает коллекцию ограничительных перечней владельца свойств.

Request

POST /api/v1/restricted-list/get-by-group-property-owner

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Объект владельца свойств.

Responses

Status Code	Type	Description	Samples
200	IRestrictedListGroupPropertyOwnerItem[]	OK

RestrictedList.Create

Создает новый ограничительный перечень.

Request

POST /api/v1/restricted-list/create

Responses

Status Code	Type	Description	Samples
200	IRestrictedList	OK

RestrictedList.Update

Редактирует ограничительный перечень.

Request

POST /api/v1/restricted-list/update

Parameters

Name	Type	Default	Notes
body	IUpdateRestrictedListRequest		Объект редактирования ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200	IRestrictedList	OK

RestrictedList.AddOwner

Добавляет владельца ограничительного перечня.

Request

POST /api/v1/restricted-list/add-owner

Parameters

Name	Type	Default	Notes
body	IAddOwnerRestrictedListRequest		Объект запроса добавления владельца.

Responses

Status Code	Type	Description	Samples
200		OK

RestrictedList.RemoveOwner

Удаляет владельца ограничительного перечня.

Request

POST /api/v1/restricted-list/remove-owner

Parameters

Name	Type	Default	Notes
body	IRemoveOwnerRestrictedListRequest		Объект запроса удаления владельца.

Responses

Status Code	Type	Description	Samples
200		OK

RestrictedList.UpdateRoleItem

Редактирует значение элемента ограничительного перечня.

Request

POST /api/v1/restricted-list/update-role-item

Parameters

Name	Type	Default	Notes
body	IUpdateRoleRestrictedListRequest		Объект запроса редактирования элемента перечня.

Responses

Status Code	Type	Description	Samples
200	IRestrictedListRole	OK

RestrictedList.Delete

Удаляет ограничительный перечень.

Request

POST /api/v1/restricted-list/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200		OK

RestrictedList.SetItem

Переключает ограничительный перечень у владельца.

Request

POST /api/v1/restricted-list/set-item

Parameters

Name	Type	Default	Notes
body	ISetItemRestrictedListRequest		Объект запроса ограничения перечня.

Responses

Status Code	Type	Description	Samples
200	IRestrictedListGroupPropertyOwnerItem	OK

Role

Role.GetById

Возвращает роль.

Request

POST /api/v1/role/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор роли.

Responses

Status Code	Type	Description	Samples
200	IRole	OK

Role.GetByUid

Возвращает роль по ее идентификатору.

Request

POST /api/v1/role/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IRole	OK

Role.GetAll

Возвращает все роли.

Request

POST /api/v1/role/get-all

Responses

Status Code	Type	Description	Samples
200	IRole[]	OK

Search

Search.GetStatus

Возвращает статус запроса

Request

POST /api/v1/search/get-status

Responses

Status Code	Type	Description	Samples
200	ISearchStatusResponse	OK

Search.ExecuteSearch

Возвращает страницу с результатами поиска

Request

POST /api/v1/search/execute-search

Parameters

Name	Type	Default	Notes
body	ISearchRequest

Responses

Status Code	Type	Description	Samples
200	ISearchResultItemIPaginatedList	OK

Search.GetDefaultSearchCondition

Возвращает данные об условии поиска по умолчанию

Request

POST /api/v1/search/get-default-search-condition

Responses

Status Code	Type	Description	Samples
200	ISearchCondition	OK

Search.GetSearchCondition

Возвращает данные об условии поиска

Request

POST /api/v1/search/get-search-condition

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор свойства поиска.

Responses

Status Code	Type	Description	Samples
200	ISearchCondition	OK

Search.GetComparingConditions

Возвращает сравнительные условия для указанного конца определения связи.

Request

POST /api/v1/search/get-comparing-conditions

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор конца определения связи.

Responses

Status Code	Type	Description	Samples
200	IComparingCondition[]	OK

Search.GetStoredConditions

Возвращает список хранимых условий поиска текущего пользователя

Request

POST /api/v1/search/get-stored-conditions

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

Search.GetStoredCondition

Возвращает хранимое условие поиска

Request

POST /api/v1/search/get-stored-condition

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор хранимого условия поиска.

Responses

Status Code	Type	Description	Samples
200	IStoredCondition	OK

Search.ExecutePropertySearch

Возвращает результат поиска по свойствам

Request

POST /api/v1/search/execute-property-search

Parameters

Name	Type	Default	Notes
body	IPropertySearchRequest		Запрос поиска по свойствам.

Responses

Status Code	Type	Description	Samples
200	IPropertySearchResultObjectIPaginatedList	OK

Search.ExecutePropertySearchComplexScopes

Возвращает результат поиска по свойствам с составной областью поиска

Request

POST /api/v1/search/execute-property-search-complex-scopes

Parameters

Name	Type	Default	Notes
body	IPropertySearchComplexScopesRequest		Запрос поиска по свойствам с составной областью поиска.

Responses

Status Code	Type	Description	Samples
200	IPropertySearchResultObjectIPaginatedList	OK

Search.ExecuteTicketSearch

Возвращает результат поиска заявок

Request

POST /api/v1/search/execute-ticket-search

Parameters

Name	Type	Default	Notes
body	IExecuteSearchTicketRequest		Запрос поиска заявок.

Responses

Status Code	Type	Description	Samples
200	ITicketBaseInfo[]	OK

Search.CreateStoredCondition

Создаёт хранимую конфигурацию поиска по свойствам

Request

POST /api/v1/search/create-stored-condition

Parameters

Name	Type	Default	Notes
body	ICreateStoredConditionRequest		Конфигурация условий поиска для сохранения.

Responses

Status Code	Type	Description	Samples
200		OK

Search.DeleteStoredCondition

Удаляет хранимую конфигурацию поиска по свойствам

Request

POST /api/v1/search/delete-stored-condition

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор хранимого условия поиска.

Responses

Status Code	Type	Description	Samples
200	IStoredCondition	OK

Search.GetCompabilityElements

Возвращает совместимые элементы.

Request

POST /api/v1/search/get-compability-elements

Parameters

Name	Type	Default	Notes
body	IGetCompabilityElementsRequest		Запрос совместимых элементов.

Responses

Status Code	Type	Description	Samples
200	IPropertySearchResultObjectIPaginatedList	OK

Search.GetDuplicates

Возвращает результат поиска дублей.

Request

POST /api/v1/search/get-duplicates

Parameters

Name	Type	Default	Notes
body	IGetDuplicatesRequest		Запрос поиска дублей.

Responses

Status Code	Type	Description	Samples
200	ISearchDuplicateItem[]	OK

Search.ReplaceDuplicates

Производит замену дублей оригиналом.

Request

POST /api/v1/search/replace-duplicates

Parameters

Name	Type	Default	Notes
body	IReplaceDuplicatesRequest		Запрос замены дублей.

Responses

Status Code	Type	Description	Samples
200		OK

Search.JoinDuplicates

Производит объединение дублей с оригиналом.

Request

POST /api/v1/search/join-duplicates

Parameters

Name	Type	Default	Notes
body	IJoinDuplicatesRequest		Запрос объединения дублей.

Responses

Status Code	Type	Description	Samples
200		OK

Search.DeleteDuplicates

Производит удаление дублей.

Request

POST /api/v1/search/delete-duplicates

Parameters

Name	Type	Default	Notes
body	IDeleteDuplicatesRequest		Запрос удаления дублей.

Responses

Status Code	Type	Description	Samples
200		OK

Security

Security.GetRolesByReference

Возвращает список ролей с доступом к справочнику.

Request

POST /api/v1/security/get-roles-by-reference

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	IRole[]	OK

Security.GetCatalogRights

Возвращает настройки безопасности каталога.

Request

POST /api/v1/security/get-catalog-rights

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор каталога.

Responses

Status Code	Type	Description	Samples
200	IStructureRight[]	OK

Security.GetGroupRights

Возвращает настройки безопасности группы.

Request

POST /api/v1/security/get-group-rights

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы.

Responses

Status Code	Type	Description	Samples
200	IGroupSecurity	OK

Security.AddRightCatalog

Добавляет новое право для указанного каталога.

Request

POST /api/v1/security/add-right-catalog

Parameters

Name	Type	Default	Notes
body	IAddRightRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.AddRight

Добавляет новое право для указанного субъекта доступа.

Request

POST /api/v1/security/add-right

Parameters

Name	Type	Default	Notes
body	IAddRightRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.AddConcept

Добавляет понятие в настройки безопасности группы.

Request

POST /api/v1/security/add-concept

Parameters

Name	Type	Default	Notes
body	IGroupConceptsEditRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConcept	OK

Security.UpdateCatalogRightSettings

Изменяет настройки доступа роли для указанного каталога.

Request

POST /api/v1/security/update-catalog-right-settings

Parameters

Name	Type	Default	Notes
body	ICatalogRightSettingsRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.UpdateGroupRightSettings

Изменяет настройки доступа роли для указанной группы.

Request

POST /api/v1/security/update-group-right-settings

Parameters

Name	Type	Default	Notes
body	IGroupRightSettingsRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.UpdateConceptRightSettings

Изменяет настройки доступа роли для указанного понятия.

Request

POST /api/v1/security/update-concept-right-settings

Parameters

Name	Type	Default	Notes
body	IConceptRightSettingsRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.RemoveRightCatalog

Удаляет право для указанного каталога.

Request

POST /api/v1/security/remove-right-catalog

Parameters

Name	Type	Default	Notes
body	IRemoveRightRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.RemoveRight

Удаляет право для указанного субъекта доступа.

Request

POST /api/v1/security/remove-right

Parameters

Name	Type	Default	Notes
body	IRemoveRightRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Security.RemoveConcept

Удаляет понятие из настроек безопасности группы.

Request

POST /api/v1/security/remove-concept

Parameters

Name	Type	Default	Notes
body	IGroupConceptsEditRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Sso

Sso.GetSettings

Возвращает адрес общей системы авторизации.

Request

POST /api/v1/sso/get-settings

Responses

Status Code	Type	Description	Samples
200	ISsoSettingsResponse	OK

StandardSizes

StandardSizes.GetByAssortment

Возвращает типоразмеры по идентификаторам сортамента.

Request

POST /api/v1/standard-sizes/get-by-assortment

Parameters

Name	Type	Default	Notes
body	IGetStandardSizeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IElementPaginatedList	OK

StandardSizes.GetPath

Возвращает путь к группе типоразмеров по идентификаторам сортамента.

Request

POST /api/v1/standard-sizes/get-path

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор сортамента

Responses

Status Code	Type	Description	Samples
200	INamedObject[]	OK

StandardSizes.GetDefinedDimensions

Возвращает список свойств из группы "Материалы и сортаменты → Свойства сортаментов → Определяемые размеры".

Request

POST /api/v1/standard-sizes/get-defined-dimensions

Responses

Status Code	Type	Description	Samples
200	IPropertyDefinitionBase[]	OK

StandardSizes.CreateTemplate

Создает шаблон типоразмера и группу для указанного сортамента.

Request

POST /api/v1/standard-sizes/create-template

Parameters

Name	Type	Default	Notes
body	ICreateStandardsizeTemplateRequest

Responses

Status Code	Type	Description	Samples
200	IStandardsizeDesignationTemplate	OK

StandardSizes.GetTemplate

Возвращает шаблон типоразмера.

Request

POST /api/v1/standard-sizes/get-template

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы элементов

Responses

Status Code	Type	Description	Samples
200	IStandardsizeDesignationTemplate	OK

StandardSizes.UpdateTemplate

Редактирует шаблон указанного типоразмера.

Request

POST /api/v1/standard-sizes/update-template

Parameters

Name	Type	Default	Notes
body	IUpdateStandardSizeTemplateRequest

Responses

Status Code	Type	Description	Samples
200	IStandardsizeDesignationTemplate	OK

StandardSizes.Create

Создает типоразмер для указанного сортамента.

Request

POST /api/v1/standard-sizes/create

Parameters

Name	Type	Default	Notes
body	ICreateStandardsizeRequest

Responses

Status Code	Type	Description	Samples
200	IElement	OK

Storage

Storage.GetStorageSettings

Возвращает настройки хранилища.

Request

POST /api/v1/storage/get-storage-settings

Responses

Status Code	Type	Description	Samples
200		OK

Storage.SetStorageSettings

Устанавливает настройки хранилища.

Request

POST /api/v1/storage/set-storage-settings

Parameters

Name	Type	Default	Notes
body	ISetStorageSettingsRequest		Запрос установки настроек хранилища.

Responses

Status Code	Type	Description	Samples
200	IStorageSettingsResponse	OK

Table

Table.GetTable

Возвращает содержимое группы в виде таблицы.

Request

POST /api/v1/table/get-table

Parameters

Name	Type	Default	Notes
body	IGetTableRequest		Запрос таблицы.

Responses

Status Code	Type	Description	Samples
200	ITable	OK

Table.GetFilterValues

Возвращает уникальные значения для указанного столбца таблицы.

Request

POST /api/v1/table/get-filter-values

Parameters

Name	Type	Default	Notes
body	IGetFilterValuesRequest		Идентификатор квалификатора свойства.

Responses

Status Code	Type	Description	Samples
200	IPropertyValueContainer	OK

Table.GetColumnsInfo

Возвращает информацию о столбцах для таблицы.

Request

POST /api/v1/table/get-columns-info

Parameters

Name	Type	Default	Notes
body	IGetColumnsInfoRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IGetColumnsInfoResponse	OK

Table.GetSettings

Возвращает настройки таблицы элемента структуры.

Request

POST /api/v1/table/get-settings

Parameters

Name	Type	Default	Notes
body	IGetTableSettingsRequest

Responses

Status Code	Type	Description	Samples
200	IHierarchicalTableSettings	OK

Table.CreateTableColumnDefinition

Создаёт новое определение столбца таблицы в настройках таблицы.

Request

POST /api/v1/table/create-table-column-definition

Parameters

Name	Type	Default	Notes
body	ICreateTableColumnDefinitionRequest		Запрос создания определения столбца таблицы.

Responses

Status Code	Type	Description	Samples
200	IHierarchicalTableSettings	OK

Table.DeleteTableColumnDefinition

Удаляет определение столбца таблицы из настроек таблицы.

Request

POST /api/v1/table/delete-table-column-definition

Parameters

Name	Type	Default	Notes
body	IDeleteTableColumnDefinitionRequest		Запрос на удаление столбца таблицы.

Responses

Status Code	Type	Description	Samples
200		OK

Table.SetOverrideSettings

Устанавливает признак переопределения настроек таблицы.

Request

POST /api/v1/table/set-override-settings

Parameters

Name	Type	Default	Notes
body	ISetOverrideSettingRequest

Responses

Status Code	Type	Description	Samples
200	IHierarchicalTableSettings	OK

Table.SetInheritanceSettings

Устанавливает признак наследования настроек таблицы.

Request

POST /api/v1/table/set-inheritance-settings

Parameters

Name	Type	Default	Notes
body	ISetInheritanceSettings

Responses

Status Code	Type	Description	Samples
200		OK

Table.UpdateMeasureUnitOfColumn

Изменяет единицу измерения у определения столбца таблицы.

Request

POST /api/v1/table/update-measure-unit-of-column

Parameters

Name	Type	Default	Notes
body	IUpdateMeasureUnitOfColumnRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

Table.UpdatePositionOfColumns

Изменяет порядок определений столбцов таблицы.

Request

POST /api/v1/table/update-position-of-columns

Parameters

Name	Type	Default	Notes
body	IUpdatePositionOfColumnsRequest		Запрос на изменение порядка определений столбцов таблицы.

Responses

Status Code	Type	Description	Samples
200		OK

Table.UpdatePositionOfColumnsForUser

Изменяет порядок столбцов таблицы для текущего пользователя.

Request

POST /api/v1/table/update-position-of-columns-for-user

Parameters

Name	Type	Default	Notes
body	IUpdatePositionOfColumnsRequest		Запрос изменения позиций колонок.

Responses

Status Code	Type	Description	Samples
200		OK

Table.UpdateColumnsForUser

Изменяет состав столбцов таблицы для текущего пользователя.

Request

POST /api/v1/table/update-columns-for-user

Parameters

Name	Type	Default	Notes
body	IUpdateColumnsForUserRequest		Запрос изменения состава колонок.

Responses

Status Code	Type	Description	Samples
200		OK

Table.ResetSettingsForUser

Сбрасывает настройки таблицы для текущего пользователя.

Request

POST /api/v1/table/reset-settings-for-user

Parameters

Name	Type	Default	Notes
body	IResetSettingsForUserRequest		Идентификатор группы.

Responses

Status Code	Type	Description	Samples
200		OK

Ticket

Ticket.GetTemplate

Возвращает шаблон для заполнения дополнительных свойств заявки.

Request

POST /api/v1/ticket/get-template

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerContainer	OK

Ticket.GetById

Возвращает общую информацию о заявке.

Request

POST /api/v1/ticket/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор заявки.

Responses

Status Code	Type	Description	Samples
200	Ticket	OK

Ticket.GetAdditionalProperties

Возвращает свойства, дополнительно назначенные заявке.

Request

POST /api/v1/ticket/get-additional-properties

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор заявки.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerContainer	OK

Ticket.GetBusinessProcessDisplayItems

Возвращает коллекцию элементов бизнес-процесса.

Request

POST /api/v1/ticket/get-business-process-display-items

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор заявки

Responses

Status Code	Type	Description	Samples
200	IBusinessProcessDisplayItem[]	OK

Ticket.GetBusinessProcessCommands

Возвращает коллекцию доступных команд.

Request

POST /api/v1/ticket/get-business-process-commands

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор заявки

Responses

Status Code	Type	Description	Samples
200	IBusinessProcessCommand[]	OK

Ticket.ExecuteBusinessProcessCommand

Выполняет команду.

Request

POST /api/v1/ticket/execute-business-process-command

Parameters

Name	Type	Default	Notes
body	IExecuteBusinessProcessCommandTicketRequest		Запрос выполнения команды.

Responses

Status Code	Type	Description	Samples
200		OK

Ticket.Revoke

Отзывает заявку.

Request

POST /api/v1/ticket/revoke

Parameters

Name	Type	Default	Notes
body	IRevokeTicketRequest		Запрос отзыва заявки.

Responses

Status Code	Type	Description	Samples
200		OK

Ticket.GetTable

Возвращает содержимое таблицы заявок.

Request

POST /api/v1/ticket/get-table

Parameters

Name	Type	Default	Notes
body	IGetTableTicketRequest		Запрос таблицы.

Responses

Status Code	Type	Description	Samples
200	ITable	OK

Ticket.GetUniqueCellValues

Возвращает уникальные значения для указанного столбца таблицы.

Request

POST /api/v1/ticket/get-unique-cell-values

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор квалификатора свойства.

Responses

Status Code	Type	Description	Samples
200	IAblePropertyValues	OK

Ticket.AddApprovementStage

Добавляет этап согласования в заявку.

Request

POST /api/v1/ticket/add-approvement-stage

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор заявки.

Responses

Status Code	Type	Description	Samples
200	ITicket	OK

Ticket.RemoveApprovementStage

Удаляет этап согласования.

Request

POST /api/v1/ticket/remove-approvement-stage

Parameters

Name	Type	Default	Notes
body	IRemoveApprovementStageTicketRequest		Запрос удаления.

Responses

Status Code	Type	Description	Samples
200		OK

Ticket.SetApprovementStageUser

Назначает ответственного этапу согласования.

Request

POST /api/v1/ticket/set-approvement-stage-user

Parameters

Name	Type	Default	Notes
body	ISetApprovementStageUserTicketRequest		Запрос назначения ответственного.

Responses

Status Code	Type	Description	Samples
200	ITicket	OK

Ticket.ReportToAdministrator

Отправляет сообщение о проблеме.

Request

POST /api/v1/ticket/report-to-administrator

Parameters

Name	Type	Default	Notes
body	IReportToAdministratorTicketRequest		Запрос сообщения о проблеме.

Responses

Status Code	Type	Description	Samples
200	ITicket	OK

Ticket.GetHistory

Возвращает историю сообщений заявки.

Request

POST /api/v1/ticket/get-history

Parameters

Name	Type	Default	Notes
body	IGetHistoryTicketRequest		Запрос истории сообщений заявки.

Responses

Status Code	Type	Description	Samples
200	ITicketMessage[]	OK

Ticket.CreateComment

Создаёт комментарий.

Request

POST /api/v1/ticket/create-comment

Parameters

Name	Type	Default	Notes
body	ICreateCommentTicketRequest		Запрос создания комментария.

Responses

Status Code	Type	Description	Samples
200	ITicketMessage	OK

Ticket.UpdateComment

Редактирует комментарий.

Request

POST /api/v1/ticket/update-comment

Parameters

Name	Type	Default	Notes
body	ICreateCommentTicketRequest		Запрос редактирования комментария.

Responses

Status Code	Type	Description	Samples
200	ITicketMessage	OK

Ticket.RemoveComment

Удаляет комментарий.

Request

POST /api/v1/ticket/remove-comment

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор комментария.

Responses

Status Code	Type	Description	Samples
200		OK

Ticket.ExecuteSearch

Возвращает страницу с результатами поиска заявок

Request

POST /api/v1/ticket/execute-search

Parameters

Name	Type	Default	Notes
body	IExecuteSearchTicketRequest

Responses

Status Code	Type	Description	Samples
200	ISearchResultTicketPaginatedList	OK

Ticket.Create

Создает заявку.

Request

POST /api/v1/ticket/create

Parameters

Name	Type	Default	Notes
body	ICreateTicketRequest		Запрос на создание заявки.

Responses

Status Code	Type	Description	Samples
200	ITicket	OK

Ticket.Update

Редактирует заявку.

Request

POST /api/v1/ticket/update

Parameters

Name	Type	Default	Notes
body	IUpdateTicketRequest		Запрос на редактирование заявки.

Responses

Status Code	Type	Description	Samples
200	ITicket	OK

Ticket.Delete

Удаляет заявку.

Request

POST /api/v1/ticket/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор заявки.

Responses

Status Code	Type	Description	Samples
200		OK

Tree

Tree.GetClassification

Возвращает корень дерева классификации.

Request

POST /api/v1/tree/get-classification

Parameters

Name	Type	Default	Notes
body	IClassificationTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeIPaginatedList	OK

Tree.GetClassificationReference

Возвращает каталоги дерева классификации для указанного справочника.

Request

POST /api/v1/tree/get-classification-reference

Parameters

Name	Type	Default	Notes
body	IClassificationNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeIPaginatedList	OK

Tree.GetClassificationNode

Возвращает узел дерева классификации.

Request

POST /api/v1/tree/get-classification-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNode	OK

Tree.GetClassificationNodeChildren

Возвращает дочерние узлы узла дерева классификации.

Request

POST /api/v1/tree/get-classification-node-children

Parameters

Name	Type	Default	Notes
body	IClassificationNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeIPaginatedList	OK

Tree.FindNode

Возвращает дочерний узел дерева классификации.

Request

POST /api/v1/tree/find-node

Parameters

Name	Type	Default	Notes
body	IFindChildClassificationNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeTask	OK

Tree.GetScopeClassificationFilterItems

Возвращает список элементов фильтра для указанных областей фильтрации.

Request

POST /api/v1/tree/get-scope-classification-filter-items

Parameters

Name	Type	Default	Notes
body	IScopeClassificationFilterItemsRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IGetFilterItemsResponse	OK

Tree.GetScopeClassification

Возвращает первый уровень дерева классификации, отфильтрованного по областям.

Request

POST /api/v1/tree/get-scope-classification

Parameters

Name	Type	Default	Notes
body	IScopeClassificationTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeIPaginatedList	OK

Tree.GetScopeClassificationNode

Возвращает указанный узел дерева классификации, отфильтрованного по областям.

Request

POST /api/v1/tree/get-scope-classification-node

Parameters

Name	Type	Default	Notes
body	IScopeClassificationNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNode	OK

Tree.GetScopeClassificationNodeChildren

Возвращает содержимое указанного узла дерева классификации, отфильтрованного по областям.

Request

POST /api/v1/tree/get-scope-classification-node-children

Parameters

Name	Type	Default	Notes
body	IScopeClassificationNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeIPaginatedList	OK

Tree.GetPropDefClassification

Возвращает первый уровень дерева свойств.

Request

POST /api/v1/tree/get-prop-def-classification

Parameters

Name	Type	Default	Notes
body	IPropDefClassificationTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IPropertyTreeNodeIPaginatedList	OK

Tree.GetPropDefClassificationNode

Возвращает указанный узел дерева свойств.

Request

POST /api/v1/tree/get-prop-def-classification-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IPropertyTreeNode	OK

Tree.GetPropDefClassificationNodeChildren

Возвращает содержимое указанного узла дерева свойств.

Request

POST /api/v1/tree/get-prop-def-classification-node-children

Parameters

Name	Type	Default	Notes
body	IPropDefClassificationTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IPropertyTreeNodeIPaginatedList	OK

Tree.GetConceptClassification

Возвращает первый уровень дерева понятий.

Request

POST /api/v1/tree/get-concept-classification

Parameters

Name	Type	Default	Notes
body	IConceptClassificationTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNodeIPaginatedList	OK

Tree.GetConceptClassificationNode

Возвращает указанный узел дерева понятий.

Request

POST /api/v1/tree/get-concept-classification-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNode	OK

Tree.GetConceptClassificationNodeChildren

Возвращает содержимое указанного узла дерева понятий.

Request

POST /api/v1/tree/get-concept-classification-node-children

Parameters

Name	Type	Default	Notes
body	IConceptClassificationTreeNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNodeIPaginatedList	OK

Tree.GetConceptPropertySource

Возвращает первый уровень дерева понятий со свойствами.

Request

POST /api/v1/tree/get-concept-property-source

Parameters

Name	Type	Default	Notes
body	IConceptPropertySourceTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNodeIPaginatedList	OK

Tree.GetConceptPropertySourceNode

Возвращает указанный узел дерева понятий со свойствами.

Request

POST /api/v1/tree/get-concept-property-source-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNode	OK

Tree.GetConceptPropertySourceNodeChildren

Возвращает содержимое указанного узла дерева понятий со свойствами.

Request

POST /api/v1/tree/get-concept-property-source-node-children

Parameters

Name	Type	Default	Notes
body	IConceptPropertySourceTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNodeIPaginatedList	OK

Tree.GetOwnConceptPropertySource

Возвращает дерево собственных понятий каталога/группы.

Request

POST /api/v1/tree/get-own-concept-property-source

Parameters

Name	Type	Default	Notes
body	IOwnConceptPropertySourceRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IConceptTreeNodeIPaginatedList	OK

Tree.GetEventLog

Возвращает корень дерева событий.

Request

POST /api/v1/tree/get-event-log

Parameters

Name	Type	Default	Notes
body	IEventLogTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IEventLogTreeNode	OK

Tree.GetEventLogNode

Возвращает содержимое первого уровня указанного узла дерева событий.

Request

POST /api/v1/tree/get-event-log-node

Parameters

Name	Type	Default	Notes
body	IEventLogNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IEventLogTreeNodeIPaginatedList	OK

Tree.GetFormula

Возвращает первый уровень дерева формул.

Request

POST /api/v1/tree/get-formula

Parameters

Name	Type	Default	Notes
body	IFormulaTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetFormulaNode

Возвращает указанный узел дерева формул.

Request

POST /api/v1/tree/get-formula-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNode	OK

Tree.GetFormulaNodeChildren

Возвращает содержимое указанного узла дерева формул.

Request

POST /api/v1/tree/get-formula-node-children

Parameters

Name	Type	Default	Notes
body	IFormulaTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetViewpointNode

Возвращает содержимое указанного узла дерева представлений.

Request

POST /api/v1/tree/get-viewpoint-node

Parameters

Name	Type	Default	Notes
body	IViewpointTreeNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IClassificationTreeNodeIPaginatedList	OK

Tree.GetFavorites

Возвращает первый уровень дерева избранного.

Request

POST /api/v1/tree/get-favorites

Parameters

Name	Type	Default	Notes
body	IFavoritesTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IFavoritesTreeNodeIPaginatedList	OK

Tree.GetFavoritesNode

Возвращает указанный узел дерева избранного.

Request

POST /api/v1/tree/get-favorites-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IFavoritesTreeNode	OK

Tree.GetFavoritesNodeChildren

Возвращает содержимое указанного узла дерева избранного.

Request

POST /api/v1/tree/get-favorites-node-children

Parameters

Name	Type	Default	Notes
body	IFavoritesTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IFavoritesTreeNodeIPaginatedList	OK

Tree.GetElementLinks

Возвращает первый уровень дерева связей элемента.

Request

POST /api/v1/tree/get-element-links

Parameters

Name	Type	Default	Notes
body	IElementLinksRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkTreeNodeIPaginatedList	OK

Tree.GetElementLinksNode

Возвращает указанный узел дерева связей элемента.

Request

POST /api/v1/tree/get-element-links-node

Parameters

Name	Type	Default	Notes
body	ILinkTreeNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkTreeNode	OK

Tree.GetElementLinksNodeChildren

Возвращает содержимое указанного узла дерева связей элемента (для представления в виде дерева).

Request

POST /api/v1/tree/get-element-links-node-children

Parameters

Name	Type	Default	Notes
body	IElementLinksNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkTreeNodeIPaginatedList	OK

Tree.GetElementLinkableEnds

Возвращает первый уровень дерева концов связей элемента.

Request

POST /api/v1/tree/get-element-linkable-ends

Parameters

Name	Type	Default	Notes
body	ILinkScopesTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkScopeTreeNodeIPaginatedList	OK

Tree.GetElementLinkableEndsNode

Возвращает указанный узел дерева концов связей элемента.

Request

POST /api/v1/tree/get-element-linkable-ends-node

Parameters

Name	Type	Default	Notes
body	ILinkScopesNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkScopeTreeNode	OK

Tree.GetElementLinkableEndsNodeChildren

Возвращает содержимое указанного узла дерева концов связей элемента.

Request

POST /api/v1/tree/get-element-linkable-ends-node-children

Parameters

Name	Type	Default	Notes
body	ILinkScopesTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkScopeTreeNodeIPaginatedList	OK

Tree.GetPropertySearch

Возвращает первый уровень результата поиска по свойствам.

Request

POST /api/v1/tree/get-property-search

Parameters

Name	Type	Default	Notes
body	IPropertySearchTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetPropertySearchNodeChildren

Возвращает содержимое указанного узла дерева результатов поиска по свойствам.

Request

POST /api/v1/tree/get-property-search-node-children

Parameters

Name	Type	Default	Notes
body	IPropertySearchNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetCompabilityElements

Возвращает совместимые элементы в виде дерева.

Request

POST /api/v1/tree/get-compability-elements

Parameters

Name	Type	Default	Notes
body	IGetCompabilityElementsTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetCompabilityElementsNodeChildren

Возвращает содержимое указанного узла дерева совместимых элементов.

Request

POST /api/v1/tree/get-compability-elements-node-children

Parameters

Name	Type	Default	Notes
body	IGetCompabilityElementsTreeNodeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetSecurity

Возвращает первый уровень дерева оргструктуры.

Request

POST /api/v1/tree/get-security

Parameters

Name	Type	Default	Notes
body	ISecurityTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetSecurityNode

Возвращает указанный узел дерева оргструктуры.

Request

POST /api/v1/tree/get-security-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNode	OK

Tree.GetSecurityNodeChildren

Возвращает содержимое указанного узла дерева оргструктуры.

Request

POST /api/v1/tree/get-security-node-children

Parameters

Name	Type	Default	Notes
body	ISecurityTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ITreeNodeIPaginatedList	OK

Tree.GetMeasureClassification

Возвращает первый уровень дерева единиц измерения.

Request

POST /api/v1/tree/get-measure-classification

Parameters

Name	Type	Default	Notes
body	IMeasureTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IMeasureTreeNodeIPaginatedList	OK

Tree.GetMeasureClassificationNode

Возвращает указанный узел дерева единиц измерения.

Request

POST /api/v1/tree/get-measure-classification-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IMeasureTreeNode	OK

Tree.GetMeasureClassificationNodeChildren

Возвращает содержимое указанного узла дерева единиц измерения.

Request

POST /api/v1/tree/get-measure-classification-node-children

Parameters

Name	Type	Default	Notes
body	IMeasureTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IMeasureTreeNodeIPaginatedList	OK

Tree.GetLinkDefClassification

Возвращает первый уровень дерева классификации определений связей.

Request

POST /api/v1/tree/get-link-def-classification

Parameters

Name	Type	Default	Notes
body	ILinkDefClassificationTreeRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkScopeTreeNodeIPaginatedList	OK

Tree.GetLinkDefClassificationNode

Возвращает указанный узел дерева классификации определений связей.

Request

POST /api/v1/tree/get-link-def-classification-node

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkScopeTreeNode	OK

Tree.GetLinkDefClassificationNodeChildren

Возвращает содержимое указанного узла дерева классификации определений связей.

Request

POST /api/v1/tree/get-link-def-classification-node-children

Parameters

Name	Type	Default	Notes
body	ILinkDefClassificationTreeNodeChildrenRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	ILinkScopeTreeNodePaginatedList	OK

User

User.GetByUid

Возвращает пользователя по его идентификатору.

Request

POST /api/v1/user/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IUser	OK

User.GetById

Возвращает пользователя.

Request

POST /api/v1/user/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор пользователя.

Responses

Status Code	Type	Description	Samples
200	IUser	OK

User.Create

Создает нового пользователя.

Request

POST /api/v1/user/create

Parameters

Name	Type	Default	Notes
body	ICreateUserRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IUser	OK

User.Update

Редактирует пользователя.

Request

POST /api/v1/user/update

Parameters

Name	Type	Default	Notes
body	IUpdateUserRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IUser	OK

User.Delete

Удаляет пользователя.

Request

POST /api/v1/user/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор пользователя.

Responses

Status Code	Type	Description	Samples
200		OK

User.ChangePassword

Производит смену пароля пользователя.

Request

POST /api/v1/user/change-password

Parameters

Name	Type	Default	Notes
body	IChangePasswordRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

User.GetAll

Возвращает всех пользователей.

Request

POST /api/v1/user/get-all

Parameters

Name	Type	Default	Notes
body	IAllUsersRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IUserBaseInfoIPaginatedList	OK

User.SetPhoto

Устанавливает фото пользователя.

Request

POST /api/v1/user/set-photo[?userId]

Parameters

Name	Type	Default	Notes
userId			Идентификатор пользователя.
file

Responses

Status Code	Type	Description	Samples
200		OK

User.GetPhoto

Возвращает фото пользователя.

Request

POST /api/v1/user/get-photo

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор пользователя.

Responses

Status Code	Type	Description	Samples
200		OK

User.RemovePhoto

Удаляет фото пользователя.

Request

POST /api/v1/user/remove-photo

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest

Responses

Status Code	Type	Description	Samples
200		OK

User.AddRole

Добавляет роль пользователю.

Request

POST /api/v1/user/add-role

Parameters

Name	Type	Default	Notes
body	IAddRoleRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

User.RemoveRole

Удаляет роль пользователя.

Request

POST /api/v1/user/remove-role

Parameters

Name	Type	Default	Notes
body	IRemoveRoleRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

User.AddPosition

Добавляет должность пользователю.

Request

POST /api/v1/user/add-position

Parameters

Name	Type	Default	Notes
body	IAddPositionRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

User.RemovePosition

Удаляет должность пользователя.

Request

POST /api/v1/user/remove-position

Parameters

Name	Type	Default	Notes
body	IRemovePositionRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200		OK

UserOptions

UserOptions.Get

Возвращает опции пользователя.

Request

POST /api/v1/user-options/get

Responses

Status Code	Type	Description	Samples
200	IUserOptions	OK

UserOptions.GetUserOptionsForRestrictedList

Возвращает опции пользователя для ограничительного перечня.

Request

POST /api/v1/user-options/get-user-options-for-restricted-list

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор ограничительного перечня.

Responses

Status Code	Type	Description	Samples
200	IUserOptionsForRestrictedList	OK

UserOptions.Update

Редактирует опции пользователя.

Request

POST /api/v1/user-options/update

Parameters

Name	Type	Default	Notes
body	IUpdateUserOptionsRequest		Запрос редактирования опций пользователя.

Responses

Status Code	Type	Description	Samples
200	IUserOptions	OK

Viewpoint

Viewpoint.GetTemplate

Возвращает шаблон для заполнения свойств представления.

Request

POST /api/v1/viewpoint/get-template

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200	IPropertyOwnerResponse	OK

Viewpoint.GetById

Возвращает представление.

Request

POST /api/v1/viewpoint/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор представления.

Responses

Status Code	Type	Description	Samples
200	IViewpoint	OK

Viewpoint.GetByUid

Возвращает представление по его идентификатору.

Request

POST /api/v1/viewpoint/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IViewpoint	OK

Viewpoint.GetByLocation

Возвращает представление.

Request

POST /api/v1/viewpoint/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	Viewpoint	OK

Viewpoint.GetDefaultLocation

Возвращает строку расположения представления.

Request

POST /api/v1/viewpoint/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор представления.

Responses

Status Code	Type	Description	Samples
200	string	OK

Viewpoint.GetByGroup

Возвращает представления, находящиеся в группе представлений.

Request

POST /api/v1/viewpoint/get-by-group

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpoint[]	OK

Viewpoint.GetByElement

Возвращает представления, принадлежащие элементу.

Request

POST /api/v1/viewpoint/get-by-element

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор элемента.

Responses

Status Code	Type	Description	Samples
200	IViewpoint[]	OK

Viewpoint.GetUsages

Возвращает элементы, которые используют представление.

Request

POST /api/v1/viewpoint/get-usages

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор представления.

Responses

Status Code	Type	Description	Samples
200	IClassificationObject[]	OK

Viewpoint.LinkViewpointsToElement

Привязывает представления к элементу.

Request

POST /api/v1/viewpoint/link-viewpoints-to-element

Parameters

Name	Type	Default	Notes
body	ILinkViewpointsToElementRequest		Запрос привязки представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpoint[]	OK

Viewpoint.UnlinkViewpointsFromElement

Отвязывает представление от элемента.

Request

POST /api/v1/viewpoint/unlink-viewpoints-from-element

Parameters

Name	Type	Default	Notes
body	IUnlinkViewpointsFromElementRequest		Запрос открепления представления.

Responses

Status Code	Type	Description	Samples
200	IViewpoint[]	OK

Viewpoint.Create

Создаёт новое представление.

Request

POST /api/v1/viewpoint/create

Parameters

Name	Type	Default	Notes
body	ICreateViewpointRequest		Запрос создания представления.

Responses

Status Code	Type	Description	Samples
200	IViewpoint	OK

Viewpoint.CreateWithValues

Создаёт новое представление с параметрами.

Request

POST /api/v1/viewpoint/create-with-values

Parameters

Name	Type	Default	Notes
body	ICreateViewpointWithValuesRequest		Запрос создания представления с параметрами.

Responses

Status Code	Type	Description	Samples
200	IViewpoint	OK

Viewpoint.Update

Обновляет представление.

Request

POST /api/v1/viewpoint/update

Parameters

Name	Type	Default	Notes
body	IUpdateViewpointRequest		Запрос обновления представления.

Responses

Status Code	Type	Description	Samples
200	IViewpoint	OK

Viewpoint.Delete

Удаляет представление.

Request

POST /api/v1/viewpoint/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор удаляемого представление.

Responses

Status Code	Type	Description	Samples
200		OK

Viewpoint.DeleteMany

Удаляет список представлений.

Request

POST /api/v1/viewpoint/delete-many

Parameters

Name	Type	Default	Notes
body	IDeleteManyRequest		Идентификаторы удаляемых представлений.

Responses

Status Code	Type	Description	Samples
200	IDeleteManyResponse	OK

ViewpointCatalog

ViewpointCatalog.GetById

Возвращает каталог представлений.

Request

POST /api/v1/viewpoint-catalog/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор каталога представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpointCatalog	OK

ViewpointCatalog.GetByUid

Возвращает каталог представлений по его идентификатору.

Request

POST /api/v1/viewpoint-catalog/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IViewpointCatalog	OK

ViewpointCatalog.GetByLocation

Возвращает каталог представлений.

Request

POST /api/v1/viewpoint-catalog/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IViewpointCatalog	OK

ViewpointCatalog.GetDefaultLocation

Возвращает строку расположения каталога элементов.

Request

POST /api/v1/viewpoint-catalog/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор каталога представлений.

Responses

Status Code	Type	Description	Samples
200	string	OK

ViewpointCatalog.GetByReference

Возвращает каталог представлений справочника.

Request

POST /api/v1/viewpoint-catalog/get-by-reference

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор справочника.

Responses

Status Code	Type	Description	Samples
200	IViewpointCatalog	OK

ViewpointCatalog.Update

Изменяет данные о каталоге представлений.

Request

POST /api/v1/viewpoint-catalog/update

Parameters

Name	Type	Default	Notes
body	IUpdateViewpointCatalogRequest		Каталог представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpointCatalog	OK

ViewpointGroup

ViewpointGroup.GetById

Возвращает группу представлений.

Request

POST /api/v1/viewpoint-group/get-by-id

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup	OK

ViewpointGroup.GetByUid

Возвращает группу представлений по ее идентификатору.

Request

POST /api/v1/viewpoint-group/get-by-uid

Parameters

Name	Type	Default	Notes
body	IGetByUidRequest		Запрос поиска объекта по Guid.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup	OK

ViewpointGroup.GetByLocation

Возвращает группу представлений.

Request

POST /api/v1/viewpoint-group/get-by-location

Parameters

Name	Type	Default	Notes
body	string		Строка расположения.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup	OK

ViewpointGroup.GetDefaultLocation

Возвращает строку расположения группы представлений.

Request

POST /api/v1/viewpoint-group/get-default-location

Parameters

Name	Type	Default	Notes
body	IGetDefaultLocation		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200	string	OK

ViewpointGroup.GetByGroup

Возвращает группы, находящиеся внутри указанной группы представлений.

Request

POST /api/v1/viewpoint-group/get-by-group

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup[]	OK

ViewpointGroup.GetByCatalog

Возвращает группы, находящиеся внутри каталога представлений.

Request

POST /api/v1/viewpoint-group/get-by-catalog

Parameters

Name	Type	Default	Notes
body	IGetByIdRequest		Идентификатор каталога представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup[]	OK

ViewpointGroup.GetStatistics

Возвращает статистику группы представлений.

Request

POST /api/v1/viewpoint-group/get-statistics

Parameters

Name	Type	Default	Notes
body	IIdentifierRequest		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200	IGroupStatistics	OK

ViewpointGroup.Create

Создаёт новую группу представлений.

Request

POST /api/v1/viewpoint-group/create

Parameters

Name	Type	Default	Notes
body	ICreateViewpointGroupRequest		Параметры запроса.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup	OK

ViewpointGroup.Update

Изменяет данные о группе представлений.

Request

POST /api/v1/viewpoint-group/update

Parameters

Name	Type	Default	Notes
body	IUpdateViewpointGroupRequest		Группа представлений.

Responses

Status Code	Type	Description	Samples
200	IViewpointGroup	OK

ViewpointGroup.Delete

Удаляет группу представлений.

Request

POST /api/v1/viewpoint-group/delete

Parameters

Name	Type	Default	Notes
body	IDeleteRequest		Идентификатор группы представлений.

Responses

Status Code	Type	Description	Samples
200		OK

Definitions

IGetByIdRequest

Представляет запрос объекта по идентификатору.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IdentifiableObjectType

Представляет тип объекта.

IGetClassInfoResponse

Модель данных ответа на запрос информацию о классе изделий.

Name	Type	Notes
name	string	Наименование класса изделий.
description	string	Описание класса изделий.
image	IImagePropertyValue[]	Представляет данные свойства типа "Изображение".

IImagePropertyValue

Представляет данные свойства типа "Изображение".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	string	Возвращает значение свойства.
body	string (byte)

IIdentifiableObject

Представляет идентифицируемый объект.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IGetAssortmentInstanceRequest

Запрос получения экземпляров сортамента, соответствующие указанным материалу и типоразмеру.

Name	Type	Notes
material	IIdentifiableObject[]	Представляет идентифицируемый объект.
standardSize	IIdentifiableObject[]	Представляет идентифицируемый объект.

IAssortmentInstance

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
ownerGroup	IIdentifiableObject	Представляет идентифицируемый объект.
isMaterial	boolean	Признак того, что элемент является материалом
isAssortmentInstancesOwner	boolean	Признак того, что элемент является материалом или сортаментом
hasParts	boolean
designationPrefix	string
designationUpperPart	string
designationLowerPart	string
designationPostfix	string

Applicability

Представляет применяемость объекта.

INamedObject

Путь до объекта.

Name	Type	Notes
name	string	Имя объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IIdentifierRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

ICreateAssortmentInstanceRequest

Запрос создания экземпляра сортамента.

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
material	IIdentifiableObject[]	Представляет идентифицируемый объект.
standardSize	IIdentifiableObject[]	Представляет идентифицируемый объект.
assortmentInstanceData	ICreateElementWithValuesRequest[]	Представляет запрос создания элемента с параметрами.

ICreateElementWithValuesRequest

Представляет запрос создания элемента с параметрами.

Name	Type	Notes
elementGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
addedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно добавить.
values	IAblePropertyValuesRequest[]

IPropertyValueItem

Список свойств, которым присваиваются значения.

Name	Type	Notes
value	IIdentifiableObject[]	Представляет идентифицируемый объект.
contract	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
evaluationMode	EvaluationMode	Представляет режим вычисления значения для свойства.

EvaluationMode

Представляет режим вычисления значения для свойства.

IAblePropertyValuesRequest

Name	Type	Notes
doubleProperties	IDoublePropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
stringProperties	IStringPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
booleanProperties	IBooleanPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
colorProperties	IColorPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
opticProperties	IOpticPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
dateTimeProperties	IDateTimePropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
imageProperties	IImagePropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
rtfProperties	IRtfPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumProperties	IEnumPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
setProperties	ISetPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
integerProperties	IIntegerPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
binaryProperties	IBinaryPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
guidProperties	IGuidPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumBoolProperties	IEnumBoolPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumDoubleProperties	IEnumDoublePropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumIntProperties	IEnumIntPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumStringProperties	IEnumStringPropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
tableProperties	ITablePropertyValueRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IDoublePropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IDoublePropertyValueRequest[]

IDoublePropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	IDoubleValue[]	Представляет данные свойства типа "Вещественное число".

IDoubleValue

Представляет данные свойства типа "Вещественное число".

Name	Type	Notes
mode	DoublePropertyMode	Режимы свойства типа Double.
value	number (double)	Возвращает значение свойства.
minValue	number (double)	Возвращает минимальное значение.
maxValue	number (double)	Возвращает максимальное значение.
lowerTolerance	number (double)	Возвращает нижнее поле допуска.
upperTolerance	number (double)	Возвращает верхнее поле допуска.
measureUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.

DoublePropertyMode

Режимы свойства типа Double.

IStringPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IStringPropertyValueRequest[]

IStringPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

IBooleanPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IBooleanPropertyValueRequest[]

IBooleanPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	boolean	Возвращает значение свойства.

IColorPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IColorPropertyValueRequest[]

IColorPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	IColorValue[]	Представляет данные свойства типа "Цвет".

IColorValue

Представляет данные свойства типа "Цвет".

Name	Type	Notes
r	integer (int32)	Возвращает значение красного канала.
g	integer (int32)	Возвращает значение зеленого канала.
b	integer (int32)	Возвращает значение синего канала.
a	integer (int32)	Возвращает значение прозрачности.

IOpticPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IOpticPropertyValueRequest[]

IOpticPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	IOpticValue[]	Представляет данные свойства типа "Оптическое".

IOpticValue

Представляет данные свойства типа "Оптическое".

Name	Type	Notes
ambient	number (double)	Возвращает значение общего света.
diffuse	number (double)	Возвращает значение диффузии.
emission	number (double)	Возвращает значение излучения.
shininess	number (double)	Возвращает значение блеска.
specularity	number (double)	Возвращает или задает значение зеркальности.
transparency	number (double)	Возвращает значение прозрачности.

IDateTimePropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IDateTimePropertyValueRequest[]

IDateTimePropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	IDateTimeValue[]	Представляет данные свойства типа "Дата/Время".

IDateTimeValue

Представляет данные свойства типа "Дата/Время".

Name	Type	Notes
value	string (date-time)	Возвращает значение свойства.
useTime	boolean	Признак использования времени

IImagePropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IImagePropertyValueRequest[]

IImagePropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

IRtfPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IRtfPropertyValueRequest[]

IRtfPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

IEnumPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumPropertyValueRequest[]

IEnumPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

ISetPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	ISetPropertyValueRequest[]

ISetPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	array	Возвращает значение свойства.

IIntegerPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IIntegerPropertyValueRequest[]

IIntegerPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	integer (int32)	Возвращает значение свойства.

IBinaryPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IBinaryPropertyValueRequest[]

IBinaryPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

IGuidPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IGuidPropertyValueRequest[]

IGuidPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

IEnumBoolPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumBoolPropertyValueRequest[]

IEnumBoolPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	boolean	Возвращает значение свойства.

IEnumDoublePropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumDoublePropertyValueRequest[]

IEnumDoublePropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	number (double)	Возвращает значение свойства.

IEnumIntPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumIntPropertyValueRequest[]

IEnumIntPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	integer (int32)	Возвращает значение свойства.

IEnumStringPropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumStringPropertyValueRequest[]

IEnumStringPropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	string	Возвращает значение свойства.

ITablePropertyValueRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	ITablePropertyValueRequest[]

ITablePropertyValueRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
value	ITableValueRequest[]	Модель данных для назначения значений свойствам типа Table.

ITableValueRequest

Модель данных для назначения значений свойствам типа Table.

Name	Type	Notes
rows	ITablePropertyRowRequest[]	Строки таблицы.

ITablePropertyRowRequest

Строки таблицы.

Name	Type	Notes
cellValues	IIdentifiableObject[]	Значения ячеек строки.

IElement

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
ownerGroup	IIdentifiableObject	Представляет идентифицируемый объект.
isMaterial	boolean	Признак того, что элемент является материалом
isAssortmentInstancesOwner	boolean	Признак того, что элемент является материалом или сортаментом

IGetAssortmentRequest

Запрос получения сортаментов, связанных с материалом.

Name	Type	Notes
material	IIdentifiableObject[]	Представляет идентифицируемый объект.
filterString	string	Значение фильтра.

ILinkMaterialsRequest

Модель данных для создания связи сортаментa и материалов.

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
materials	IIdentifiableObject[]	Идентификаторы материалов.
standardSpecificationsDocument	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICreateAssortmentRequest

Модель данных для создания сортамента.

Name	Type	Notes
material	IIdentifiableObject[]	Представляет идентифицируемый объект.
assortmentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
assortmentDocument	IIdentifiableObject[]	Представляет идентифицируемый объект.
standardSpecificationsDocument	IIdentifiableObject[]	Представляет идентифицируемый объект.
addedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно добавить.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
propertyValues	IAblePropertyValuesRequest[]

BackgroundTaskInfo

Name	Type	Notes
id	string (uuid)
name	string
status	BackgroundTaskStatus	Представляет статусы фоновых задач.

BackgroundTaskStatus

Представляет статусы фоновых задач.

IAddRightRequest

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

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
accessSubject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveRightRequest

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

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
accessSubject	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICancelBackgroundTaskRequest

Запрос отмены операции.

Name	Type	Notes
backgroundTaskId	string (uuid)

IdentifierRequest

Представляет идентификатор объекта для запроса.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IUpdateClassIdRequest

Представляет запрос редактирования идентификатора класса объекта.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
classId	string	Идентификатор класса.
changeIdsForExistingObjects	boolean	Признак редактирования классов для существующих объектов.

IClassificationObject

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
entity	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetByUidRequest

Представляет запрос объекта по идентификатору типа Guid.

Name	Type	Notes
id	string	Идентификатор объекта.

IGetLocationsRequest

Представляет запрос получения списка строк расположения.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы для которых нужно получить строки.

IGetLocationsResponse

Name	Type	Notes
objects	ILocateableObject[]

ILocateableObject

Name	Type	Notes
applicability	Applicability	Представляет применяемость объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
location	string	Строка расположения.

ILinkedElement

Представляет привязанный элемент.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
multiCatalogedItems	IClassifiableObject[]	Множественная классификация привязанного элемента.

IClassifiableObject

Множественная классификация привязанного элемента.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.

IAccessRightsRequest

Представляет запрос прав для указанных элементов классификации.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы объектов классификации.

IClassificationAccessRight

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
accessRight	AccessRights	Представляет права доступа.

AccessRights

Представляет права доступа.

IAboutResponse

Ответ о программе.

Name	Type	Notes
storageVersion	string	Версия хранилища.
productVersion	string	Версия продукта.
serverVersion	string	Версия сервера.
webServerVersion	string	Версия веб сервера.

IAppServerConfiguration

Представляет конфигурацию сервера приложений.

Name	Type	Notes
address	string	Адрес сервера.
port	string	Порт сервера.

IConcept

Представляет понятие.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
code	string	Уникальный код.
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
superConcept	IIdentifiableObject[]	Представляет идентифицируемый объект.
conceptPropertySources	IConceptPropertySource[]	Возвращает коллекцию всех источников свойств в понятии.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]

IConceptPropertySource

Возвращает коллекцию всех источников свойств в понятии.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
contract	INamedObject[]	Представляет объект, обладающий именем.
type	PropertyType	Типы свойств.
isLinked	boolean	Возвращает признак, является ли свойство связанным.
isMandatory	boolean	Возвращает или задает признак "Обязательное свойство".
isMandatoryEnabled	boolean	Возвращает или задает редактируемость признака "Обязательное свойство".
isHidden	boolean	Возвращает или задает признак "Скрытое свойство".
isHiddenEnabled	boolean	Возвращает или задает редактируемость признака "Скрытое свойство".
isSpecial	boolean	Возвращает или задает признак "Специальное свойство".
isSpecialEnabled	boolean	Возвращает или задает редактируемость признака "Специальное свойство".
isUnique	boolean	Возвращает или задает признак "Уникальное свойство"
isUniqueEnabled	boolean	Возвращает или задает редактируемость признака "Уникальное свойство"
isIndexable	boolean	Возвращает или задает признак "Индексируемое свойство".
isIndexableEnabled	boolean	Возвращает или задает редактируемость признака "Индексируемое свойство".
isDynamic	boolean	Возвращает или задает признак "Дополнительное свойство".
isDynamicEnabled	boolean	Возвращает редактируемость признака "Дополнительное свойство".
isDisplayedForSelection	boolean	Возвращает или задает признак "Отображать для выбора".
isDisplayedForSelectionEnabled	boolean	Возвращает редактируемость признака "Отображать для выбора".
isSetBeforeApplying	boolean	Возвращает или задает признак "Задать перед применением".
isSetBeforeApplyingEnabled	boolean	Возвращает редактируемость признака "Задать перед применением".
isUsedInModelFamiliesDefault	boolean	Возвращает или задает признак "Используется в семействах моделей по умолчанию".
isUsedInModelFamiliesDefaultEnabled	boolean	Возвращает редактируемость признака "Используется в семействах моделей по умолчанию".
isReadOnly	boolean	Возвращает или задает признак "Запретить изменение".
isReadOnlyEnabled	boolean	Возвращает редактируемость признака "Запретить изменение".
position	integer (int32)	Возвращает или задает позицию источника свойства в контракте.
isDefaultIfEmpty	boolean	Возвращает или задает признак того, что для неназначенных значений выводится значение по умолчанию.
isDefaultIfEmptyEnabled	boolean	Возвращает редактируемость признака того, что для неназначенных значений выводится значение по умолчанию.
isDefaultEnabled	boolean	Возвращает редактируемость значений по умолчанию.
isNameManuallySet	boolean	Задать имя вручную.
propertySource	IPropertySource[]	Представляет источник свойства.
measureEntity	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultMeasureUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
isInherited	boolean	Признак того, что источник свойства в понятии унаследован.

PropertyType

Типы свойств.

IPropertySource

Представляет источник свойства.

Name	Type	Notes
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IPropertyDefinitionWithItems[]	Определение свойства с предопределёнными значениями.
ownerContract	INamedObject[]	Представляет объект, обладающий именем.
isLinked	boolean	Признак того, что источник свойства является ссылочным.
linkDefinitionEnd	INamedObject[]	Представляет объект, обладающий именем.
linkedConceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyDefinitionWithItems

Определение свойства с предопределёнными значениями.

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
enumItems	IEnumPropertyDefinitionItem[]	Список доступных значений свойства "Перечислимое".
enumStringItems	IEnumStringItem[]	Список доступных значений свойства "Перечислимое строковое с описанием".
enumBoolItems	IEnumBoolItem[]	Список доступных значений свойства "Перечислимое логическое с описанием".
enumIntItems	IEnumIntItem[]	Список доступных значений свойства "Перечислимое целое с описанием".
enumDoubleItems	IEnumDoubleItem[]	Список доступных значений свойства "Перечислимое вещественное с описанием".
setItems	ISetPropertyDefinitionItem[]	Список доступных значений свойства "Множество".
measureUnits	IMeasureUnit[]	Список единиц измерений.

IEnumPropertyDefinitionItem

Список доступных значений свойства "Перечислимое".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Возвращает или задает позицию пункта перечисления.
value	string	Возвращает или задает значение.

IEnumStringItem

Список доступных значений свойства "Перечислимое строковое с описанием".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Возвращает или задает позицию пункта перечисления.
description	string	Возвращает описание.
value	string	Значение свойства.

IEnumBoolItem

Список доступных значений свойства "Перечислимое логическое с описанием".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Возвращает или задает позицию пункта перечисления.
description	string	Возвращает описание.
value	boolean	Значение свойства.

IEnumIntItem

Список доступных значений свойства "Перечислимое целое с описанием".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Возвращает или задает позицию пункта перечисления.
description	string	Возвращает описание.
value	integer (int32)	Значение свойства.

IEnumDoubleItem

Список доступных значений свойства "Перечислимое вещественное с описанием".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Возвращает или задает позицию пункта перечисления.
description	string	Возвращает описание.
value	number (double)	Значение свойства.

ISetPropertyDefinitionItem

Список доступных значений свойства "Множество".

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Возвращает или задает позицию пункта перечисления.
value	string	Возвращает или задает значение.

IMeasureUnit

Список единиц измерений.

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
uid	string (uuid)	Уникальный идентификатор объекта.
isBasic	boolean	Возвращает или задает признак того, что единица измерения является базовой.
designation	string	Возвращает или задает описание измеряемой сущности из ЕдИзм.
fromBasicFactor	number (double)	Возвращает или задает множитель перевода из базовой единицы из ЕдИзм.
fromBasicOffset	number (double)	Возвращает или задает смещение перевода из базовой единицы из ЕдИзм.
measureEntity	IIdentifiableObject[]	Представляет идентифицируемый объект.
codeOkei	string	Возвращает или задает код по ОКЕИ.
internationalDesignationOkei	string	Возвращает или задает международное обозначение по ОКЕИ.
internationalLiteralDesignation	string	Возвращает или задает международное буквенное обозначение.
literalDesignation	string	Возвращает или задает национальное буквенное обозначение.

IAblePropertyValues

Представляет доступные значения разных типов свойств.

Name	Type	Notes
doubleProperties	IDoublePropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
stringProperties	IStringPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
booleanProperties	IBooleanPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
colorProperties	IColorPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
opticProperties	IOpticPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
dateTimeProperties	IDateTimePropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
imageProperties	IImagePropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
rtfProperties	IRtfPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumProperties	IEnumPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
setProperties	ISetPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
integerProperties	IIntegerPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
binaryProperties	IBinaryPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
guidProperties	IGuidPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumBoolProperties	IEnumBoolPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumDoubleProperties	IEnumDoublePropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumIntProperties	IEnumIntPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
enumStringProperties	IEnumStringPropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
tableProperties	ITablePropertyValueListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IDoublePropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IDoublePropertyValue[]

IDoublePropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IDoubleValue[]	Представляет данные свойства типа "Вещественное число".

IStringPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IStringPropertyValue[]

IStringPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	string	Возвращает значение свойства.

IBooleanPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IBooleanPropertyValue[]

IBooleanPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	boolean	Возвращает значение свойства.

IColorPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IColorPropertyValue[]

IColorPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IColorValue[]	Представляет данные свойства типа "Цвет".

IOpticPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IOpticPropertyValue[]

IOpticPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IOpticValue[]	Представляет данные свойства типа "Оптическое".

IDateTimePropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IDateTimePropertyValue[]

IDateTimePropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IDateTimeValue[]	Представляет данные свойства типа "Дата/Время".

IImagePropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IImagePropertyValue[]

IRtfPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IRtfPropertyValue[]

IRtfPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	string	Возвращает значение свойства.

IEnumPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumPropertyValue[]

IEnumPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	string	Возвращает значение свойства.

ISetPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	ISetPropertyValue[]

ISetPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	array	Возвращает значение свойства.

IIntegerPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IIntegerPropertyValue[]

IIntegerPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	integer (int32)	Возвращает значение свойства.

IBinaryPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IBinaryPropertyValue[]

IBinaryPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	string	Возвращает значение свойства.

IGuidPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IGuidPropertyValue[]

IGuidPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	string	Возвращает значение свойства.

IEnumBoolPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumBoolPropertyValue[]

IEnumBoolPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IEnumBoolItem[]	Представляет данные значения свойства "Перечислимое логическое с описанием".

IEnumDoublePropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumDoublePropertyValue[]

IEnumDoublePropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IEnumDoubleItem[]	Представляет данные значения свойства "Перечислимое вещественное с описанием".

IEnumIntPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumIntPropertyValue[]

IEnumIntPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IEnumIntItem[]	Представляет данные значения свойства "Перечислимое целое с описанием".

IEnumStringPropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IEnumStringPropertyValue[]

IEnumStringPropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IEnumStringItem[]	Представляет данные значения свойства "Перечислимое строковое с описанием".

ITablePropertyValueListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	ITablePropertyValue[]

ITablePropertyValue

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	ITableValue[]	Представляет данные свойства типа "Таблица".

ITableValue

Представляет данные свойства типа "Таблица".

Name	Type	Notes
columns	IIdentifiableObject[]	Столбцы таблицы.
rows	ITablePropertyRow[]	Строки таблицы.

ITablePropertyRow

Строки таблицы.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
owningValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
cellValues	IIdentifiableObject[]	Значения ячеек строки.
position	integer (int32)	Позиция строки в коллекции строк владеющего значения.

IAbleMeasureEntities

Name	Type	Notes
entities	IMeasureEntity[]	Измеряемые сущности.

IMeasureEntity

Измеряемые сущности.

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
uid	string (uuid)	Уникальный идентификатор объекта.
basicUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.

IAbleMeasureUnits

Name	Type	Notes
units	IMeasureUnit[]	Единицы измерения.

IGetByCodeRequest

Представляет запрос объекта по коду.

Name	Type	Notes
code	string	Код объекта.

IGetByAbsoluteCodeRequest

Представляет запрос объекта по полному коду.

Name	Type	Notes
absoluteCode	string	Полный код.

IGetConceptAsOwnRequest

Представляет запрос понятия для назначения его как собственного.

Name	Type	Notes
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
conceptAppointer	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetAllConceptsRequest

Запрос всех понятий.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Строка фильтрации.

IConceptPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IConcept[]	Возвращает элементы страницы.

IAppointedConceptsResponse

Name	Type	Notes
isReverseOrder	boolean	Порядок отображения понятий
appointedConcepts	IAppointedConcept[]	Список назначенных понятий

IAppointedConcept

Список назначенных понятий

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
position	integer (int32)	Позиция в группе.
isMandatory	boolean	Признак "Обязательное для объектов".
isInheritable	boolean	Признак "Наследуемое" (для дочерних групп).
isDisabled	boolean	Признак "Отключенное".
isPredefined	boolean	Признак "Предопределенное".
isInherited	boolean	Признак "Наследуется" (от вышестоящих групп или каталога).
concept	INamedObject[]	Представляет объект, обладающий именем.
conceptAppointer	INamedObject[]	Представляет объект, обладающий именем.

IAddAppointedConceptRequest

Представляет запрос добавления понятия к каталогу/группе.

Name	Type	Notes
conceptAppointer	IIdentifierRequest[]
concept	IIdentifierRequest[]

IRemoveAppointedConceptRequest

Представляет запрос удаления назначенного понятия у каталога/группы.

Name	Type	Notes
conceptAppointer	IIdentifierRequest[]
concept	IIdentifierRequest[]

ISetOrderDirectionConceptRequest

Представляет запрос изменения порядка отображения понятий.

Name	Type	Notes
conceptAppointer	IIdentifiableObject[]	Представляет идентифицируемый объект.
isReverseOrder	boolean	Порядок отображения понятий.

ISetInheritableConceptRequest

Представляет запрос установки назначаемому понятию признака "Наследуемое".

Name	Type	Notes
appointedConcept	IIdentifiableObject[]	Представляет идентифицируемый объект.
isInheritable	boolean	Признак "Наследуемое".

ISetMandatoryConceptRequest

Представляет запрос установки назначаемому понятию признака "Обязательное для объектов".

Name	Type	Notes
appointedConcept	IIdentifiableObject[]	Представляет идентифицируемый объект.
isMandatory	boolean	Признак "Обязательное для объектов".

ISetDisabledConceptRequest

Представляет запрос установки назначаемому понятию признака "Отключенное".

Name	Type	Notes
conceptAppointer	IIdentifiableObject[]	Представляет идентифицируемый объект.
appointedConcept	IIdentifiableObject[]	Представляет идентифицируемый объект.
isDisabled	boolean	Признак "Отключенное".

IAppointedConceptsOrderRequest

Модель данных для запроса на изменение порядка собственных понятий

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
appointedConcepts	array	Упорядоченные идентификаторы собственных понятий.

ICreateConceptRequest

Прдеставляет объект создания понятия.

Name	Type	Notes
parent	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Название понятия.

IGetByCodeConceptPropertySourceRequest

Представляет запрос поиска свойства понятия по коду определения свойства.

Name	Type	Notes
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
code	string	Код свойства.

ICreateConceptPropertySourceRequest

Запрос на создание нового свойства понятия.

Name	Type	Notes
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.

IUpdateConceptPropertySourceRequest

Запрос на редактирование понятия свойства.

Name	Type	Notes
conceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.
isMandatory	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isHidden	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isSpecial	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isUnique	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isIndexable	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isDynamic	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isDisplayedForSelection	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isSetBeforeApplying	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isReadOnly	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
position	Int32Optional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isDefaultIfEmpty	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
defaultMeasureUnit	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
defaultPropertyValue	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isNameManuallySet	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

BooleanOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	boolean

Int32Optional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	integer (int32)

IIdentifiableObjectOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IIdentifiableObject[]	Представляет идентифицируемый объект.

IDeleteRequest

Запрос удаления объекта по идентификатору.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

ISetDisplayNameConceptPropertySourceRequest

Запрос на изменение отображаемого имени свойства понятия.

Name	Type	Notes
conceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.
newDisplayName	string	Новое отображаемое имя.

ISetDefaultMeasureUnitForAllValuesConceptPropertySourceRequest

Запрос на установку единиц измерения по умолчанию для всех значений.

Name	Type	Notes
conceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISetFormulaConceptPropertySourceRequest

Запрос назначения формулы в свойстве владельца свойств (или удаления, если formula == null)

Name	Type	Notes
conceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyOwner	IIdentifiableObject[]	Представляет идентифицируемый объект.
formula	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISetIsUniqueConceptPropertySourceRequest

Запрос на установку признака уникальности свойства понятия.

Name	Type	Notes
conceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.
isUnique	boolean	Флаг уникальности свойства.

IPropertyOwnerResponse

Представляет ответ на запрос владельца свойств.

Name	Type	Notes
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
allContracts	IContractRef[]	Понятия.
propertyOwner	IPropertyOwnerRef[]	Представляет класс владельца свойств (ссылочный).

IAblePropertyDefinitions

Представляет доступные определения свойств.

Name	Type	Notes
doubleProperties	IDoublePropertyDefinition[]	Определения свойств типа "Вещественное число".
stringProperties	IStringPropertyDefinition[]	Определения свойств типа "Строка".
booleanProperties	IBooleanPropertyDefinition[]	Определения свойств типа "Логическое".
colorProperties	IColorPropertyDefinition[]	Определения свойств типа "Цвет".
opticProperties	IOpticPropertyDefinition[]	Определения свойств типа "Оптическое".
dateTimeProperties	IDateTimePropertyDefinition[]	Определения свойств типа "Дата/Время".
imageProperties	IImagePropertyDefinition[]	Определения свойств типа "Изображение".
rtfProperties	IRtfPropertyDefinition[]	Определения свойств типа "RTF-текст".
enumProperties	IEnumPropertyDefinition[]	Определения свойств типа "Перечислимое".
setProperties	ISetPropertyDefinition[]	Определения свойств типа "Множество".
integerProperties	IIntegerPropertyDefinition[]	Определения свойств типа "Целое число".
binaryProperties	IBinaryPropertyDefinition[]	Определения свойств типа "Бинарные данные".
guidProperties	IGuidPropertyDefinition[]	Определения свойств типа "Уникальный идентификатор".
enumBoolProperties	IEnumBoolPropertyDefinition[]	Определения свойств типа "Перечислимое логическое с описанием".
enumDoubleProperties	IEnumDoublePropertyDefinition[]	Определения свойств типа "Перечислимое вещественное с описанием".
enumIntProperties	IEnumIntPropertyDefinition[]	Определения свойств типа "Перечислимое целое с описанием".
enumStringProperties	IEnumStringPropertyDefinition[]	Определения свойств типа "Перечислимое строковое с описанием".
tableProperties	ITablePropertyDefinition[]	Определения свойств типа "Таблица".

IDoublePropertyDefinition

Определения свойств типа "Вещественное число".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
measureEntity	IIdentifiableObject[]	Представляет идентифицируемый объект.

IStringPropertyDefinition

Определения свойств типа "Строка".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IBooleanPropertyDefinition

Определения свойств типа "Логическое".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IColorPropertyDefinition

Определения свойств типа "Цвет".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IOpticPropertyDefinition

Определения свойств типа "Оптическое".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IDateTimePropertyDefinition

Определения свойств типа "Дата/Время".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IImagePropertyDefinition

Определения свойств типа "Изображение".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRtfPropertyDefinition

Определения свойств типа "RTF-текст".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEnumPropertyDefinition

Определения свойств типа "Перечислимое".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	IEnumPropertyDefinitionItem[]	Доступные значения свойства.

ISetPropertyDefinition

Определения свойств типа "Множество".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	ISetPropertyDefinitionItem[]	Доступные значения свойства.

IIntegerPropertyDefinition

Определения свойств типа "Целое число".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IBinaryPropertyDefinition

Определения свойств типа "Бинарные данные".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGuidPropertyDefinition

Определения свойств типа "Уникальный идентификатор".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEnumBoolPropertyDefinition

Определения свойств типа "Перечислимое логическое с описанием".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	IEnumBoolItem[]	Доступные значения свойства.

IEnumDoublePropertyDefinition

Определения свойств типа "Перечислимое вещественное с описанием".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	IEnumDoubleItem[]	Доступные значения свойства.

IEnumIntPropertyDefinition

Определения свойств типа "Перечислимое целое с описанием".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	IEnumIntItem[]	Доступные значения свойства.

IEnumStringPropertyDefinition

Определения свойств типа "Перечислимое строковое с описанием".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	IEnumStringItem[]	Доступные значения свойства.

ITablePropertyDefinition

Определения свойств типа "Таблица".

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
properties	IContractPropertySourceRef[]	Свойства контракта.
canUnassign	boolean	Признак того, можно ли убрать назначенный контракт с владельца свойств.
superConcept	INamedObject[]	Представляет объект, обладающий именем.
ownPropertyValues	boolean	Признак того, что значения наследуемых свойств задаются понятием-предком.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
columns	ITablePropertyDefinitionColumn[]	Определения столбцов табличного свойства.

IContractPropertySourceRef

Свойства контракта.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isMandatory	boolean	Возвращает или задает признак "Обязательное свойство".
isMandatoryEnabled	boolean	Возвращает или задает редактируемость признака "Обязательное свойство".
isHidden	boolean	Возвращает или задает признак "Скрытое свойство".
isHiddenEnabled	boolean	Возвращает или задает редактируемость признака "Скрытое свойство".
isSpecial	boolean	Возвращает или задает признак "Специальное свойство".
isSpecialEnabled	boolean	Возвращает или задает редактируемость признака "Специальное свойство".
isUnique	boolean	Возвращает или задает признак "Уникальное свойство"
isUniqueEnabled	boolean	Возвращает или задает редактируемость признака "Уникальное свойство"
isIndexable	boolean	Возвращает или задает признак "Индексируемое свойство".
isIndexableEnabled	boolean	Возвращает или задает редактируемость признака "Индексируемое свойство".
isDynamic	boolean	Возвращает или задает признак "Дополнительное свойство".
isDynamicEnabled	boolean	Возвращает редактируемость признака "Дополнительное свойство".
isDisplayedForSelection	boolean	Возвращает или задает признак "Отображать для выбора".
isDisplayedForSelectionEnabled	boolean	Возвращает редактируемость признака "Отображать для выбора".
isSetBeforeApplying	boolean	Возвращает или задает признак "Задать перед применением".
isSetBeforeApplyingEnabled	boolean	Возвращает редактируемость признака "Задать перед применением".
isUsedInModelFamiliesDefault	boolean	Возвращает или задает признак "Используется в семействах моделей по умолчанию".
isUsedInModelFamiliesDefaultEnabled	boolean	Возвращает редактируемость признака "Используется в семействах моделей по умолчанию".
isReadOnly	boolean	Возвращает или задает признак "Запретить изменение".
isReadOnlyEnabled	boolean	Возвращает редактируемость признака "Запретить изменение".
position	integer (int32)	Возвращает или задает позицию источника свойства в контракте.
isDefaultIfEmpty	boolean	Возвращает или задает признак того, что для неназначенных значений выводится значение по умолчанию.
isDefaultIfEmptyEnabled	boolean	Возвращает редактируемость признака того, что для неназначенных значений выводится значение по умолчанию.
isDefaultEnabled	boolean	Возвращает редактируемость значений по умолчанию.
isNameManuallySet	boolean	Задать имя вручную.
propertySource	IPropertySourceRef[]	Представляет источник свойства.
defaultMeasureUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
appointedFormula	INamedObject[]	Представляет объект, обладающий именем.
ownerContract	INamedObject[]	Представляет объект, обладающий именем.

IPropertySourceRef

Представляет источник свойства.

Name	Type	Notes
absoluteCode	string	Длинный уникальный код.
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isLinked	boolean	Признак того, что источник свойства является ссылочным.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
ownerContract	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkedConceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.

ITablePropertyDefinitionColumn

Определения столбцов табличного свойства.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isMandatory	boolean	Возвращает или задает признак "Обязательное свойство".
isMandatoryEnabled	boolean	Возвращает или задает редактируемость признака "Обязательное свойство".
isHidden	boolean	Возвращает или задает признак "Скрытое свойство".
isHiddenEnabled	boolean	Возвращает или задает редактируемость признака "Скрытое свойство".
isSpecial	boolean	Возвращает или задает признак "Специальное свойство".
isSpecialEnabled	boolean	Возвращает или задает редактируемость признака "Специальное свойство".
isUnique	boolean	Возвращает или задает признак "Уникальное свойство"
isUniqueEnabled	boolean	Возвращает или задает редактируемость признака "Уникальное свойство"
isIndexable	boolean	Возвращает или задает признак "Индексируемое свойство".
isIndexableEnabled	boolean	Возвращает или задает редактируемость признака "Индексируемое свойство".
isDynamic	boolean	Возвращает или задает признак "Дополнительное свойство".
isDynamicEnabled	boolean	Возвращает редактируемость признака "Дополнительное свойство".
isDisplayedForSelection	boolean	Возвращает или задает признак "Отображать для выбора".
isDisplayedForSelectionEnabled	boolean	Возвращает редактируемость признака "Отображать для выбора".
isSetBeforeApplying	boolean	Возвращает или задает признак "Задать перед применением".
isSetBeforeApplyingEnabled	boolean	Возвращает редактируемость признака "Задать перед применением".
isUsedInModelFamiliesDefault	boolean	Возвращает или задает признак "Используется в семействах моделей по умолчанию".
isUsedInModelFamiliesDefaultEnabled	boolean	Возвращает редактируемость признака "Используется в семействах моделей по умолчанию".
isReadOnly	boolean	Возвращает или задает признак "Запретить изменение".
isReadOnlyEnabled	boolean	Возвращает редактируемость признака "Запретить изменение".
position	integer (int32)	Возвращает или задает позицию источника свойства в контракте.
isDefaultIfEmpty	boolean	Возвращает или задает признак того, что для неназначенных значений выводится значение по умолчанию.
isDefaultIfEmptyEnabled	boolean	Возвращает редактируемость признака того, что для неназначенных значений выводится значение по умолчанию.
isDefaultEnabled	boolean	Возвращает редактируемость значений по умолчанию.
isNameManuallySet	boolean	Задать имя вручную.
propertySource	IPropertySourceRef[]	Представляет источник свойства.
defaultMeasureUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
appointedFormula	INamedObject[]	Представляет объект, обладающий именем.
ownerContract	INamedObject[]	Представляет объект, обладающий именем.
type	PropertyType	Типы свойств.
isUniqueInTable	boolean	Признак "Уникально в таблице".
tablePropertyDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.

IContractRef

Понятия.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
code	string	Уникальный код.
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
properties	IContractPropertySourceRef[]	Свойства контракта.
canUnassign	boolean	Признак того, можно ли убрать назначенный контракт с владельца свойств.
superConcept	INamedObject[]	Представляет объект, обладающий именем.
ownPropertyValues	boolean	Признак того, что значения наследуемых свойств задаются понятием-предком.

IPropertyOwnerRef

Представляет класс владельца свойств (ссылочный).

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
properties	IPropertyRef[]	Свойства.

IPropertyRef

Свойства.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
isOwn	boolean	Возвращает признак того, что свойство является собственным.
isLinked	boolean	Возвращает признак того, что свойство является связанным.
contract	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
contractPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkedPropertyInfo	ILinkedPropertyInfoRef[]	Информация о связанном свойстве.
value	IIdentifiableObject[]	Представляет идентифицируемый объект.
evaluationPropertyInfo	IEvaluationPropertyInfoRef[]	Информация о формуле и вычислениях в свойстве.

ILinkedPropertyInfoRef

Информация о связанном свойстве.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkableItem	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEvaluationPropertyInfoRef

Информация о формуле и вычислениях в свойстве.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
evaluationMode	EvaluationMode	Представляет режим вычисления значения для свойства.
formula	INamedObject[]	Представляет объект, обладающий именем.
appointedFormula	INamedObject[]	Представляет объект, обладающий именем.
usePropertyValue	boolean	Возвращает признак того, что свойство будет использовать явно заданное значение (формула вычисляться не будет).
evaluationErrorMessage	string	Возвращает текст ошибки, если невозможно вычислить значение по формуле.

IDocument

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
ownerGroup	INamedObject[]	Представляет объект, обладающий именем.
files	IFile[]	Файлы, привязанные к документу.

IFile

Файлы, привязанные к документу.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
name	string	Имя объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
creationDate	string (date-time)	Дата создания.
modificationDate	string (date-time)	Дата изменения.
size	integer (int32)	Размер файла в байтах.
filesOwner	IIdentifiableObject[]	Представляет идентифицируемый объект.
extension	string	Расширение файла.

IGetDefaultLocation

Представляет запрос строки расположения.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

ICreateDocumentRequest

Представляет запрос создания документа.

Name	Type	Notes
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименование документа.

ICreateDocumentWithValuesRequest

Представляет запрос создания документа с параметрами.

Name	Type	Notes
documentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
addedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно добавить.
values	IAblePropertyValuesRequest[]

IUpdateDocumentRequest

Запрос изменения наименование документа.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

StringOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	string

ILinkDocumentOwnersRequest

Представляет запрос привязки документа к владельцам.

Name	Type	Notes
document	IIdentifiableObject[]	Представляет идентифицируемый объект.
documentOwners	IIdentifiableObject[]	Идентификаторы владельцев документа.

IUnlinkDocumentOwnersRequest

Представляет запрос отвязки документа от владельцев.

Name	Type	Notes
document	IIdentifiableObject[]	Представляет идентифицируемый объект.
documentOwners	IIdentifiableObject[]	Идентификаторы владельцев документа.

IDeleteManyRequest

Представляет запрос удаления множества элементов справочника.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы удаляемых объектов.

IDeleteManyResponse

Представляет список объектов, которые не удалось удалить.

Name	Type	Notes
objectsDeleteDenied	INamedObject[]	Объекты, для удаления которых недостаточно прав.
objectsNotFound	IIdentifiableObject[]	Объекты, которые не были найдены.

IDocumentCatalog

Представляет каталог документов.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
classId	string	Возвращает или задает название класса элементов.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
reference	IIdentifiableObject[]	Представляет идентифицируемый объект.
isEntry	boolean	Признак "Объект является точкой входа".

IUpdateDocumentCatalogRequest

Запрос обновления каталога документов.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isEntry	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IDocumentGroup

Группа документов.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
description	string	Описание.
id	string	Идентификатор
classId	string	Возвращает или задает название класса элементов.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
parentCatalog	IIdentifiableObject[]	Представляет идентифицируемый объект.
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
hasObjects	boolean	Признак наличия объектов (элементов, документов или представлений) у группы
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
createDeleteAccess	boolean	Возвращает признак, может ли пользователь создавать/удалять объекты.
isEntry	boolean	Признак "Объект является точкой входа".

IGroupStatistics

Представляет статистику группы.

Name	Type	Notes
groupsCount	integer (int32)	Количество дочерних групп.
objectsCount	integer (int32)	Количество объектов группы.
subGroupsCount	integer (int32)	Количество входящих подгрупп на всех уровнях вложенности.
allObjectsCount	integer (int32)	Количество объектов в т.ч. из подгрупп на всех уровнях вложенности.

ICreateDocumentGroupRequest

Представляет запрос создания документа.

Name	Type	Notes
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименование документа.

IUpdateDocumentGroupRequest

Запрос обновления группы документов.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
iconCode	Int32Optional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isEntry	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

ILinkDocumentsRequest

Модель данных для привязывания документа к объекту-владельцу.

Name	Type	Notes
documentOwnerObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
documentObjects	IIdentifiableObject[]	Документ.

IOwnedDocument

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
document	IDocument
documentOwner	INamedObject	Представляет объект, обладающий именем.
isInherited	boolean	Признак того, что документ унаследован

IUnlinkDocumentsRequest

Модель данных для удаления связи между документом и объектом-владельцем.

Name	Type	Notes
documentOwnerObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
documentObjects	IIdentifiableObject[]	Документ.

IPropertyOwnerContainer

Представляет контейнер для данных о владельце свойств.

Name	Type	Notes
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
allContracts	IContractRef[]	Понятия.

ILinkDefinitionEnd

Конец определения связи

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
absoluteCode	string	Длинный уникальный код.
code	string	Уникальный код.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
fullName	string	Возвращает полное имя
shortName	string	Возвращает сокращённое имя
multiplicity	LinkEndMultiplicity	Множественность конца связи.
isMultiple	boolean	Возвращает признак того, что конец множественный
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
otherEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
aggregate	boolean	Возвращает или задает признак того, что объекты данного конца связи относятся к объектам противоположного конца связи как "целое"
refersAs	string	Возвращает или задает описание того, как объекты данного конца связи относятся к объектам противоположного конца связи

LinkEndMultiplicity

Множественность конца связи.

IGetLinkedElementsLocationsRequest

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

Name	Type	Notes
elementLocation	string	Расположение элемента-источника.
linkDefCode	string	Код определения связи.

ILinkElementsToViewpointRequest

Запрос привязки элементов справочника и представлению.

Name	Type	Notes
elements	IIdentifiableObject[]	Список элементов для привязки.
viewpoint	IIdentifiableObject[]	Представляет идентифицируемый объект.

IUnlinkElementsFromViewpointRequest

Запрос отмены привязки элементов справочника и представления.

Name	Type	Notes
elements	IIdentifiableObject[]	Элемент, от которого открепляется представление.
viewpoint	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICreateElementRequest

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

Name	Type	Notes
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименования элемента.

IUpdateElementRequest

Представляет запрос обновления элемента справочника.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IDeleteElementRequest

Запрос удаления элемента по идентификатору.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
deleteWithViewpoints	boolean	Признак того, что вместе с элементом нужно удалить связанные представления.

IDeleteManyElementsRequest

Запрос удаления списка элементов.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы удаляемых объектов.
deleteWithViewpoints	boolean	Признак того, что вместе с элементом нужно удалить связанные представления.

IDeleteManyElementsResponse

Представляет ответ на запрос удаления списка элементов.

Name	Type	Notes
objectsDeleteDenied	INamedObject[]	Объекты, для удаления которых недостаточно прав.
objectsNotFound	IIdentifiableObject[]	Объекты, которые не были найдены.
deletedViewpoints	IIdentifiableObject[]	Удалённые связанные представления.

IElementCatalog

Представляет каталог элементов.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
classId	string	Возвращает или задает название класса элементов.
id	string	Идентификатор
description	string	Описание.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
reference	IIdentifiableObject[]	Представляет идентифицируемый объект.
isEntry	boolean	Признак "Объект является точкой входа".

ICreateElementCatalogRequest

Запрос создания каталога элементов справочника.

Name	Type	Notes
reference	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименования элемента.

IUpdateElementCatalogRequest

Запрос обновления каталога элементов справочника.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
iconCode	Int32Optional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isEntry	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IElementGroup

Группа элементов.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
description	string	Описание.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
parentCatalog	IIdentifiableObject[]	Представляет идентифицируемый объект.
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
hasObjects	boolean	Признак наличия объектов (элементов, документов или представлений) у группы
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
createDeleteAccess	boolean	Возвращает признак, может ли пользователь создавать/удалять объекты.
isEntry	boolean	Признак "Объект является точкой входа".
classId	string	Возвращает или задает название класса элементов.
isAllPartSizesTab	boolean	Признак отображения вкладки "Все размеры".

ICreateElementGroupRequest

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

Name	Type	Notes
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименования элемента.

IUpdateElementGroupRequest

Запрос обновления группы элементов справочника.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
iconCode	Int32Optional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isEntry	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IEventLogRoot

Корень журнала событий.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isLoggingEnabled	boolean	Возвращает и задает признак того, что в текущей сессии включено логирование.
isLoggingEnabledGlobal	boolean	Возвращает и задает признак того, что логирование включено глобально.
isAutoClearEnabled	boolean	Возвращает и задает признак того, что автоочистка журнала включена.
autoClearHistoryStorageTimeInDays	integer (int32)	Возвращает и задает, сколько дней необходимо хранить историю при включенной автоочистке.

ISessionRecordsGroup

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
openingDateTime	string (date-time)	Время открытия группы.
closingDateTime	string (date-time)	Время закрытия группы.
sessionResult	SessionRecordsGroupResult	Результат состоянии сессии записи журнала.
user	IUser[]	Пользователь.
moduleName	string	Название модуля, в котором открыта сессия.
machineName	string	Название машины, на которой открыта сессия.

SessionRecordsGroupResult

Результат состоянии сессии записи журнала.

IUser

Пользователь.

Name	Type	Notes
description	string	Описание.
code	string	Уникальный код.
externalId	string	Внешний идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
firstName	string	Возвращает или задает имя.
patronymic	string	Возвращает или задает отчество.
lastName	string	Возвращает или задает фамилию.
isAdministrator	boolean	Возвращает или задает признак того, что пользователь является администратором.
email	string	Возвращает или задает e-mail.
fullName	string	Возвращает полное имя.
im	string	Возвращает или задает идентификатор службы мгновенных сообщений.
login	string	Возвращает или задает логин.
phone	string	Возвращает или задает номер телефона.
hasPhoto	boolean	Возвращает признак, задано ли пользователю фото.
additionalInfo	string	Возвращает или задает дополнительную информацию.
web	string	Возвращает или задает web-контакт.
roles	IRole[]	Возвращает собственные роли.
positions	IPosition[]	Возвращает должности.

IRole

Возвращает собственные роли.

Name	Type	Notes
description	string	Описание.
code	string	Уникальный код.
externalId	string	Внешний идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
name	string	Имя объекта.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IPosition

Возвращает должности.

Name	Type	Notes
description	string	Описание.
code	string	Уникальный код.
externalId	string	Внешний идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
name	string	Имя объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

ITransactionRecordsGroup

Группа записей журнала событий в транзакции.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
openingDateTime	string (date-time)	Время открытия группы.
closingDateTime	string (date-time)	Время закрытия группы.
transactionResult	TransactionRecordsGroupResult	Результат записи журнала событий в транзакции.
user	IUser[]	Пользователь.
result	TransactionRecordsGroupResult	Результат записи журнала событий в транзакции.

TransactionRecordsGroupResult

Результат записи журнала событий в транзакции.

IEventRecord

Представляет запись события.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
message	string	Сообщение.
type	EventRecordTypes	Тип записи журнала событий.
dateTime	string (date-time)	Дата и время возникновения события.
loggedObject	ILoggedObject[]	Представляет объект наблюдения и внесения изменений в журнал.
reference	ILoggedObject[]	Представляет объект наблюдения и внесения изменений в журнал.
user	IUser[]	Пользователь.
result	TransactionRecordsGroupResult	Результат записи журнала событий в транзакции.

EventRecordTypes

Тип записи журнала событий.

ILoggedObject

Представляет объект наблюдения и внесения изменений в журнал.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IFavoritesItem

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
ownerGroup	IIdentifiableObject	Представляет идентифицируемый объект.

IMoveToRequest

Модель данных для перемещения объекта в избранном.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
item	IIdentifiableObject[]	Представляет идентифицируемый объект.

IAddToRequest

Модель данных для добавления объекта в избранное.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
item	IIdentifiableObject[]	Представляет идентифицируемый объект.

IAddManyToRequest

Модель данных для добавления объектов в избранное.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
items	IIdentifiableObject[]	Список объектов для добавления.

IRemoveManyRequest

Модель данных для удаления списка объектов из группы избранного.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы удаляемых объектов.

IFavoritesCatalog

Представляет каталог избранного.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
classId	string	Возвращает или задает название класса элементов.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
isEntry	boolean	Признак "Объект является точкой входа".

IImportFavoritesResponse

Модель данных ответа на запрос об импорте избранного.

Name	Type	Notes
totalGroups	integer (int32)	Общее количество обработанных групп.
groupsImported	integer (int32)	Общее количество импортированных групп.
totalElements	integer (int32)	Общее количество обработанных элементов.
elementsImported	integer (int32)	Общее количество импортированных элементов.
importMessages	array	Список сообщений по итогам импорта.

IFavoritesGroup

Группа избранного

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
description	string	Описание.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
parentCatalog	IIdentifiableObject[]	Представляет идентифицируемый объект.
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
hasObjects	boolean	Признак наличия объектов (элементов, документов или представлений) у группы
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
createDeleteAccess	boolean	Возвращает признак, может ли пользователь создавать/удалять объекты.
isEntry	boolean	Признак "Объект является точкой входа".

ICreateFavoritesGroupRequest

Модель данных для создания группы избранного.

Name	Type	Notes
parent	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Название новой группы(если не указано, будет присвоено стандартное название).

IUpdateFavoritesGroupRequest

Запрос обновления свойств группы избранных.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	string	Имя группы.

IAddToDocumentRequest

Модель данных для добавления файла документу.

Name	Type	Notes
document	IIdentifiableObject[]	Представляет идентифицируемый объект.
fileName	string	Актуальное имя файла.
temporaryFileName	string	Имя временного файла.
creationDate	string (date-time)	Дата создания файла.
modificationDate	string (date-time)	Дата последнего редактирования файла.

IAddToTicketRequest

Модель данных для добавления файла заявке.

Name	Type	Notes
ticket	IIdentifiableObject[]	Представляет идентифицируемый объект.
fileName	string	Актуальное имя файла.
temporaryFileName	string	Имя временного файла.

IRenameFileRequest

Модель данных для редактирования файла документа.

Name	Type	Notes
file	IIdentifiableObject[]	Представляет идентифицируемый объект.
fileName	string	Наименование документа.

IReplaceRequest

Модель данных для замены содержимого файла.

Name	Type	Notes
file	IIdentifiableObject[]	Представляет идентифицируемый объект.
temporaryFileName	string	Имя временного файла.

IDownloadFileRequest

Представляет запрос загрузки файла.

Name	Type	Notes
fileName	string	Наименование файла.

IFormula

Представляет формулу.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
code	string	Уникальный код.
description	string	Описание.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
body	string	Возвращает или задает тело формулы.
parameters	IFormulaParameter[]	Список параметров формулы.

IFormulaParameter

Список параметров формулы.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
body	string	Возвращает или задает тело параметра формулы.
position	integer (int32)	Возвращает или задает позицию параметра в коллекции параметров формулы.
formula	IIdentifiableObject[]	Представляет идентифицируемый объект.

IContractAppointedFormula

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
appointedFormulas	IAppointedFormula[]	Список назначенных формул.
nestedItems	INestedItem[]	Элементы с вложенностью.

IAppointedFormula

Список назначенных формул.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
formula	IFormula	Представляет формулу.
formulaAppointer	IClassifiableObject
formulaTargetQualifier	IFormulaTargetQualifier	Представляет объект, позволяющий определить свойство, которому будет назначена формула.
position	integer (int32)	Позиция в списке.

IFormulaTargetQualifier

Представляет объект, позволяющий определить свойство, которому будет назначена формула.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
contract	INamedObject	Представляет объект, обладающий именем.
type	PropertyType	Типы свойств.
isLinked	boolean	Возвращает признак, является ли свойство связанным.

INestedItem

Элементы с вложенностью.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
appointedFormulas	IAppointedFormula[]	Список назначенных формул.
type	PropertyType	Типы свойств.
position	integer (int32)	Позиция в списке.

IAddAppointedFormulaRequest

Параметры назначения формулы на квалификатор свойства для каталога/группы.

Name	Type	Notes
formulaAppointer	IIdentifiableObject[]	Представляет идентифицируемый объект.
formulaTargetQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
formula	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEvaluatePropertyFormulaRequest

Запрос получения значения вычисляемого свойства.

Name	Type	Notes
formula	IIdentifiableObject[]	Представляет идентифицируемый объект.
conceptPropertySource	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyOwner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyValue

Представляет данные значения свойства.

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILicense

Name	Type	Notes
description	string	Описание.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
info	string	Возвращает дополнительную информацию о лицензии
canReleased	boolean	Возвращает признак того, что лицензия может быть отдана.

ILink

Связь.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
sourceLinkedItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkDefinitionOtherEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkedItemsCount	integer (int32)	Количество связанных элементов.
linkedItems	ILinkable[]	Список элементов, привязанных к элементу-источнику.

ILinkable

Список элементов, привязанных к элементу-источнику.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
linkedElement	IIdentifiableObject[]	Представляет идентифицируемый объект.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkedElementsRequest

Модель данных для запроса связанных элементов.

Name	Type	Notes
element	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkDefinition

Представляет определение связи.

Name	Type	Notes
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
code	string	Уникальный код.
description	string	Описание.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
name	string	Имя объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
source	ILinkDefinitionEnd[]	Конец определения связи
destination	ILinkDefinitionEnd[]	Конец определения связи
multiplicity	LinkDefinitionMultiplicity	Множественность определения связи.
direction	LinkDefinitionDirection	Направление связи
useForFiltering	boolean	Признак того, что связь будет учитываться в фильтрах.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.

LinkDefinitionMultiplicity

Множественность определения связи.

LinkDefinitionDirection

Направление связи

IComparingConditionDefinition

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
operation	integer (int32)	Операция.
options	integer (int32)	Опции.
isMandatory	boolean	Обязательное.
linkDefinition	IIdentifiableObject	Представляет идентифицируемый объект.
source	IComparingConditionDefinitionEnd	Конец описания сравнительного условия.
destination	IComparingConditionDefinitionEnd	Конец описания сравнительного условия.
currentType	PropertyMixedComparisonType	Группы совместимых для смешанного сравнения типов свойств.

IComparingConditionDefinitionEnd

Конец описания сравнительного условия.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
comparingConditionDefinition	IIdentifiableObject	Представляет идентифицируемый объект.
propertyQualifiers	ISearchPropertyQualifier[]	Квалификаторы свойств.
linkDefinitionEnd	IIdentifiableObject	Представляет идентифицируемый объект.

ISearchPropertyQualifier

Квалификаторы свойств.

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
propertyDefinition	IPropertyDefinition	Определение свойства.
conceptPropertySource	IConceptPropertySource	Представляет источник свойства в понятии.

IPropertyDefinition

Определение свойства.

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
ownerBaseGroup	IIdentifiableObject	Представляет идентифицируемый объект.
id	string	Идентификатор
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.
ownerGroup	IIdentifiableObject	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject	Представляет идентифицируемый объект.

PropertyMixedComparisonType

Группы совместимых для смешанного сравнения типов свойств.

ICompareOperationMetadata

Name	Type	Notes
operation	integer (int32)	Возвращает код операции.
isNullValue	boolean	Возвращает признак того, что данная операция не требует значения.
displayName	string	Возвращает имя операции.
compareOptionsMetadata	ICompareOptionMetadata[]	Возвращает метаданные опций операции.

ICompareOptionMetadata

Возвращает метаданные опций операции.

Name	Type	Notes
option	integer (int32)	Возвращает код опции.
displayName	string	Возвращает имя опции.

ICheckElementExistInScopeRequest

Представляет запрос проверки вхождения владельца свойств в указанную область.

Name	Type	Notes
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyOwner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEditPropertyQualifiersRequest

Модель данных для запроса на добавление/удаление квалификаторов свойств в условиях совместимости.

Name	Type	Notes
comparingConditionDefinitionEndId	integer (int32)	Идентификатор конца условия совместимости.
propertyQualifierIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICreateLinkDefGroupRequest

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

Name	Type	Notes
parentLinkDefGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименование группы.

ICreateLinkDefinitionRequest

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

Name	Type	Notes
parentLinkDefGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
sourceName	string	Имя первого конца создаваемой связи.
destinationName	string	Имя второго конца создаваемой связи.

ICreateComparingConditionDefinitionRequest

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

Name	Type	Notes
linkDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименование условия совместимости.

IUpdateComparingConditionDefinitionRequest

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

Name	Type	Notes
comparingConditionDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименование условия совместимости.
code	string	Уникальный код условия совместимости.
isMandatory	boolean	Признак "Обязательное".
operation	integer (int32)	Операция сравнения.
options	integer (int32)	Опции сравнения.

ILinkInstance

Экземпляр связи.

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
sourceLink	ILink[]	Связь.
destinationLink	ILink[]	Связь.
sourceLinkableItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
destinationLinkableItem	IIdentifiableObject[]	Представляет идентифицируемый объект.

IAddConceptsRequest

Модель данных для добавления понятий экземпляру связи.

Name	Type	Notes
linkInstance	IIdentifiableObject[]	Представляет идентифицируемый объект.
concepts	IIdentifiableObject[]	Идентификаторы понятий.

IAddPropertiesRequest

Модель данных для добавления собственных свойств экземпляру связи.

Name	Type	Notes
linkInstance	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyDefinitions	IIdentifiableObject[]	Идентификаторы свойств.

IDeleteConceptRequest

Модель данных для удаления понятия экземпляра связи.

Name	Type	Notes
linkInstance	IIdentifiableObject[]	Представляет идентифицируемый объект.
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.

IDeletePropertiesRequest

Модель данных для удаления собственных свойств экземпляра связи.

Name	Type	Notes
linkInstance	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyDefinitions	IIdentifiableObject[]	Идентификаторы свойств.

ILinkElementsRequest

Модель данных для создания связи элементов.

Name	Type	Notes
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
element	IIdentifiableObject[]	Представляет идентифицируемый объект.
elementToLinks	IIdentifiableObject[]	Идентификаторы элементов, входящих в области противоположного конца связи.

ILinkMaterialsAssortmentsRequest

Модель данных для создания связи материалов и сортаментов.

Name	Type	Notes
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
element	IIdentifiableObject[]	Представляет идентифицируемый объект.
elementToLinks	IIdentifiableObject[]	Идентификаторы элементов, входящих в области противоположного конца связи.
document	IIdentifiableObject[]	Представляет идентифицируемый объект.

IDeleteLinksRequest

Модель данных для удаления связи элементов.

Name	Type	Notes
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
element	IIdentifiableObject[]	Представляет идентифицируемый объект.
elementToLinks	IIdentifiableObject[]	Идентификаторы элементов, входящих в области противоположного конца связи.

IStorageDefinition

Name	Type	Notes
storageId	string (uuid)	Идентификатор хранилища.
displayName	string	Отображаемое имя хранилища.

IStorageInfo

Представляет информацию о хранилище.

Name	Type	Notes
storageId	string (uuid)	Идентификатор хранилища.
name	string	Имя хранилища.
dateOfCreation	string (date-time)	Дата создания;
version	string	Версия хранилища.

ISsoSettingsResponse

Представляет настройки единой системы авторизации.

Name	Type	Notes
available	boolean	Признак доступности сервера Sso.
url	string	Адрес сервера.
privateUrl	string	Приватный адрес сервера.

ISignInRequest

Модель данных для авторизации пользователя

Name	Type	Notes
moduleName	string	Пароль
clientType	ClientTypes	Тип клиентов ПОЛИНОМ:MDM.
storageId	string	Идентификатор хранилища
login	string	Имя пользователя ПОЛИНОМ:MDM
password	string	Пароль

ClientTypes

Тип клиентов ПОЛИНОМ:MDM.

IAuthResponse

Ответ на авторизацию пользователя.

Name	Type	Notes
access_token	string	Токен доступа.
token_type	string	Тип токена доступа.
expires_in	integer (int32)	Срок жизни токена доступа. (сек.)
refresh_token	string	Токен обновления токена доступа.

ISignInBySystemRequest

Модель данных для авторизации пользователя.

Name	Type	Notes
moduleName	string	Пароль
clientType	ClientTypes	Тип клиентов ПОЛИНОМ:MDM.
storageId	string	Идентификатор хранилища

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

IGetMaterialRequest

Запрос получения материалов, связанных с сортаментом.

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
filterString	string	Значение фильтра.

ILinkAssortmentsRequest

Модель данных для создания связи материалa и сортаментов.

Name	Type	Notes
material	IIdentifiableObject[]	Представляет идентифицируемый объект.
assortments	IIdentifiableObject[]	Идентификаторы сортаментов.
standardSpecificationsDocument	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICreateMaterial

Модель данных для создания материала.

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
materialGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
materialDocument	IIdentifiableObject[]	Представляет идентифицируемый объект.
standardSpecificationsDocument	IIdentifiableObject[]	Представляет идентифицируемый объект.
addedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно добавить.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
propertyValues	IAblePropertyValuesRequest[]

IGetAllMeasureRequest

Представляет запрос на получение всех единиц измерения.

Name	Type	Notes
storageName	string	Имя хранилища.

IAllMeasurement

Представляет контейнер всех измеряемых сущностей.

Name	Type	Notes
entities	IAllMeasureEntity[]	Список всех измеряемых сущностей.

IAllMeasureEntity

Список всех измеряемых сущностей.

Name	Type	Notes
code	string	Уникальный код.
name	string	Имя объекта.
basicUnitCode	string	Базовый код величины.
units	IAllMeasureUnit[]	Список всех единиц измерений данной измеряемой сущности.

IAllMeasureUnit

Список всех единиц измерений данной измеряемой сущности.

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
description	string	Описание.
isBasic	boolean	Возвращает или задает признак того, что единица измерения является базовой.
designation	string	Возвращает или задает описание измеряемой сущности из ЕдИзм.
fromBasicFactor	string	Возвращает или задает множитель перевода из базовой единицы из ЕдИзм.
fromBasicOffset	string	Возвращает или задает смещение перевода из базовой единицы из ЕдИзм.
codeOkei	string	Возвращает или задает код по ОКЕИ.
internationalDesignationOkei	string	Возвращает или задает международное обозначение по ОКЕИ.
internationalLiteralDesignation	string	Возвращает или задает международное буквенное обозначение.
literalDesignation	string	Возвращает или задает национальное буквенное обозначение.

IGetByIdMeasureEntityRequest

Запрос поиска измеряемых величин по идентификатору.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
storageName	string	Имя хранилища.

IGetByUidMeasureEntityRequest

Запрос поиска единиц измерения по Guid.

Name	Type	Notes
id	string	Идентификатор объекта.
storageName	string	Имя хранилища.

IGetByCodeMeasureEntityRequest

Запрос поиска измеряемой величины по коду.

Name	Type	Notes
code	string	Код объекта.
storageName	string	Имя хранилища.

IGetAllMeasureEntityRequest

Запрос поиска всех измеряемых величин.

Name	Type	Notes
storageName	string	Имя хранилища.

IUpdateMeasureEntityRequest

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

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
code	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
basicUnit	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IGetByIdMeasureUnitRequest

Представляет запрос поиска единиц измерения по идентификатору.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
storageName	string	Имя хранилища.

IGetByCodeMeasureUnitRequest

Представляет запрос поиска единицы измерения по коду.

Name	Type	Notes
code	string	Код объекта.
storageName	string	Имя хранилища.

IGetByEntityMeasureUnitRequest

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

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
storageName	string	Имя хранилища.

IUpdateMeasureUnitRequest

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

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
code	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
designation	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
fromBasicFactor	DoubleOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
fromBasicOffset	number (double)	Возвращает или задает смещение перевода из базовой единицы из ЕдИзм.
codeOkei	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
internationalDesignationOkei	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
internationalLiteralDesignation	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
literalDesignation	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

DoubleOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	number (double)

IPermission

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
id	string	Идентификатор
description	string	Описание.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
currentUserHasPermission	boolean	Признак того, что текущий пользователь имеет это разрешение.

IPermissionItem

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
role	IRole	Представляет роль.
permission	IIdentifiableObject	Представляет идентифицируемый объект.
value	boolean	Значение.

IUpdatePermissionRequest

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

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
code	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
permissionItems	IPermissionItemListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IPermissionItemListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IPermissionItem[]

ICreatePropertyDefinitionRequest

Модель данных для создания нового определения свойства.

Name	Type	Notes
typeId	IdentifiableObjectType	Представляет тип объекта.
name	string	Наименование нового определения свойства (если не указано, будет присвоено стандартное название).
description	string	Описание нового определения свойства.
code	string	Код нового определения свойства (если не указано, будет присвоено значение по умолчанию).
measureEntityId	integer (int32)	Идентификатор измеряемой сущности (заполняется при создании свойства с типом "Число с плавающей точкой").
groupId	integer (int32)	Идентификатор группы, в которую будет помещено новое описание свойства.

IUpdatePropertyDefinitionRequest

Модель данных для обновления определения свойства.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	string	Отображаемое имя свойства.
type	PropertyType	Типы свойств.
description	string	Описание свойства.
code	string	Код описания свойства.
measureEntityId	integer (int32)	Идентификатор измеряемой сущности (заполняется при создании свойства с типом "Число с плавающей точкой").

IAddItemRequest

Модель данных для добавления нового пункта перечисления в определение свойства.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
stringValue	string	Пункт перечисления (заполняется для типа "Строка").
integerValue	integer (int32)	Пункт перечисления (заполняется для типа "Целое число").
doubleValue	number (double)	Пункт перечисления (заполняется для типа "Число с плавающей точкой").
boolValue	boolean	Пункт перечисления (заполняется для типа "Логическое").
description	string	Описание пункта перечисления (заполняется для перечислений с описанием).

IRemoveItemRequest

Модель данных для удаления пункта перечисления из определения свойства.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
stringValue	string	Пункт перечисления (заполняется для типа "Строка").
integerValue	integer (int32)	Пункт перечисления (заполняется для типа "Целое число").
doubleValue	number (double)	Пункт перечисления (заполняется для типа "Число с плавающей точкой").
boolValue	boolean	Пункт перечисления (заполняется для типа "Логическое").

IAddColumnRequest

Модель данных для добавления нового столбца в определение табличного свойства.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
columnIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveColumnRequest

Модель данных для удаления столбца из определения табличного свойства.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
columnIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IUpdateColumnRequest

Модель данных для редактирования столбца табличного свойства.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
columnIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
nameInTable	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
values	IAblePropertyValuesOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isDefaultIfEmpty	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isMandatory	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isUnique	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isUniqueInTable	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isDynamic	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isIndexable	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isHidden	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isReadOnly	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IAblePropertyValuesOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.

IGetMoveToGroupPropertyDefinitionGroupRequest

Модель данных для перемещения объекта в группу определений избранного.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
group	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISetMoveToGroupPropertyDefinitionGroupRequest

Модель данных для перемещения объекта в группу определений избранного.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
group	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyDefinitionUsage

Использвание определения свойства.

Name	Type	Notes
contracts	IContract[]	Понятия, в которых используется определение свойства.
hasValues	boolean	Признак того, имеет ли определение свойства присвоенные значения.

IContract

Понятия, в которых используется определение свойства.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
code	string	Уникальный код.
description	string	Описание.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
contractPropertySources	IContractPropertySource[]	Возвращает коллекцию контрактных источников свойств.

IContractPropertySource

Возвращает коллекцию контрактных источников свойств.

Name	Type	Notes
name	string	Имя объекта.
id	string	Идентификатор
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
contract	INamedObject[]	Представляет объект, обладающий именем.
type	PropertyType	Типы свойств.
isLinked	boolean	Возвращает признак, является ли свойство связанным.
isMandatory	boolean	Возвращает или задает признак "Обязательное свойство".
isMandatoryEnabled	boolean	Возвращает или задает редактируемость признака "Обязательное свойство".
isHidden	boolean	Возвращает или задает признак "Скрытое свойство".
isHiddenEnabled	boolean	Возвращает или задает редактируемость признака "Скрытое свойство".
isSpecial	boolean	Возвращает или задает признак "Специальное свойство".
isSpecialEnabled	boolean	Возвращает или задает редактируемость признака "Специальное свойство".
isUnique	boolean	Возвращает или задает признак "Уникальное свойство"
isUniqueEnabled	boolean	Возвращает или задает редактируемость признака "Уникальное свойство"
isIndexable	boolean	Возвращает или задает признак "Индексируемое свойство".
isIndexableEnabled	boolean	Возвращает или задает редактируемость признака "Индексируемое свойство".
isDynamic	boolean	Возвращает или задает признак "Дополнительное свойство".
isDynamicEnabled	boolean	Возвращает редактируемость признака "Дополнительное свойство".
isDisplayedForSelection	boolean	Возвращает или задает признак "Отображать для выбора".
isDisplayedForSelectionEnabled	boolean	Возвращает редактируемость признака "Отображать для выбора".
isSetBeforeApplying	boolean	Возвращает или задает признак "Задать перед применением".
isSetBeforeApplyingEnabled	boolean	Возвращает редактируемость признака "Задать перед применением".
isUsedInModelFamiliesDefault	boolean	Возвращает или задает признак "Используется в семействах моделей по умолчанию".
isUsedInModelFamiliesDefaultEnabled	boolean	Возвращает редактируемость признака "Используется в семействах моделей по умолчанию".
isReadOnly	boolean	Возвращает или задает признак "Запретить изменение".
isReadOnlyEnabled	boolean	Возвращает редактируемость признака "Запретить изменение".
position	integer (int32)	Возвращает или задает позицию источника свойства в контракте.
isDefaultIfEmpty	boolean	Возвращает или задает признак того, что для неназначенных значений выводится значение по умолчанию.
isDefaultIfEmptyEnabled	boolean	Возвращает редактируемость признака того, что для неназначенных значений выводится значение по умолчанию.
isDefaultEnabled	boolean	Возвращает редактируемость значений по умолчанию.
isNameManuallySet	boolean	Задать имя вручную.
propertySource	IPropertySource[]	Представляет источник свойства.
measureEntity	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultMeasureUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.
defaultPropertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyDefinitionCatalog

Каталог определений свойств.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
classId	string	Возвращает или задает название класса элементов.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)

IPropertyDefinitionGroup

Группа определений свойств.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
description	string	Описание.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
parentCatalog	IIdentifiableObject[]	Представляет идентифицируемый объект.
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
hasObjects	boolean	Признак наличия объектов (элементов, документов или представлений) у группы
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
createDeleteAccess	boolean	Возвращает признак, может ли пользователь создавать/удалять объекты.

ICreatePropertyDefinitionGroupRequest

Модель данных для создания группы определений свойств.

Name	Type	Notes
parent	IIdentifiableObject[]	Представляет идентифицируемый объект.
groupName	string	Название новой группы(если не указано, будет присвоено стандартное название).

IUpdatePropertyDefinitionGroupRequest

Представляет запрос на редактирование группы определений свойств.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IDeleteManyPropertyDefinitionGroupsRequest

Модель данных для удаления списка групп описаний свойств.

Name	Type	Notes
groupIds	array	Идентификаторы удаляемых групп.

IGetPropertyRequest

Представляет запрос свойства владельца свойств.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyResponse

Ответ на запрос свойства.

Name	Type	Notes
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
allContracts	IContractRef[]	Понятия.

IGetPropertiesRequest

Параметры запроса свойств объекта.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetPropertiesByGroupRequest

Модель данных для постраничного запроса элементов группы

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetPropertiesByGroupResponse

Представляет ответ на запрос владельцев свойств по группе.

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
items	IPropertyOwnerRef[]	Возвращает элементы страницы.
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
allContracts	IContractRef[]	Понятия.

IRealizesRequest

Представляет запрос проверки реализации контрактов у владельца свойств.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
concepts	IConceptIdentifier[]	Список реализуемых понятий.

IConceptIdentifier

Список реализуемых понятий.

Name	Type	Notes
identifier	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
absoluteCode	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IGetLinkedPropertyRequest

Модель данных для назначения значений свойствам экземпляров связи.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkedElement	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyValueContainer

Представляет контейнер для данных значения свойств.

Name	Type	Notes
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.

ISetPropertyValuesRequest

Модель данных для назначения значений свойствам.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
addedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно добавить.
deletedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно удалить.
deletedOwnProperties	IIdentifiableObject[]	Список собственных свойств, которые нужно удалить.
deletedDynamicProperties	IIdentifiableObject[]	Список дополнительных свойств, которые нужно удалить.
values	IAblePropertyValuesRequest[]

ISetPropertyValuesResponse

Представляет ответ после редактирования владельца свойств.

Name	Type	Notes
name	string	Наименование.
applicability	Applicability	Представляет применяемость объекта.

IAddTablePropertyRowRequest

Модель данных для добавления строки в табличное свойство.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveTablePropertyRowRequest

Модель данных для удаления строки из табличного свойства.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
targetRow	integer (int32)	Позиция целевой строки.

IReplaceTablePropertyRowRequest

Модель данных для изменения позиции строки в табличном свойстве.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
targetRow	integer (int32)	Позиция целевой строки.
newPosition	integer (int32)	Новая позиция строки.

ISetTablePropertyValuesRequest

Модель данных для назначения значений табличному свойству.

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
concept	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
cells	ITableCellValueRequest[]	Список ячеек таблицы для редактирования.
values	IAblePropertyValuesRequest[]

ITableCellValueRequest

Список ячеек таблицы для редактирования.

Name	Type	Notes
value	IIdentifiableObject[]	Представляет идентифицируемый объект.
row	integer (int32)	Строка.
column	integer (int32)	Столбец.

ISetLinkedPropertyValuesRequest

Name	Type	Notes
properties	ILinkedPropertyValueItem[]	Список освойств, которым присваиваются значения.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkedPropertyValueItem

Список освойств, которым присваиваются значения.

Name	Type	Notes
linkedProperty	IIdentifiableObject[]	Представляет идентифицируемый объект.
contract	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISetFormulaPropertyValueRequest

Name	Type	Notes
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
properties	IFormulaPropertyValueItem[]	Список свойств, которым присваиваются значения.

IFormulaPropertyValueItem

Список свойств, которым присваиваются значения.

Name	Type	Notes
propertyFormulaInfo	IPropertyFormulaInfo[]
contract	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyFormulaInfo

Name	Type	Notes
formulaInfo	IIdentifiableObject[]	Представляет идентифицируемый объект.
tablePropertyColumnFormula	ITablePropertyColumnFormula[]
tablePropertyRowFormula	ITablePropertyRowFormula[]

ITablePropertyColumnFormula

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
formula	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.

ITablePropertyRowFormula

Name	Type	Notes
formula	IIdentifiableObject[]	Представляет идентифицируемый объект.
columnNumber	integer (int32)	Порядковый номер столбца.
rowNumber	integer (int32)	Порядковый номер строки.

ISetExternalFormulaRequest

Name	Type	Notes
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveManyOwnPropertiesRequest

Представляет запрос удаления собственных свойств объекта.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы удаляемых объектов.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveManyOwnConceptsRequest

Представляет запрос удаления собственных понятий объекта.

Name	Type	Notes
identifiers	IIdentifiableObject[]	Идентификаторы удаляемых объектов.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IReference

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

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
description	string	Описание.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
documentCatalog	IDocumentCatalog[]	Представляет каталог документов.
viewpointCatalog	IViewpointCatalog[]	Представляет каталог представлений.
currentUserIsAdmin	boolean	Признак того, что текущий пользователь является администратором справочника.

IViewpointCatalog

Представляет каталог представлений.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
classId	string	Возвращает или задает название класса элементов.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
reference	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICreateReferenceRequest

Представляет запрос создания документа.

Name	Type	Notes
name	string	Наименование справочника.

IUpdateReferenceRequest

Запрос изменения справочника.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
iconCode	Int32Optional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IRestrictedList

Ограничительный перечень.

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
description	string	Описание.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isMandatory	boolean	Возвращает или задает опцию "Обязательный".

IGetByUserRestrictedListRequest

Представляет запрос списка ограничительных перечней.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Строка фильтра.

IRestrictedListPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IRestrictedList[]	Возвращает элементы страницы.

IGetAllRestrictedListRequest

Представляет запрос списка ограничительных перечней.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Строка фильтра.

IGetRoleItemRestrictedListRequest

Представляет запрос получения ограничительного перечня.

Name	Type	Notes
list	IIdentifiableObject[]	Представляет идентифицируемый объект.
roleItem	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRestrictedListRole

Элемент ограничительного перечня.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
role	IIdentifiableObject[]	Представляет идентифицируемый объект.
restrictedList	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	boolean	Возвращает или задает значение.
name	string	Название элемента ограничительного перечня.

IRestrictedListGroupPropertyOwnerItem

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
restrictedList	INamedObject	Представляет объект, обладающий именем.
groupPropertyOwner	INamedObject	Представляет объект, обладающий именем.
value	boolean	Возвращает или задает значение.

IUpdateRestrictedListRequest

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

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
code	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isMandatory	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IAddOwnerRestrictedListRequest

Представляет запрос на добавление владельца ограничительного перечня.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveOwnerRestrictedListRequest

Представляет запрос на удаление владельца ограничительного перечня.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.

IUpdateRoleRestrictedListRequest

Представляет объект запроса редактирования элемента ограничительного перечня.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
roleItem	IIdentifierRequest[]
value	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

ISetItemRestrictedListRequest

Представляет запрос включения/выключения ограничительного перечня у владельца.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
owner	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

ISearchStatusResponse

Модель данных ответа на запрос статуса поиска

Name	Type	Notes
status	SearchStatusEnum

SearchStatusEnum

ISearchRequest

Модель данных поискового запроса.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
searchText	string	Ключевая фраза для поиска.
scopes	IIdentifiableObject[]	Области поиска.

ISearchResultItemIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	ISearchResultItem[]	Возвращает элементы страницы.

ISearchResultItem

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.

ISearchCondition

Условие поиска.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
enabled	boolean	Возвращает или задает признак того, что условие включено.
conceptName	string	Наименование понятия.
propertyName	string	Наименование свойства.
isConceptedProperty	boolean	Признак того, что свойство с понятием.
propertyDefinition	IPropertyDefinitionWithItems[]	Определение свойства с предопределёнными значениями.
definitionMetaData	IPropertyDefinitionMetadata[]	Метаданные определения свойства.
searchConditionTargetQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertyDefinitionMetadata

Метаданные определения свойства.

Name	Type	Notes
propertyType	PropertyType	Типы свойств.
isComparable	boolean	Возвращает признак того, что значения свойства могут сравниваться между собой.
compareOperationsMetadata	ICompareOperationMetadata[]	Возвращает метаданные операций сравнения.
displayName	string	Возвращает имя определения.

IComparingCondition

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
comparingConditionDefinition	IComparingConditionDefinition	Описание сравнительного условия.
comparingConditionDefinitionEnd	IComparingConditionDefinitionEnd	Конец описания сравнительного условия.
propertyDefinition	IPropertyDefinitionWithItems	Определение свойства с предопределёнными значениями.
isEnabled	boolean	Включено.
isMandatory	boolean	Обязательное.

IStoredCondition

Сохранённая конфигурация поиска по свойствам.

Name	Type	Notes
name	string	Имя объекта.
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
userOptions	IIdentifiableObject[]	Представляет идентифицируемый объект.
condition	IComplexCondition[]	Составное условие.
ownerScope	IIdentifiableObject[]	Представляет идентифицируемый объект.

IComplexCondition

Составное условие.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
enabled	boolean	Возвращает или задает признак того, что условие включено.
intersectionType	IntersectionType	Типы пересечения подусловий сложного условия.
simpleConditions	ISimpleCondition[]	Простое условие.
complexConditions	array	Сложное условие.
elementConditions	ICompatibilityConditionForElement[]	Условие для поиска совместимых объектов по владельцу свойства.
propValueConditions	ICompatibilityConditionForPropValue[]	Условие для поиска совместимых объектов по значению.

IntersectionType

Типы пересечения подусловий сложного условия.

ISimpleCondition

Простое условие.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
enabled	boolean	Возвращает или задает признак того, что условие включено.
contract	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
searchConditionTargetQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
operation	integer (int32)	Операция сравнения.
options	integer (int32)	Опции операции сравнения.
value	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICompatibilityConditionForElement

Условие для поиска совместимых объектов по владельцу свойства.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
enabled	boolean	Возвращает или задает признак того, что условие включено.
linkDefinitionEnd	ILinkDefinitionEnd[]	Конец определения связи
comparingConditions	IComparingCondition[]	Сравнительные условия.
element	INamedObject[]	Представляет объект, обладающий именем.
enabledComparingConditionDefinitions	IIdentifiableObject[]	Описания сравнительных условий, по которым будет выполняться поиск.

ICompatibilityConditionForPropValue

Условие для поиска совместимых объектов по значению.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
enabled	boolean	Возвращает или задает признак того, что условие включено.
linkDefinitionEnd	ILinkDefinitionEnd[]	Конец определения связи
comparingConditions	IComparingConditionForPropValue[]	Условия сравнения.

IComparingConditionForPropValue

Условия сравнения.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
comparingConditionDefinition	IComparingConditionDefinition[]	Описание сравнительного условия.
comparingConditionDefinitionEnd	IComparingConditionDefinitionEnd[]	Конец описания сравнительного условия.
propertyDefinition	IPropertyDefinitionWithItems[]	Определение свойства с предопределёнными значениями.
isEnabled	boolean	Включено.
isMandatory	boolean	Обязательное.
propertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertySearchRequest

Модель данных для запроса поиска по свойствам с одной областью поиска.

Name	Type	Notes
ownerScope	IIdentifiableObject[]	Представляет идентифицируемый объект.
condition	IComplexConditionRequest[]	Модель данных для запроса составного условия.
values	IAblePropertyValuesRequest[]
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Количество объектов на странице.

IComplexConditionRequest

Модель данных для запроса составного условия.

Name	Type	Notes
enabled	boolean	Возвращает или задает признак того, что условие включено.
intersectionType	IntersectionType	Типы пересечения подусловий сложного условия.
simpleConditions	ISimpleConditionRequest[]	Список простых условий.
complexConditions	array	Список сложных условий.
elementConditions	ICompatibilityConditionForElementRequest[]	Список условий для поиска совместимых объектов по владельцу свойства.
propValueConditions	ICompatibilityConditionForPropValueRequest[]	Список условий для поиска совместимых объектов по значению.

ISimpleConditionRequest

Список простых условий.

Name	Type	Notes
enabled	boolean	Возвращает или задает признак того, что условие включено.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
searchConditionTargetQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
operation	integer (int32)	Операция сравнения.
options	integer (int32)	Опции операции сравнения.
value	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICompatibilityConditionForElementRequest

Список условий для поиска совместимых объектов по владельцу свойства.

Name	Type	Notes
enabled	boolean	Возвращает или задает признак того, что условие включено.
element	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
enabledComparingConditionDefinitions	IIdentifiableObject[]	Идентификаторы сравнительных условий, по которым будет выполняться поиск.

ICompatibilityConditionForPropValueRequest

Список условий для поиска совместимых объектов по значению.

Name	Type	Notes
enabled	boolean	Возвращает или задает признак того, что условие включено.
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
comparingConditions	IComparingConditionForPropValueRequest[]	Условия сравнения.

IComparingConditionForPropValueRequest

Условия сравнения.

Name	Type	Notes
isEnabled	boolean	Возвращает или задает признак того, что условие включено.
comparingConditionDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertySearchResultObjectIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IPropertySearchResultObject[]	Возвращает элементы страницы.

IPropertySearchResultObject

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
applicability	Applicability	Представляет применяемость объекта.
innerObjects	IClassifiableObject[]	Вложенные объекты.
multiClassificationPaths	array	Объекты, в которые множественно-классифицирован объект.

IPropertySearchComplexScopesRequest

Модель данных для запроса поиска по свойствам с несколькими областями поиска.

Name	Type	Notes
groupedOwnerScope	IGroupedPropertyOwnerScope[]	Составная область поиска.
condition	IComplexConditionRequest[]	Модель данных для запроса составного условия.
values	IAblePropertyValuesRequest[]
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Количество объектов на странице.

IGroupedPropertyOwnerScope

Составная область поиска.

Name	Type	Notes
ownerScopes	IIdentifiableObject[]	Идентификаторы областей поиска.
groupedOwnerScopes	array	Список вложенных составных областей поиска.
intersectionType	boolean	Тип пересечения областей поиска (true - И, false - ИЛИ).

IExecuteSearchTicketRequest

Модель данных поискового запроса в заявках

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
searchText	string	Ключевая фраза для поиска.

ITicketBaseInfo

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
number	string	Номер заявки.

ICreateStoredConditionRequest

Модель данных для сохранения конфигурации поискового запроса.

Name	Type	Notes
ownerScope	IIdentifiableObject[]	Представляет идентифицируемый объект.
condition	IComplexConditionRequest[]	Модель данных для запроса составного условия.
values	IAblePropertyValuesRequest[]
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Количество объектов на странице.
name	string	Наименование сохраняемой конфигурации поиска.

IGetCompabilityElementsRequest

Name	Type	Notes
elementId	integer (int32)	Идентификатор элемента.
linkDefinitionEndId	integer (int32)	Идентификатор конца определения связи.
pageNumber	integer (int32)	Номер страницы
pageSize	integer (int32)	Количество объектов на странице

IGetDuplicatesRequest

Модель данных для запроса поиска дублей.

Name	Type	Notes
ownerScope	IIdentifiableObject[]	Представляет идентифицируемый объект.
sourceElement	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISearchDuplicateItem

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
isOriginal	boolean	Признак того, что элемент является оригиналом.
isChecked	boolean	Признак того, что элемент проверен.

IReplaceDuplicatesRequest

Модель данных для замены дублей оригиналом.

Name	Type	Notes
duplicateItems	IDuplicateObjectItem[]	Список дублей для замены.

IDuplicateObjectItem

Список дублей для замены.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isOriginal	boolean	Признак того, что элемент является оригиналом.
isChecked	boolean	Признак того, что элемент проверен.

IJoinDuplicatesRequest

Модель данных для объединения дублей.

Name	Type	Notes
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
elements	IDuplicateObjectItem[]	Список элементов-дублей.
properties	IJoinPropertyItem[]	Список объединяемых свойств.
documents	IDuplicateObjectItem[]	Список объединяемых документов.
links	IJoinLinkItem[]	Список объединяемых связей.
viewPoints	IDuplicateObjectItem[]	Список объединяемых представлений.

IJoinPropertyItem

Список объединяемых свойств.

Name	Type	Notes
value	IIdentifiableObject[]	Представляет идентифицируемый объект.
contract	IIdentifiableObject[]	Представляет идентифицируемый объект.
definition	IIdentifiableObject[]	Представляет идентифицируемый объект.
evaluationMode	EvaluationMode	Представляет режим вычисления значения для свойства.
isChecked	boolean	Признак применения свойства.

IJoinLinkItem

Список объединяемых связей.

Name	Type	Notes
linkDefinitionEnd	IIdentifiableObject[]	Представляет идентифицируемый объект.
linkedElements	IDuplicateObjectItem[]	Связанные элементы.
isOriginal	boolean	Признак принадлежности элементу-оригиналу.
isChecked	boolean	Признак объединения.

IDeleteDuplicatesRequest

Модель данных для удаления дублей.

Name	Type	Notes
duplicateItems	IDuplicateObjectItem[]	Список дублей для удаления.

IStructureRight

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
subject	IRole	Представляет роль.
read	boolean	Право на чтение.
readWrite	boolean	Право на чтение и запись.
creatingDeleting	boolean	Право на создание и удаление.
canChangeRead	boolean	Возвращает признак того, можно ли изменить значение Read.
canChangeReadWrite	boolean	Возвращает признак того, можно ли изменить значение ReadWrite.
canChangeCreatingDeleting	boolean	Возвращает признак того, можно ли изменить значение CreatingDeleting.
isOverriddenByReferenceAdministratorRight	boolean	Возвращает признак того, что право перекрыто привилегией Администратор справочника.

IGroupSecurity

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
structureItem	IStructureItemWithSecurity[]	Элемент структуры с настройками доступа.
rights	IGroupStructureRight[]	Права.
securityConcepts	IConceptStructureSecurity[]	Коллекция настроек, доступа понятий элемента структуры.

IStructureItemWithSecurity

Элемент структуры с настройками доступа.

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
security	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGroupStructureRight

Права.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
subject	IRole[]	Представляет роль.
read	boolean	Право на чтение.
readWrite	boolean	Право на чтение и запись.
creatingDeleting	boolean	Право на создание и удаление.
canChangeRead	boolean	Возвращает признак того, можно ли изменить значение Read.
canChangeReadWrite	boolean	Возвращает признак того, можно ли изменить значение ReadWrite.
canChangeCreatingDeleting	boolean	Возвращает признак того, можно ли изменить значение CreatingDeleting.
isOverriddenByReferenceAdministratorRight	boolean	Возвращает признак того, что право перекрыто привилегией Администратор справочника.
isOverridden	boolean	Возвращает признак, является ли право перекрытым.

IConceptStructureSecurity

Коллекция настроек, доступа понятий элемента структуры.

Name	Type	Notes
rights	IConceptStructureRight[]	Права.
concept	IConcept[]	Представляет понятие.

IConceptStructureRight

Права.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
subject	IRole[]	Представляет роль.
read	boolean	Право читать свойства понятия у объектов в группе.
readWrite	boolean	Право читать и писать свойства понятия у объектов в группе.
canChangeRead	boolean	Возвращает признак, можно ли изменять значение Read.
canChangeReadWrite	boolean	Возвращает признак, можно ли изменять значение ReadWrite.
isOverridden	boolean	Возвращает признак, является ли право перекрытым.

IGroupConceptsEditRequest

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

Name	Type	Notes
groupIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
conceptId	integer (int32)	Идентификатор понятия.

ICatalogRightSettingsRequest

Представляет запрос изменения настроек настроек доступа у права на каталоге.

Name	Type	Notes
catalogIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
right	IStructureRight[]	Настройки безопасности каталога.

IGroupRightSettingsRequest

Представляет запрос изменения настроек настроек доступа у права на группе.

Name	Type	Notes
groupIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
structureRight	IGroupStructureRight[]	Настройки безопасности группы.

IConceptRightSettingsRequest

Представляет запрос изменения настроек доступа у права на понятии.

Name	Type	Notes
groupIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
conceptId	integer (int32)	Идентификатор понятия.
right	IConceptStructureRight[]	Настройки безопасности понятия элемента структуры.

IGetStandardSizeRequest

Запрос типоразмеров, связанные с сортаментом.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
filter	IStandardsizeFilter[]

IStandardsizeFilter

Name	Type	Notes
material	IIdentifiableObject[]	Представляет идентифицируемый объект.
filterString	string	Значение фильтра
filterMode	FilterMode	Представляет режим фильтра.
onlyWithAssortmentInstances	boolean	Признак отображения типоразмеров с экземплярами сортаментов

FilterMode

Представляет режим фильтра.

IElementPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IElement[]	Возвращает элементы страницы.

IPropertyDefinitionBase

Name	Type	Notes
name	string	Имя объекта.
code	string	Уникальный код.
absoluteCode	string	Длинный уникальный код.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
type	PropertyType	Типы свойств.

ICreateStandardsizeTemplateRequest

Модель для создания шаблона и группы типоразмера для указанного сортамента.

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
standardsizeDesignationTemplate	IStandardsizeTemplateProperties[]	Массив свойств.
removeLeadingPrefix	boolean	Опция "Удалить лидирующий префикс"

IStandardsizeTemplateProperties

Массив свойств.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
unit	IIdentifiableObject[]	Представляет идентифицируемый объект.
prefix	string	Префикс свойства.
isEnabled	boolean	Признак того, выбрано ли свойство для формирования имени по формуле.

IStandardsizeDesignationTemplate

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

Name	Type	Notes
properties	IStandardsizeTemplateProperties[]	Массив свойств.

IUpdateStandardSizeTemplateRequest

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
standardsizeDesignationTemplate	IStandardsizeTemplateProperties[]	Массив свойств.
removeLeadingPrefix	boolean	Опция "Удалить лидирующий префикс"

ICreateStandardsizeRequest

Модель для создания типоразмера.

Name	Type	Notes
assortment	IIdentifiableObject[]	Представляет идентифицируемый объект.
standartsizeValue	ICreateElementWithValuesRequest[]	Представляет запрос создания элемента с параметрами.

ISetStorageSettingsRequest

Представляет запрос установки настроек хранилища.

Name	Type	Notes
allowDuplicateNames	CanDoOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

CanDoOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	CanDo	Возможные состояния настройки "Разрешено создание дублей".

CanDo

Возможные состояния настройки "Разрешено создание дублей".

IStorageSettingsResponse

Настройки хранилища.

Name	Type	Notes
allowDuplicateNames	CanDo	Возможные состояния настройки "Разрешено создание дублей".

IGetTableRequest

Модель данных для запроса группы в виде таблицы

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
filters	IColumnFilterData[]	Фильтры таблицы
sorting	IColumnOrderData[]	Сортировка таблицы

IColumnFilterData

Фильтры таблицы

Name	Type	Notes
propertyQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
value	IIdentifiableObject[]	Представляет идентифицируемый объект.

IColumnOrderData

Сортировка таблицы

Name	Type	Notes
propertyQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
orderType	OrderType	Тип сортировки.

OrderType

Тип сортировки.

ITable

Представляет таблицу.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
definitions	IAblePropertyDefinitions[]	Представляет доступные определения свойств.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
values	IAblePropertyValues[]	Представляет доступные значения разных типов свойств.
allContracts	IContractRef[]	Понятия.
columns	ITableColumn[]	Возвращает или задает колонки таблицы.
rows	ITableRow[]	Возвращает или задает строки таблицы.

ITableColumn

Возвращает или задает колонки таблицы.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
orderType	OrderType	Тип сортировки.
contract	INamedObject[]	Представляет объект, обладающий именем.
definition	IPropertyDefinitionBase[]	Определение свойства.
displayName	string	Возвращает название свойства.
filter	string	Возвращает или задает фильтр.
filterValue	IIdentifiableObject[]	Представляет идентифицируемый объект.
isFiltered	boolean	Возвращает признак того, что колонка фильтруется.
measureUnit	IMeasureUnit[]	Представляет единицу измерения.
propertyQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
canFilter	boolean	Возвращает признак того, что к колонке может быть применен фильтр.

ITableRow

Возвращает или задает строки таблицы.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
owner	IClassificationObject[]
cells	ITableCell[]	Возвращает ячейки (свойства) табличной строки.

ITableCell

Возвращает ячейки (свойства) табличной строки.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
column	IIdentifiableObject[]	Представляет идентифицируемый объект.
propertyValue	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetFilterValuesRequest

Запрос значений фильтра.

Name	Type	Notes
propertyQualifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetColumnsInfoRequest

Параметры запроса получения информации о колонках таблицы.

Name	Type	Notes
group	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetColumnsInfoResponse

Ответ на запрос информации о колонках.

Name	Type	Notes
contracts	ITableContract[]	Контракты принадлежащие таблице.

ITableContract

Контракты принадлежащие таблице.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
properties	ITableContractProperty[]	Свойства понятия.

ITableContractProperty

Свойства понятия.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isSelected	boolean	Возвращает признак, что свойство выбрано для отображения в таблице

IGetTableSettingsRequest

Параметры запроса настроек таблицы.

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.

IHierarchicalTableSettings

Настройки таблицы с учетом иерархии.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
measureEntities	IAbleMeasureEntities[]
measureUnits	IAbleMeasureUnits[]
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isOverridden	boolean	Признак того, что настройки таблицы на данном элементе структуры перекрыты.
inherit	boolean	Признак того, что настройки наследуются.
inheritedFrom	IClassifiableObject[]
tableColumnDefinitions	ITableColumnDefinition[]	Коллекция определений столбцов таблицы.

ITableColumnDefinition

Коллекция определений столбцов таблицы.

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
propertyQualifier	IPropertyQualifier[]	Квалификатор свойства.
measureUnit	IMeasureUnit[]	Представляет единицу измерения.

IPropertyQualifier

Квалификатор свойства.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
name	string	Имя объекта.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

ICreateTableColumnDefinitionRequest

Модель данных для запроса на удаление таблицы.

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
tableColumnDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.

IDeleteTableColumnDefinitionRequest

Модель данных для запроса на удаление таблицы.

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
tableColumnDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISetOverrideSettingRequest

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
isOverridden	boolean	Признак переопределения настроек для дочерних групп.

ISetInheritanceSettings

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
inherit	boolean	Признак наследования настроек для дочерних групп.

IUpdateMeasureUnitOfColumnRequest

Name	Type	Notes
tableColumnDefinition	IIdentifiableObject[]	Представляет идентифицируемый объект.
measureUnit	IIdentifiableObject[]	Представляет идентифицируемый объект.

IUpdatePositionOfColumnsRequest

Модель данных для запроса на изменение порядка определений столбцов таблицы

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
tableColumnDefinitions	IIdentifiableObject[]	Упорядоченные идентификаторы определений столбцов таблицы.

IUpdateColumnsForUserRequest

Модель данных для изменения столбцов таблицы

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
tableColumnDefinitions	IIdentifiableObject[]	Упорядоченные идентификаторы определений столбцов таблицы.

IResetSettingsForUserRequest

Name	Type	Notes
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.

Ticket

Заявка.

Name	Type	Notes
objectId	integer (int32)	Устанавливает и возвращает идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	string	Имя объекта.
canEditName	boolean	Возвращает признак, может ли текущий пользователь редактировать имя заявки.
canEditDescription	boolean	Возвращает признак, может ли текущий пользователь редактировать описание заявки.
description	string	Описание заявки.
status	TicketStatus	Состояние заявки.
canEditPriority	boolean	Возвращает признак, может ли текущий пользователь редактировать приоритет заявки.
priority	TicketPriority	Приоритет заявки.
creator	IUser[]	Пользователь.
canEditCurrentAccountableUser	boolean	Возвращает признак, может ли текущий пользователь редактировать текущего ответственного заявки.
currentAccountableUser	IUser[]	Пользователь.
dateOfCreation	string (date-time)	Дата создания.
dateOfCompletion	string (date-time)	Дата завершения.
dateOfStart	string (date-time)	Дата начала.
canEditPlannedDateOfCompletion	boolean	Возвращает признак, может ли текущий пользователь редактировать планируемую дату завершения заявки.
plannedDateOfCompletion	string (date-time)	Планируемая дата завершения.
canEditNumber	boolean	Возвращает признак, может ли текущий пользователь редактировать номер заявки.
number	string	Номер заявки.
nature	TicketNature	Характер заявки.
canEditNature	boolean	Возвращает признак, может ли текущий пользователь редактировать характер заявки.
structureItem	IClassificationObject[]
structureItemLocation	string	Локейшн элемента структуры, с которым связана заявка.
canEditStructureItemLocation	boolean	Возвращает признак, может ли текущий пользователь редактировать локейшн элемента структуры, с которым связана заявка.
ticketObject	IClassificationObject[]
objectLocation	string	Локейшн объекта заявки.
canEditObjectLocation	boolean	Возвращает признак, может ли текущий пользователь редактировать локейшн объекта заявки.
canDelete	boolean	Возвращает признак, может ли текущий пользователь удалить заявку.
canRevoke	boolean	Возвращает признак, может ли текущий пользователь отозвать заявку.
canEditAttachments	boolean	Возвращает признак, может ли текущий пользователь добавлять и удалять вложенные файлы заявки.
canEditAdditionalProperties	boolean	Возвращает признак, может ли текущий пользователь редактировать дополнительные свойства заявки.
canAddApprovementStage	boolean	Возвращает признак, можно ли текущему пользователю добавить этап согласования.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.

TicketStatus

Состояние заявки.

TicketPriority

Приоритет заявки.

TicketNature

Характер заявки.

IBusinessProcessDisplayItem

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
currentAccountableUser	IUser	Пользователь.
canSetCurrentAccountableUser	boolean	Признак, может ли текущий пользователь установить ответственного пользователя для данного элемента бизнес-процесса.
natureOfWork	string	Характер работы.
taskName	string	Название задачи.
isCompleted	boolean	Признак, завершен ли данный элемент бизнес-процесса.
dateOfCompletion	string (date-time)	Дата и время завершения данного элемента бизнес-процесса.
canDelete	boolean	Признак, можно ли удалить данный отображаемый элемент бизнес-процесса.
availableAccountableUsers	IUser[]	Доступные ответственные.

IBusinessProcessCommand

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isUserCommentNeeded	boolean	Признак, нуждается ли команда в комментарии пользователя.
isUserChangeNeeded	boolean	Признак, нуждается ли команда в смене пользователя.

IExecuteBusinessProcessCommandTicketRequest

Запрос выполнения команды.

Name	Type	Notes
ticketId	integer (int32)	Идентификатор заявки.
commandNumber	integer (int32)	Номер команды (нумерация с 1).
note	string	Комментарий.
userId	integer (int32)	Идентификатор пользователя.

IRevokeTicketRequest

Запрос отзыва заявки.

Name	Type	Notes
ticketId	integer (int32)	Идентификатор заявки.
note	string	Комментарий.

IGetTableTicketRequest

Запрос таблицы заявок

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
ticketTableType	TicketTableType
filters	IColumnFilterData[]	Фильтры таблицы
sorts	IColumnOrderData[]	Сортировки таблицы

TicketTableType

ITicket

Заявка.

Name	Type	Notes
name	string	Имя объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
description	string	Описание.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
canEditName	boolean	Возвращает признак, может ли текущий пользователь редактировать имя заявки.
canEditDescription	boolean	Возвращает признак, может ли текущий пользователь редактировать описание заявки.
status	TicketStatus	Состояние заявки.
canEditPriority	boolean	Возвращает признак, может ли текущий пользователь редактировать приоритет заявки.
priority	TicketPriority	Приоритет заявки.
creator	IUser[]	Пользователь.
canEditCurrentAccountableUser	boolean	Возвращает признак, может ли текущий пользователь редактировать текущего ответственного заявки.
currentAccountableUser	IUser[]	Пользователь.
dateOfCreation	string (date-time)	Дата создания.
dateOfCompletion	string (date-time)	Дата завершения.
dateOfStart	string (date-time)	Дата начала.
canEditPlannedDateOfCompletion	boolean	Возвращает признак, может ли текущий пользователь редактировать планируемую дату завершения заявки.
plannedDateOfCompletion	string (date-time)	Планируемая дата завершения.
canEditNumber	boolean	Возвращает признак, может ли текущий пользователь редактировать номер заявки.
number	string	Номер заявки.
nature	TicketNature	Характер заявки.
canEditNature	boolean	Возвращает признак, может ли текущий пользователь редактировать характер заявки.
structureItem	IClassificationObject[]
structureItemLocation	string	Локейшн элемента структуры, с которым связана заявка.
canEditStructureItemLocation	boolean	Возвращает признак, может ли текущий пользователь редактировать локейшн элемента структуры, с которым связана заявка.
ticketObject	IClassificationObject[]
objectLocation	string	Локейшн объекта заявки.
canEditObjectLocation	boolean	Возвращает признак, может ли текущий пользователь редактировать локейшн объекта заявки.
canDelete	boolean	Возвращает признак, может ли текущий пользователь удалить заявку.
canRevoke	boolean	Возвращает признак, может ли текущий пользователь отозвать заявку.
canEditAttachments	boolean	Возвращает признак, может ли текущий пользователь добавлять и удалять вложенные файлы заявки.
canEditAdditionalProperties	boolean	Возвращает признак, может ли текущий пользователь редактировать дополнительные свойства заявки.
canAddApprovementStage	boolean	Возвращает признак, можно ли текущему пользователю добавить этап согласования.

IRemoveApprovementStageTicketRequest

Запрос удаления этапа согласования.

Name	Type	Notes
ticketId	integer (int32)	Идентификатор заявки.
approvementStageNumber	integer (int32)	Номер этапа согласования.

ISetApprovementStageUserTicketRequest

Запрос назначения этапу согласования ответственного.

Name	Type	Notes
ticketId	integer (int32)	Идентификатор заявки.
userId	integer (int32)	Идентификатор пользователя.
approvementStageNumber	integer (int32)	Номер этапа согласования.

IReportToAdministratorTicketRequest

Запрос сообщения о проблеме.

Name	Type	Notes
ticketId	integer (int32)	Идентификатор заявки.
note	string	Комментарий.

IGetHistoryTicketRequest

Представляет запрос истории сообщений заявки.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
systemEvents	boolean	Отображать системные события.
usersComments	boolean	Отображать комментарии пользователей.

ITicketMessage

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
canEdit	boolean	Возвращает признак, может ли текущий пользователь редактировать данный комментарий.
owner	IIdentifiableObject	Представляет идентифицируемый объект.
header	string	Заголовок комментария.
body	string	Тело комментария.
messageType	TicketMessageType	Тип сообщения заявки.
isEdited	boolean	Признак того, что комментарий редактировали после создания.
author	IUserBaseInfo	Базовая информация о пользователе
dateOfCreation	string (date-time)	Дата и время создания.
messages	array	Комментарии.

TicketMessageType

Тип сообщения заявки.

IUserBaseInfo

Базовая информация о пользователе

Name	Type	Notes
id	string	Идентификатор
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
fullName	string	Возвращает полное имя.
login	string	Возвращает или задает логин.
isAdministrator	boolean	Возвращает или задает признак того, что пользователь является администратором.
hasPhoto	boolean	Возвращает признак, задано ли пользователю фото.

ICreateCommentTicketRequest

Запрос создания комментария.

Name	Type	Notes
source	IIdentifiableObject[]	Представляет идентифицируемый объект.
text	string	Текст комментария.

ISearchResultTicketPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	ISearchResultTicket[]	Возвращает элементы страницы.

ISearchResultTicket

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
number	string	Номер заявки.

ICreateTicketRequest

Name	Type	Notes
name	string	Имя заявки.
description	string	Описание заявки.
structureItem	IIdentifiableObject[]	Представляет идентифицируемый объект.
ticketObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
nature	TicketNature	Характер заявки.
priority	TicketPriority	Приоритет заявки.
plannedDateOfCompletion	string (date-time)	Планируемая дата завершения.
values	IAblePropertyValuesRequest[]
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
fileNames	ITicketFileNameInfo[]	Список имен файлов и временных файлов, которые сохраняются в заявке.

ITicketFileNameInfo

Список имен файлов и временных файлов, которые сохраняются в заявке.

Name	Type	Notes
fileName	string	Актуальное имя файла.
temporaryFileName	string	Имя временного файла.

IUpdateTicketRequest

Запрос обновления заявки.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
number	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
structureItem	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
ticketObject	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
nature	TicketNatureOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
priority	TicketPriorityOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
plannedDateOfCompletion	DateTimeOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
structureItemLocationNote	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isNeededToResetExecutors	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isNeededToResetApprovers	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
objectLocationNote	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
values	IAblePropertyValuesRequest[]

TicketNatureOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	TicketNature	Характер заявки.

TicketPriorityOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	TicketPriority	Приоритет заявки.

DateTimeOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	string (date-time)

IClassificationTreeRequest

Представляет первичный запрос дерева классификации.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ClassificationTreeOptions	Опции дерева классификации.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

ClassificationTreeOptions

Опции дерева классификации.

TreeFilterOptions

Опции фильтрации дерева.

IClassificationTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IClassificationTreeNode[]	Возвращает элементы страницы.

IClassificationTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.
hasObjects	boolean	Признак что, узел имеет подчиненные объекты.

IAccessControlObject

Представляет объект, обладающий правом доступа.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

IClassificationNodeChildrenRequest

Представляет запрос узла дерева классификации.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ClassificationTreeOptions	Опции дерева классификации.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
parentNodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
startIndex	integer (int32)	Индекс начального элемента выборки (нумерация с 1).
endIndex	integer (int32)	Индекс конечного элемента выборки (включая этот элемент).

IFindChildClassificationNodeRequest

Представляет запрос дочернего узла дерева классификации.

Name	Type	Notes
parentObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
originalObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IClassificationTreeNodeTask

Name	Type	Notes
id	integer (int32)
exception	AggregateException[]
status	TaskStatus
isCanceled	boolean
isCompleted	boolean
isCompletedSuccessfully	boolean
creationOptions	TaskCreationOptions
asyncState
isFaulted	boolean
result	IClassificationTreeNode[]	Узел дерева классификации.

AggregateException

Name	Type	Notes
targetSite	MethodBase[]
data	object
innerException	Exception[]
helpLink	string
source	string
hResult	integer (int32)
stackTrace	string
innerExceptions	Exception[]
message	string

MethodBase

Name	Type	Notes
memberType	MemberTypes
name	string
declaringType	Type[]
reflectedType	Type[]
module	Module[]
customAttributes	CustomAttributeData[]
isCollectible	boolean
metadataToken	integer (int32)
attributes	MethodAttributes
methodImplementationFlags	MethodImplAttributes
callingConvention	CallingConventions
isAbstract	boolean
isConstructor	boolean
isFinal	boolean
isHideBySig	boolean
isSpecialName	boolean
isStatic	boolean
isVirtual	boolean
isAssembly	boolean
isFamily	boolean
isFamilyAndAssembly	boolean
isFamilyOrAssembly	boolean
isPrivate	boolean
isPublic	boolean
isConstructedGenericMethod	boolean
isGenericMethod	boolean
isGenericMethodDefinition	boolean
containsGenericParameters	boolean
methodHandle	RuntimeMethodHandle[]
isSecurityCritical	boolean
isSecuritySafeCritical	boolean
isSecurityTransparent	boolean

MemberTypes

Enum Values

1
2
4
8
16
32
64
128
191

Type

Name	Type	Notes
name	string
customAttributes	CustomAttributeData[]
isCollectible	boolean
metadataToken	integer (int32)
isInterface	boolean
memberType	MemberTypes
namespace	string
assemblyQualifiedName	string
fullName	string
assembly	Assembly[]
module	Module[]
isNested	boolean
declaringType
declaringMethod
reflectedType
underlyingSystemType
isTypeDefinition	boolean
isArray	boolean
isByRef	boolean
isPointer	boolean
isConstructedGenericType	boolean
isGenericParameter	boolean
isGenericTypeParameter	boolean
isGenericMethodParameter	boolean
isGenericType	boolean
isGenericTypeDefinition	boolean
isSZArray	boolean
isVariableBoundArray	boolean
isByRefLike	boolean
isFunctionPointer	boolean
isUnmanagedFunctionPointer	boolean
hasElementType	boolean
genericTypeArguments	array
genericParameterPosition	integer (int32)
genericParameterAttributes	GenericParameterAttributes
attributes	TypeAttributes
isAbstract	boolean
isImport	boolean
isSealed	boolean
isSpecialName	boolean
isClass	boolean
isNestedAssembly	boolean
isNestedFamANDAssem	boolean
isNestedFamily	boolean
isNestedFamORAssem	boolean
isNestedPrivate	boolean
isNestedPublic	boolean
isNotPublic	boolean
isPublic	boolean
isAutoLayout	boolean
isExplicitLayout	boolean
isLayoutSequential	boolean
isAnsiClass	boolean
isAutoClass	boolean
isUnicodeClass	boolean
isCOMObject	boolean
isContextful	boolean
isEnum	boolean
isMarshalByRef	boolean
isPrimitive	boolean
isValueType	boolean
isSignatureType	boolean
isSecurityCritical	boolean
isSecuritySafeCritical	boolean
isSecurityTransparent	boolean
structLayoutAttribute	StructLayoutAttribute[]
typeInitializer	ConstructorInfo[]
typeHandle	RuntimeTypeHandle[]
guid	string (uuid)
baseType
isSerializable	boolean
containsGenericParameters	boolean
isVisible	boolean

CustomAttributeData

Name	Type	Notes
attributeType
constructor	ConstructorInfo[]
constructorArguments	CustomAttributeTypedArgument[]
namedArguments	CustomAttributeNamedArgument[]

ConstructorInfo

Name	Type	Notes
name	string
declaringType
reflectedType
module	Module[]
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)
attributes	MethodAttributes
methodImplementationFlags	MethodImplAttributes
callingConvention	CallingConventions
isAbstract	boolean
isConstructor	boolean
isFinal	boolean
isHideBySig	boolean
isSpecialName	boolean
isStatic	boolean
isVirtual	boolean
isAssembly	boolean
isFamily	boolean
isFamilyAndAssembly	boolean
isFamilyOrAssembly	boolean
isPrivate	boolean
isPublic	boolean
isConstructedGenericMethod	boolean
isGenericMethod	boolean
isGenericMethodDefinition	boolean
containsGenericParameters	boolean
methodHandle	RuntimeMethodHandle[]
isSecurityCritical	boolean
isSecuritySafeCritical	boolean
isSecurityTransparent	boolean
memberType	MemberTypes

Module

Name	Type	Notes
assembly	Assembly[]
fullyQualifiedName	string
name	string
mdStreamVersion	integer (int32)
moduleVersionId	string (uuid)
scopeName	string
moduleHandle	ModuleHandle[]
customAttributes	array
metadataToken	integer (int32)

Assembly

Name	Type	Notes
definedTypes	TypeInfo[]
exportedTypes	array
codeBase	string
entryPoint	MethodInfo[]
fullName	string
imageRuntimeVersion	string
isDynamic	boolean
location	string
reflectionOnly	boolean
isCollectible	boolean
isFullyTrusted	boolean
customAttributes	array
escapedCodeBase	string
manifestModule
modules	array
globalAssemblyCache	boolean
hostContext	integer (int64)
securityRuleSet	SecurityRuleSet

TypeInfo

Name	Type	Notes
name	string
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)
isInterface	boolean
memberType	MemberTypes
namespace	string
assemblyQualifiedName	string
fullName	string
assembly
module
isNested	boolean
declaringType
declaringMethod
reflectedType
underlyingSystemType
isTypeDefinition	boolean
isArray	boolean
isByRef	boolean
isPointer	boolean
isConstructedGenericType	boolean
isGenericParameter	boolean
isGenericTypeParameter	boolean
isGenericMethodParameter	boolean
isGenericType	boolean
isGenericTypeDefinition	boolean
isSZArray	boolean
isVariableBoundArray	boolean
isByRefLike	boolean
isFunctionPointer	boolean
isUnmanagedFunctionPointer	boolean
hasElementType	boolean
genericTypeArguments	array
genericParameterPosition	integer (int32)
genericParameterAttributes	GenericParameterAttributes
attributes	TypeAttributes
isAbstract	boolean
isImport	boolean
isSealed	boolean
isSpecialName	boolean
isClass	boolean
isNestedAssembly	boolean
isNestedFamANDAssem	boolean
isNestedFamily	boolean
isNestedFamORAssem	boolean
isNestedPrivate	boolean
isNestedPublic	boolean
isNotPublic	boolean
isPublic	boolean
isAutoLayout	boolean
isExplicitLayout	boolean
isLayoutSequential	boolean
isAnsiClass	boolean
isAutoClass	boolean
isUnicodeClass	boolean
isCOMObject	boolean
isContextful	boolean
isEnum	boolean
isMarshalByRef	boolean
isPrimitive	boolean
isValueType	boolean
isSignatureType	boolean
isSecurityCritical	boolean
isSecuritySafeCritical	boolean
isSecurityTransparent	boolean
structLayoutAttribute	StructLayoutAttribute[]
typeInitializer
typeHandle	RuntimeTypeHandle[]
guid	string (uuid)
baseType
isSerializable	boolean
containsGenericParameters	boolean
isVisible	boolean
genericTypeParameters	array
declaredConstructors	array
declaredEvents	EventInfo[]
declaredFields	FieldInfo[]
declaredMembers	MemberInfo[]
declaredMethods	MethodInfo[]
declaredNestedTypes	array
declaredProperties	PropertyInfo[]
implementedInterfaces	array

GenericParameterAttributes

TypeAttributes

StructLayoutAttribute

Name	Type	Notes
typeId
value	LayoutKind

LayoutKind

RuntimeTypeHandle

Name	Type	Notes
value	IntPtr

IntPtr

EventInfo

Name	Type	Notes
name	string
declaringType
reflectedType
module
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)
memberType	MemberTypes
attributes	EventAttributes
isSpecialName	boolean
addMethod	MethodInfo[]
removeMethod	MethodInfo[]
raiseMethod	MethodInfo[]
isMulticast	boolean
eventHandlerType

EventAttributes

MethodInfo

Name	Type	Notes
name	string
declaringType
reflectedType
module
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)
attributes	MethodAttributes
methodImplementationFlags	MethodImplAttributes
callingConvention	CallingConventions
isAbstract	boolean
isConstructor	boolean
isFinal	boolean
isHideBySig	boolean
isSpecialName	boolean
isStatic	boolean
isVirtual	boolean
isAssembly	boolean
isFamily	boolean
isFamilyAndAssembly	boolean
isFamilyOrAssembly	boolean
isPrivate	boolean
isPublic	boolean
isConstructedGenericMethod	boolean
isGenericMethod	boolean
isGenericMethodDefinition	boolean
containsGenericParameters	boolean
methodHandle	RuntimeMethodHandle[]
isSecurityCritical	boolean
isSecuritySafeCritical	boolean
isSecurityTransparent	boolean
memberType	MemberTypes
returnParameter	ParameterInfo[]
returnType
returnTypeCustomAttributes	ICustomAttributeProvider

MethodAttributes

MethodImplAttributes

CallingConventions

Enum Values

1
2
3
32
64

RuntimeMethodHandle

Name	Type	Notes
value	IntPtr

ParameterInfo

Name	Type	Notes
attributes	ParameterAttributes
member	MemberInfo[]
name	string
parameterType
position	integer (int32)
isIn	boolean
isLcid	boolean
isOptional	boolean
isOut	boolean
isRetval	boolean
defaultValue
rawDefaultValue
hasDefaultValue	boolean
customAttributes	array
metadataToken	integer (int32)

ParameterAttributes

MemberInfo

Name	Type	Notes
memberType	MemberTypes
name	string
declaringType
reflectedType
module
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)

ICustomAttributeProvider

FieldInfo

Name	Type	Notes
name	string
declaringType
reflectedType
module
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)
memberType	MemberTypes
attributes	FieldAttributes
fieldType
isInitOnly	boolean
isLiteral	boolean
isNotSerialized	boolean
isPinvokeImpl	boolean
isSpecialName	boolean
isStatic	boolean
isAssembly	boolean
isFamily	boolean
isFamilyAndAssembly	boolean
isFamilyOrAssembly	boolean
isPrivate	boolean
isPublic	boolean
isSecurityCritical	boolean
isSecuritySafeCritical	boolean
isSecurityTransparent	boolean
fieldHandle	RuntimeFieldHandle[]

FieldAttributes

RuntimeFieldHandle

Name	Type	Notes
value	IntPtr

PropertyInfo

Name	Type	Notes
name	string
declaringType
reflectedType
module
customAttributes	array
isCollectible	boolean
metadataToken	integer (int32)
memberType	MemberTypes
propertyType
attributes	PropertyAttributes
isSpecialName	boolean
canRead	boolean
canWrite	boolean
getMethod	MethodInfo[]
setMethod	MethodInfo[]

PropertyAttributes

SecurityRuleSet

ModuleHandle

Name	Type	Notes
mdStreamVersion	integer (int32)

CustomAttributeTypedArgument

Name	Type	Notes
argumentType
value

CustomAttributeNamedArgument

Name	Type	Notes
memberInfo	MemberInfo[]
typedValue	CustomAttributeTypedArgument[]
memberName	string
isField	boolean

Exception

Name	Type	Notes
targetSite	MethodBase[]
message	string
data	object
innerException
helpLink	string
source	string
hResult	integer (int32)
stackTrace	string

TaskStatus

TaskCreationOptions

IScopeClassificationFilterItemsRequest

Представляет запрос элементов фильтра дерева классификации, отфильтрованного по областям.

Name	Type	Notes
scopes	IScopeData[]	Идентификаторы областей.

IScopeData

Идентификаторы областей.

Name	Type	Notes
identifier	IIdentifiableObjectOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
location	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IGetFilterItemsResponse

Представляет ответ получения элементов фильтра.

Name	Type	Notes
groups	IClassificationTreeFilterItem[]	Элементы фильтра групп.
elements	IClassificationTreeFilterItem[]	Элементы фильтра элементов справочника.

IClassificationTreeFilterItem

Элементы фильтра групп.

Name	Type	Notes
scope	IScopeData[]	Данные области фильтрации дерева.
instance	IClassificationObject[]
selected	boolean	Признак выбора области фильтрации.

IScopeClassificationTreeRequest

Представляет запрос первого уровня дерева классификации, отфильтрованного по областям.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ClassificationTreeOptions	Опции дерева классификации.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
useLinkInstance	boolean	Признак настройки фильтра по наличию экземпляра связи.
scopes	IScopeData[]	Идентификаторы областей.

IScopeClassificationNodeRequest

Представляет запрос требуемого узла дерева классификации, отфильтрованного по областям.

Name	Type	Notes
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IScopeClassificationNodeChildrenRequest

Представляет запрос содержимого узла в дереве классификации, отфильтрованного по областям.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ClassificationTreeOptions	Опции дерева классификации.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
useLinkInstance	boolean	Признак настройки фильтра по наличию экземпляра связи.
scopes	IScopeData[]	Идентификаторы областей.
parentNodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
startIndex	integer (int32)	Индекс начального элемента выборки (нумерация с 1).
endIndex	integer (int32)	Индекс конечного элемента выборки (включая этот элемент).

IPropDefClassificationTreeRequest

Представляет запрос дерева свойств.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	PropDefClassificationTreeOptions	Опции дерева классификации определений свойств.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

PropDefClassificationTreeOptions

Опции дерева классификации определений свойств.

IPropertyTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IPropertyTreeNode[]	Возвращает элементы страницы.

IPropertyTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.

IPropDefClassificationTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве свойств.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	PropDefClassificationTreeOptions	Опции дерева классификации определений свойств.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IConceptClassificationTreeRequest

Представляет запрос дерева понятий.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ConceptClassificationTreeOptions	Опции дерева понятий.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

ConceptClassificationTreeOptions

Опции дерева понятий.

IConceptTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IConceptTreeNode[]	Возвращает элементы страницы.

IConceptTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.
conceptPropertySource	IConceptPropertySource[]	Представляет источник свойства в понятии.
children	array	Список дочерних узлов.

IConceptClassificationTreeNodeRequest

Представляет запрос содержимого узла в дереве понятий.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ConceptClassificationTreeOptions	Опции дерева понятий.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IConceptPropertySourceTreeRequest

Представляет запрос дерева понятий со свойствами.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ConceptPropertySourcesTreeOptions	Опции дерева понятий со свойствами.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

ConceptPropertySourcesTreeOptions

Опции дерева понятий со свойствами.

IConceptPropertySourceTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве понятий со свойствами.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	ConceptPropertySourcesTreeOptions	Опции дерева понятий со свойствами.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IOwnConceptPropertySourceRequest

Представляет запрос дерева собственных понятий каталога/группы.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEventLogTreeRequest

Представляет запрос дерева журнала событий.

Name	Type	Notes
filterString	string	Возвращает и устанавливает строку фильтрации.
from	integer (int64)	Возвращает и устанавливает дату начала.
to	integer (int64)	Возвращает и устанавливает дату окончания.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
refresh	boolean	Признак загрузки дерева с начала.

IEventLogTreeNode

Узел дерева журнала событий.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.
dateTime	string (date-time)	Возвращает и устанавливает дату и время события.
userName	string	Возвращает и устанавливает пользователя.
reference	ILoggedObject[]	Представляет объект наблюдения и внесения изменений в журнал.

IEventLogNodeRequest

Возвращает и устанавливает параметры фильтрации.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.
from	integer (int64)	Возвращает и устанавливает дату начала.
to	integer (int64)	Возвращает и устанавливает дату окончания.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
refresh	boolean	Признак загрузки дерева с начала.
parentNodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IEventLogTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IEventLogTreeNode[]	Возвращает элементы страницы.

IFormulaTreeRequest

Представляет запрос дерева формул.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	FormulaTreeOptions	Опции дерева формул
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

FormulaTreeOptions

Опции дерева формул

ITreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	ITreeNode[]	Возвращает элементы страницы.

ITreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.

IFormulaTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве формул.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	FormulaTreeOptions	Опции дерева формул
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IViewpointTreeNodeRequest

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.
filterString	string	Возвращает и устанавливает строку фильтрации.

IFavoritesTreeRequest

Представляет запрос дерева избранного.

Name	Type	Notes
options	FavoritesTreeOptions	Опции дерева избранного.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

FavoritesTreeOptions

Опции дерева избранного.

IFavoritesTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IFavoritesTreeNode[]	Возвращает элементы страницы.

IFavoritesTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.

IFavoritesTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве избранного.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
options	FavoritesTreeOptions	Опции дерева избранного.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IElementLinksRequest

Представляет запрос указанного узла дерева связей элемнта.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
elementId	integer (int32)	Возвращает и устанавливает идентификатор элемента.
filterString	string	Возвращает и устанавливает строку фильтрации.
options	ElementLinksTreeOptions	Опции дерева определений связей.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

ElementLinksTreeOptions

Опции дерева определений связей.

ILinkTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	ILinkTreeNode[]	Возвращает элементы страницы.

ILinkTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
applicability	Applicability	Представляет применяемость объекта.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.
multiplicity	LinkEndMultiplicity	Множественность конца связи.
linkInstance	IIdentifiableObject[]	Представляет идентифицируемый объект.
link	ILink[]	Связь.
path	INamedObject[]	Путь до объекта.
totalElementsCount	integer (int32)	Количество всех связанных элементов.

ILinkTreeNodeRequest

Представляет запрос узла дерева связанных элементов.

Name	Type	Notes
objectId	integer (int32)	Идентификатор узла.
typeId	IdentifiableObjectType	Представляет тип объекта.
elementId	integer (int32)	Идентификатор элемента, для котрого строится дерево связей.
linkDefinitionEndId	integer (int32)	Идентификатор определения связи.

IElementLinksNodeChildrenRequest

Представляет запрос указанного узла дерева связей элемента.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
elementId	integer (int32)	Возвращает и устанавливает идентификатор элемента.
filterString	string	Возвращает и устанавливает строку фильтрации.
options	ElementLinksTreeOptions	Опции дерева определений связей.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
linkDefinitionEndId	integer (int32)	Идентификатор определения связи.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkScopesTreeRequest

Представляет запрос первого уровня дерева областей связей элемента.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
elementId	integer (int32)	Возвращает и устанавливает идентификатор элемента для построения дерева.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
options	LinkDefClassificationTreeOptions	Опции дерева определений связей.

LinkDefClassificationTreeOptions

Опции дерева определений связей.

ILinkScopeTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	ILinkScopeTreeNode[]	Возвращает элементы страницы.

ILinkScopeTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.
refersAs	string	Тип ссылки.
thisEndName	string	Название текущего конца ссылки.
otherEndName	string	Название другого конца ссылки.
direction	LinkDefinitionDirection	Направление связи

ILinkScopesNodeRequest

Представляет запрос требуемого узла дерева областей связей элемента.

Name	Type	Notes
elementId	integer (int32)	Возвращает и устанавливает идентификатор элемента для построения дерева.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.

ILinkScopesTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве областей связей элемента.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
elementId	integer (int32)	Возвращает и устанавливает идентификатор элемента для построения дерева.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
options	LinkDefClassificationTreeOptions	Опции дерева определений связей.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IPropertySearchTreeRequest

Модель данных для запроса поиска с результатом в виде дерева.

Name	Type	Notes
ownerScope	IIdentifiableObject[]	Представляет идентифицируемый объект.
condition	IComplexConditionRequest[]	Модель данных для запроса составного условия.
values	IAblePropertyValuesRequest[]
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Количество объектов на странице.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

IPropertySearchNodeChildrenRequest

Модель данных для запроса узла в дереве результата поиска по свойствам.

Name	Type	Notes
ownerScope	IIdentifiableObject[]	Представляет идентифицируемый объект.
condition	IComplexConditionRequest[]	Модель данных для запроса составного условия.
values	IAblePropertyValuesRequest[]
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Количество объектов на странице.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IGetCompabilityElementsTreeRequest

Модель данных для запроса совместимых элементов в виде дерева.

Name	Type	Notes
elementId	integer (int32)	Идентификатор элемента.
linkDefinitionEndId	integer (int32)	Идентификатор конца определения связи.
pageNumber	integer (int32)	Номер страницы
pageSize	integer (int32)	Количество объектов на странице
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

IGetCompabilityElementsTreeNodeRequest

Name	Type	Notes
elementId	integer (int32)	Идентификатор элемента.
linkDefinitionEndId	integer (int32)	Идентификатор конца определения связи.
pageNumber	integer (int32)	Номер страницы
pageSize	integer (int32)	Количество объектов на странице
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

ISecurityTreeRequest

Представляет первичный запрос дерева оргструктуры.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

ISecurityTreeNodeChildrenRequest

Представляет запрос дочернего узла дерева оргструктуры.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
parentNodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

IMeasureTreeRequest

Представляет запрос дерева единиц измерения.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.

IMeasureTreeNodeIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IMeasureTreeNode[]	Возвращает элементы страницы.

IMeasureTreeNode

Возвращает элементы страницы.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
isSystemObject	boolean	Признак системного объекта.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
leaf	boolean	Признак наличия дочерних узлов или объектов.
count	integer (int32)	Количество подчиненных элементов.
parent	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
nodeObject	IAccessControlObject[]	Представляет объект, обладающий правом доступа.
filterConditionApply	boolean	Признак того, что узел удовлетворяет условиям фильтра.
accessRight	AccessRights	Представляет права доступа.
isBasicMeasureUnit	boolean	Признак системного объекта.

IMeasureTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве единиц измерения.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkDefClassificationTreeRequest

Представляет запрос первого уровня дерева классификации определений связей.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
options	LinkDefClassificationTreeOptions	Опции дерева определений связей.

ILinkDefClassificationTreeNodeChildrenRequest

Представляет запрос содержимого узла в дереве классификации определений связей.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы
pageSize	integer (int32)	Количество объектов на странице
filterString	string	Возвращает и устанавливает строку фильтрации.
filterOptions	TreeFilterOptions	Опции фильтрации дерева.
options	LinkDefClassificationTreeOptions	Опции дерева определений связей.
nodeObject	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkScopeTreeNodePaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	ILinkScopeTreeNode[]	Возвращает элементы страницы.

ICreateUserRequest

Представляет запрос создания пользователя.

Name	Type	Notes
login	string	Возвращает и устанавливает логин.
password	string	Возвращает и устанавливает пароль.

IUpdateUserRequest

Представляет запрос редактирования пользователя.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
firstName	string	Возвращает или задает имя.
patronymic	string	Возвращает или задает отчество.
lastName	string	Возвращает или задает фамилию.
email	string	Возвращает или задает e-mail.
im	string	Возвращает или задает идентификатор службы мгновенных сообщений.
phone	string	Возвращает или задает номер телефона.
additionalInfo	string	Возвращает или задает дополнительную информацию.
web	string	Возвращает или задает web-контакт.
isAdministrator	boolean	Возвращает или задает признак того, что пользователь является администратором.

IChangePasswordRequest

Представляет запрос смены пароля пользователя.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
password	string	Пароль.

IAllUsersRequest

Представляет запрос списка всех пользователей.

Name	Type	Notes
pageNumber	integer (int32)	Номер страницы.
pageSize	integer (int32)	Размер страницы.
filterString	string	Возвращает и устанавливает строку фильтрации.

IUserBaseInfoIPaginatedList

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

Name	Type	Notes
pageNumber	integer (int32)	Возвращает номер страницы.
pageSize	integer (int32)	Возвращает количество элементов в странице.
totalPages	integer (int32)	Возвращает общее количество страниц.
totalCount	integer (int32)	Возвращает общее количество элементов.
hasPreviousPage	boolean	Возвращает признак существования предыдущей страницы.
hasNextPage	boolean	Возвращает признак существования следующей страницы.
items	IUserBaseInfo[]	Возвращает элементы страницы.

IAddRoleRequest

Представляет запрос добавления роли пользователю.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
roleIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemoveRoleRequest

Представляет запрос удаления роли пользователя.

Name	Type	Notes
userId	integer (int32)	Идентификатор пользователя.
roleId	integer (int32)	Идентификатор роли.

IAddPositionRequest

Представляет запрос добавления должности пользователю.

Name	Type	Notes
identifier	IIdentifiableObject[]	Представляет идентифицируемый объект.
positionIdentifier	IIdentifiableObject[]	Представляет идентифицируемый объект.

IRemovePositionRequest

Представляет запрос удаления должности пользователя.

Name	Type	Notes
userId	integer (int32)	Идентификатор пользователя.
positionId	integer (int32)	Идентификатор должности.

IUserOptions

Опции пользователя.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
viewApplicableOnly	boolean	Возвращает или задает признак того, что будут видны только объекты с разрешенной применяемостью.
objectsAutoSave	boolean	Настройка пользователя "Автоматически сохранять изменения при выходе из режима редактирования".
favoritesCatalog	IIdentifiableObject[]	Представляет идентифицируемый объект.
storedConditions	IIdentifiableObject[]	Хранимые условия.
additionalUserOptions	IAdditionalUserOptions[]	Дополнительные опции пользователя.

IAdditionalUserOptions

Дополнительные опции пользователя.

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
userOptionsForRestrictedLists	IUserOptionsForRestrictedList[]	Возвращает коллекцию ограничительных перечней пользователя
isSuitableForAllRestrictedLists	boolean	Включает или отключает опцию "Объект входит во все включенные перечни".
isWithoutAllRestrictedLists	boolean	Включает или отключает опцию "Показывать только объекты вне включенных перечней".

IUserOptionsForRestrictedList

Возвращает коллекцию ограничительных перечней пользователя

Name	Type	Notes
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
isEnabled	boolean	Включает или отключает фильтрацию по ограничительному перечню.
restrictedList	IRestrictedList[]	Ограничительный перечень.

IUpdateUserOptionsRequest

Запрос на редактирование дополнительных опций пользователя.

Name	Type	Notes
viewApplicableOnly	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
objectAutoSave	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
additionalUserOptions	IUpdateAdditionalUserOptionsRequestOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IUpdateAdditionalUserOptionsRequestOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IUpdateAdditionalUserOptionsRequest[]	Запрос на редактирование дополнительных опций пользователя.

IUpdateAdditionalUserOptionsRequest

Запрос на редактирование дополнительных опций пользователя.

Name	Type	Notes
isSuitableForAllRestrictedLists	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isWithoutAllRestrictedLists	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
userOptionsForRestrictedLists	IUpdateUserOptionsForRestrictedListRequestListOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IUpdateUserOptionsForRestrictedListRequestListOptional

Представляет структуру для хранения информации о наличии поля в запросе.

Name	Type	Notes
hasValue	boolean
value	IUpdateUserOptionsForRestrictedListRequest[]

IUpdateUserOptionsForRestrictedListRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор ограничительного перечня.
isEnabled	boolean	Включает или отключает фильтрацию по ограничительному перечню.

IViewpoint

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.

Viewpoint

Представляет представление.

Name	Type	Notes
objectId	integer (int32)	Устанавливает и возвращает идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки.
iconColor	integer (int32)	Возвращает или задает цвет иконки.
path	INamedObject[]	Путь до объекта.
writeAccess	boolean
id	string	Идентификатор
ownerGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.

ILinkViewpointsToElementRequest

Name	Type	Notes
viewpoints	IIdentifiableObject[]	Список представлений для добавления.
element	IIdentifiableObject[]	Представляет идентифицируемый объект.

IUnlinkViewpointsFromElementRequest

Name	Type	Notes
viewpoints	IIdentifiableObject[]	Открепляемый элемент.
element	IIdentifiableObject[]	Представляет идентифицируемый объект.

ICreateViewpointRequest

Представляет запрос создания представления.

Name	Type	Notes
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименования представления.

ICreateViewpointWithValuesRequest

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

Name	Type	Notes
viewpointGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
properties	IPropertyValueItem[]	Список свойств, которым присваиваются значения.
addedOwnConcepts	IIdentifiableObject[]	Список собственных понятий, которые нужно добавить.
values	IAblePropertyValuesRequest[]

IUpdateViewpointRequest

Представляет запрос обновления элемента справочника.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IUpdateViewpointCatalogRequest

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
isEntry	BooleanOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.

IViewpointGroup

Группа представлений.

Name	Type	Notes
name	string	Имя объекта.
iconCode	integer (int32)	Код используемой иконки
iconColor	integer (int32)	Возвращает или задает цвет иконки.
writeAccess	boolean	Возвращает признак, открыт ли объект на запись.
description	string	Описание.
id	string	Идентификатор
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
path	INamedObject[]	Путь до объекта.
parentCatalog	IIdentifiableObject[]	Представляет идентифицируемый объект.
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
hasObjects	boolean	Признак наличия объектов (элементов, документов или представлений) у группы
count	integer (int32)	Количество дочерних узлов и объектов (учитываются только узлы первого уровня вложенности)
createDeleteAccess	boolean	Возвращает признак, может ли пользователь создавать/удалять объекты.

ICreateViewpointGroupRequest

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

Name	Type	Notes
parentGroup	IIdentifiableObject[]	Представляет идентифицируемый объект.
name	string	Наименования элемента.

IUpdateViewpointGroupRequest

Запрос обновления группы элементов справочника.

Name	Type	Notes
objectId	integer (int32)	Идентификатор объекта.
typeId	IdentifiableObjectType	Представляет тип объекта.
name	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
description	StringOptional[]	Представляет структуру для хранения информации о наличии поля в запросе.
iconCode	Int32Optional[]	Представляет структуру для хранения информации о наличии поля в запросе.