OrbusInfinity

O OrbusInfinity permite que as equipes de arquitetura gerem o blueprint digital da empresa e tomem decisões informadas com base em uma exibição unificada dos negócios agora e no futuro. Crie automações personalizadas para criar, ler e atualizar Objetos e Relações em seu repositório de dados.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Orbus Software
URL	https://support.orbussoftware.com
Email	support@orbussoftware.com

Metadados do conector
Publicador	Orbus Software
Site da Web	https://www.orbussoftware.com
Política de privacidade	https://www.orbussoftware.com/privacy-policy
Categorias	Site; Dados

Conector OrbusInfinity

O OrbusInfinity é uma verdadeira solução multilocatário saaS que fornece a plataforma final para habilitar sua transformação digital.

O OrbusInfinity integra-se diretamente ao Microsoft Office para permitir que você vincule, troque, visualize e sincronize dados facilmente com o repositório OrbusInfinity.

O OrbusInfinity Connector é criado com base na API OrbusInfinity e fornece operações para interagir convenientemente com a plataforma.

Publicador: Software Orbus

Pré-requisitos

Para usar o conector, você precisa:

Plano do Power Automate com acesso a conectores Premium
Assinatura orbusInfinity que inclui o acesso à API
Conta OrbusInfinity

Authentication

autenticação oAuth2 com fluxo implícito
Você deve ser autenticado para executar qualquer operação listada abaixo

Operações com suporte

Operation	Description
Obtenção de objetos	Obter objetos e seus detalhes
Postagem de objetos	Criar um novo objeto
Objetos Get Single	Obter detalhes de um objeto
Exclusão de objetos	Excluir um objeto
Patch de objetos	Atualizar valores de atributo de um objeto existente
Obtenção de Relações	Obter relações e seus detalhes
Postagem de Relações	Criar uma nova relação
Relações Ficam Individuais	Obter detalhes de uma relação
Exclusão de relações	Excluir uma relação
Patch de relações	Atualizar valores de atributo de uma relação existente
Post Webhooks	Cria um gatilho com o evento solicitado
Excluir Webhooks	Excluir um webhook existente

Objetos

Operações para configurar e gerenciar objetos de modelo.

Obtenção de objetos

GET /odata/Objects

Obter objetos e seus detalhes

A resposta padrão inclui a lista de 50 objetos, que foram criados mais recentemente no OrbusInfinity, e suas propriedades de nível superior. Use os parâmetros OData abaixo para filtrar, ordenar, expandir propriedades adicionais e selecionar apenas as propriedades especificadas na saída.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
$select	consulta	cadeia	false	Um subconjunto de propriedades a serem incluídas para cada objeto na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	consulta	cadeia	false	As propriedades adicionais (juntamente com as padrão) a serem incluídas para cada Objeto na resposta. Além disso, você pode solicitar as seguintes propriedades: `Model`, , `ObjectType`, `AttributeValues`, `AttributeValuesFlat`, , `CreatedBy`, `LastModifiedBy`, , `LockedBy`. `Detail`
$filtro	consulta	cadeia	false	A expressão pela qual você filtra os Objetos no resultado. Você pode filtrar Objetos por um valor para as seguintes propriedades: `ObjectId`, , `Name`, `ObjectTypeId`, `LockedOn`, `LockedById`, `IsApproved`, , `ModelId`, `DateCreated`, `CreatedById`, , `LastModifiedDate`, `LastModifiedById`, , `Detail`, `ObjectTypeAttributeValues`, , `Model`, , `CreatedBy`, `LastModifiedBy`, `LockedBy`. O número mínimo e padrão de expressões é 0; o máximo — 100.
$orderby	consulta	cadeia	false	A ordem na qual os Objetos são classificados na resposta, por uma propriedade selecionada. Por exemplo, insira `Name desc` para solicitar Objetos em ordem decrescente por propriedade `Name`. O número mínimo e padrão de expressões é 0; o máximo — 5.
$top	consulta	integer(int32)	false	A contagem dos Objetos, que foram criados mais recentemente no OrbusInfinity, para incluir na resposta. O valor mínimo é 0; o máximo — 50. Por exemplo, insira `20` para retornar 20 objetos que foram criados mais recentemente no OrbusInfinity.
$skip	consulta	integer(int32)	false	A contagem dos Objetos, que foram criados mais recentemente no OrbusInfinity, para excluir da resposta. O valor mínimo e padrão é 0; o máximo — 50. Por exemplo, insira `20` para ignorar 20 objetos que foram criados mais recentemente no OrbusInfinity e retornar os próximos 50.
$count	consulta	boolean	false	Se for true, a contagem total de Objetos será especificada na resposta. Por padrão, o parâmetro é definido como false, o que significa que a contagem total não é retornada.

Responses

Retorna resposta dinâmica.

Postagem de objetos

POST /odata/Objects

Criar um novo objeto

Você deve especificar a ID do tipo de objeto, a ID do modelo e a identificação de atributos para o novo objeto. Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor.

Parâmetro de corpo

Parâmetros

Nome	In	Tipo	Obrigatório	Description
body	body	CreateObjectRequestValue	true	Valores de propriedade para um novo objeto. `ModelId`Especifique `ObjectTypeId`, `Name` para criar um objeto.

Descrições detalhadas

body: Valores de propriedade para um novo Objeto. ModelIdEspecifique ObjectTypeId, Name para criar um objeto. Opcionalmente, especifique propriedades adicionais, seguindo a estrutura no exemplo.

Responses

Criou um novo objeto. CreateObjectResponse

Objetos Get Single

GET /odata/Objects({key})

Obter detalhes de um objeto

A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros opcionais do OData para expandir propriedades adicionais e selecionar apenas as propriedades especificadas.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	string(uuid)	true	ID de um objeto no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
$select	consulta	cadeia	false	Um subconjunto de propriedades a serem incluídas para o Objeto na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	consulta	cadeia	false	As propriedades adicionais (juntamente com as padrão) a serem incluídas para o Objeto na resposta. Além disso, você pode solicitar as seguintes propriedades: `Model`, , `ObjectType`, `RelatedObjects`, `AttributeValues`, `AttributeValuesFlat`, , `CreatedBy`, `LastModifiedBy`, `LockedBy`, , , `Detail`, . `ApprovalDetails`

Responses

Retorna resposta dinâmica.

Exclusão de objetos

DELETE /odata/Objects({key})

Excluir um objeto

O objeto excluído é movido para a Lixeira.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	string(uuid)	true	ID de um objeto no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.

Responses

Excluiu um objeto. DeleteObjectResponse

Patch de objetos

