OrbusInfinity

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

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Orbus Software
URL	https://support.orbussoftware.com
Адрес электронной почты	support@orbussoftware.com

Метаданные соединителя
Publisher	Orbus Software
Website	https://www.orbussoftware.com
Политика конфиденциальности	https://www.orbussoftware.com/privacy-policy
Категории	Сайт; Данные

Соединитель OrbusInfinity

OrbusInfinity — это истинное мультитенантное решение SaaS, которое обеспечивает конечную платформу для обеспечения цифрового преобразования.

OrbusInfinity интегрируется непосредственно с Microsoft Office, чтобы упростить связь, обмен, визуализацию и синхронизацию данных с репозиторием OrbusInfinity.

Соединитель OrbusInfinity построен на основе API OrbusInfinity и предоставляет операции для удобного взаимодействия с платформой.

Издатель: Orbus Software

Предпосылки

Чтобы использовать соединитель, вам потребуется:

• План Power Automate с доступом к соединителям premium
• Подписка OrbusInfinity, которая включает доступ к API
• Учетная запись OrbusInfinity

Authentication

• Проверка подлинности oAuth2 с неявным потоком
• Для выполнения любой операции, указанной ниже, необходимо пройти проверку подлинности.

Поддерживаемые операции

Операция	Description
Объекты Get	Получение объектов и их сведений
Объекты Post	Создание объекта
Объекты получают одинарный	Получение сведений об объекте
Удаление объектов	Удаление объекта
Исправления объектов	Обновление значений атрибутов существующего объекта
Получение связей	Получение связей и их сведений
Связь post	Создание связи
Связь получает одинарный	Получение сведений о связи
Удаление связей	Удаление связи
Исправление связей	Обновление значений атрибутов существующей связи
Post Webhooks	Создает триггер с запрошенным событием
Удаление веб-перехватчиков	Удаление существующего веб-перехватчика

Объекты

Операции для настройки объектов модели и управления ими.

Объекты Get

GET /odata/Objects

Получение объектов и их сведений

Ответ по умолчанию включает список 50 объектов, которые были созданы в OrbusInfinity и их свойства верхнего уровня. Используйте приведенные ниже параметры OData, чтобы фильтровать, упорядочивать, развертывать дополнительные свойства и выбирать только указанные свойства в выходных данных.

Параметры

Имя	In	Тип	Обязательно	Description
$select	query	струна	false	Подмножество свойств для каждого объекта в ответе. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	query	струна	false	Дополнительные свойства (а также значения по умолчанию) для каждого объекта в ответе. Кроме того, можно запросить следующие свойства: Model, ObjectType, AttributeValuesAttributeValuesFlat, , CreatedBy, LastModifiedBy, LockedBy. Detail
$фильтр	query	струна	false	Выражение, по которым выполняется фильтрация объектов в результате. Объекты можно фильтровать по значению для следующих свойств: ObjectId, LastModifiedByCreatedByObjectTypeModelAttributeValuesDetailNameLastModifiedByIdLastModifiedDateObjectTypeIdCreatedByIdDateCreatedLockedByIdLockedOnIsApprovedModelId. LockedBy Минимальное и стандартное число выражений равно 0; максимальное значение — 100.
$orderby	query	струна	false	Порядок сортировки объектов в ответе по выбранному свойству. Например, введите Name desc запрос объектов в порядке убывания по свойству Name. Минимальное и стандартное число выражений равно 0; максимальное значение — 5.
$top	query	integer(int32)	false	Количество объектов, которые были недавно созданы в OrbusInfinity, для включения в ответ. Минимальное значение равно 0; максимальное значение — 50. Например, введите 20 для возврата 20 объектов, которые были созданы в OrbusInfinity.
$skip	query	integer(int32)	false	Количество объектов, которые были недавно созданы в OrbusInfinity, чтобы исключить из ответа. Минимальное и значение по умолчанию равно 0; максимальное значение — 50. Например, введите 20 , чтобы пропустить 20 объектов, которые были недавно созданы в OrbusInfinity и вернуть следующие 50.
$count	query	булевый	false	Если значение true, общее количество объектов указывается в ответе. По умолчанию параметр имеет значение false, что означает, что общее число не возвращается.

Responses

Возвращает динамический ответ.

Объекты Post

POST /odata/Objects

Создание объекта

Необходимо указать идентификатор типа объекта, идентификатор модели и идентификатор атрибутов для нового объекта. Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value.

Параметр body

Параметры

Имя	In	Тип	Обязательно	Description
body	body	CreateObjectRequestValue	true	Значения свойств для нового объекта. Укажите ObjectTypeId, NameModelIdчтобы создать объект.

Подробные описания

текст: значения свойств для нового объекта. Укажите ObjectTypeId, NameModelIdчтобы создать объект. При необходимости укажите дополнительные свойства, следуя структуре в примере.

Responses

Создан новый объект. CreateObjectResponse

Объекты получают одинарный

GET /odata/Objects({key})

Получение сведений об объекте

Ответ по умолчанию включает только свойства верхнего уровня. Используйте необязательные параметры OData, чтобы развернуть дополнительные свойства и выбрать только указанные свойства.

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	string(uuid)	true	Идентификатор объекта в формате GUID, например 00000000-0000-0000-0000-000000000000.
$select	query	струна	false	Подмножество свойств для объекта в ответе. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	query	струна	false	Дополнительные свойства (а также значения по умолчанию) для объекта в ответе. Кроме того, можно запросить следующие свойства: Model, ObjectTypeRelatedObjectsCreatedByAttributeValuesAttributeValuesFlat, LockedByLastModifiedBy, . ApprovalDetailsDetail

Responses

Возвращает динамический ответ.

Удаление объектов

DELETE /odata/Objects({key})

Удаление объекта

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

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	string(uuid)	true	Идентификатор объекта в формате GUID, например 00000000-0000-0000-0000-000000000000.

Responses

Удален объект. DeleteObjectResponse

Исправления объектов

PATCH /odata/Objects({key})

Обновление значений атрибутов существующего объекта

Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value. Будут обновлены только указанные значения атрибутов.

Параметр body

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	string(uuid)	true	Идентификатор объекта в формате GUID, например 00000000-0000-0000-0000-000000000000.
body	body	UpdateObjectRequestValue	true	Значения атрибутов для обновления указанного объекта. Для каждого атрибута укажите

Responses

Обновлен объект. UpdateObjectResponse

Отношения

Операции по настройке отношений модели и управлению ими.

Получение связей

GET /odata/Relationships

Получение связей и их сведений

Ответ по умолчанию включает список 50 связей, которые были созданы в OrbusInfinity и их свойства верхнего уровня. Используйте приведенные ниже параметры OData, чтобы фильтровать, упорядочивать, развертывать дополнительные свойства и выбирать только указанные свойства в выходных данных.

Параметры

Имя	In	Тип	Обязательно	Description
includeIntersectional	query	булевый	false	Если значение true, включите в выходные данные связи пересечения.
$select	query	струна	false	Подмножество свойств для каждого отношения в ответе. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	query	струна	false	Дополнительные свойства (а также значения по умолчанию) для каждого отношения в ответе. Кроме того, можно запросить следующие свойства: LeadObject, LeadRelationship, MemberObjectRelationshipType, , Model, AttributeValues, AttributeValuesFlat. Detail
$фильтр	query	струна	false	Выражение, по которым вы фильтруете связи в результате. Связи можно фильтровать по значению для следующих свойств: RelationshipId, RelationshipTypeIdModelId, , RelationshipType, Model, LeadObjectId, . MemberObjectIdDetailLeadRelationshipId Минимальное и стандартное число выражений равно 0; максимальное значение — 100.
$orderby	query	струна	false	Порядок сортировки связей в ответе по выбранному свойству. Например, введите DateCreated desc запрос связей в порядке убывания по свойству DateCreated. Минимальное и стандартное число выражений равно 0; максимальное значение — 5.
$top	query	integer(int32)	false	Количество связей, которые были недавно созданы в OrbusInfinity, чтобы включить в ответ. Минимальное значение равно 0; максимальное значение — 50. Например, введите 20 20 связей, которые были созданы в OrbusInfinity.
$skip	query	integer(int32)	false	Количество связей, которые были недавно созданы в OrbusInfinity, чтобы исключить из ответа. Минимальное и значение по умолчанию равно 0; максимальное значение — 50. Например, введите 20 , чтобы пропустить 20 связей, которые были созданы в OrbusInfinity и возвращают следующие 50.
$count	query	булевый	false	Если задано значение true, общее количество связей указывается в ответе. По умолчанию параметр имеет значение false, что означает, что общее число не возвращается.

Подробные описания

includeIntersectional: если true, включите в выходные данные пересечения связи. Отношения пересечения имеют значение для LeadRelationshipId свойства, а регулярные связи имеют значение для LeadObjectId свойства.

Responses

Возвращает динамический ответ.

Связь post

POST /odata/Relationships

