Sdílet prostřednictvím


OrbusInfinity (Preview)

OrbusInfinity enables architecture teams to generate digital blueprint of the enterprise and take informed decisions based on a unified view of the business-now and in the future. Build custom automations to create, read, and update Objects and Relationships within your data repository.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Orbus Software
URL https://support.orbussoftware.com
Email support@orbussoftware.com
Connector Metadata
Publisher Orbus Software
Website https://www.orbussoftware.com
Privacy policy https://www.orbussoftware.com/privacy-policy
Categories Website;Data

OrbusInfinity Connector

OrbusInfinity is a true SaaS multi-tenant solution that delivers the ultimate platform to enable your digital transformation.

OrbusInfinity integrates directly with Microsoft Office to allow you easily link, exchange, visualize, and synchronize data with the OrbusInfinity repository.

The OrbusInfinity Connector is built on top of the OrbusInfinity API and provides operations to conveniently interact with the platform.

Publisher: Orbus Software

Prerequisites

To use the connector, you need:

  • Power Automate plan with access to premium connectors
  • OrbusInfinity subscription which includes the API access
  • OrbusInfinity account

Authentication

  • oAuth2 authentication with implicit flow
  • You must be authenticated to perform any operation listed below

Supported operations

Operation Description
Objects Get Get Objects and their details
Objects Post Create a new Object
Objects Get Single Get details of an Object
Objects Delete Delete an Object
Objects Patch Update Attribute values of an existing Object
Relationships Get Get Relationships and their details
Relationships Post Create a new Relationship
Relationships Get Single Get details of a Relationship
Relationships Delete Delete a Relationship
Relationships Patch Update Attribute values of an existing Relationship
Post Webhooks Creates a trigger with the requested event
Delete Webhooks Delete an existing webhook

Objects

Operations for configuring and managing Model Objects.

Objects Get

GET /odata/Objects

Get Objects and their details

Default response includes the list of 50 Objects, which were most recently created in OrbusInfinity, and their top-level properties. Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.

Parameters

Name In Type Required Description
$select query string false A subset of properties to include for each Object in the response. If left blank, default properties are returned.
$expand query string false The additional properties (along with the default ones) to include for each Object in the response.
You can additionally request the following properties: Model, ObjectType, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, Detail.
$filter query string false The expression you filter the Objects in the result by. You can filter Objects by a value for the following properties: ObjectId, Name, ObjectTypeId, LockedOn, LockedById, IsApproved, ModelId, DateCreated, CreatedById, LastModifiedDate, LastModifiedById, Detail, AttributeValues, ObjectType, Model, CreatedBy, LastModifiedBy, LockedBy.
The minimum and default number of expressions is 0; the maximum—100.
$orderby query string false The order in which Objects are sorted in the response, by a selected property. For example, enter Name desc to request Objects in descending order by property Name.
The minimum and default number of expressions is 0; the maximum—5.
$top query integer(int32) false The count of the Objects, which were most recently created in OrbusInfinity, to include in the response. The minimum value is 0; the maximum—50.
For example, enter 20 to return 20 Objects that were most recently created in OrbusInfinity.
$skip query integer(int32) false The count of the Objects, which were most recently created in OrbusInfinity, to exclude from the response. The minimum and default value is 0; the maximum—50.
For example, enter 20 to skip 20 Objects that were most recently created in OrbusInfinity and return the next 50.
$count query boolean false If true, the total count of Objects is specified in the response. By default, the parameter is set to false, which means the total count is not returned.

Responses

Returns dynamic response.

Objects Post

POST /odata/Objects

Create a new Object

You must specify Object Type ID, Model ID, and Identifying Attribute(s) for the new Object. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Body parameter

Parameters

Name In Type Required Description
body body CreateObjectRequestValue true Property values for a new Object. Specify ObjectTypeId, ModelId, Name to create an Object.

Detailed descriptions

body: Property values for a new Object. Specify ObjectTypeId, ModelId, Name to create an Object. Optionally specify additional properties, following the structure in the example.

Responses

Created a new Object. CreateObjectResponse

Objects Get Single

GET /odata/Objects({key})

Get details of an Object

Default response includes only top-level properties. Use optional OData parameters to expand additional properties and select only specified properties.

Parameters

Name In Type Required Description
key path string(uuid) true ID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.
$select query string false A subset of properties to include for the Object in the response. If left blank, default properties are returned.
$expand query string false The additional properties (along with the default ones) to include for the Object in the response.
You can additionally request the following properties: Model, ObjectType, RelatedObjects, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, Detail, ApprovalDetails.

Responses

Returns dynamic response.

Objects Delete

DELETE /odata/Objects({key})

Delete an Object

The deleted Object is moved to the Recycle Bin.

Parameters

Name In Type Required Description
key path string(uuid) true ID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.

Responses

Deleted an Object. DeleteObjectResponse

Objects Patch

PATCH /odata/Objects({key})

Update Attribute values of an existing Object

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Body parameter

Parameters

Name In Type Required Description
key path string(uuid) true ID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.
body body UpdateObjectRequestValue true Attribute value(s) to update for the specified Object. For each Attribute, specify