PATCH /odata/Objects({key})

Atualizar valores de atributo de um objeto existente

Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor. Somente os valores de atributo especificados serão atualizados.

Parâmetro de corpo

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	string(uuid)	true	ID de um objeto no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
body	body	UpdateObjectRequestValue	true	Valores de atributo a serem atualizados para o Objeto especificado. Para cada atributo, especifique

Responses

Atualizou o objeto. UpdateObjectResponse

Relationships

Operações para configurar e gerenciar relações de modelo.

Obtenção de Relações

GET /odata/Relationships

Obter relações e seus detalhes

A resposta padrão inclui a lista de 50 Relações, que foram criadas mais recentemente no OrbusInfinity, e suas propriedades de nível superior. Use os parâmetros OData abaixo para filtrar, ordenar, expandir propriedades adicionais e selecionar apenas as propriedades especificadas na saída.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
includeIntersectional	consulta	boolean	false	Se for true, inclua Relações Interseccionais na saída.

$select	consulta	cadeia	false	Um subconjunto de propriedades a serem incluídas para cada Relação na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	consulta	cadeia	false	As propriedades adicionais (juntamente com as padrão) a serem incluídas para cada Relação na resposta. Além disso, você pode solicitar as seguintes propriedades: `LeadObject`, , `LeadRelationship`, `MemberObject`, `RelationshipType`, , `Model`, `AttributeValues`, , `AttributeValuesFlat`. `Detail`
$filtro	consulta	cadeia	false	A expressão pela qual você filtra as Relações no resultado. Você pode filtrar Relações por um valor para as seguintes propriedades: `RelationshipId`, , `RelationshipTypeId`, `ModelId`, `RelationshipType`, , `Model`, `LeadObjectId`, `LeadRelationshipId`, , `MemberObjectId`, . `Detail` O número mínimo e padrão de expressões é 0; o máximo — 100.
$orderby	consulta	cadeia	false	A ordem na qual relações são classificadas na resposta, por uma propriedade selecionada. Por exemplo, insira `DateCreated desc` para solicitar Relações em ordem decrescente por propriedade `DateCreated`. O número mínimo e padrão de expressões é 0; o máximo — 5.
$top	consulta	integer(int32)	false	A contagem das Relações, que foram criadas mais recentemente no OrbusInfinity, para incluir na resposta. O valor mínimo é 0; o máximo — 50. Por exemplo, insira `20` para retornar 20 Relações que foram criadas mais recentemente no OrbusInfinity.
$skip	consulta	integer(int32)	false	A contagem das Relações, que foram criadas mais recentemente no OrbusInfinity, para excluir da resposta. O valor mínimo e padrão é 0; o máximo — 50. Por exemplo, insira `20` para ignorar 20 Relações que foram criadas mais recentemente no OrbusInfinity e retornar as próximas 50.
$count	consulta	boolean	false	Se for true, a contagem total de Relações será especificada na resposta. Por padrão, o parâmetro é definido como false, o que significa que a contagem total não é retornada.

Descrições detalhadas

includeIntersectional: se verdadeiro, inclua Relações Interseccionais na saída. Relações intersecionais têm um valor para LeadRelationshipId a propriedade e relações regulares têm um valor para LeadObjectId a propriedade.

Responses

Retorna resposta dinâmica.

Postagem de Relações

POST /odata/Relationships

Criar uma nova relação

Você deve especificar ID do tipo de relação, ID do modelo, ID do par de tipo de relação, ID do objeto de cliente potencial, ID do objeto membro e identificação de atributos para a nova relação. Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor.

Parâmetro de corpo

Parâmetros

Nome	In	Tipo	Obrigatório	Description
body	body	CreateRelationshipRequestValue	true	Valores de propriedade para uma nova Relação. Especifique `RelationshipTypeId`, `ModelId`, `RelationshipTypePairId`, `LeadModelItemIdMemberModelItemId` para criar uma relação.

Responses

Criou uma nova relação. CreateRelationshipResponse

Relações Ficam Individuais

GET /odata/Relationships({key})

Obter detalhes de uma relação

A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros opcionais do OData para expandir propriedades adicionais e selecionar apenas as propriedades especificadas.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	string(uuid)	true	ID de uma relação no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
$select	consulta	cadeia	false	Um subconjunto de propriedades a serem incluídas para a Relação na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	consulta	cadeia	false	As propriedades adicionais (juntamente com as padrão) a serem incluídas para a Relação na resposta. Além disso, você pode solicitar as seguintes propriedades: `LeadObject`, , `LeadRelationship`, `MemberObject`, `RelationshipType`, `Model`, , `AttributeValues`, `AttributeValuesFlat`, , `Detail`, . `ApprovalDetails`

Responses

Retorna resposta dinâmica.

Exclusão de relações

DELETE /odata/Relationships({key})

Excluir uma relação

A relação excluída é movida para a Lixeira.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	string(uuid)	true	ID de uma relação no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.

Responses

Excluiu a relação. DeleteRelationshipResponse

Patch de relações

PATCH /odata/Relationships({key})

Atualizar valores de atributo de uma relação existente

Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor. Somente os valores de atributo especificados serão atualizados.

Parâmetro de corpo

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	string(uuid)	true	ID de uma relação no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
body	body	UpdateRelationshipRequestValue	true	Valores de atributo a serem atualizados para a Relação especificada. Para cada atributo, especifique

Responses

Atualizou a relação. UpdateRelationshipResponse

Webhooks

Operações para gerenciar webhooks.

Post Webhooks

POST /odata/Webhooks

Quando um evento ocorre

Cria um gatilho com o evento solicitado, portanto, quando esse evento ocorrer em OrbusInfinity, o aplicativo localizado na URL fornecida será notificado.

Parâmetro de corpo

Parâmetros

Nome	In	Tipo	Obrigatório	Description
body	body	CreateWebhookRequest	true	A solicitação que contém as informações do webhook.

Responses

SaveWebhookResponse

Excluir Webhooks

DELETE /odata/Webhooks({key})

Excluir um webhook existente

Exclui um webhook existente fornecendo a ID do Webhook.

Parâmetros

Nome	In	Tipo	Obrigatório	Description
chave	caminho	integer(int32)	true	O identificador do webhook.

Responses

DeleteWebhookResponse

Schemas

WebhookSaved

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
webhookId	integer(int32)	false	none	ID do Webhook.

ObjectCreated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
nome	cadeia	false	none	Nome do objeto criado.
objectId	string(uuid)	false	none	ID do objeto criado.
modelId	string(uuid)	false	none	ID do modelo do objeto criado.
objectTypeId	string(uuid)	false	none	ID do tipo de objeto do objeto criado.