Создание связи

Необходимо указать идентификатор типа связи, идентификатор модели, идентификатор пары связей, идентификатор объекта свинца, идентификатор объекта-члена и идентификатор атрибутов для новой связи. Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value.

Параметр body

Параметры

Имя	In	Тип	Обязательно	Description
body	body	CreateRelationshipRequestValue	true	Значения свойств для нового отношения. Укажите RelationshipTypeId, , LeadModelItemIdModelIdRelationshipTypePairIdMemberModelItemId чтобы создать связь.

Responses

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

Связь получает одинарный

GET /odata/Relationships({key})

Получение сведений о связи

Ответ по умолчанию включает только свойства верхнего уровня. Используйте необязательные параметры OData, чтобы развернуть дополнительные свойства и выбрать только указанные свойства.

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	string(uuid)	true	Идентификатор связи в формате GUID, например 00000000-0000-0000-0000-000000000000.
$select	query	струна	false	Подмножество свойств для включения связи в ответ. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	query	струна	false	Дополнительные свойства (а также значения по умолчанию) для включения связи в ответ. Кроме того, можно запросить следующие свойства: , LeadRelationship, , , , AttributeValues, AttributeValuesFlat. DetailApprovalDetailsModelRelationshipTypeMemberObjectLeadObject

Responses

Возвращает динамический ответ.

Удаление связей

DELETE /odata/Relationships({key})

Удаление связи

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

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	string(uuid)	true	Идентификатор связи в формате GUID, например 00000000-0000-0000-0000-000000000000.

Responses

Удалена связь. DeleteRelationshipResponse

Исправление связей

PATCH /odata/Relationships({key})

Обновление значений атрибутов существующей связи

Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value. Будут обновлены только указанные значения атрибутов.

Параметр body

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	string(uuid)	true	Идентификатор связи в формате GUID, например 00000000-0000-0000-0000-000000000000.
body	body	UpdateRelationshipRequestValue	true	Значения атрибутов для обновления указанной связи. Для каждого атрибута укажите

Responses

Обновлена связь. UpdateRelationshipResponse

Webhooks

Операции управления веб-перехватчиками.

Post Webhooks

POST /odata/Webhooks

При возникновении события

Создает триггер с запрошенным событием, поэтому при возникновении этого события в OrbusInfinity приложение, расположенное по указанному URL-адресу, будет уведомлено.

Параметр body

Параметры

Имя	In	Тип	Обязательно	Description
body	body	CreateWebhookRequest	true	Запрос, содержащий сведения о веб-перехватчике.

Responses

SaveWebhookResponse

Удаление веб-перехватчиков

DELETE /odata/Webhooks({key})

Удаление существующего веб-перехватчика

Удаляет существующий веб-перехватчик, предоставив идентификатор веб-перехватчика.

Параметры

Имя	In	Тип	Обязательно	Description
key	путь	integer(int32)	true	Идентификатор веб-перехватчика.

Responses

DeleteWebhookResponse

Schemas

WebhookSaved

Свойства

Имя	Тип	Обязательно	Restrictions	Description
webhookId	integer(int32)	false	none	Идентификатор веб-перехватчика.

ObjectCreated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
имя	струна	false	none	Имя созданного объекта.
objectId	string(uuid)	false	none	Идентификатор созданного объекта.
modelId	string(uuid)	false	none	Идентификатор модели созданного объекта.
objectTypeId	string(uuid)	false	none	Идентификатор типа объекта созданного объекта.

ObjectDeleted

Свойства

Имя	Тип	Обязательно	Restrictions	Description
objectId	string(uuid)	false	none	Идентификатор удаленного объекта.
objectName	струна	false	none	Имя удаленного объекта.

ObjectUpdated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
objectId	string(uuid)	false	none	Идентификатор объекта.
имя	струна	false	none	Имя объекта.

СвязьCreated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
relationshipId	string(uuid)	false	none	Идентификатор связи.
leadObjectId	string(uuid)	false	none	Идентификатор объекта свинца связи.
leadRelationshipId	string(uuid)	false	none	Идентификатор отношения свинца. Используется для связей пересечения.
memberObjectId	string(uuid)	false	none	Идентификатор объекта-члена связи.

СвязьDeleted

Свойства

Имя	Тип	Обязательно	Restrictions	Description
deletedRelationshipId	string(uuid)	false	none	Идентификатор удаленной связи.

СвязьUpdated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
relationshipId	string(uuid)	false	none	Идентификатор связи.

MessageCategory

Ценность
Ошибка
Предупреждение
Информация

MessageCode