Responses

Updated the Object. UpdateObjectResponse

Relationships

Operations for configuring and managing Model Relationships.

Relationships Get

GET /odata/Relationships

Get Relationships and their details

Default response includes the list of 50 Relationships, which were most recently created in OrbusInfinity, and their top-level properties. Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.

Parameters

Name In Type Required Description
includeIntersectional query boolean false If true, include Intersectional Relationships in the output.
$select query string false A subset of properties to include for each Relationship in the response. If left blank, default properties are returned.
$expand query string false The additional properties (along with the default ones) to include for each Relationship in the response.
You can additionally request the following properties: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, Detail.
$filter query string false The expression you filter the Relationships in the result by. You can filter Relationships by a value for the following properties: RelationshipId, RelationshipTypeId, ModelId, RelationshipType, Model, LeadObjectId, LeadRelationshipId, MemberObjectId, Detail.
The minimum and default number of expressions is 0; the maximum—100.
$orderby query string false The order in which Relationships are sorted in the response, by a selected property. For example, enter DateCreated desc to request Relationships in descending order by property DateCreated.
The minimum and default number of expressions is 0; the maximum—5.
$top query integer(int32) false The count of the Relationships, which were most recently created in OrbusInfinity, to include in the response. The minimum value is 0; the maximum—50.
For example, enter 20 to return 20 Relationships that were most recently created in OrbusInfinity.
$skip query integer(int32) false The count of the Relationships, which were most recently created in OrbusInfinity, to exclude from the response. The minimum and default value is 0; the maximum—50.
For example, enter 20 to skip 20 Relationships that were most recently created in OrbusInfinity and return the next 50.
$count query boolean false If true, the total count of Relationships is specified in the response. By default, the parameter is set to false, which means the total count is not returned.

Detailed descriptions

includeIntersectional: If true, include Intersectional Relationships in the output. Intersectional Relationships have a value for LeadRelationshipId property, and regular Relationships have a value for LeadObjectId property.

Responses

Returns dynamic response.

Relationships Post

POST /odata/Relationships

Create a new Relationship

You must specify Relationship Type ID, Model ID, Relationship Type Pair ID, Lead Object ID, Member Object ID, and Identifying Attribute(s) for the new Relationship. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Body parameter

Parameters

Name In Type Required Description
body body CreateRelationshipRequestValue true Property values for a new Relationship. Specify RelationshipTypeId, ModelId, RelationshipTypePairId, LeadModelItemId, MemberModelItemId to create a Relationship.

Responses

Created a new Relationship. CreateRelationshipResponse

Relationships Get Single

GET /odata/Relationships({key})

Get details of a Relationship

Default response includes only top-level properties. Use optional OData parameters to expand additional properties and select only specified properties.

Parameters

Name In Type Required Description
key path string(uuid) true ID of a Relationship in the GUID format, for example 00000000-0000-0000-0000-000000000000.
$select query string false A subset of properties to include for the Relationship in the response. If left blank, default properties are returned.
$expand query string false The additional properties (along with the default ones) to include for the Relationship in the response.
You can additionally request the following properties: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, Detail, ApprovalDetails.

Responses

Returns dynamic response.

Relationships Delete

DELETE /odata/Relationships({key})

Delete a Relationship

The deleted Relationship is moved to the Recycle Bin.

Parameters

Name In Type Required Description
key path string(uuid) true ID of a Relationship in the GUID format, for example 00000000-0000-0000-0000-000000000000.

Responses

Deleted the Relationship. DeleteRelationshipResponse

Relationships Patch

PATCH /odata/Relationships({key})

Update Attribute values of an existing Relationship

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Body parameter

Parameters

Name In Type Required Description
key path string(uuid) true ID of a Relationship in the GUID format, for example 00000000-0000-0000-0000-000000000000.
body body UpdateRelationshipRequestValue true Attribute value(s) to update for the specified Relationship. For each Attribute, specify

Responses

Updated the Relationship. UpdateRelationshipResponse

Webhooks

Operations for managing Webhooks.

Post Webhooks

POST /odata/Webhooks

When an event occurs

Creates a trigger with the requested event, so when that event occurs in OrbusInfinity, the application located at the provided URL will be notified.

Body parameter

Parameters

Name In Type Required Description
body body CreateWebhookRequest true The request containing the webhook information.

Responses

SaveWebhookResponse

Delete Webhooks

DELETE /odata/Webhooks({key})

Delete an existing webhook

Deletes an existing webhook by providing the Webhook Id.

Parameters

Name In Type Required Description
key path integer(int32) true The webhook identifier.

Responses

DeleteWebhookResponse

Schemas

WebhookSaved

Properties

Name Type Required Restrictions Description
webhookId integer(int32) false none Id of Webhook.

ObjectCreated

Properties

Name Type Required Restrictions Description
name string false none Name of created Object.
objectId string(uuid) false none Id of created Object.
modelId string(uuid) false none Model Id of created Object.
objectTypeId string(uuid) false none Object Type Id of created object.

ObjectDeleted

Properties

Name Type Required Restrictions Description
objectId string(uuid) false none Id of deleted Object.
objectName string false none Name of deleted Object.