ObjectDeleted

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
objectId	string(uuid)	false	none	ID do objeto excluído.
objectName	cadeia	false	none	Nome do objeto excluído.

ObjectUpdated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
objectId	string(uuid)	false	none	ID de um objeto.
nome	cadeia	false	none	Nome de um objeto.

RelationshipCreated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
relationshipId	string(uuid)	false	none	Id de relação.
leadObjectId	string(uuid)	false	none	ID do objeto Lead da relação.
leadRelationshipId	string(uuid)	false	none	ID da relação de cliente potencial da relação. Usado para relações interseccionais.
memberObjectId	string(uuid)	false	none	ID do objeto membro da relação.

RelationshipDeleted

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
deletedRelationshipId	string(uuid)	false	none	ID da relação excluída.

RelationshipUpdated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
relationshipId	string(uuid)	false	none	Id de relação.

MessageCategory

Value
Erro
Aviso
Informação

MessageCode

Value
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryMismatch
CustomDocumentTypeNotSupported
CustomDocumentTypeMustHaveAtLeastOneFileExtension
DocumentTypeFileExtensionNotSupportedForCustomCategory
IdentifiingAttributeAssignmentWithInstancesExists
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
IdentifiingAttributeAssignmentExists
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
Modelos Ativados
ModelagemSolutionsAreNotUnique
IdentifiingAttributeCannotBeImportant
MultipleIdentifyingAttributeAssignments
AttributesAreAlreadyAssigned
MetamodelItemHasInstances
IdentifiingAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
UnableToAssignSystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AttributeChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
IdentifiingAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
ModelagemSolutionDoesNotExist
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
IdentifiingAttributeValueNotProvided
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
Objetos Mesclados
ObjectReclassified
ObjectsReclassified
ObjectsRelationshipsMerged
RelationshipCreated
RelationshipsCreated
RelationshipsCopied
RelationshipUpdated
RelationshipsUpdated
RelationshipDeleted
RelationshipsDeleted
RelationshipSkipped
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
Relações Mescladas
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
Área de TrabalhoCriada
WorkspacesCreated
WorkspaceCapacityIsExceeded
WorkspaceNameIsNotUnique
WorkspaceUpdated
WorkspacesUpdated
WorkspaceDoesNotExist
CommandsValidated
Área de TrabalhoDeletada
WorkspacesDeleted
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculated
PricingTierIsNotValid
PermissionDenied
Erro Interno do Servidor
SolicitaçãoInválida
Não Encontrado
Proibido
RequestAccepted
OverrideAll

Message

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.WebhookSaved

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	WebhookSaved	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.ObjectCreated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	ObjectCreated	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.ObjectDeleted

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	ObjectDeleted	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.ObjectUpdated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	ObjectUpdated	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.RelationshipCreated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	RelationshipCreated	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.RelationshipDeleted

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	RelationshipDeleted	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

OperationMessage.RelationshipUpdated

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
messageDefinition	RelationshipUpdated	false	none	none
messageCategory	MessageCategory	false	none	Indica o tipo de Mensagem.
messageCode	MessageCode	false	none	none
mensagem	cadeia	false	somente leitura	Conteúdo da mensagem.

CreateWebhookRequest

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
segredo	cadeia	false	none	Segredo do Receptor.
eventType	cadeia	true	none	Tipo de evento de assinatura.
url	cadeia	true	none	URL do receptor.
data de expiração	string(date-time)	false	none	Obtém ou define a data de validade. Se nenhuma data de validade for fornecida, um valor por padrão será usado (normalmente 6 meses após a data de criação).

DeleteWebhookResponse

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

SaveWebhookResponse

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.WebhookSaved	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

CreateObjectRequestValue

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
objectTypeId	string(uuid)	true	none	ID do tipo de objeto.
attributeValuesFlat	objeto	false	none	Pares de valores de chave de valores de atributo.
additionalProperties	qualquer	false	none	none
modelId	string(uuid)	true	none	ID do modelo.

Modelo que representa a criação de resposta de operação de objeto.

UpdateObjectRequestValue

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
attributeValuesFlat	objeto	false	none	Pares de valores de chave de valores de atributo.

CreateObjectResponse

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.ObjectCreated	false	none	none
operationType	OperationType	false	none	none
entityTypes	Tipo de Entidade	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

DeleteObjectResponse

Modelo que representa a resposta da operação de exclusão de objeto.

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.ObjectDeleted	false	none	none
operationType	OperationType	false	none	none
entityTypes	Tipo de Entidade	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

UpdateObjectResponse

Modelo que representa a resposta da operação de objeto de atualização.

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.ObjectUpdated	false	none	none
operationType	OperationType	false	none	none
entityTypes	Tipo de Entidade	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

CreateRelationshipRequestValue

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
relationshipTypeId	string(uuid)	true	none	ID do tipo de relação.
relationshipTypePairId	string(uuid)	false	none	Se de par de tipo de relação.
leadModelItemId	string(uuid)	true	none	ID do item de modelo principal da relação.
memberModelItemId	string(uuid)	true	none	ID do item de modelo de membro da relação.
attributeValuesFlat	objeto	false	none	none
modelId	string(uuid)	true	none	ID do modelo.

UpdateRelationshipRequestValue

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
attributeValuesFlat	objeto	false	none	none

CreateRelationshipResponse

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.RelationshipCreated	false	none	none
operationType	OperationType	false	none	none
entityTypes	Tipo de Entidade	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

DeleteRelationshipResponse

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.RelationshipDeleted	false	none	none
operationType	OperationType	false	none	none
entityTypes	Tipo de Entidade	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

UpdateRelationshipResponse

Propriedades

Nome	Tipo	Obrigatório	Restrictions	Description
successMessage	OperationMessage.RelationshipUpdated	false	none	none
operationType	OperationType	false	none	none
entityTypes	Tipo de Entidade	false	none	none
sucesso	boolean	false	none	Indica o êxito da operação.
messages	Mensagem	false	somente leitura	Mensagens de resposta.

Tipo de Entidade

Value
None
Solução
ObjectType
RelationshipType
RelationshipTypePair
Attribute
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Modelo
Object
Relationship
Documento
DocumentComponent
Workspace
Função

OperationType