Ценность
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryMismatch
CustomDocumentTypeNotSupported
CustomDocumentTypeMustHaveAtLeastOneFileExtension
DocumentTypeFileExtensionNotSupportedForCustomCategory
ИдентификацияAttributeAssignmentWithInstancesExists
DocumentTypeDoesNotExist
DocumentTypeNameIsInvalid
DocumentTypeFilenameInvalid
DocumentTypePrimaryTemplateAlreadyExists
DocumentTypeDoesNotSupportAncillaryTemplateFiles
MissingDocumentTypeTemplateFile
MissingDocumentTypePrimaryTemplateFile
MultipleDocumentTypePrimaryTemplateFiles
DocumentTypeFileExtensionNotSupportedForCategory
TemplateFilenamesMustBeUnique
ContentTypeSaveOperationFailed
InvalidDocumentTypeRelationshipType
MetamodelItemMustBelongToAModellingSolution
ParentObjectTypeDoesNotExist
ObjectTypeHasCircularReference
ObjectsTypeHasNotChanged
ModelDoesNotExist
MetamodelItemIsNotUniqueToModellingSolution
MetamodelItemNotInModel
MetamodelItemIsSystemLocked
MetamodelItemIsHidden
MetamodelItemIsAlreadyVisible
MetamodelItemIsNotApprovable
MetamodelItemHasNotRequiredCategory
MetamodelItemHasNotAttributeAssignment
MetamodelItemHasNotCommonSolutionsWithIdentifyingAttribute
АтрибутыDeleted
ObjectTypesDeleted
RelationshipTypesDeleted
DependentModelItemsExist
ModelItemsDoesNotHaveComponents
ModelItemIsNotComponentOfDocumentType
RelationshipPairMembersAreNotComponentsOfDocument
MultipleDuplicateMetamodelItems
EntityIsAlreadyProtected
EntityIsAlreadyUnprotected
AttributeDoesNotExist
AttributeDoesNotExistByName
AttributeDoesNotExistByKey
AttributeNotAssignedToMetamodelItem
AttributeIsNotIdentifyingAttribute
AttributeNotInModelModellingSolution
AttributeAssignmentCannotBeEdited
ИдентификацияAttributeAssignmentExists
InheritedAttributeAssignmentExists
MultipleDuplicateAttributes
AttributeCategoryMismatch
AttributeDateTimeDateOnly
AttributeDateTimeMaximumIsNotDateOnly
AttributeDateTimeMinimumIsNotDateOnly
AttributeValueHyperlinkNotUri
AttributeValuesCommitted
AttributeHyperlinkDisplayValueProvided
AttributeHyperlinkUriNotProvided
AttributeMultipleValuesProvided
AttributeHyperlinkValueTooLong
AttributeHyperlinkDisplayValueTooLong
AttributePersonOrGroupIsGroup
AttributeValuePersonOrGroupNotInGroup
AttributeNumberMaximumValueExceedsLimits
AttributeNumberMinimumValueExceedsLimits
AttributeMinimumNumberPrecisionIsNotEqualToPrecisionValue
AttributeMaximumNumberPrecisionIsNotEqualToPrecisionValue
AttributeCurrencyMaximumValueExceedsLimits
AttributeCurrencyMinimumValueExceedsLimits
AttributeCurrencyMaximumValueInvalidPrecision
AttributeCurrencyMinimumValueInvalidPrecision
AttributeTextMinimumValueExceedsLimits
AttributeTextMaximumValueExceedsLimits
AttributeDoesNotExists
AttributeWithNameAlreadyExists
InvalidIsoCurrencySymbol
AttributeNumberPrecisionIsOutOfRange
AttributeMinimumValueIsGreaterThanMaximumValue
AttributeCurrencyMinimumValueIsGreaterThanMaximumValue
AttributeDateTimeMinimumValueIsGreaterThanMaximumValue
AttributeNumberMinimumValueIsGreaterThanMaximumValue
AttributeTextMinimumLengthValueIsGreaterThanMaximumLengthValue
Не удается Выполнить не удается загрузитьReadOnlyAttributes
Не удается Получить ХидденAttributes
Не в состоянииToDeleteSystemAttributeAssignment
MappedImportWorksheetSettingsDoesNotExist
MappedImportWorksheetSettingsDoesNotBelongToUser
ModelDoesNotHaveSubsetOfModellingSolutions
ModelNameNotUnique
ModelNameValueNotProvided
ModelIsDeactivated
ModelIsActivated
ModelsDeactivated
ModelsActivated
МоделированиеSolutionsAreNotUnique
ОпределениеAttributeCannotBeImportant
MultipleIdentifyingAttributeAssignments
AttributesAreAlreadyAssigned
MetamodelItemHasInstances
ОпределениеAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
Не удается Получить SystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AttributeChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
ОпределениеAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
МоделированиеSolutionDoesNotExist
ModelItemReuseDeletionRequired
ObjectIsReuse
ObjectIsVariant
ObjectIsReused
RelationshipDeletionRequired
FeedbackDeletionRequired
ViewModellingSolutionIdsNotAllowedOnCollectionView
ViewMustBelongToAModellingSolution
AdHocViewsCannotContainRuntimeParameters
ViewDimensionsRequired
TraceabilityViewFilterSetMustContainFilters
TraceabilityViewFilterCannotHaveMoreColumns
ViewDimensionRequireGroups
ViewFilterGroupRequireViewFilters
ViewFilterGroupHasIncorrectPositions
InvalidViewDimensionCategories
ViewFilterCategoryNotAllowedInCollectionView
ViewFilterHasTooManyIdentifyingParameters
ViewFilterIsMissingIdentifyingParameters
ViewFilterHasTooManyRuntimeParameters
ViewFilterIsMissingRuntimeParameter
ViewFilterParameterValuesNotProvided
ViewFilterParameterValuesProvidedForRuntimeParameter
ViewFilterParameterValuesProvidedForNullOperatorParameter
ViewFilterParameterOperatorNotSupported
ViewFilterParameterCategoryNotSupported
ViewFilterParameterValueTextIsTooLong
MetamodelItemCategoryNotSupported
ViewModelIdParameterMustBeRuntime
ViewGenerationStorageExpiredOrEmpty
ViewGenerationStorageNotAvailableForSavedParameters
ViewDimensionDoesNotExist
ViewFilterParameterRuntimeMissing
ViewFilterParameterRuntimeNotNeeded
ModelNotAvailableToAnyViewModellingSolutions
ModelNotAvailableToAllViewModellingSolutions
Важное значениеAttributeValueNotProvided
DisplayAttributeValueNotProvided
UniqueAttributeValueNotUnique
AttributeValueNumberOutOfRange
AttributeValueNumberOutOfRangeLowerOnly
AttributeValueNumberOutOfRangeUpperOnly
AttributeValueCurrencyOutOfRange
AttributeValueCurrencyOutOfRangeLowerOnly
AttributeValueCurrencyOutOfRangeUpperOnly
AttributeValueTextOutOfRange
AttributeValueTextOutOfRangeLowerOnly
AttributeValueTextOutOfRangeUpperOnly
AttributeValueDateTimeOutOfRange
AttributeValueDateTimeDateOnly
AttributeValueDateTimeOutOfRangeLowerOnly
AttributeValueDateTimeOutOfRangeUpperOnly
AttributeValueTextPlainTextMissing
AttributeValueCurrencyInvalidPrecision
AttributeValueNumberInvalidPrecision
AttributeValueChoiceDuplicateExistingChoice
AttributeValueNotChoice
AttributeValueChoiceInvalidParent
AttributeValueChoiceMultipleValuesProvided
AttributeValueHyperlinkMultipleValuesProvided
AttributeValuePersonOrGroupMultipleValuesProvided
AttributeValueBothPersonAndGroupHaveValue
MultipleDuplicateAttributeValues
AttributePersonOrGroupInvalid
Не в состоянииToDeleteGlobalAttribute
Не удается ИзменитьGlobalAttribute
Не в состоянииToDeleteSystemAttribute
Не удается Получить SystemAttribute
Не удается Изменить ИмяOrSolutionForGlobalAttribute
Не удается Изменить конфигурациюConfigurationForGlobalAttribute
Не удается Изменить конфигурациюConfigurationForAssignedAttribute
ProtectedAttributeConfigurationHasChanged
ProtectedMetamodelItemHasChanged
ProtectedObjectTypeHasChanged
ProtectedRelationshipTypeHasChanged
ModelItemDoesNotExist
MetamodelItemDoesNotExist
ModelItemIsAlike
ModelItemIsLocked
ModelItemIsUnlocked
ModelItemIsNotObject
ModelItemIsNotRelationship
ModelItemIsNotApprovable
ModelItemIsNotPendingReview
ModelItemIsAlreadyPendingReview
ModelItemVersionIsNotLast
ModelItemsTypeNotEquals
ModelItemsEquals
ModelItemIsDeactivated
ModelItemsActivatedDeactivated
ModelItemsDeactivated
ModelItemsActivated
UserIsNotInApproversList
ИдентификацияAttributeValueNotProvided
ObjectIsAlike
RelationshipIsAlike
LeadObjectDoesNotExist
LeadRelationshipDoesNotExist
MemberObjectDoesNotExist
NoValidRelationshipTypeExists
RelationshipTypePairDoesNotExist
ProtectedSolutionDoesNotContainLeadAndMember
RelationshipTypePairIsNotAssignedToRelationshipType
RelationshipTypePairIsDeactivated
RelationshipTypePairIsNotValid
UpdateSelfReferencePairInCaseOfHierarchicalDirectionDoesNotExist
DeleteSelfReferencePairInCaseOfHierarchicalDirectionDoesNotExist
DuplicateRelationshipTypePair
ObjectCapacityIsApproaching
ObjectCapacityIsAvailable
PermissionDeniedFeature
PermissionDeniedModel
PermissionDeniedModelItem
PermissionDeniedLeadModelItem
PermissionDeniedMemberModelItem
PermissionDeniedModelModelItem
PermissionDeniedModelMetamodelItem
PermissionDeniedDataImport
PersonNotInAnyRole
DependentModelItemsCannotBeUnlocked
PermissionDeniedModelAdministration
GroupDoesNotExist
PersonDoesNotExist
ДубликатыGroupSpecified
ДубликатыPersonSpecified
DuplicateMetamodelItemInModellingSolution
SolutionIsAssignedToModels
SolutionDoesNotExist
SolutionAlreadyExists
WebhookDoesNotExist
WebhookWithSameDataAlreadyExists
WebhookEventTypeIsNotValid
WebhookUrlIsNotValid
WebhookExpirationDateIsNotValid
WebhookUrlCannotBeAuthenticated
DocumentFilePathIsInaccessible
LicenseKeyIsNotValid
LicenseNotValid
SecretHasTooManyCharacters
NotificationDoesNotExist
NotificationDoesNotBelongToUser
DocumentIsCounterpartLinked
ModelItemIsCounterpartLinked
ObjectCounterpartLinked
DocumentLinkDoesNotExist
DocumentComponentDoesNotExist
ComponentDoesNotExist
SingleRepresentationSituationDoesNotExists
ComponentRepresentationSituationNotValid
MetamodelEntityIsProtected
MetamodelEntityIsNotProtected
AttributeAssignmentOfChildObjectTypeCannotBeProtected
SolutionWithProtectedAttributeAssignmentsCannotBeUnprotected
ObjectCapacityIsExceed
MetamodelItemApproversEntriesExceedMaximumLimit
ДублированныйDocumentTypeLinkSpecified
ClientForVisioDocumentTypeIsInvalid
DocumentUrlIsInvalid
DocumentPageIsOutOfRange
DocumentExportFormatIsInvalid
DataFileIsInvalid
ImportFileDoesNotExist
ImportFileCanNotBeOpened
ImportFileRequiredWorksheetMissing
ImportFileWorksheetFromMappingsMissing
ImportFileXmlSchemaIsInvalid
ImportFailedUnknownError
ImportIsInvalid
MetamodelItemIsAlreadyHidden
RelationshipTypePairIsAlreadyHidden
RelationshipTypePairIsAlreadyActive
AttributeAssignmentsDeleted
AttributeAssignmentsCommited
DocumentsDeleted
SharePointSiteSet
DocumentsRegistered
DocumentTypeCreated
DocumentTypeDeleted
DocumentTypeUpdated
DocumentTypeTemplateFilesSaved
DocumentTypeMetamodelItemsSaved
AttributeAssigmentsSaved
AttributeCreated
АтрибутUpdated
ModelItemsReused
ModelItemsDeleted
ObjectCreated
ObjectUpdated
ОбъектыCreated
ОбъектыUpdated
ObjectSkipped
ObjectsCopied
ObjectDeleted
ОбъектыDeleted
Объекты Объединены
ObjectReclassified
ObjectsReclassified
ObjectsRelationshipsMerged
СвязьCreated
СвязьCreated
RelationshipsCopied
СвязьUpdated
СвязиUpdated
СвязьDeleted
СвязьDeleted
СвязьSkipped
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
Связи Объединены
LeadToMemberDirectionEmpty
MemberToLeadDirectionEmpty
RepresentationSituationIsNotValid
IntersectionalRelationshipRepresentationIsNotValid
IntersectionalRelationshipTypeWithSamePairAlreadyExists
IntersectionalRelationshipTypeCannotHavePairsWithAnyLeadOrMember
RelationshipTypeHasNoPairs
DuplicateRelationshipTypeInModellingSolution
DocumentManagementSystemRetrieved
ObjectTypeCreated
РешениеCreated
РешениеDeleted
WebhookSaved
WebhookDeleted
MappedImportWorksheetSettingsCreated
MappedImportWorksheetSettingsUpdated
ModelCopied
ModelItemsCopied
ModelItemLocked
ModelItemUnlocked
ModelItemApprovalRequested
ModelItemApprovalRequestCompleted
ModelItemsNotApprovable
ModelCreated
ModelUpdated
NotificationCreated
NotificationDataHasIncorrectType
NotificationEndDatePrecedesStartDate
BothNotificationProgressCountsAndPercentAreSet
NotificationsDeleted
NotificationsPurged
NotificationsRead
NotificationsReadAll
NotificationsUpdated
RelationshipTypeUpdated
RelationshipTypeCreated
RelationshipTypesCreated
RelationshipTypePairUpdated
RelationshipTypePairsCreated
DocumentCreated
DocumentUpdated
DocumentCounterpartAssigned
DocumentCounterpartUnassigned
DocumentCounterpartsDeleted
DocumentCounterpartsCreated
DocumentCounterpartsUpdated
DocumentCounterpartsReassigned
DocumentFilePathIsInvalid
DocumentModelRootPathIsNotValid
DocumentFilePathIsTooLong
DocumentFilenameRequiresFileExtension
DocumentFilenameContainsInvalidCharacters
DocumentFileExtensionNotSupportedForCategory
DocumentFileExtensionNotSupportedForCustomCategory
DocumentFileExtensionNotSupportedForFileTypeFilter
DocumentAlreadyExists
DocumentHasCounterparts
DocumentTypeLinksDeleted
DocumentTypeLinkDoesNotExist
DocumentTypeLinkIsInherited
InheritedDocumentLinkAlreadyExists
DocumentTypeLinkAlreadyExists
MetamodelItemIsNotAnObjectType
MetamodelItemIsNotARelationshipType
DocumentTypeLinkCreated
DocumentTypeLinksCreated
ObjectTypeUpdated
RequestCannotBeProcessed
LeadObjectTypeDoesNotExist
MemberObjectTypeDoesNotExist
DocumentComponentUpdated
DocumentComponentsUpdated
DocumentComponentDeleted
DocumentComponentCreated
DocumentComponentsCreated
DocumentTypeComponentsUpdated
DocumentTypeComponentAlreadyExists
DocumentTypeComponentDoesNotExist
MetamodelItemHasDocumentComponents
DocumentTypeCategoryIsNotVisioType
DocumentTypeCategoryIsVisioType
DocumentTypeComponentsCreated
DocumentTypeComponentsDeleted
DocumentTypeRelationshipTypeEndpointsDoNotExist
DocumentTypeTemplateUpdated
MetamodelEntitiesLocked
MetamodelEntityIsLocked
MetamodelEntitiesUnlocked
RecycleBinPurged
EntitiesProtectionStateApplied
MetamodelItemApprovalInformationHasChanged
DocumentHasDifferentDocumentType
ExternalDocumentDoesNotHaveExternalDocumentId
LeadRelationshipTypeDoesNotExist
IntersectionalRelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageIsNotValid
MetamodelItemDeactivated
MetamodelItemsDeactivated
DescriptionIsInvalid
RelationshipTypePairActivated
RelationshipTypePairsActivated
RelationshipTypePairDeactivated
RelationshipTypePairsDeactivated
MetamodelItemActivated
MetamodelItemsActivated
FailedToSaveRelationshipTypeConnectedToDetails
MemberModelItemIsNotObject
LeadModelItemIsNotObject
LeadModelItemIsNotRelationship
WorkspaceCreated
WorkspacesCreated
WorkspaceCapacityIsExceed
WorkspaceNameIsNotUnique
WorkspaceUpdated
WorkspacesUpdated
WorkspaceDoesNotExist
CommandsValidated
WorkspaceDeleted
WorkspacesDeleted
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculated
PricingTierIsNotValid
PermissionDenied
ВнутренняяОшибкаСервера
Неверный запрос
Не найдено
Запрещено
RequestAccepted
OverrideAll