ObjectUpdated

Properties

Name Type Required Restrictions Description
objectId string(uuid) false none Id of an Object.
name string false none Name of an Object.

RelationshipCreated

Properties

Name Type Required Restrictions Description
relationshipId string(uuid) false none Id of relationship.
leadObjectId string(uuid) false none Id of relationship's Lead Object.
leadRelationshipId string(uuid) false none Id of relationship's Lead Relationship. Used for Intersectional relationships.
memberObjectId string(uuid) false none Id of relationship's Member Object.

RelationshipDeleted

Properties

Name Type Required Restrictions Description
deletedRelationshipId string(uuid) false none Id of deleted relationship.

RelationshipUpdated

Properties

Name Type Required Restrictions Description
relationshipId string(uuid) false none Id of relationship.

MessageCategory

Value
Error
Warning
Information

MessageCode

Value
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryMismatch
CustomDocumentTypeNotSupported
CustomDocumentTypeMustHaveAtLeastOneFileExtension
DocumentTypeFileExtensionNotSupportedForCustomCategory
IdentifyingAttributeAssignmentWithInstancesExists
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
AttributesDeleted
ObjectTypesDeleted
RelationshipTypesDeleted
DependentModelItemsExist
ModelItemsDoesNotHaveComponents
ModelItemIsNotComponentOfDocumentType
RelationshipPairMembersAreNotComponentsOfDocument
MultipleDuplicateMetamodelItems
EntityIsAlreadyProtected
EntityIsAlreadyUnprotected
AttributeDoesNotExist
AttributeDoesNotExistByName
AttributeDoesNotExistByKey
AttributeNotAssignedToMetamodelItem
AttributeIsNotIdentifyingAttribute
AttributeNotInModelModellingSolution
AttributeAssignmentCannotBeEdited
IdentifyingAttributeAssignmentExists
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
UnableToAssignReadOnlyAttributes
UnableToAssignHiddenAttributes
UnableToDeleteSystemAttributeAssignment
MappedImportWorksheetSettingsDoesNotExist
MappedImportWorksheetSettingsDoesNotBelongToUser
ModelDoesNotHaveSubsetOfModellingSolutions
ModelNameNotUnique
ModelNameValueNotProvided
ModelIsDeactivated
ModelIsActivated
ModelsDeactivated
ModelsActivated
ModellingSolutionsAreNotUnique
IdentifyingAttributeCannotBeImportant
MultipleIdentifyingAttributeAssignments
AttributesAreAlreadyAssigned
MetamodelItemHasInstances
IdentifyingAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
UnableToAssignSystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AttributeChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
IdentifyingAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
ModellingSolutionDoesNotExist
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
ImportantAttributeValueNotProvided
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
UnableToDeleteGlobalAttribute
UnableToUpdateGlobalAttribute
UnableToDeleteSystemAttribute
UnableToUpdateSystemAttribute
UnableToUpdateNameOrSolutionForGlobalAttribute
UnableToUpdateConfigurationForGlobalAttribute
UnableToUpdateConfigurationForAssignedAttribute
ProtectedAttributeConfigurationHasChanged
ProtectedMetamodelItemHasChanged
ProtectedObjectTypeHasChanged
ProtectedRelationshipTypeHasChanged
ModelItemDoesNotExist
MetamodelItemDoesNotExist
ModelItemIsAlike
ModelItemIsLocked
ModelItemIsUnlocked
ModelItemIsNotObject
ModelItemIsNotRelationship
ModelItemIsNotApprovable
ModelItemIsNotPendingReview
ModelItemIsAlreadyPendingReview
ModelItemVersionIsNotLast
ModelItemsTypeNotEquals
ModelItemsEquals
ModelItemIsDeactivated
ModelItemsActivatedDeactivated
ModelItemsDeactivated
ModelItemsActivated
UserIsNotInApproversList
IdentifyingAttributeValueNotProvided
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
DuplicateGroupSpecified
DuplicatePersonSpecified
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
ObjectCapacityIsExceeded
MetamodelItemApproversEntriesExceedMaximumLimit
DuplicatedDocumentTypeLinkSpecified
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
AttributeUpdated
ModelItemsReused
ModelItemsDeleted
ObjectCreated
ObjectUpdated
ObjectsCreated
ObjectsUpdated
ObjectSkipped
ObjectsCopied
ObjectDeleted
ObjectsDeleted
ObjectsMerged
ObjectReclassified
ObjectsReclassified
ObjectsRelationshipsMerged
RelationshipCreated
RelationshipsCreated
RelationshipsCopied
RelationshipUpdated
RelationshipsUpdated
RelationshipDeleted
RelationshipsDeleted
RelationshipSkipped
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
RelationshipsMerged
LeadToMemberDirectionEmpty
MemberToLeadDirectionEmpty
RepresentationSituationIsNotValid
IntersectionalRelationshipRepresentationIsNotValid
IntersectionalRelationshipTypeWithSamePairAlreadyExists
IntersectionalRelationshipTypeCannotHavePairsWithAnyLeadOrMember
RelationshipTypeHasNoPairs
DuplicateRelationshipTypeInModellingSolution
DocumentManagementSystemRetrieved
ObjectTypeCreated
SolutionCreated
SolutionDeleted
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
WorkspaceCapacityIsExceeded
WorkspaceNameIsNotUnique
WorkspaceUpdated
WorkspacesUpdated
WorkspaceDoesNotExist
CommandsValidated
WorkspaceDeleted
WorkspacesDeleted
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculated
PricingTierIsNotValid
PermissionDenied
InternalServerError
BadRequest
NotFound
Forbidden
RequestAccepted
OverrideAll