Value
Create
Update
Delete

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
OrbusInfinity API URL	cadeia	URL da API orbusInfinity. Por exemplo, `https://example-api.orbusinfinity.com`	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar valores de atributo de um objeto existente	Use `AttributeValuesFlat` a propriedade para especificar valores de atributo no formato chave-valor. Somente os valores de atributo especificados serão atualizados.
Atualizar valores de atributo de uma relação existente	Use `AttributeValuesFlat` a propriedade para especificar valores de atributo no formato chave-valor. Somente os valores de atributo especificados serão atualizados.
Criar um novo objeto	Você deve especificar a ID do tipo de objeto, a ID do modelo e a identificação de atributos para o novo objeto. Use `AttributeValuesFlat` a propriedade para especificar valores de atributo no formato chave-valor.
Criar uma nova relação	Você deve especificar ID do tipo de relação, ID do modelo, ID do par de tipo de relação, ID do objeto de cliente potencial, ID do objeto membro e identificação de atributos para a nova relação. Use `AttributeValuesFlat` a propriedade para especificar valores de atributo no formato chave-valor.
Excluir um objeto	O objeto excluído é movido para a Lixeira.
Excluir uma relação	A relação excluída é movida para a Lixeira.
Obter detalhes de um objeto	A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros opcionais do OData para expandir propriedades adicionais e selecionar apenas as propriedades especificadas.
Obter detalhes de uma relação	A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros opcionais do OData para expandir propriedades adicionais e selecionar apenas as propriedades especificadas.
Obter objetos e seus detalhes	A resposta padrão inclui a lista de 50 objetos, que foram criados mais recentemente no OrbusInfinity, e suas propriedades de nível superior. Use os parâmetros OData abaixo para filtrar, ordenar, expandir propriedades adicionais e selecionar apenas as propriedades especificadas na saída.
Obter relações e seus detalhes	A resposta padrão inclui a lista de 50 Relações, que foram criadas mais recentemente no OrbusInfinity, e suas propriedades de nível superior. Use os parâmetros OData abaixo para filtrar, ordenar, expandir propriedades adicionais e selecionar apenas as propriedades especificadas na saída.

Atualizar valores de atributo de um objeto existente

ID da operação:: Objects_Patch

Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor. Somente os valores de atributo especificados serão atualizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
chave	key	True	uuid	ID de um objeto no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
attributeValuesFlat	attributeValuesFlat		object	Pares de valores de chave de valores de atributo.

Retornos

Modelo que representa a resposta da operação de objeto de atualização.

Corpo: OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Atualizar valores de atributo de uma relação existente

ID da operação:: Relationships_Patch

Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor. Somente os valores de atributo especificados serão atualizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
chave	key	True	uuid	ID de uma relação no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
attributeValuesFlat	attributeValuesFlat		object

Retornos

Corpo: OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Criar um novo objeto

ID da operação:: Objects_Post

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
objectTypeId	objectTypeId	True	uuid	ID do tipo de objeto.
attributeValuesFlat	attributeValuesFlat		object	Pares de valores de chave de valores de atributo.
modelId	modelId	True	uuid	ID do modelo.

Retornos

Modelo que representa a criação de resposta de operação de objeto.

Corpo: OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Criar uma nova relação

ID da operação:: Relationships_Post

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
relationshipTypeId	relationshipTypeId	True	uuid	ID do tipo de relação.
relationshipTypePairId	relationshipTypePairId		uuid	Se de par de tipo de relação.
leadModelItemId	leadModelItemId	True	uuid	ID do item de modelo principal da relação.
memberModelItemId	memberModelItemId	True	uuid	ID do item de modelo de membro da relação.
attributeValuesFlat	attributeValuesFlat		object
modelId	modelId	True	uuid	ID do modelo.

Retornos

Corpo: OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Excluir um objeto

ID da operação:: Objects_Delete

O objeto excluído é movido para a Lixeira.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
chave	key	True	uuid	ID de um objeto no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.

Retornos

Modelo que representa a resposta da operação de exclusão de objeto.

Corpo: OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Excluir uma relação

ID da operação:: Relationships_Delete

A relação excluída é movida para a Lixeira.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
chave	key	True	uuid	ID de uma relação no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.

Retornos

Corpo: OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Obter detalhes de um objeto

ID da operação:: Objects_Get_Single

A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros opcionais do OData para expandir propriedades adicionais e selecionar apenas as propriedades especificadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
chave	key	True	uuid	ID de um objeto no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
$select	$select		string	Um subconjunto de propriedades a serem incluídas para o Objeto na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	$expand		string	As propriedades adicionais (juntamente com as padrão) a serem incluídas para o Objeto na resposta. Além disso, você pode solicitar as seguintes propriedades: `Model`, , `ObjectType`, `RelatedObjects`, `AttributeValues`, `AttributeValuesFlat`, , `CreatedBy`, `LastModifiedBy`, `LockedBy`, , , `Detail`, . `ApprovalDetails`

Retornos

Entidade do objeto OData.

Corpo: OfficeArchitect.Contracts.OData.Model.Object_Level0

Obter detalhes de uma relação

ID da operação:: Relationships_Get_Single

A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros opcionais do OData para expandir propriedades adicionais e selecionar apenas as propriedades especificadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
chave	key	True	uuid	ID de uma relação no formato GUID, por exemplo `00000000-0000-0000-0000-000000000000`.
$select	$select		string	Um subconjunto de propriedades a serem incluídas para a Relação na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	$expand		string	As propriedades adicionais (juntamente com as padrão) a serem incluídas para a Relação na resposta. Além disso, você pode solicitar as seguintes propriedades: `LeadObject`, , `LeadRelationship`, `MemberObject`, `RelationshipType`, `Model`, , `AttributeValues`, `AttributeValuesFlat`, , `Detail`, . `ApprovalDetails`

Retornos

Relação.

Corpo: OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Obter objetos e seus detalhes

ID da operação:: Objects_Get

Parâmetros