Message

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.WebhookSaved

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	WebhookSaved	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.ObjectCreated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	ObjectCreated	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.ObjectDeleted

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	ObjectDeleted	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.ObjectUpdated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	ObjectUpdated	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.RelationshipCreated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	СвязьCreated	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.RelationshipDeleted

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	СвязьDeleted	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

OperationMessage.RelationshipUpdated

Свойства

Имя	Тип	Обязательно	Restrictions	Description
messageDefinition	СвязьUpdated	false	none	none
messageCategory	MessageCategory	false	none	Указывает тип сообщения.
messageCode	MessageCode	false	none	none
сообщение	струна	false	read-only	Содержимое сообщения.

CreateWebhookRequest

Свойства

Имя	Тип	Обязательно	Restrictions	Description
secret	струна	false	none	Секрет получателя.
eventType	струна	true	none	Тип события подписки.
URL-адрес	струна	true	none	URL-адрес получателя.
дата окончания срока действия	string(date-time)	false	none	Возвращает или задает дату окончания срока действия. Если дата окончания срока действия не указана, одно значение по умолчанию будет использоваться (обычно 6 месяцев после даты создания).

DeleteWebhookResponse

Свойства

Имя	Тип	Обязательно	Restrictions	Description
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

SaveWebhookResponse

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.WebhookSaved	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

CreateObjectRequestValue

Свойства

Имя	Тип	Обязательно	Restrictions	Description
objectTypeId	string(uuid)	true	none	Идентификатор типа объекта.
attributeValuesFlat	объект	false	none	Пары ключевых значений атрибутов.
additionalProperties	any	false	none	none
modelId	string(uuid)	true	none	Идентификатор модели.

Модель, представляющая ответ операции создания объекта.

UpdateObjectRequestValue

Свойства

Имя	Тип	Обязательно	Restrictions	Description
attributeValuesFlat	объект	false	none	Пары ключевых значений атрибутов.

CreateObjectResponse

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.ObjectCreated	false	none	none
тип операции	OperationType	false	none	none
entityTypes	EntityType (Тип сущности)	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

DeleteObjectResponse

Модель, представляющая ответ операции удаления объекта.

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.ObjectDeleted	false	none	none
тип операции	OperationType	false	none	none
entityTypes	EntityType (Тип сущности)	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

UpdateObjectResponse

Модель, представляющая ответ операции обновления объекта.

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.ObjectUpdated	false	none	none
тип операции	OperationType	false	none	none
entityTypes	EntityType (Тип сущности)	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

CreateRelationshipRequestValue

Свойства

Имя	Тип	Обязательно	Restrictions	Description
relationshipTypeId	string(uuid)	true	none	Идентификатор типа связи.
relationshipTypePairId	string(uuid)	false	none	Если пара типов отношений.
leadModelItemId	string(uuid)	true	none	Идентификатор элемента модели потенциальных моделей связи.
memberModelItemId	string(uuid)	true	none	Идентификатор элемента модели члена связи.
attributeValuesFlat	объект	false	none	none
modelId	string(uuid)	true	none	Идентификатор модели.

UpdateRelationshipRequestValue

Свойства

Имя	Тип	Обязательно	Restrictions	Description
attributeValuesFlat	объект	false	none	none

CreateRelationshipResponse

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.RelationshipCreated	false	none	none
тип операции	OperationType	false	none	none
entityTypes	EntityType (Тип сущности)	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

DeleteRelationshipResponse

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.RelationshipDeleted	false	none	none
тип операции	OperationType	false	none	none
entityTypes	EntityType (Тип сущности)	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

UpdateRelationshipResponse

Свойства

Имя	Тип	Обязательно	Restrictions	Description
successMessage	OperationMessage.RelationshipUpdated	false	none	none
тип операции	OperationType	false	none	none
entityTypes	EntityType (Тип сущности)	false	none	none
success	булевый	false	none	Указывает успешное выполнение операции.
messages	Message	false	read-only	Ответные сообщения.

EntityType

Ценность
None
Solution
ObjectType
RelationshipType
RelationshipTypePair
Свойство
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Модель
Object
Relationship
Документ
DocumentComponent
Workspace
Role

Тип операции