Message

Properties

Name Type Required Restrictions Description
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.WebhookSaved

Properties

Name Type Required Restrictions Description
messageDefinition WebhookSaved false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.ObjectCreated

Properties

Name Type Required Restrictions Description
messageDefinition ObjectCreated false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.ObjectDeleted

Properties

Name Type Required Restrictions Description
messageDefinition ObjectDeleted false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.ObjectUpdated

Properties

Name Type Required Restrictions Description
messageDefinition ObjectUpdated false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.RelationshipCreated

Properties

Name Type Required Restrictions Description
messageDefinition RelationshipCreated false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.RelationshipDeleted

Properties

Name Type Required Restrictions Description
messageDefinition RelationshipDeleted false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

OperationMessage.RelationshipUpdated

Properties

Name Type Required Restrictions Description
messageDefinition RelationshipUpdated false none none
messageCategory MessageCategory false none Indicates the type of Message.
messageCode MessageCode false none none
message string false read-only Message content.

CreateWebhookRequest

Properties

Name Type Required Restrictions Description
secret string false none Receiver Secret.
eventType string true none Subscription Event Type.
url string true none Receiver Url.
expirationDate string(date-time) false none Gets or sets the expiration date. If no expiration date is provided, one value
by default will be used (typically 6 months after creation date).

DeleteWebhookResponse

Properties

Name Type Required Restrictions Description
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

SaveWebhookResponse

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.WebhookSaved false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

CreateObjectRequestValue

Properties

Name Type Required Restrictions Description
objectTypeId string(uuid) true none ID of the Object Type.
attributeValuesFlat object false none Key value pairs of Attribute values.
additionalProperties any false none none
modelId string(uuid) true none ID of the Model.

Model that represents create object operation response.

UpdateObjectRequestValue

Properties

Name Type Required Restrictions Description
attributeValuesFlat object false none Key value pairs of attribute values.

CreateObjectResponse

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.ObjectCreated false none none
operationType OperationType false none none
entityTypes EntityType false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

DeleteObjectResponse

Model that represents delete object operation response.

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.ObjectDeleted false none none
operationType OperationType false none none
entityTypes EntityType false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

UpdateObjectResponse

Model that represents update object operation response.

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.ObjectUpdated false none none
operationType OperationType false none none
entityTypes EntityType false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

CreateRelationshipRequestValue

Properties

Name Type Required Restrictions Description
relationshipTypeId string(uuid) true none Id of Relationship's type.
relationshipTypePairId string(uuid) false none If of relationship type pair.
leadModelItemId string(uuid) true none Id of relationship's lead model item.
memberModelItemId string(uuid) true none Id of relationship's member model item.
attributeValuesFlat object false none none
modelId string(uuid) true none ID of the Model.

UpdateRelationshipRequestValue

Properties

Name Type Required Restrictions Description
attributeValuesFlat object false none none

CreateRelationshipResponse

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.RelationshipCreated false none none
operationType OperationType false none none
entityTypes EntityType false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

DeleteRelationshipResponse

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.RelationshipDeleted false none none
operationType OperationType false none none
entityTypes EntityType false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

UpdateRelationshipResponse

Properties

Name Type Required Restrictions Description
successMessage OperationMessage.RelationshipUpdated false none none
operationType OperationType false none none
entityTypes EntityType false none none
success boolean false none Indicates operation success.
messages Message false read-only Response messages.

EntityType

Value
None
Solution
ObjectType
RelationshipType
RelationshipTypePair
Attribute
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Model
Object
Relationship
Document
DocumentComponent
Workspace
Role

OperationType

Value
Create
Update
Delete

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
OrbusInfinity API URL string OrbusInfinity API URL. E.g. https://example-api.orbusinfinity.com True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a new Object

You must specify Object Type ID, Model ID, and Identifying Attribute(s) for the new Object. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Create a new Relationship

You must specify Relationship Type ID, Model ID, Relationship Type Pair ID, Lead Object ID, Member Object ID, and Identifying Attribute(s) for the new Relationship. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Delete a Relationship

The deleted Relationship is moved to the Recycle Bin.

Delete an Object

The deleted Object is moved to the Recycle Bin.

Get details of a Relationship

Default response includes only top-level properties. Use optional OData parameters to expand additional properties and select only specified properties.

Get details of an Object

Default response includes only top-level properties. Use optional OData parameters to expand additional properties and select only specified properties.

Get Objects and their details

Default response includes the list of 50 Objects, which were most recently created in OrbusInfinity, and their top-level properties. Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.

Get Relationships and their details

Default response includes the list of 50 Relationships, which were most recently created in OrbusInfinity, and their top-level properties. Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.