Nome	Chave	Tipo	Description
$select	$select	string	Um subconjunto de propriedades a serem incluídas para cada objeto na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	$expand	string	As propriedades adicionais (juntamente com as padrão) a serem incluídas para cada Objeto na resposta. Além disso, você pode solicitar as seguintes propriedades: `Model`, , `ObjectType`, `AttributeValues`, `AttributeValuesFlat`, , `CreatedBy`, `LastModifiedBy`, , `LockedBy`. `Detail`
$filtro	$filter	string	A expressão pela qual você filtra os Objetos no resultado. Você pode filtrar Objetos por um valor para as seguintes propriedades: `ObjectId`, , `Name`, `ObjectTypeId`, `LockedOn`, `LockedById`, `IsApproved`, , `ModelId`, `DateCreated`, `CreatedById`, , `LastModifiedDate`, `LastModifiedById`, , `Detail`, `ObjectTypeAttributeValues`, , `Model`, , `CreatedBy`, `LastModifiedBy`, `LockedBy`. O número mínimo e padrão de expressões é 0; o máximo — 100.
$orderby	$orderby	string	A ordem na qual os Objetos são classificados na resposta, por uma propriedade selecionada. Por exemplo, insira `Name desc` para solicitar Objetos em ordem decrescente por propriedade `Name`. O número mínimo e padrão de expressões é 0; o máximo — 5.
$top	$top	integer	A contagem dos Objetos, que foram criados mais recentemente no OrbusInfinity, para incluir na resposta. O valor mínimo é 0; o máximo — 50. Por exemplo, insira `20` para retornar 20 objetos que foram criados mais recentemente no OrbusInfinity.
$skip	$skip	integer	A contagem dos Objetos, que foram criados mais recentemente no OrbusInfinity, para excluir da resposta. O valor mínimo e padrão é 0; o máximo — 50. Por exemplo, insira `20` para ignorar 20 objetos que foram criados mais recentemente no OrbusInfinity e retornar os próximos 50.
$count	$count	boolean	Se for true, a contagem total de Objetos será especificada na resposta. Por padrão, o parâmetro é definido como false, o que significa que a contagem total não é retornada.

Retornos

Representa informações adicionais às quais os formatos OData dão suporte. É apenas para fins de documentação do Swagger.

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

Obter relações e seus detalhes

ID da operação:: Relationships_Get

Parâmetros

Nome	Chave	Tipo	Description
includeIntersectional	includeIntersectional	boolean	Se for true, inclua Relações Interseccionais na saída. Relações intersecionais têm um valor para `LeadRelationshipId` a propriedade e relações regulares têm um valor para `LeadObjectId` a propriedade.
$select	$select	string	Um subconjunto de propriedades a serem incluídas para cada Relação na resposta. Se estiverem em branco, as propriedades padrão serão retornadas.
$expand	$expand	string	As propriedades adicionais (juntamente com as padrão) a serem incluídas para cada Relação na resposta. Além disso, você pode solicitar as seguintes propriedades: `LeadObject`, , `LeadRelationship`, `MemberObject`, `RelationshipType`, , `Model`, `AttributeValues`, , `AttributeValuesFlat`. `Detail`
$filtro	$filter	string	A expressão pela qual você filtra as Relações no resultado. Você pode filtrar Relações por um valor para as seguintes propriedades: `RelationshipId`, , `RelationshipTypeId`, `ModelId`, `RelationshipType`, , `Model`, `LeadObjectId`, `LeadRelationshipId`, , `MemberObjectId`, . `Detail` O número mínimo e padrão de expressões é 0; o máximo — 100.
$orderby	$orderby	string	A ordem na qual relações são classificadas na resposta, por uma propriedade selecionada. Por exemplo, insira `DateCreated desc` para solicitar Relações em ordem decrescente por propriedade `DateCreated`. O número mínimo e padrão de expressões é 0; o máximo — 5.
$top	$top	integer	A contagem das Relações, que foram criadas mais recentemente no OrbusInfinity, para incluir na resposta. O valor mínimo é 0; o máximo — 50. Por exemplo, insira `20` para retornar 20 Relações que foram criadas mais recentemente no OrbusInfinity.
$skip	$skip	integer	A contagem das Relações, que foram criadas mais recentemente no OrbusInfinity, para excluir da resposta. O valor mínimo e padrão é 0; o máximo — 50. Por exemplo, insira `20` para ignorar 20 Relações que foram criadas mais recentemente no OrbusInfinity e retornar as próximas 50.
$count	$count	boolean	Se for true, a contagem total de Relações será especificada na resposta. Por padrão, o parâmetro é definido como false, o que significa que a contagem total não é retornada.

Retornos

Representa informações adicionais às quais os formatos OData dão suporte. É apenas para fins de documentação do Swagger.

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

Gatilhos

Quando um evento ocorre

Cria um gatilho com o evento solicitado, portanto, quando esse evento ocorrer em OrbusInfinity, o aplicativo localizado na URL fornecida será notificado.

Quando um evento ocorre

ID da operação:: Post_Webhooks

Cria um gatilho com o evento solicitado, portanto, quando esse evento ocorrer em OrbusInfinity, o aplicativo localizado na URL fornecida será notificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
segredo	secret		string	Segredo do Receptor.
eventType	eventType	True	string	Tipo de evento de assinatura.
data de expiração	expirationDate		date-time	Obtém ou define a data de validade. Se nenhuma data de validade for fornecida, um valor por padrão será usado (normalmente 6 meses após a data de criação).

Retornos

Corpo: OfficeArchitect.Contracts.Notification.WebhookPayload

Definições

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Nome	Caminho	Tipo	Description
		object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Nome	Caminho	Tipo	Description
nome	name	string	Nome do objeto criado.
objectId	objectId	uuid	ID do objeto criado.
modelId	modelId	uuid	ID do modelo do objeto criado.
objectTypeId	objectTypeId	uuid	ID do tipo de objeto do objeto criado.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2

Nome	Caminho	Tipo	Description
objectId	objectId	uuid	ID do objeto excluído.
objectName	objectName	string	Nome do objeto excluído.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2

Nome	Caminho	Tipo	Description
objectId	objectId	uuid	ID de um objeto.
nome	name	string	Nome de um objeto.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Nome	Caminho	Tipo	Description
relationshipId	relationshipId	uuid	Id de relação.
leadObjectId	leadObjectId	uuid	ID do objeto Lead da relação.
leadRelationshipId	leadRelationshipId	uuid	ID da relação de cliente potencial da relação. Usado para relações interseccionais.
memberObjectId	memberObjectId	uuid	ID do objeto membro da relação.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Nome	Caminho	Tipo	Description
deletedRelationshipId	deletedRelationshipId	uuid	ID da relação excluída.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Nome	Caminho	Tipo	Description
relationshipId	relationshipId	uuid	Id de relação.

OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de Mensagem.

: string

OfficeArchitect.Contracts.Message.MessageCode

: string

OfficeArchitect.Contracts.Message.Message_Level1

Nome	Caminho	Tipo	Description
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.MessageDefinition
mensagem	message	string	Conteúdo da mensagem.

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

Nome	Caminho	Tipo	Description
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
mensagem	message	string	Conteúdo da mensagem.

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

Nome	Caminho	Tipo	Description
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
mensagem	message	string	Conteúdo da mensagem.

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

Nome	Caminho	Tipo	Description
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
mensagem	message	string	Conteúdo da mensagem.

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

Nome	Caminho	Tipo	Description
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
mensagem	message	string	Conteúdo da mensagem.

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

Nome	Caminho	Tipo	Description
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
mensagem	message	string	Conteúdo da mensagem.

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