Ценность
Create
Update
Delete

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

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

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
URL-адрес API OrbusInfinity	струна	URL-адрес API OrbusInfinity. Например. https://example-api.orbusinfinity.com	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Обновление значений атрибутов существующего объекта	Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value. Будут обновлены только указанные значения атрибутов.
Обновление значений атрибутов существующей связи	Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value. Будут обновлены только указанные значения атрибутов.
Получение объектов и их сведений	Ответ по умолчанию включает список 50 объектов, которые были созданы в OrbusInfinity и их свойства верхнего уровня. Используйте приведенные ниже параметры OData, чтобы фильтровать, упорядочивать, развертывать дополнительные свойства и выбирать только указанные свойства в выходных данных.
Получение сведений о связи	Ответ по умолчанию включает только свойства верхнего уровня. Используйте необязательные параметры OData, чтобы развернуть дополнительные свойства и выбрать только указанные свойства.
Получение сведений об объекте	Ответ по умолчанию включает только свойства верхнего уровня. Используйте необязательные параметры OData, чтобы развернуть дополнительные свойства и выбрать только указанные свойства.
Получение связей и их сведений	Ответ по умолчанию включает список 50 связей, которые были созданы в OrbusInfinity и их свойства верхнего уровня. Используйте приведенные ниже параметры OData, чтобы фильтровать, упорядочивать, развертывать дополнительные свойства и выбирать только указанные свойства в выходных данных.
Создание объекта	Необходимо указать идентификатор типа объекта, идентификатор модели и идентификатор атрибутов для нового объекта. Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value.
Создание связи	Необходимо указать идентификатор типа связи, идентификатор модели, идентификатор пары связей, идентификатор объекта свинца, идентификатор объекта-члена и идентификатор атрибутов для новой связи. Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value.
Удаление объекта	Удаленный объект перемещается в корзину.
Удаление связи	Удаленная связь перемещается в корзину.

Обновление значений атрибутов существующего объекта

Идентификатор операции:

Objects_Patch

Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value. Будут обновлены только указанные значения атрибутов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
key	key	True	uuid	Идентификатор объекта в формате GUID, например 00000000-0000-0000-0000-000000000000.
attributeValuesFlat	attributeValuesFlat		object	Пары ключевых значений атрибутов.

Возвращаемое значение

Модель, представляющая ответ операции обновления объекта.

Тело

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Обновление значений атрибутов существующей связи

Идентификатор операции:

Relationships_Patch

Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value. Будут обновлены только указанные значения атрибутов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
key	key	True	uuid	Идентификатор связи в формате GUID, например 00000000-0000-0000-0000-000000000000.
attributeValuesFlat	attributeValuesFlat		object

Возвращаемое значение

Тело

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Получение объектов и их сведений

Идентификатор операции:

Objects_Get

Ответ по умолчанию включает список 50 объектов, которые были созданы в OrbusInfinity и их свойства верхнего уровня. Используйте приведенные ниже параметры OData, чтобы фильтровать, упорядочивать, развертывать дополнительные свойства и выбирать только указанные свойства в выходных данных.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
$select	$select		string	Подмножество свойств для каждого объекта в ответе. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	$expand		string	Дополнительные свойства (а также значения по умолчанию) для каждого объекта в ответе. Кроме того, можно запросить следующие свойства: Model, ObjectType, AttributeValuesAttributeValuesFlat, , CreatedBy, LastModifiedBy, LockedBy. Detail
$фильтр	$filter		string	Выражение, по которым выполняется фильтрация объектов в результате. Объекты можно фильтровать по значению для следующих свойств: ObjectId, LastModifiedByCreatedByObjectTypeModelAttributeValuesDetailNameLastModifiedByIdLastModifiedDateObjectTypeIdCreatedByIdDateCreatedLockedByIdLockedOnIsApprovedModelId. LockedBy Минимальное и стандартное число выражений равно 0; максимальное значение — 100.
$orderby	$orderby		string	Порядок сортировки объектов в ответе по выбранному свойству. Например, введите Name desc запрос объектов в порядке убывания по свойству Name. Минимальное и стандартное число выражений равно 0; максимальное значение — 5.
$top	$top		integer	Количество объектов, которые были недавно созданы в OrbusInfinity, для включения в ответ. Минимальное значение равно 0; максимальное значение — 50. Например, введите 20 для возврата 20 объектов, которые были созданы в OrbusInfinity.
$skip	$skip		integer	Количество объектов, которые были недавно созданы в OrbusInfinity, чтобы исключить из ответа. Минимальное и значение по умолчанию равно 0; максимальное значение — 50. Например, введите 20 , чтобы пропустить 20 объектов, которые были недавно созданы в OrbusInfinity и вернуть следующие 50.
$count	$count		boolean	Если значение true, общее количество объектов указывается в ответе. По умолчанию параметр имеет значение false, что означает, что общее число не возвращается.

Возвращаемое значение

Представляет дополнительные сведения, поддерживаемые форматами OData. Это только для целей документации swagger.

Тело

OfficeArchitect.Contracts.Swagger.Response.ODataPageResponse-Of-OfficeArchitect.Contracts.OData.Model.Object

Получение сведений о связи

Идентификатор операции:

Relationships_Get_Single

Ответ по умолчанию включает только свойства верхнего уровня. Используйте необязательные параметры OData, чтобы развернуть дополнительные свойства и выбрать только указанные свойства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
key	key	True	uuid	Идентификатор связи в формате GUID, например 00000000-0000-0000-0000-000000000000.
$select	$select		string	Подмножество свойств для включения связи в ответ. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	$expand		string	Дополнительные свойства (а также значения по умолчанию) для включения связи в ответ. Кроме того, можно запросить следующие свойства: , LeadRelationship, , , , AttributeValues, AttributeValuesFlat. DetailApprovalDetailsModelRelationshipTypeMemberObjectLeadObject

Возвращаемое значение

Связь.

Тело

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Получение сведений об объекте

Идентификатор операции:

Objects_Get_Single

Ответ по умолчанию включает только свойства верхнего уровня. Используйте необязательные параметры OData, чтобы развернуть дополнительные свойства и выбрать только указанные свойства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
key	key	True	uuid	Идентификатор объекта в формате GUID, например 00000000-0000-0000-0000-000000000000.
$select	$select		string	Подмножество свойств для объекта в ответе. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	$expand		string	Дополнительные свойства (а также значения по умолчанию) для объекта в ответе. Кроме того, можно запросить следующие свойства: Model, ObjectTypeRelatedObjectsCreatedByAttributeValuesAttributeValuesFlat, LockedByLastModifiedBy, . ApprovalDetailsDetail

Возвращаемое значение

Сущность объекта OData.

Тело

OfficeArchitect.Contracts.OData.Model.Object_Level0

Получение связей и их сведений

Идентификатор операции:

Relationships_Get

Ответ по умолчанию включает список 50 связей, которые были созданы в OrbusInfinity и их свойства верхнего уровня. Используйте приведенные ниже параметры OData, чтобы фильтровать, упорядочивать, развертывать дополнительные свойства и выбирать только указанные свойства в выходных данных.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
includeIntersectional	includeIntersectional		boolean	Если значение true, включите в выходные данные связи пересечения. Отношения пересечения имеют значение для LeadRelationshipId свойства, а регулярные связи имеют значение для LeadObjectId свойства.
$select	$select		string	Подмножество свойств для каждого отношения в ответе. Если осталось пустым, возвращаются свойства по умолчанию.
$expand	$expand		string	Дополнительные свойства (а также значения по умолчанию) для каждого отношения в ответе. Кроме того, можно запросить следующие свойства: LeadObject, LeadRelationship, MemberObjectRelationshipType, , Model, AttributeValues, AttributeValuesFlat. Detail
$фильтр	$filter		string	Выражение, по которым вы фильтруете связи в результате. Связи можно фильтровать по значению для следующих свойств: RelationshipId, RelationshipTypeIdModelId, , RelationshipType, Model, LeadObjectId, . MemberObjectIdDetailLeadRelationshipId Минимальное и стандартное число выражений равно 0; максимальное значение — 100.
$orderby	$orderby		string	Порядок сортировки связей в ответе по выбранному свойству. Например, введите DateCreated desc запрос связей в порядке убывания по свойству DateCreated. Минимальное и стандартное число выражений равно 0; максимальное значение — 5.
$top	$top		integer	Количество связей, которые были недавно созданы в OrbusInfinity, чтобы включить в ответ. Минимальное значение равно 0; максимальное значение — 50. Например, введите 20 20 связей, которые были созданы в OrbusInfinity.
$skip	$skip		integer	Количество связей, которые были недавно созданы в OrbusInfinity, чтобы исключить из ответа. Минимальное и значение по умолчанию равно 0; максимальное значение — 50. Например, введите 20 , чтобы пропустить 20 связей, которые были созданы в OrbusInfinity и возвращают следующие 50.
$count	$count		boolean	Если задано значение true, общее количество связей указывается в ответе. По умолчанию параметр имеет значение false, что означает, что общее число не возвращается.

Возвращаемое значение

Представляет дополнительные сведения, поддерживаемые форматами OData. Это только для целей документации swagger.

Тело

OfficeArchitect.Contracts.Swagger.Response.ODataPageResponse-Of-OfficeArchitect.Contracts.OData.Model.Relationship

Создание объекта

Идентификатор операции:

Objects_Post