Update Attribute values of an existing Object

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Update Attribute values of an existing Relationship

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Create a new Object

You must specify Object Type ID, Model ID, and Identifying Attribute(s) for the new Object. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Parameters

Name Key Required Type Description
objectTypeId
objectTypeId True uuid

ID of the Object Type.

attributeValuesFlat
attributeValuesFlat object

Key value pairs of Attribute values.

modelId
modelId True uuid

ID of the Model.

Returns

Model that represents create object operation response.

Create a new Relationship

You must specify Relationship Type ID, Model ID, Relationship Type Pair ID, Lead Object ID, Member Object ID, and Identifying Attribute(s) for the new Relationship. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Parameters

Name Key Required Type Description
relationshipTypeId
relationshipTypeId True uuid

Id of Relationship's type.

relationshipTypePairId
relationshipTypePairId uuid

If of relationship type pair.

leadModelItemId
leadModelItemId True uuid

Id of relationship's lead model item.

memberModelItemId
memberModelItemId True uuid

Id of relationship's member model item.

attributeValuesFlat
attributeValuesFlat object
modelId
modelId True uuid

ID of the Model.

Returns

Delete a Relationship

The deleted Relationship is moved to the Recycle Bin.

Parameters

Name Key Required Type Description
key
key True uuid

ID of a Relationship in the GUID format, for example 00000000-0000-0000-0000-000000000000.

Returns

Delete an Object

The deleted Object is moved to the Recycle Bin.

Parameters

Name Key Required Type Description
key
key True uuid

ID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.

Returns

Model that represents delete object operation response.

Get details of a Relationship

Default response includes only top-level properties. Use optional OData parameters to expand additional properties and select only specified properties.

Parameters

Name Key Required Type Description
key
key True uuid

ID of a Relationship in the GUID format, for example 00000000-0000-0000-0000-000000000000.

$select
$select string

A subset of properties to include for the Relationship in the response. If left blank, default properties are returned.

$expand
$expand string

The additional properties (along with the default ones) to include for the Relationship in the response.
You can additionally request the following properties: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, Detail, ApprovalDetails.

Returns

Relationship.

Get details of an Object

Default response includes only top-level properties. Use optional OData parameters to expand additional properties and select only specified properties.

Parameters

Name Key Required Type Description
key
key True uuid

ID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.

$select
$select string

A subset of properties to include for the Object in the response. If left blank, default properties are returned.

$expand
$expand string

The additional properties (along with the default ones) to include for the Object in the response.
You can additionally request the following properties: Model, ObjectType, RelatedObjects, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, Detail, ApprovalDetails.

Returns

OData Object Entity.

Get Objects and their details

Default response includes the list of 50 Objects, which were most recently created in OrbusInfinity, and their top-level properties. Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.

Parameters

Name Key Required Type Description
$select
$select string

A subset of properties to include for each Object in the response. If left blank, default properties are returned.

$expand
$expand string

The additional properties (along with the default ones) to include for each Object in the response.
You can additionally request the following properties: Model, ObjectType, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, Detail.

$filter
$filter string

The expression you filter the Objects in the result by. You can filter Objects by a value for the following properties: ObjectId, Name, ObjectTypeId, LockedOn, LockedById, IsApproved, ModelId, DateCreated, CreatedById, LastModifiedDate, LastModifiedById, Detail, AttributeValues, ObjectType, Model, CreatedBy, LastModifiedBy, LockedBy.
The minimum and default number of expressions is 0; the maximum—100.

$orderby
$orderby string

The order in which Objects are sorted in the response, by a selected property. For example, enter Name desc to request Objects in descending order by property Name.
The minimum and default number of expressions is 0; the maximum—5.

$top
$top integer

The count of the Objects, which were most recently created in OrbusInfinity, to include in the response. The minimum value is 0; the maximum—50.
For example, enter 20 to return 20 Objects that were most recently created in OrbusInfinity.

$skip
$skip integer

The count of the Objects, which were most recently created in OrbusInfinity, to exclude from the response. The minimum and default value is 0; the maximum—50.
For example, enter 20 to skip 20 Objects that were most recently created in OrbusInfinity and return the next 50.

$count
$count boolean

If true, the total count of Objects is specified in the response. By default, the parameter is set to false, which means the total count is not returned.

Returns

Represents additional information that OData formats support. It is only for swagger documentation purposes.

Get Relationships and their details

Default response includes the list of 50 Relationships, which were most recently created in OrbusInfinity, and their top-level properties. Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.

Parameters

Name Key Required Type Description
includeIntersectional
includeIntersectional boolean

If true, include Intersectional Relationships in the output. Intersectional Relationships have a value for LeadRelationshipId property, and regular Relationships have a value for LeadObjectId property.

$select
$select string

A subset of properties to include for each Relationship in the response. If left blank, default properties are returned.

$expand
$expand string

The additional properties (along with the default ones) to include for each Relationship in the response.
You can additionally request the following properties: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, Detail.

$filter
$filter string