Nome	Caminho	Tipo	Description
messageDefinition	messageDefinition	OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory	messageCategory	OfficeArchitect.Contracts.Message.MessageCategory	Indica o tipo de Mensagem.
messageCode	messageCode	OfficeArchitect.Contracts.Message.MessageCode
mensagem	message	string	Conteúdo da mensagem.

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

O status do item de modelo.

: string

OfficeArchitect.Contracts.Notification.WebhookPayload

Nome	Caminho	Tipo
ids	ids	array of
eventType	eventType	string
segredo	secret	string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Nome	Caminho	Tipo	Description
attributeAssignmentGroupId	attributeAssignmentGroupId	uuid	Representa a ID do Grupo de Atribuição de Atributos.
nome	name	string	Representa o nome do grupo de atribuição de atributo.
position	position	integer	Representa a posição do Grupo de Atribuição de Atributos.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Atribuição de Atributo.

Nome	Caminho	Tipo	Description
attributeAssignmentId	attributeAssignmentId	uuid	ID da Atribuição de Atributo.
attributeId	attributeId	uuid	Guid AttributeId.
attributeCategoryId	attributeCategoryId	integer	int AttributeCategoryId.
metamodelItemId	metamodelItemId	uuid	Guid MetamodelItemId.
attributeAssignmentGroupId	attributeAssignmentGroupId	uuid	Obtém ou define o identificador do Grupo de Atribuição de Atributos.
isIdentifier	isIdentifier	boolean	Bool IsIdentifier.
isInherited	isInherited	boolean	bool IsInherited.
isDisplay	isDisplay	boolean	Bool IsDisplay.
isImportant	isImportant	boolean	Bool IsImportant.
groupName	groupName	string	groupName de cadeia de caracteres.
position	position	integer	int Position.
Estado ativo	activeState	boolean	Bool ActiveState.
stringDefaultValue	stringDefaultValue	string	cadeia de caracteres abstrata StringDefaultValue.
isProtected	isProtected	boolean	Obtém ou define um valor que indica se a atribuição de atributo está protegida.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Nome	Caminho	Tipo	Description
metamodelItemDefaultApproverId	metamodelItemDefaultApproverId	uuid	Obtém ou define a chave de entidade.
personId	personId	uuid	Obtém ou define a ID da pessoa.
personName	personName	string	Obtém ou define o nome da pessoa.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

Solução MetamodelItem.

Nome	Caminho	Tipo	Description
solutionId	solutionId	uuid	Representa a ID da solução.
nome	name	string	Representa o nome da solução.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Representa a entidade de tipo de objeto.

Nome	Caminho	Tipo	Description
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
parentObjectType	parentObjectType	OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2	Representa a entidade de tipo de objeto.
objectTypeId	objectTypeId	uuid	Representa a ID do tipo de objeto.
parentObjectTypeId	parentObjectTypeId	uuid	Representa a referência à ID do Tipo de Objeto Pai.
dateCreated	dateCreated	date-time	Representa DateTime quando o Tipo de Objeto foi criado.
createdById	createdById	uuid	Representa a UserId pela qual o Tipo de Objeto foi criado.
dateLastModified	dateLastModified	date-time	Representa DateTime quando o tipo de objeto foi modificado.
lastModifiedById	lastModifiedById	uuid	Representa a UserId pela qual o tipo de objeto foi modificado.
Estado ativo	activeState	boolean	Representa se o tipo de objeto está em estado ativo.
isApprovable	isApprovable	boolean	Representa se o Tipo de Objeto é approvável.
color	color	OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
icon	icon	OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons
solutions	solutions	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2	Representa a propriedade de navegação para a coleção de soluções.
attributeAssignments	attributeAssignments	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2	Representa a propriedade de navegação para a coleção de atributos atribuídos.
attributeAssignmentGroups	attributeAssignmentGroups	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2	Representa a propriedade de navegação para a coleção de Grupos de Atribuições de Atributo.
childObjectTypes	childObjectTypes	array of OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2	Representa a propriedade de navegação para a coleção de tipos de objeto filho referenciados.
defaultApprovers	defaultApprovers	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2	Representa a propriedade de navegação para a coleção de aprovadores padrão.
alias	alias	string	Obtém ou define o alias do item metamodel.
nome	name	string	Obtém ou define o nome do item metamodel.
descrição	description	string	Obtém ou define a descrição do item metamodel.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa a entidade de tipo de objeto.

Nome	Caminho	Tipo	Description
objectTypeId	objectTypeId	uuid	Representa a ID do tipo de objeto.
parentObjectTypeId	parentObjectTypeId	uuid	Representa a referência à ID do Tipo de Objeto Pai.
dateCreated	dateCreated	date-time	Representa DateTime quando o Tipo de Objeto foi criado.
createdById	createdById	uuid	Representa a UserId pela qual o Tipo de Objeto foi criado.
dateLastModified	dateLastModified	date-time	Representa DateTime quando o tipo de objeto foi modificado.
lastModifiedById	lastModifiedById	uuid	Representa a UserId pela qual o tipo de objeto foi modificado.
Estado ativo	activeState	boolean	Representa se o tipo de objeto está em estado ativo.
isApprovable	isApprovable	boolean	Representa se o Tipo de Objeto é approvável.
alias	alias	string	Obtém ou define o alias do item metamodel.
nome	name	string	Obtém ou define o nome do item metamodel.
descrição	description	string	Obtém ou define a descrição do item metamodel.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

Par RelationshipType.

Nome	Caminho	Tipo	Description
relationshipTypePairId	relationshipTypePairId	uuid	Guid RelationshipTypePairId.
relationshipTypeId	relationshipTypeId	uuid	Guid RelationshipTypeId.
leadObjectTypeId	leadObjectTypeId	uuid	Guid LeadObjectTypeId.
memberObjectTypeId	memberObjectTypeId	uuid	Guid MemberObjectTypeId.
leadRelationshipTypeId	leadRelationshipTypeId	uuid	Identificador de tipo de relação de cliente potencial.
Estado ativo	activeState	boolean	Bool ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