Необходимо указать идентификатор типа объекта, идентификатор модели и идентификатор атрибутов для нового объекта. Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
objectTypeId	objectTypeId	True	uuid	Идентификатор типа объекта.
attributeValuesFlat	attributeValuesFlat		object	Пары ключевых значений атрибутов.
modelId	modelId	True	uuid	Идентификатор модели.

Возвращаемое значение

Модель, представляющая ответ операции создания объекта.

Тело

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Создание связи

Идентификатор операции:

Relationships_Post

Необходимо указать идентификатор типа связи, идентификатор модели, идентификатор пары связей, идентификатор объекта свинца, идентификатор объекта-члена и идентификатор атрибутов для новой связи. Используйте AttributeValuesFlat свойство для указания значений атрибутов в формате key-value.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
relationshipTypeId	relationshipTypeId	True	uuid	Идентификатор типа связи.
relationshipTypePairId	relationshipTypePairId		uuid	Если пара типов отношений.
leadModelItemId	leadModelItemId	True	uuid	Идентификатор элемента модели потенциальных моделей связи.
memberModelItemId	memberModelItemId	True	uuid	Идентификатор элемента модели члена связи.
attributeValuesFlat	attributeValuesFlat		object
modelId	modelId	True	uuid	Идентификатор модели.

Возвращаемое значение

Тело

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Удаление объекта

Идентификатор операции:

Objects_Delete

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
key	key	True	uuid	Идентификатор объекта в формате GUID, например 00000000-0000-0000-0000-000000000000.

Возвращаемое значение

Модель, представляющая ответ операции удаления объекта.

Тело

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Удаление связи

Идентификатор операции:

Relationships_Delete

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
key	key	True	uuid	Идентификатор связи в формате GUID, например 00000000-0000-0000-0000-000000000000.

Возвращаемое значение

Тело

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Триггеры

При возникновении события

Создает триггер с запрошенным событием, поэтому при возникновении этого события в OrbusInfinity приложение, расположенное по указанному URL-адресу, будет уведомлено.

При возникновении события

Идентификатор операции:

Post_Webhooks

Создает триггер с запрошенным событием, поэтому при возникновении этого события в OrbusInfinity приложение, расположенное по указанному URL-адресу, будет уведомлено.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
secret	secret		string	Секрет получателя.
eventType	eventType	True	string	Тип события подписки.
дата окончания срока действия	expirationDate		date-time	Возвращает или задает дату окончания срока действия. Если дата окончания срока действия не указана, по умолчанию будет использоваться одно значение (обычно 6 месяцев после создания).

Возвращаемое значение

Тело

OfficeArchitect.Contracts.Notification.WebhookPayload

Определения

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Имя	Путь	Тип	Описание
		object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Имя	Путь	Тип	Описание
имя	name	string	Имя созданного объекта.
objectId	objectId	uuid	Идентификатор созданного объекта.
modelId	modelId	uuid	Идентификатор модели созданного объекта.
objectTypeId	objectTypeId	uuid	Идентификатор типа объекта созданного объекта.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2

Имя	Путь	Тип	Описание
objectId	objectId	uuid	Идентификатор удаленного объекта.
objectName	objectName	string	Имя удаленного объекта.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2

Имя	Путь	Тип	Описание
objectId	objectId	uuid	Идентификатор объекта.
имя	name	string	Имя объекта.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Имя	Путь	Тип	Описание
relationshipId	relationshipId	uuid	Идентификатор связи.
leadObjectId	leadObjectId	uuid	Идентификатор объекта свинца связи.
leadRelationshipId	leadRelationshipId	uuid	Идентификатор отношения свинца. Используется для связей пересечения.
memberObjectId	memberObjectId	uuid	Идентификатор объекта-члена связи.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Имя	Путь	Тип	Описание
deletedRelationshipId	deletedRelationshipId	uuid	Идентификатор удаленной связи.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Имя	Путь	Тип	Описание
relationshipId	relationshipId	uuid	Идентификатор связи.

OfficeArchitect.Contracts.Message.MessageCategory

Указывает тип сообщения.

Указывает тип сообщения.

string

OfficeArchitect.Contracts.Message.MessageCode

string

OfficeArchitect.Contracts.Message.Message_Level1

Имя	Путь	Тип	Описание
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.MessageDefinition
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Message.Operation.OperationMessage-of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level1

Имя	Путь	Тип	Описание
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Message.Operation.OperationMessage-of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level1

Имя	Путь	Тип	Описание
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Message.Operation.OperationMessage-of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level1

Имя	Путь	Тип	Описание
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Message.Operation.OperationMessage-of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level1

Имя	Путь	Тип	Описание
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Message.Operation.OperationMessage-of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level1

Имя	Путь	Тип	Описание
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Message.Operation.OperationMessage-of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level1

Имя	Путь	Тип	Описание
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Указывает тип сообщения.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
сообщение	message	string	Содержимое сообщения.

OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation

string

OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage

string

OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors

string

OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons

string

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Состояние элемента модели.

Состояние элемента модели.

string

OfficeArchitect.Contracts.Notification.WebhookPayload

Имя	Путь	Тип	Описание
удостоверения личности	ids	array of
eventType	eventType	string
secret	secret	string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Имя	Путь	Тип	Описание
attributeAssignmentGroupId	attributeAssignmentGroupId	uuid	Представляет идентификатор группы назначения атрибутов.
имя	name	string	Представляет имя группы назначений атрибутов.
позиция	position	integer	Представляет позицию группы назначения атрибутов.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Назначение атрибутов.

Имя	Путь	Тип	Описание
attributeAssignmentId	attributeAssignmentId	uuid	Идентификатор назначения атрибутов.
attributeId	attributeId	uuid	Guid AttributeId.
attributeCategoryId	attributeCategoryId	integer	int AttributeCategoryId.
metamodelItemId	metamodelItemId	uuid	Guid MetamodelItemId.
attributeAssignmentGroupId	attributeAssignmentGroupId	uuid	Возвращает или задает идентификатор группы назначения атрибутов.
isIdentifier	isIdentifier	boolean	bool IsIdentifier.
isInherited	isInherited	boolean	bool IsInherited.
isDisplay	isDisplay	boolean	bool IsDisplay.
isImportant	isImportant	boolean	bool IsImportant.
groupName	groupName	string	string GroupName.
позиция	position	integer	Int Position.
activeState	activeState	boolean	bool ActiveState.
stringDefaultValue	stringDefaultValue	string	абстрактная строка StringDefaultValue.
isProtected	isProtected	boolean	Возвращает или задает значение, указывающее, защищается ли назначение атрибута.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Имя	Путь	Тип	Описание
metamodelItemDefaultApproverId	metamodelItemDefaultApproverId	uuid	Возвращает или задает ключ сущности.
personId	personId	uuid	Возвращает или задает идентификатор пользователя.
personName	personName	string	Возвращает или задает имя пользователя.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

Решение MetamodelItem.

Имя	Путь	Тип	Описание
solutionId	solutionId	uuid	Представляет идентификатор решения.
имя	name	string	Представляет имя решения.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Представляет сущность типа объекта.

Имя	Путь	Тип	Описание
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
parentObjectType	parentObjectType	OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2	Представляет сущность типа объекта.
objectTypeId	objectTypeId	uuid	Представляет идентификатор типа объекта.
parentObjectTypeId	parentObjectTypeId	uuid	Представляет ссылку на идентификатор типа родительского объекта.
dateCreated	dateCreated	date-time	Представляет DateTime при создании типа объекта.
createdById	createdById	uuid	Представляет идентификатор пользователя, с помощью которого был создан тип объекта.
dateLastModified	dateLastModified	date-time	Представляет DateTime при изменении типа объекта.
lastModifiedById	lastModifiedById	uuid	Представляет Идентификатор пользователя, по которому был изменен тип объекта.
activeState	activeState	boolean	Представляет, находится ли тип объекта в активном состоянии.
isApprovable	isApprovable	boolean	Представляет, является ли тип объекта приемлемым.
color	color	OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
icon	icon	OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons
solutions	solutions	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2	Представляет свойство навигации для коллекции решений.
attributeAssignments	attributeAssignments	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2	Представляет свойство навигации для коллекции назначенных атрибутов.
attributeAssignmentGroups	attributeAssignmentGroups	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2	Представляет свойство навигации в коллекцию групп назначений атрибутов.
childObjectTypes	childObjectTypes	array of OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2	Представляет свойство навигации для коллекции ссылочных дочерних типов объектов.
defaultApprovers	defaultApprovers	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2	Представляет свойство навигации для коллекции утверждающих по умолчанию.
alias	alias	string	Возвращает или задает псевдоним элемента метамоделя.
имя	name	string	Возвращает или задает имя элемента метамоделя.
описание	description	string	Возвращает или задает описание элемента метамоделя.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Представляет сущность типа объекта.