The expression you filter the Relationships in the result by. You can filter Relationships by a value for the following properties: RelationshipId, RelationshipTypeId, ModelId, RelationshipType, Model, LeadObjectId, LeadRelationshipId, MemberObjectId, Detail.
The minimum and default number of expressions is 0; the maximum—100.

$orderby
$orderby string

The order in which Relationships are sorted in the response, by a selected property. For example, enter DateCreated desc to request Relationships in descending order by property DateCreated.
The minimum and default number of expressions is 0; the maximum—5.

$top
$top integer

The count of the Relationships, which were most recently created in OrbusInfinity, to include in the response. The minimum value is 0; the maximum—50.
For example, enter 20 to return 20 Relationships that were most recently created in OrbusInfinity.

$skip
$skip integer

The count of the Relationships, which were most recently created in OrbusInfinity, to exclude from the response. The minimum and default value is 0; the maximum—50.
For example, enter 20 to skip 20 Relationships that were most recently created in OrbusInfinity and return the next 50.

$count
$count boolean

If true, the total count of Relationships is specified in the response. By default, the parameter is set to false, which means the total count is not returned.

Returns

Represents additional information that OData formats support. It is only for swagger documentation purposes.

Update Attribute values of an existing Object

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Parameters

Name Key Required Type Description
key
key True uuid

ID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Key value pairs of attribute values.

Returns

Model that represents update object operation response.

Update Attribute values of an existing Relationship

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Parameters

Name Key Required Type Description
key
key True uuid

ID of a Relationship in the GUID format, for example 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Returns

Triggers

When an event occurs

Creates a trigger with the requested event, so when that event occurs in OrbusInfinity, the application located at the provided URL will be notified.

When an event occurs

Creates a trigger with the requested event, so when that event occurs in OrbusInfinity, the application located at the provided URL will be notified.

Parameters

Name Key Required Type Description
secret
secret string

Receiver Secret.

eventType
eventType True string

Subscription Event Type.

expirationDate
expirationDate date-time

Gets or sets the expiration date. If no expiration date is provided, one value by default will be used (typically 6 months after creation date).

Returns

Definitions

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Name Path Type Description
object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Name Path Type Description
name
name string

Name of created Object.

objectId
objectId uuid

Id of created Object.

modelId
modelId uuid

Model Id of created Object.

objectTypeId
objectTypeId uuid

Object Type Id of created object.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2

Name Path Type Description
objectId
objectId uuid

Id of deleted Object.

objectName
objectName string

Name of deleted Object.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2

Name Path Type Description
objectId
objectId uuid

Id of an Object.

name
name string

Name of an Object.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Name Path Type Description
relationshipId
relationshipId uuid

Id of relationship.

leadObjectId
leadObjectId uuid

Id of relationship's Lead Object.

leadRelationshipId
leadRelationshipId uuid

Id of relationship's Lead Relationship. Used for Intersectional relationships.

memberObjectId
memberObjectId uuid

Id of relationship's Member Object.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Name Path Type Description
deletedRelationshipId
deletedRelationshipId uuid

Id of deleted relationship.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Name Path Type Description
relationshipId
relationshipId uuid

Id of relationship.

OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

Indicates the type of Message.

OfficeArchitect.Contracts.Message.MessageCode

OfficeArchitect.Contracts.Message.Message_Level1

Name Path Type Description
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.MessageDefinition
message
message string

Message content.

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

Name Path Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
message
message string

Message content.

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

Name Path Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
message
message string

Message content.

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

Name Path Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
message
message string

Message content.

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

Name Path Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
message
message string

Message content.

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

Name Path Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
message
message string

Message content.

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

Name Path Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indicates the type of Message.

messageCode
messageCode OfficeArchitect.Contracts.Message.MessageCode
message
message string

Message content.

OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation

OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage

OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors

OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

The status of the model item.

The status of the model item.

OfficeArchitect.Contracts.Notification.WebhookPayload

Name Path Type Description
ids
ids array of
eventType
eventType string
secret
secret string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Name Path Type Description
attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Represents the Id of Attribute Assignment Group.

name
name string

Represents the Name of Attribute Assignment Group.

position
position integer

Represents the position of Attribute Assignment Group.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Attribute Assignment.

Name Path Type Description
attributeAssignmentId
attributeAssignmentId uuid

Attribute Assignment Id.

attributeId
attributeId uuid

Guid AttributeId.

attributeCategoryId
attributeCategoryId integer

int AttributeCategoryId.

metamodelItemId
metamodelItemId uuid

Guid MetamodelItemId.

attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Gets or sets Attribute Assignment Group identifier.

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
position integer

int Position.

activeState
activeState boolean

bool ActiveState.

stringDefaultValue
stringDefaultValue string

abstract string StringDefaultValue.

isProtected
isProtected boolean

Gets or sets a value indicating whether the attribute assignment is protected.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Name Path Type Description
metamodelItemDefaultApproverId
metamodelItemDefaultApproverId uuid

Gets or sets the entity key.

personId
personId uuid

Gets or sets the person id.

personName
personName string

Gets or sets the person name.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

MetamodelItem Solution.

Name Path Type Description
solutionId
solutionId uuid

Represents the solution id.

name
name string

Represents the solution name.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Represents the Object Type entity.