Nome	Caminho	Tipo	Description
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
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.
Estado ativo	activeState	boolean	Bool ActiveState.
isApprovable	isApprovable	boolean	Representa se o RelationshipType é approvável.
leadToMemberDirection	leadToMemberDirection	string	cadeia de caracteres LeadToMemberDirection.
memberToLeadDirection	memberToLeadDirection	string	string MemberToLeadDirection.
representação	representation	OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation
direção	direction	OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage
color	color	OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
relationshipTypePairs	relationshipTypePairs	array of OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2	Listar RelationshipTypePairs RelationshipTypePairs.
solutions	solutions	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2	Listar Soluções metamodelItemSolution.
attributeAssignments	attributeAssignments	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2	Listar AttributeAssignment AttributeAssignments.
attributeAssignmentGroups	attributeAssignmentGroups	array of OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2	Representa a propriedade de navegação para a coleção de Grupos de Atribuições de Atributo.
defaultApprovers	defaultApprovers	array of OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2	Representa a propriedade de navegação para a coleção de aprovadores padrão.
alias	alias	string	Obtém ou define o alias do item metamodel.
nome	name	string	Obtém ou define o nome do item metamodel.
descrição	description	string	Obtém ou define a descrição do item metamodel.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

Nome	Caminho	Tipo	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.
Estado ativo	activeState	boolean	Bool ActiveState.
isApprovable	isApprovable	boolean	Representa se o RelationshipType é approvável.
leadToMemberDirection	leadToMemberDirection	string	cadeia de caracteres LeadToMemberDirection.
memberToLeadDirection	memberToLeadDirection	string	string MemberToLeadDirection.
alias	alias	string	Obtém ou define o alias do item metamodel.
nome	name	string	Obtém ou define o nome do item metamodel.
descrição	description	string	Obtém ou define a descrição do item metamodel.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Nome	Caminho	Tipo	Description
value	value	double	valor decimal.
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	attributeAlias de cadeia de caracteres.

OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat

Nome	Caminho	Tipo	Description
		object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Nome	Caminho	Tipo
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
comentário	comment	string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Nome	Caminho	Tipo
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
comentário	comment	string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Nome	Caminho	Tipo	Description
solutionId	solutionId	uuid	Representa a ID da solução.
nome	name	string	Representa o nome da solução.

OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

Nome	Caminho	Tipo	Description
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
descrição	description	string	Representa a descrição do modelo.
dateCreated	dateCreated	date-time	Representa DateTime quando o modelo foi criado.
createdById	createdById	uuid	Representa a UserId pela qual o modelo foi criado.
dateLastModified	dateLastModified	date-time	Representa DateTime quando o modelo foi modificado.
lastModifiedById	lastModifiedById	uuid	Representa a UserId pela qual o modelo foi modificado.
startDate	startDate	date-time	Representa DateTime quando o modelo foi iniciado.
data de término	endDate	date-time	Representa DateTime quando o modelo estava desatualizado.
color	color	OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors
isHidden	isHidden	boolean	Representa que o modelo está desativado.
solutions	solutions	array of OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2	Representa a propriedade de navegação para a coleção de soluções.
modelId	modelId	uuid	Representa a ID do modelo.
nome	name	string	Representa o nome do modelo.

OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

Nome	Caminho	Tipo	Description
descrição	description	string	Representa a descrição do modelo.
dateCreated	dateCreated	date-time	Representa DateTime quando o modelo foi criado.
createdById	createdById	uuid	Representa a UserId pela qual o modelo foi criado.
dateLastModified	dateLastModified	date-time	Representa DateTime quando o modelo foi modificado.
lastModifiedById	lastModifiedById	uuid	Representa a UserId pela qual o modelo foi modificado.
startDate	startDate	date-time	Representa DateTime quando o modelo foi iniciado.
data de término	endDate	date-time	Representa DateTime quando o modelo estava desatualizado.
isHidden	isHidden	boolean	Representa que o modelo está desativado.
modelId	modelId	uuid	Representa a ID do modelo.
nome	name	string	Representa o nome do modelo.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1

Nome	Caminho	Tipo	Description
originalObjectId	originalObjectId	uuid	A ID do objeto original.
currentVersionNumber	currentVersionNumber	integer	O número da versão atual do ModelItem.
status	status	OfficeArchitect.Contracts.ModelItem.ModelItemStatus	O status do item de modelo.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Nome	Caminho	Tipo	Description
originalObjectId	originalObjectId	uuid	A ID do objeto original.
currentVersionNumber	currentVersionNumber	integer	O número da versão atual do ModelItem.

OfficeArchitect.Contracts.OData.Model.Object_Level0

Entidade do objeto OData.

Nome	Caminho	Tipo	Description
objectType	objectType	OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1	Representa a entidade de tipo de objeto.
lockedBy	lockedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Auditar Usuário.
detail	detail	OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1
approvalDetails	approvalDetails	OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
modelo	model	OfficeArchitect.Contracts.OData.Model.Model_Level1	Model.
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Auditar Usuário.
objectId	objectId	uuid	Guid ObjectId.
nome	name	string	Nome da cadeia de caracteres.
objectTypeId	objectTypeId	uuid	Guid ObjectTypeId.
lockedOn	lockedOn	date-time	Data bloqueada.
lockedById	lockedById	uuid	ID do usuário LockedBy.
isApproved	isApproved	boolean	Aprovado.
relatedObjects	relatedObjects	array of OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2	lista virtual 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.
data_da_última modificação	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
attributeValues	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Listar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level1

Entidade do objeto OData.

Nome	Caminho	Tipo	Description
objectType	objectType	OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2	Representa a entidade de tipo de objeto.
lockedBy	lockedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
detail	detail	OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2
approvalDetails	approvalDetails	OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
modelo	model	OfficeArchitect.Contracts.OData.Model.Model_Level2	Model.
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
objectId	objectId	uuid	Guid ObjectId.
nome	name	string	Nome da cadeia de caracteres.
objectTypeId	objectTypeId	uuid	Guid ObjectTypeId.
lockedOn	lockedOn	date-time	Data bloqueada.
lockedById	lockedById	uuid	ID do usuário LockedBy.
isApproved	isApproved	boolean	Aprovado.
relatedObjects	relatedObjects	array of OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2	lista virtual 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.
data_da_última modificação	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
attributeValues	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Listar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level2

Entidade do objeto OData.

Nome	Caminho	Tipo	Description
objectId	objectId	uuid	Guid ObjectId.
nome	name	string	Nome da cadeia de caracteres.
objectTypeId	objectTypeId	uuid	Guid ObjectTypeId.
lockedOn	lockedOn	date-time	Data bloqueada.
lockedById	lockedById	uuid	ID do usuário LockedBy.
isApproved	isApproved	boolean	Aprovado.
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
data_da_última modificação	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

Objeto relacionado.

Nome	Caminho	Tipo	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