Имя	Путь	Тип	Описание
objectTypeId	objectTypeId	uuid	Представляет идентификатор типа объекта.
parentObjectTypeId	parentObjectTypeId	uuid	Представляет ссылку на идентификатор типа родительского объекта.
dateCreated	dateCreated	date-time	Представляет DateTime при создании типа объекта.
createdById	createdById	uuid	Представляет идентификатор пользователя, с помощью которого был создан тип объекта.
dateLastModified	dateLastModified	date-time	Представляет DateTime при изменении типа объекта.
lastModifiedById	lastModifiedById	uuid	Представляет Идентификатор пользователя, по которому был изменен тип объекта.
activeState	activeState	boolean	Представляет, находится ли тип объекта в активном состоянии.
isApprovable	isApprovable	boolean	Представляет, является ли тип объекта приемлемым.
alias	alias	string	Возвращает или задает псевдоним элемента метамоделя.
имя	name	string	Возвращает или задает имя элемента метамоделя.
описание	description	string	Возвращает или задает описание элемента метамоделя.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

Пара RelationshipType.

Имя	Путь	Тип	Описание
relationshipTypePairId	relationshipTypePairId	uuid	Guid RelationshipTypePairId.
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
leadObjectTypeId	leadObjectTypeId	uuid	Guid LeadObjectTypeId.
memberObjectTypeId	memberObjectTypeId	uuid	Guid MemberObjectTypeId.
leadRelationshipTypeId	leadRelationshipTypeId	uuid	Идентификатор типа связи свинца.
activeState	activeState	boolean	bool ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

Имя	Путь	Тип	Описание
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
dateCreated	dateCreated	date-time	DateTime DateCreated.
createdById	createdById	uuid	Guid CreatedById.
dateLastModified	dateLastModified	date-time	DateTime DateLastModified.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
activeState	activeState	boolean	bool ActiveState.
isApprovable	isApprovable	boolean	Указывает, является ли тип RelationshipType репрезетируемым.
leadToMemberDirection	leadToMemberDirection	string	string LeadToMemberDirection.
memberToLeadDirection	memberToLeadDirection	string	string MemberToLeadDirection.
представление	representation	OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation
направление	direction	OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage
color	color	OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
relationshipTypePairs	relationshipTypePairs	array of OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2	Список RelationshipTypePairs RelationshipTypePairs.
solutions	solutions	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2	Перечисление решений MetamodelItemSolution.
attributeAssignments	attributeAssignments	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2	List AttributeAssignment AttributeAssignments.
attributeAssignmentGroups	attributeAssignmentGroups	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2	Представляет свойство навигации в коллекцию групп назначений атрибутов.
defaultApprovers	defaultApprovers	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2	Представляет свойство навигации для коллекции утверждающих по умолчанию.
alias	alias	string	Возвращает или задает псевдоним элемента метамоделя.
имя	name	string	Возвращает или задает имя элемента метамоделя.
описание	description	string	Возвращает или задает описание элемента метамоделя.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

Имя	Путь	Тип	Описание
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
dateCreated	dateCreated	date-time	DateTime DateCreated.
createdById	createdById	uuid	Guid CreatedById.
dateLastModified	dateLastModified	date-time	DateTime DateLastModified.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
activeState	activeState	boolean	bool ActiveState.
isApprovable	isApprovable	boolean	Указывает, является ли тип RelationshipType репрезетируемым.
leadToMemberDirection	leadToMemberDirection	string	string LeadToMemberDirection.
memberToLeadDirection	memberToLeadDirection	string	string MemberToLeadDirection.
alias	alias	string	Возвращает или задает псевдоним элемента метамоделя.
имя	name	string	Возвращает или задает имя элемента метамоделя.
описание	description	string	Возвращает или задает описание элемента метамоделя.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Имя	Путь	Тип	Описание
value	value	double	десятичное значение.
stringValue	stringValue	string	string StringValue.
attributeValueId	attributeValueId	integer	long AttributeValueId.
attributeCategoryId	attributeCategoryId	integer	int AttributeCategoryId.
attributeId	attributeId	uuid	Guid AttributeId.
modelItemId	modelItemId	uuid	Guid ModelItemId.
attributeName	attributeName	string	string AttributeName.
attributeAlias	attributeAlias	string	string AttributeAlias.

OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat

Имя	Путь	Тип	Описание
		object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Имя	Путь	Тип	Описание
isApprovable	isApprovable	boolean
isPendingReview	isPendingReview	boolean
запрошенныйBy	requestedBy	uuid
запрошенныйon	requestedOn	date-time
запрошенный номерOnVersionNumber	requestedOnVersionNumber	integer
completedBy	completedBy	uuid
completedOn	completedOn	date-time
completedOnVersionNumber	completedOnVersionNumber	integer
Комментарий	comment	string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Имя	Путь	Тип	Описание
isApprovable	isApprovable	boolean
isPendingReview	isPendingReview	boolean
запрошенныйBy	requestedBy	uuid
запрошенныйon	requestedOn	date-time
запрошенный номерOnVersionNumber	requestedOnVersionNumber	integer
completedBy	completedBy	uuid
completedOn	completedOn	date-time
completedOnVersionNumber	completedOnVersionNumber	integer
Комментарий	comment	string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Имя	Путь	Тип	Описание
solutionId	solutionId	uuid	Представляет идентификатор решения.
имя	name	string	Представляет имя решения.

OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

Имя	Путь	Тип	Описание
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
описание	description	string	Представляет описание модели.
dateCreated	dateCreated	date-time	Представляет DateTime при создании модели.
createdById	createdById	uuid	Представляет идентификатор пользователя, с помощью которого была создана модель.
dateLastModified	dateLastModified	date-time	Представляет DateTime при изменении модели.
lastModifiedById	lastModifiedById	uuid	Представляет идентификатор пользователя, по которому модель была изменена.
startDate	startDate	date-time	Представляет DateTime при запуске модели.
Дата окончания	endDate	date-time	Представляет DateTime, когда модель устарела.
color	color	OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
isHidden	isHidden	boolean	Представляет модель деактивирована.
solutions	solutions	array of OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2	Представляет свойство навигации для коллекции решений.
modelId	modelId	uuid	Представляет идентификатор модели.
имя	name	string	Представляет имя модели.

OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

Имя	Путь	Тип	Описание
описание	description	string	Представляет описание модели.
dateCreated	dateCreated	date-time	Представляет DateTime при создании модели.
createdById	createdById	uuid	Представляет идентификатор пользователя, с помощью которого была создана модель.
dateLastModified	dateLastModified	date-time	Представляет DateTime при изменении модели.
lastModifiedById	lastModifiedById	uuid	Представляет идентификатор пользователя, по которому модель была изменена.
startDate	startDate	date-time	Представляет DateTime при запуске модели.
Дата окончания	endDate	date-time	Представляет DateTime, когда модель устарела.
isHidden	isHidden	boolean	Представляет модель деактивирована.
modelId	modelId	uuid	Представляет идентификатор модели.
имя	name	string	Представляет имя модели.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1

Имя	Путь	Тип	Описание
originalObjectId	originalObjectId	uuid	Идентификатор исходного объекта.
currentVersionNumber	currentVersionNumber	integer	Номер текущей версии ModelItem.
статус	status	OfficeArchitect.Contracts.ModelItem.ModelItemStatus	Состояние элемента модели.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Имя	Путь	Тип	Описание
originalObjectId	originalObjectId	uuid	Идентификатор исходного объекта.
currentVersionNumber	currentVersionNumber	integer	Номер текущей версии ModelItem.

OfficeArchitect.Contracts.OData.Model.Object_Level0

Сущность объекта OData.

Имя	Путь	Тип	Описание
objectType	objectType	OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1	Представляет сущность типа объекта.
Заблокированный	lockedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Аудит пользователя.
detail	detail	OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1
утверждениеDetails	approvalDetails	OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
model	model	OfficeArchitect.Contracts.OData.Model.Model_Level1	Model.
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Аудит пользователя.
objectId	objectId	uuid	Guid ObjectId.
имя	name	string	строковое имя.
objectTypeId	objectTypeId	uuid	Guid ObjectTypeId.
Заблокированный	lockedOn	date-time	Дата блокировки.
lockedById	lockedById	uuid	Идентификатор пользователя LockedBy.
isApproved	isApproved	boolean	Утверждено.
relatedObjects	relatedObjects	array of OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2	virtual List RelatedObject RelatedObjects.
attributeValuesFlat	attributeValuesFlat	OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
дата последнего изменения	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
Значения атрибута	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Перечисление AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level1

Сущность объекта OData.