Name Path Type Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

parentObjectType
parentObjectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Represents the Object Type entity.

objectTypeId
objectTypeId uuid

Represents the Id of the Object Type.

parentObjectTypeId
parentObjectTypeId uuid

Represents the reference to Parent Object Type Id.

dateCreated
dateCreated date-time

Represents DateTime when the Object Type was created.

createdById
createdById uuid

Represents the UserId by whom the Object Type was created.

dateLastModified
dateLastModified date-time

Represents DateTime when the Object Type was modified.

lastModifiedById
lastModifiedById uuid

Represents the UserId by whom the Object Type was modified.

activeState
activeState boolean

Represents if the Object Type is in active state.

isApprovable
isApprovable boolean

Represents if the Object Type is approvable.

color
color OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
icon
icon OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons
solutions
solutions array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

Represents the navigation property to the collection of solutions.

attributeAssignments
attributeAssignments array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Represents the navigation property to the collection of assigned attributes.

attributeAssignmentGroups
attributeAssignmentGroups array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Represents the navigation property to the collection of Attribute Assignments Groups.

childObjectTypes
childObjectTypes array of OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Represents the navigation property to the collection of referenced Child Object Types.

defaultApprovers
defaultApprovers array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Represents the navigation property to the collection of default approvers.

alias
alias string

Gets or sets the alias of the metamodel item.

name
name string

Gets or sets the name of the metamodel item.

description
description string

Gets or sets the description of the metamodel item.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Represents the Object Type entity.

Name Path Type Description
objectTypeId
objectTypeId uuid

Represents the Id of the Object Type.

parentObjectTypeId
parentObjectTypeId uuid

Represents the reference to Parent Object Type Id.

dateCreated
dateCreated date-time

Represents DateTime when the Object Type was created.

createdById
createdById uuid

Represents the UserId by whom the Object Type was created.

dateLastModified
dateLastModified date-time

Represents DateTime when the Object Type was modified.

lastModifiedById
lastModifiedById uuid

Represents the UserId by whom the Object Type was modified.

activeState
activeState boolean

Represents if the Object Type is in active state.

isApprovable
isApprovable boolean

Represents if the Object Type is approvable.

alias
alias string

Gets or sets the alias of the metamodel item.

name
name string

Gets or sets the name of the metamodel item.

description
description string

Gets or sets the description of the metamodel item.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

RelationshipType Pair.

Name Path Type Description
relationshipTypePairId
relationshipTypePairId uuid

Guid RelationshipTypePairId.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadObjectTypeId
leadObjectTypeId uuid

Guid LeadObjectTypeId.

memberObjectTypeId
memberObjectTypeId uuid

Guid MemberObjectTypeId.

leadRelationshipTypeId
leadRelationshipTypeId uuid

Lead Relationship Type identifier.

activeState
activeState boolean

bool ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

Name Path Type Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

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

Represents if the RelationshipType is approvable.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

representation
representation OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation
direction
direction OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage
color
color OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
relationshipTypePairs
relationshipTypePairs array of OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

List RelationshipTypePairs RelationshipTypePairs.

solutions
solutions array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

List MetamodelItemSolution Solutions.

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

Represents the navigation property to the collection of Attribute Assignments Groups.

defaultApprovers
defaultApprovers array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Represents the navigation property to the collection of default approvers.

alias
alias string

Gets or sets the alias of the metamodel item.

name
name string

Gets or sets the name of the metamodel item.

description
description string

Gets or sets the description of the metamodel item.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

Name Path Type Description
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

Represents if the RelationshipType is approvable.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

alias
alias string

Gets or sets the alias of the metamodel item.

name
name string

Gets or sets the name of the metamodel item.

description
description string

Gets or sets the description of the metamodel item.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Name Path Type Description
value
value double

decimal Value.

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

Name Path Type Description
object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Name Path Type Description
isApprovable
isApprovable boolean
isPendingReview
isPendingReview boolean
requestedBy
requestedBy uuid
requestedOn
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
completedBy
completedBy uuid
completedOn
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
comment
comment string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Name Path Type Description
isApprovable
isApprovable boolean
isPendingReview
isPendingReview boolean
requestedBy
requestedBy uuid
requestedOn
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
completedBy
completedBy uuid
completedOn
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
comment
comment string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Name Path Type Description
solutionId
solutionId uuid

Represents the solution id.

name
name string

Represents the solution name.

OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

Name Path Type Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

description
description string

Represents the Description of the model.

dateCreated
dateCreated date-time

Represents DateTime when the Model was created.

createdById
createdById uuid

Represents the UserId by whom the Model was created.

dateLastModified
dateLastModified date-time

Represents DateTime when the Model was modified.

lastModifiedById
lastModifiedById uuid

Represents the UserId by whom the Model was modified.

startDate
startDate date-time

Represents DateTime when the Model was started.

endDate
endDate date-time

Represents DateTime when the Model was outdated.

color
color OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
isHidden
isHidden boolean

Represents Model is deactivated.

solutions
solutions array of OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Represents the navigation property to the collection of solutions.

modelId
modelId uuid

Represents the model id.

name
name string

Represents the model name.

OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

Name Path Type Description
description
description string

Represents the Description of the model.

dateCreated
dateCreated date-time

Represents DateTime when the Model was created.

createdById
createdById uuid

Represents the UserId by whom the Model was created.

dateLastModified
dateLastModified date-time

Represents DateTime when the Model was modified.

lastModifiedById
lastModifiedById uuid

Represents the UserId by whom the Model was modified.

startDate
startDate date-time

Represents DateTime when the Model was started.

endDate
endDate date-time

Represents DateTime when the Model was outdated.

isHidden
isHidden boolean

Represents Model is deactivated.

modelId
modelId uuid

Represents the model id.

name
name string

Represents the model name.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1

Name Path Type Description
originalObjectId
originalObjectId uuid

The original object id.

currentVersionNumber
currentVersionNumber integer

The ModelItem current version number.

status
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

The status of the model item.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Name Path Type Description
originalObjectId
originalObjectId uuid

The original object id.

currentVersionNumber
currentVersionNumber integer

The ModelItem current version number.

OfficeArchitect.Contracts.OData.Model.Object_Level0

OData Object Entity.

Name Path Type Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Represents the Object Type entity.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Audit User.

detail
detail OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1
approvalDetails
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
model
model OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Audit User.

objectId
objectId uuid

Guid ObjectId.

name
name string

string Name.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Locked Date.

lockedById
lockedById uuid

LockedBy User Id.

isApproved
isApproved boolean

Is Approved.

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
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level1

OData Object Entity.

Name Path Type Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Represents the Object Type entity.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

detail
detail OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2
approvalDetails
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
model
model OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

objectId
objectId uuid

Guid ObjectId.

name
name string

string Name.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Locked Date.

lockedById
lockedById uuid

LockedBy User Id.

isApproved
isApproved boolean

Is Approved.

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
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level2

OData Object Entity.

Name Path Type Description
objectId
objectId uuid

Guid ObjectId.

name
name string

string Name.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Locked Date.

lockedById
lockedById uuid

LockedBy User Id.

isApproved
isApproved boolean

Is Approved.

modelId
modelId uuid

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

Related Object.

Name Path Type Description
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

Name Path Type Description
originalRelationshipId
originalRelationshipId uuid

The original relationship id.

currentVersionNumber
currentVersionNumber integer

The ModelItem current version number.

status
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

The status of the model item.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Name Path Type Description
originalRelationshipId
originalRelationshipId uuid

The original relationship id.

currentVersionNumber
currentVersionNumber integer

The ModelItem current version number.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Relationship.

Name Path Type Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level1

OData Object Entity.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relationship.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level1

OData Object Entity.

relationshipType
relationshipType OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

detail
detail OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1
approvalDetails
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
model
model OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Audit User.

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

Relationship Type Pair Id.

isApproved
isApproved boolean

Is Approved.

attributeValuesFlat
attributeValuesFlat OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId
modelId uuid

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relationship.

Name Path Type Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level2

OData Object Entity.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relationship.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level2

OData Object Entity.

relationshipType
relationshipType OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

detail
detail OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2
approvalDetails
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
model
model OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

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

Relationship Type Pair Id.

isApproved
isApproved boolean

Is Approved.

attributeValuesFlat
attributeValuesFlat OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId
modelId uuid

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relationship.

Name Path Type Description
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

Relationship Type Pair Id.

isApproved
isApproved boolean

Is Approved.

modelId
modelId uuid

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Audit User.

Name Path Type Description
userId
userId uuid

Guid UserId.

name
name string

string Name.

emailAddress
emailAddress string

string EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Audit User.

Name Path Type Description
userId
userId uuid

Guid UserId.

name
name string

string Name.

emailAddress
emailAddress string

string EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Model that represents create object operation response.

Name Path Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level1
operationType
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indicates operation success.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Response messages.

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Model that represents delete object operation response.

Name Path Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level1
operationType
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indicates operation success.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Response messages.

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Model that represents update object operation response.

Name Path Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level1
operationType
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indicates operation success.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Response messages.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Name Path Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level1
operationType
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indicates operation success.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Response messages.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Name Path Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level1
operationType
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indicates operation success.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Response messages.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Name Path Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level1
operationType
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indicates operation success.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Response messages.

OfficeArchitect.Contracts.Response.EntityType

OfficeArchitect.Contracts.Response.OperationType

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

Represents additional information that OData formats support. It is only for swagger documentation purposes.

Name Path Type Description
@odata.context
@odata.context string

The link to Odata Context.

value
value array of OfficeArchitect.Contracts.OData.Model.Object_Level0

Gets the collection of entities for this feed.

@odata.nextLink
@odata.nextLink uri

Gets the link for the next page of values in the feed.

@odata.count
@odata.count integer

Gets the total count of values in the feed.

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

Represents additional information that OData formats support. It is only for swagger documentation purposes.

Name Path Type Description
@odata.context
@odata.context string

The link to Odata Context.

value
value array of OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Gets the collection of entities for this feed.

@odata.nextLink
@odata.nextLink uri

Gets the link for the next page of values in the feed.

@odata.count
@odata.count integer

Gets the total count of values in the feed.