Nome	Caminho	Tipo	Description
originalRelationshipId	originalRelationshipId	uuid	A ID da relação original.
currentVersionNumber	currentVersionNumber	integer	O número da versão atual do ModelItem.
status	status	OfficeArchitect.Contracts.ModelItem.ModelItemStatus	O status do item de modelo.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Nome	Caminho	Tipo	Description
originalRelationshipId	originalRelationshipId	uuid	A ID da relação original.
currentVersionNumber	currentVersionNumber	integer	O número da versão atual do ModelItem.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Relação.

Nome	Caminho	Tipo	Description
leadObject	leadObject	OfficeArchitect.Contracts.OData.Model.Object_Level1	Entidade do objeto OData.
leadRelationship	leadRelationship	OfficeArchitect.Contracts.OData.Model.Relationship_Level1	Relação.
memberObject	memberObject	OfficeArchitect.Contracts.OData.Model.Object_Level1	Entidade do objeto OData.
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
modelo	model	OfficeArchitect.Contracts.OData.Model.Model_Level1	Model.
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1	Auditar Usuário.
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	ID do par de tipo de relação.
isApproved	isApproved	boolean	Aprovado.
attributeValuesFlat	attributeValuesFlat	OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
data_da_última modificação	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
attributeValues	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Listar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relação.

Nome	Caminho	Tipo	Description
leadObject	leadObject	OfficeArchitect.Contracts.OData.Model.Object_Level2	Entidade do objeto OData.
leadRelationship	leadRelationship	OfficeArchitect.Contracts.OData.Model.Relationship_Level2	Relação.
memberObject	memberObject	OfficeArchitect.Contracts.OData.Model.Object_Level2	Entidade do objeto OData.
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
modelo	model	OfficeArchitect.Contracts.OData.Model.Model_Level2	Model.
createdBy	createdBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
lastModifiedBy	lastModifiedBy	OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2	Auditar Usuário.
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	ID do par de tipo de relação.
isApproved	isApproved	boolean	Aprovado.
attributeValuesFlat	attributeValuesFlat	OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
data_da_última modificação	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.
attributeValues	attributeValues	array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2	Listar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relação.

Nome	Caminho	Tipo	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	ID do par de tipo de relação.
isApproved	isApproved	boolean	Aprovado.
modelId	modelId	uuid	Guid ModelId.
dateCreated	dateCreated	date-time	DateTime? DateCreated.
createdById	createdById	uuid	Guid CreatedById.
data_da_última modificação	lastModifiedDate	date-time	DateTime? LastModifiedDate.
lastModifiedById	lastModifiedById	uuid	Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar Usuário.

Nome	Caminho	Tipo	Description
userId	userId	uuid	Guid UserId.
nome	name	string	Nome da cadeia de caracteres.
endereço de email	emailAddress	string	string EmailAddress.
isInactive	isInactive	boolean	Bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar Usuário.

Nome	Caminho	Tipo	Description
userId	userId	uuid	Guid UserId.
nome	name	string	Nome da cadeia de caracteres.
endereço de email	emailAddress	string	string EmailAddress.
isInactive	isInactive	boolean	Bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Modelo que representa a criação de resposta de operação de objeto.

Nome	Caminho	Tipo	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
sucesso	success	boolean	Indica o êxito da operação.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Mensagens de resposta.

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Modelo que representa a resposta da operação de exclusão de objeto.

Nome	Caminho	Tipo	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
sucesso	success	boolean	Indica o êxito da operação.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Mensagens de resposta.

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Modelo que representa a resposta da operação de objeto de atualização.

Nome	Caminho	Tipo	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
sucesso	success	boolean	Indica o êxito da operação.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Mensagens de resposta.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Nome	Caminho	Tipo	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
sucesso	success	boolean	Indica o êxito da operação.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Mensagens de resposta.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Nome	Caminho	Tipo	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
sucesso	success	boolean	Indica o êxito da operação.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Mensagens de resposta.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Nome	Caminho	Tipo	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
sucesso	success	boolean	Indica o êxito da operação.
messages	messages	array of OfficeArchitect.Contracts.Message.Message_Level1	Mensagens de resposta.

OfficeArchitect.Contracts.Response.EntityType

: string

OfficeArchitect.Contracts.Response.OperationType

: string

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

Representa informações adicionais às quais os formatos OData dão suporte. É apenas para fins de documentação do Swagger.

Nome	Caminho	Tipo	Description
@odata.context	@odata.context	string	O link para o Contexto do Odata.
value	value	array of OfficeArchitect.Contracts.OData.Model.Object_Level0	Obtém a coleção de entidades para este feed.
@odata.nextLink	@odata.nextLink	uri	Obtém o link para a próxima página de valores no feed.
@odata.count	@odata.count	integer	Obtém a contagem total de valores no feed.

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

Representa informações adicionais às quais os formatos OData dão suporte. É apenas para fins de documentação do Swagger.

Nome	Caminho	Tipo	Description
@odata.context	@odata.context	string	O link para o Contexto do Odata.
value	value	array of OfficeArchitect.Contracts.OData.Model.Relationship_Level0	Obtém a coleção de entidades para este feed.
@odata.nextLink	@odata.nextLink	uri	Obtém o link para a próxima página de valores no feed.
@odata.count	@odata.count	integer	Obtém a contagem total de valores no feed.

Compartilhar via

OrbusInfinity

Conector OrbusInfinity

Pré-requisitos

Authentication

Operações com suporte

Objetos

Obtenção de objetos

Parâmetros

Responses

Postagem de objetos

Parâmetros

Descrições detalhadas

Responses

Objetos Get Single

Parâmetros

Responses

Exclusão de objetos

Parâmetros

Responses

Patch de objetos

Parâmetros

Responses

Relationships

Obtenção de Relações

Parâmetros

Descrições detalhadas

Responses

Postagem de Relações

Parâmetros

Responses

Relações Ficam Individuais

Parâmetros

Responses

Exclusão de relações

Parâmetros

Responses

Patch de relações

Parâmetros

Responses

Webhooks

Post Webhooks

Parâmetros

Responses

Excluir Webhooks

Parâmetros

Responses

Schemas

WebhookSaved

Propriedades

ObjectCreated

Propriedades

ObjectDeleted

Propriedades

ObjectUpdated

Propriedades

RelationshipCreated

Propriedades

RelationshipDeleted

Propriedades

RelationshipUpdated

Propriedades

MessageCategory

MessageCode

Message

Propriedades

OperationMessage.WebhookSaved

Propriedades

OperationMessage.ObjectCreated

Propriedades

OperationMessage.ObjectDeleted

Propriedades

OperationMessage.ObjectUpdated

Propriedades

OperationMessage.RelationshipCreated

Propriedades

OperationMessage.RelationshipDeleted

Propriedades

OperationMessage.RelationshipUpdated

Propriedades