Имя	Путь	Тип	Описание
objectType	objectType	OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2	Представляет сущность типа объекта.
Заблокированный	lockedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
detail	detail	OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2
утверждениеDetails	approvalDetails	OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
model	model	OfficeArchitect.Contracts.OData.Model.Model_Level2	Model.
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
objectId	objectId	uuid	Guid ObjectId.
имя	name	string	строковое имя.
objectTypeId	objectTypeId	uuid	Guid ObjectTypeId.
Заблокированный	lockedOn	date-time	Дата блокировки.
lockedById	lockedById	uuid	Идентификатор пользователя LockedBy.
isApproved	isApproved	boolean	Утверждено.
relatedObjects	relatedObjects	array of OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2	virtual List RelatedObject RelatedObjects.
attributeValuesFlat	attributeValuesFlat	OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
дата последнего изменения	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
Значения атрибута	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Перечисление AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level2

Сущность объекта OData.

Имя	Путь	Тип	Описание
objectId	objectId	uuid	Guid ObjectId.
имя	name	string	строковое имя.
objectTypeId	objectTypeId	uuid	Guid ObjectTypeId.
Заблокированный	lockedOn	date-time	Дата блокировки.
lockedById	lockedById	uuid	Идентификатор пользователя LockedBy.
isApproved	isApproved	boolean	Утверждено.
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
дата последнего изменения	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

Связанный объект.

Имя	Путь	Тип	Описание
relationshipId	relationshipId	uuid	Guid RelationshipId.
objectId	objectId	uuid	Guid ObjectId.
isLead	isLead	boolean	bool IsLead.
relatedObjectId	relatedObjectId	uuid	Guid RelatedObjectId.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1

Имя	Путь	Тип	Описание
originalRelationshipId	originalRelationshipId	uuid	Исходный идентификатор связи.
currentVersionNumber	currentVersionNumber	integer	Номер текущей версии ModelItem.
статус	status	OfficeArchitect.Contracts.ModelItem.ModelItemStatus	Состояние элемента модели.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Имя	Путь	Тип	Описание
originalRelationshipId	originalRelationshipId	uuid	Исходный идентификатор связи.
currentVersionNumber	currentVersionNumber	integer	Номер текущей версии ModelItem.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Связь.

Имя	Путь	Тип	Описание
leadObject	leadObject	OfficeArchitect.Contracts.OData.Model.Object_Level1	Сущность объекта OData.
leadRelationship	leadRelationship	OfficeArchitect.Contracts.OData.Model.Relationship_Level1	Связь.
memberObject	memberObject	OfficeArchitect.Contracts.OData.Model.Object_Level1	Сущность объекта OData.
relationshipType	relationshipType	OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1	RelationshipType.
detail	detail	OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1
утверждениеDetails	approvalDetails	OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
model	model	OfficeArchitect.Contracts.OData.Model.Model_Level1	Model.
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Аудит пользователя.
relationshipId	relationshipId	uuid	Guid RelationshipId.
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
leadRelationshipId	leadRelationshipId	uuid	Guid LeadObjectId.
leadObjectId	leadObjectId	uuid	Guid LeadObjectId.
memberObjectId	memberObjectId	uuid	Guid MemberObjectId.
relationshipTypePairId	relationshipTypePairId	uuid	Идентификатор пары типов отношений.
isApproved	isApproved	boolean	Утверждено.
attributeValuesFlat	attributeValuesFlat	OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
дата последнего изменения	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
Значения атрибута	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Перечисление AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Связь.

Имя	Путь	Тип	Описание
leadObject	leadObject	OfficeArchitect.Contracts.OData.Model.Object_Level2	Сущность объекта OData.
leadRelationship	leadRelationship	OfficeArchitect.Contracts.OData.Model.Relationship_Level2	Связь.
memberObject	memberObject	OfficeArchitect.Contracts.OData.Model.Object_Level2	Сущность объекта OData.
relationshipType	relationshipType	OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2	RelationshipType.
detail	detail	OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2
утверждениеDetails	approvalDetails	OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
model	model	OfficeArchitect.Contracts.OData.Model.Model_Level2	Model.
создано кем	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
последние изменения внесены	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Аудит пользователя.
relationshipId	relationshipId	uuid	Guid RelationshipId.
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
leadRelationshipId	leadRelationshipId	uuid	Guid LeadObjectId.
leadObjectId	leadObjectId	uuid	Guid LeadObjectId.
memberObjectId	memberObjectId	uuid	Guid MemberObjectId.
relationshipTypePairId	relationshipTypePairId	uuid	Идентификатор пары типов отношений.
isApproved	isApproved	boolean	Утверждено.
attributeValuesFlat	attributeValuesFlat	OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
дата последнего изменения	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
Значения атрибута	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Перечисление AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Связь.

Имя	Путь	Тип	Описание
relationshipId	relationshipId	uuid	Guid RelationshipId.
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
leadRelationshipId	leadRelationshipId	uuid	Guid LeadObjectId.
leadObjectId	leadObjectId	uuid	Guid LeadObjectId.
memberObjectId	memberObjectId	uuid	Guid MemberObjectId.
relationshipTypePairId	relationshipTypePairId	uuid	Идентификатор пары типов отношений.
isApproved	isApproved	boolean	Утверждено.
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
дата последнего изменения	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Аудит пользователя.

Имя	Путь	Тип	Описание
userId	userId	uuid	Guid UserId.
имя	name	string	строковое имя.
адрес электронной почты	emailAddress	string	строка EmailAddress.
isInactive	isInactive	boolean	bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Аудит пользователя.

Имя	Путь	Тип	Описание
userId	userId	uuid	Guid UserId.
имя	name	string	строковое имя.
адрес электронной почты	emailAddress	string	строка EmailAddress.
isInactive	isInactive	boolean	bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Модель, представляющая ответ операции создания объекта.

Имя	Путь	Тип	Описание
successMessage	successMessage	OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level1
тип операции	operationType	OfficeArchitect.Contracts.Response.OperationType
entityTypes	entityTypes	OfficeArchitect.Contracts.Response.EntityType
success	success	boolean	Указывает успешное выполнение операции.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Ответные сообщения.

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Модель, представляющая ответ операции удаления объекта.

Имя	Путь	Тип	Описание
successMessage	successMessage	OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level1
тип операции	operationType	OfficeArchitect.Contracts.Response.OperationType
entityTypes	entityTypes	OfficeArchitect.Contracts.Response.EntityType
success	success	boolean	Указывает успешное выполнение операции.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Ответные сообщения.

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Модель, представляющая ответ операции обновления объекта.

Имя	Путь	Тип	Описание
successMessage	successMessage	OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level1
тип операции	operationType	OfficeArchitect.Contracts.Response.OperationType
entityTypes	entityTypes	OfficeArchitect.Contracts.Response.EntityType
success	success	boolean	Указывает успешное выполнение операции.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Ответные сообщения.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Имя	Путь	Тип	Описание
successMessage	successMessage	OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level1
тип операции	operationType	OfficeArchitect.Contracts.Response.OperationType
entityTypes	entityTypes	OfficeArchitect.Contracts.Response.EntityType
success	success	boolean	Указывает успешное выполнение операции.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Ответные сообщения.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Имя	Путь	Тип	Описание
successMessage	successMessage	OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level1
тип операции	operationType	OfficeArchitect.Contracts.Response.OperationType
entityTypes	entityTypes	OfficeArchitect.Contracts.Response.EntityType
success	success	boolean	Указывает успешное выполнение операции.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Ответные сообщения.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Имя	Путь	Тип	Описание
successMessage	successMessage	OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level1
тип операции	operationType	OfficeArchitect.Contracts.Response.OperationType
entityTypes	entityTypes	OfficeArchitect.Contracts.Response.EntityType
success	success	boolean	Указывает успешное выполнение операции.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Ответные сообщения.

OfficeArchitect.Contracts.Response.EntityType

string

OfficeArchitect.Contracts.Response.OperationType

string

OfficeArchitect.Contracts.Swagger.Response.ODataPageResponse-Of-OfficeArchitect.Contracts.OData.Model.Object

Представляет дополнительные сведения, поддерживаемые форматами OData. Это только для целей документации swagger.

Имя	Путь	Тип	Описание
@odata.context	@odata.context	string	Ссылка на контекст Odata.
value	value	array of OfficeArchitect.Contracts.OData.Model.Object_Level0	Возвращает коллекцию сущностей для этого веб-канала.
@odata.nextLink	@odata.nextLink	uri	Получает ссылку на следующую страницу значений в веб-канале.
@odata.count	@odata.count	integer	Возвращает общее количество значений в веб-канале.

OfficeArchitect.Contracts.Swagger.Response.ODataPageResponse-Of-OfficeArchitect.Contracts.OData.Model.Relationship

Представляет дополнительные сведения, поддерживаемые форматами OData. Это только для целей документации swagger.

Имя	Путь	Тип	Описание
@odata.context	@odata.context	string	Ссылка на контекст Odata.
value	value	array of OfficeArchitect.Contracts.OData.Model.Relationship_Level0	Возвращает коллекцию сущностей для этого веб-канала.
@odata.nextLink	@odata.nextLink	uri	Получает ссылку на следующую страницу значений в веб-канале.
@odata.count	@odata.count	integer	Возвращает общее количество значений в веб-канале.