Partilhar via


OrbusInfinito

O OrbusInfinity permite que as equipes de arquitetura gerem um plano digital da empresa e tomem decisões informadas com base em uma visão unificada do negócio agora e no futuro. Crie automações personalizadas para criar, ler e atualizar objetos e relacionamentos em seu repositório de dados.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - 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
Editora Orbus Software
Sítio Web https://www.orbussoftware.com
Política de privacidade https://www.orbussoftware.com/privacy-policy
Categorias Sítio Web; Dados

Conector OrbusInfinity

O OrbusInfinity é uma verdadeira solução multilocatária SaaS que oferece a plataforma definitiva para permitir sua transformação digital.

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

O OrbusInfinity Connector é construído sobre a API OrbusInfinity e fornece operações para interagir convenientemente com a plataforma.

Editora: Orbus Software

Pré-requisitos

Para usar o conector, você precisa:

  • Plano Power Automate com acesso a conectores premium
  • Subscrição 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 suportadas

Funcionamento Description
Obter objetos Obter objetos e seus detalhes
Objetos Post Criar um novo objeto
Objetos ficam solteiros Obter detalhes de um objeto
Exclusão de objetos Excluir um objeto
Patch de objetos Atualizar valores de Atributo de um Objeto existente
Relacionamentos Obter Obter relacionamentos e seus detalhes
Publicações de Relacionamentos Criar uma nova relação
Relacionamentos ficam solteiros Obter detalhes de um relacionamento
Exclusão de relacionamentos Excluir um relacionamento
Patch de relacionamentos Atualizar valores de Atributo de um Relacionamento existente
Postar Webhooks Cria um gatilho com o evento solicitado
Excluir Webhooks Excluir um webhook existente

Objects

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

Obter 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 propriedades especificadas na saída.

Parâmetros

Nome In Tipo Obrigatório Description
$select consulta cadeia (de caracteres) false Um subconjunto de propriedades a serem incluídas para cada Objeto na resposta. Se deixadas em branco, as propriedades padrão serão retornadas.
$expand consulta cadeia (de caracteres) 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 (de caracteres) 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, IsApprovedModelIdDateCreatedCreatedByIdLockedById, . LastModifiedDateLastModifiedByIdDetailAttributeValuesObjectTypeModelCreatedByLastModifiedByLockedBy
O número mínimo e padrão de expressões é 0; o máximo — 100.
$orderby consulta cadeia (de caracteres) 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 inteiro(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, digite 20 para retornar 20 objetos que foram criados mais recentemente no OrbusInfinity.
$skip consulta inteiro(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, digite 20 para ignorar 20 objetos que foram criados mais recentemente no OrbusInfinity e retornar os próximos 50.
$count consulta Booleano false Se verdadeiro, a contagem total de objetos é 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.

Objetos Post

POST /odata/Objects

Criar um novo objeto

Você deve especificar ID do Tipo de Objeto, ID do Modelo e Atributo(s) de Identificação para o novo Objeto. Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor.

Parâmetro do corpo

Parâmetros

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

Descrições detalhadas

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

Responses

Criado um novo objeto. CreateObjectResponse

Objetos ficam solteiros

GET /odata/Objects({key})

Obter detalhes de um objeto

A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros OData opcionais para expandir propriedades adicionais e selecionar apenas 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 (de caracteres) false Um subconjunto de propriedades a serem incluídas para o objeto na resposta. Se deixadas em branco, as propriedades padrão serão retornadas.
$expand consulta cadeia (de caracteres) false As propriedades adicionais (juntamente com as padrão) a serem incluídas para o Object na resposta.
Além disso, você pode solicitar as seguintes propriedades: Model, ObjectType, RelatedObjects, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, ApprovalDetailsDetail.

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

Excluído 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 do 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 Valor(es) de atributo a ser atualizado para o objeto especificado. Para cada Atributo, especifique

Responses

Atualizado o objeto. UpdateObjectResponse

Relações

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

Relacionamentos Obter

GET /odata/Relationships

Obter relacionamentos 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 propriedades especificadas na saída.

Parâmetros

Nome In Tipo Obrigatório Description
incluemInterseccional consulta Booleano false Se verdadeiro, inclua Relações Interseccionais na saída.
$select consulta cadeia (de caracteres) false Um subconjunto de propriedades a serem incluídas para cada Relacionamento na resposta. Se deixadas em branco, as propriedades padrão serão retornadas.
$expand consulta cadeia (de caracteres) false As propriedades adicionais (juntamente com as padrão) a serem incluídas para cada Relacionamento na resposta.
Além disso, você pode solicitar as seguintes propriedades: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, Detail.
$filtro consulta cadeia (de caracteres) 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: , , , , , ModelLeadObjectId, , LeadRelationshipIdMemberObjectId, . DetailRelationshipTypeModelIdRelationshipTypeIdRelationshipId
O número mínimo e padrão de expressões é 0; o máximo — 100.
$orderby consulta cadeia (de caracteres) false A ordem em que Relationships é classificado 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 inteiro(int32) false A contagem dos Relacionamentos, que foram criados mais recentemente em OrbusInfinity, para incluir na resposta. O valor mínimo é 0; o máximo — 50.
Por exemplo, digite 20 para retornar 20 Relações que foram criadas mais recentemente no OrbusInfinity.
$skip consulta inteiro(int32) false A contagem dos Relacionamentos, que foram criados mais recentemente em OrbusInfinity, para excluir da resposta. O valor mínimo e padrão é 0; o máximo — 50.
Por exemplo, entre 20 para ignorar 20 Relações que foram criadas mais recentemente no OrbusInfinity e retorne as próximas 50.
$count consulta Booleano false Se verdadeiro, a contagem total de Relações é 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. As Relações Interseccionais têm um valor para LeadRelationshipId a propriedade, e as Relações regulares têm um valor para LeadObjectId a propriedade.

Responses

Retorna resposta dinâmica.

Publicações de Relacionamentos

POST /odata/Relationships

Criar uma nova relação

Você deve especificar ID do Tipo de Relacionamento, ID do Modelo, ID do Par do Tipo de Relacionamento, ID do Objeto Principal, ID do Objeto Membro e Atributo(s) de Identificação para o novo Relacionamento. Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor.

Parâmetro do corpo

Parâmetros

Nome In Tipo Obrigatório Description
body body CreateRelationshipRequestValue true Valores de propriedade para um novo Relacionamento. Especifique RelationshipTypeId, ModelId, RelationshipTypePairId, , LeadModelItemIdpara MemberModelItemId criar um Relacionamento.

Responses

Criou uma nova relação. CreateRelationshipResponse

Relacionamentos ficam solteiros

GET /odata/Relationships({key})

Obter detalhes de um relacionamento

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

Parâmetros

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

Responses

Retorna resposta dinâmica.

Exclusão de relacionamentos

DELETE /odata/Relationships({key})

Excluir um relacionamento

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

Parâmetros

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

Responses

Excluiu a relação. DeleteRelationshipResponse

Patch de relacionamentos

PATCH /odata/Relationships({key})

Atualizar valores de Atributo de um Relacionamento 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 do corpo

Parâmetros

Nome In Tipo Obrigatório Description
chave caminho string(uuid) true ID de um relacionamento no formato GUID, por exemplo 00000000-0000-0000-0000-000000000000.
body body UpdateRelationshipRequestValue true Valor(es) do(s) atributo(s) a ser atualizado(s) para a Relação especificada. Para cada Atributo, especifique

Responses

Atualizada a relação. UpdateRelationshipResponse

Webhooks

Operações para gerenciar Webhooks.

Postar Webhooks

POST /odata/Webhooks

Quando ocorre um evento

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

Parâmetro do 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 inteiro(int32) true O identificador webhook.

Responses

DeleteWebhookResponse

Schemas

WebhookSaved

Propriedades

Nome Tipo Obrigatório Restrições Description
webhookId inteiro(int32) false nenhuma Id de Webhook.

ObjectCreated

Propriedades

Nome Tipo Obrigatório Restrições Description
nome cadeia (de caracteres) false nenhuma Nome do objeto criado.
objectId string(uuid) false nenhuma Id do objeto criado.
modelId string(uuid) false nenhuma ID do modelo do objeto criado.
objectTypeId string(uuid) false nenhuma Id do tipo de objeto do objeto criado.

ObjectDeleted

Propriedades

Nome Tipo Obrigatório Restrições Description
objectId string(uuid) false nenhuma Id do objeto excluído.
objectName cadeia (de caracteres) false nenhuma Nome do objeto excluído.

ObjectUpdated

Propriedades

Nome Tipo Obrigatório Restrições Description
objectId string(uuid) false nenhuma id de um objeto.
nome cadeia (de caracteres) false nenhuma Nome de um objeto.

RelacionamentoCriado

Propriedades

Nome Tipo Obrigatório Restrições Description
relationshipId string(uuid) false nenhuma Id da relação.
leadObjectId string(uuid) false nenhuma Id do objeto principal do relacionamento.
leadRelationshipId string(uuid) false nenhuma Id do Lead Relationship do relacionamento. Usado para relações interseccionais.
memberObjectId string(uuid) false nenhuma Id do objeto membro do relacionamento.

RelacionamentoExcluído

Propriedades

Nome Tipo Obrigatório Restrições Description
deletedRelationshipId string(uuid) false nenhuma Id da relação excluída.

RelacionamentoAtualizado

Propriedades

Nome Tipo Obrigatório Restrições Description
relationshipId string(uuid) false nenhuma Id da relação.

MensagemCategoria

Valor
Erro
Advertência
Informação

Código da mensagem

Valor
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryInmatch
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
AtributosExcluídos
ObjectTypesDeleted
RelationshipTypesDeleted
DependentModelItemsExist
ModelItemsDoesNotHaveComponents
ModelItemIsNotComponentOfDocumentType
RelacionamentoPar MembrosNão SãoComponentesDeDocumento
MultipleDuplicateMetamodelItems
EntityIsAlreadyProtected
EntityIsAlreadyUnprotected
AttributeDoesNotExist
AttributeDoesNotExistByName
AttributeDoesNotExistByKey
AttributeNotAssignedToMetamodelItem
AttributeIsNotIdentifyingAttribute
AttributeNotInModellingSolution
AttributeAssignmentCannotBeEdited
IdentifyingAttributeAssignmentExists
InheritedAttributeAssignmentExists
MultipleDuplicateAttributes
AttributeCategoryIncompatibilidade
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
ModelosDesativado
ModelosAtivado
ModellingSolutionsAreNotUnique
IdentifyingAttributeCannotBeImportant
MultipleIdentifyingAttributeAssignments
AtributosSãoJáAtribuídos
MetamodelItemHasInstances
IdentifyingAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
UnableToAssignSystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AttributeChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
IdentifyingAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
ModellingSolutionDoesNotExist
ModelItemReuseDeletionRequired
ObjectIsReuse
ObjectIsVariant
ObjectIsReused
RelacionamentoExclusãoObrigatório
FeedbackDeletionRequired
ViewModellingSolutionIdsNotAllowedOnCollectionView
ViewMustBelongToAModellingSolution
AdHocViewsCannotContainRuntimeParameters
ViewDimensionsRequired
RastreabilidadeViewFilterSetMustContainFilters
TraceabilityViewFilterCannotHaveMoreColumns
ViewDimensionRequireGroups
ViewFilterGroupRequireViewFilters
ViewFilterGroupHasIncorrectPositions
InvalidViewDimensionCategories
ViewFilterCategoryNotAllowedInCollectionView
ViewFilterHasTooManyIdentifyingParameters
ViewFilterIsMissingIdentifyingParameters
ViewFilterHasTooManyRuntimeParameters
ViewFilterIsMissingRuntimeParameter
ViewFilterParameterValuesNotProvided
ViewFilterParameterValuesProvidedForRuntimeParameter
ViewFilterParameterValuesProvidedForNullOperatorParameter
ViewFilterParameterOperatorNotSupported
ViewFilterParameterCategoryNotSupported
ViewFilterParameterValueTextIsTooLong
MetamodelItemCategoryNotSupported
ViewModelIdParameterMustBeRuntime
ViewGenerationStorageExpiredOrEmpty
ViewGenerationStorageNotAvailableForSavedParameters
ViewDimensionDoesNotExist
ViewFilterParameterRuntimeAusente
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
ModelItemIsDesativada
ModelItemsActivatedDeactivated
ModelItemsDesativada
ModelItemsActivated
UserIsNotInApproversList
IdentifyingAttributeValueNotProvided
ObjectIsAlike
RelacionamentoIsAlike
LeadObjectDoesNotExist
LeadRelationshipDoesNotExist
MemberObjectDoesNotExist
NoValidRelationshipTypeExists
RelationshipTypePairDoesNotExist
ProtectedSolutionDoesNotContainLeadAndMember
RelationshipTypePairIsNotAssignedToRelationshipType
RelationshipTypePairIsDeactivated
RelationshipTypePairIsNotValid
UpdateSelfReferencePairInCaseOfHierarchicalDirectionDoesNotExist
DeleteSelfReferencePairInCaseOfHierarchicalDirectionDoesNotExist
DuplicateRelationshipTypePair
ObjectCapacityIsAproximando-se
ObjectCapacityIsAvailable
PermissionDeniedFeature
PermissionDeniedModel
PermissionDeniedModelItem
PermissionDeniedLeadModelItem
PermissionDeniedMemberModelItem
PermissionDeniedModelModelItem
PermissionDeniedModelMetamodelItem
PermissionDeniedDataImport
PersonNotInAnyRole
DependentModelItemsCannotBeUnlocked
PermissionDeniedModelAdministration
GroupDoesNotExist
PersonDoesNotExist
DuplicateGroupSpecified
DuplicatePersonSpecified
DuplicateMetamodelItemInModellingSolution
SolutionIsAssignedToModels
SolutionDoesNotExist
SoluçãoJá existe
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
DocumentosEliminados
SharePointSiteSet
DocumentosRegistados
DocumentTypeCreated
DocumentTypeDeleted
DocumentTypeUpdated
DocumentTypeTemplateFilesSaved
DocumentTypeMetamodelItemsSaved
AtributoAssigmentsSalvo
AttributeCreated
AttributeUpdated
ModelItemsReused
ModelItemsDeleted
ObjectCreated
ObjectUpdated
ObjetosCriados
ObjetosAtualizado
ObjectSkipped
ObjetosCopiados
ObjectDeleted
ObjetosExcluídos
ObjetosMesclados
ObjectReclassified
ObjetosReclassificados
ObjetosRelacionamentosMesclados
RelacionamentoCriado
RelacionamentosCriado
RelacionamentosCopiados
RelacionamentoAtualizado
RelacionamentosAtualizado
RelacionamentoExcluído
RelacionamentosExcluídos
RelacionamentoIgnorado
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
RelacionamentosMesclados
LeadToMemberDirectionEmpty
MembroToLeadDirectionEmpty
RepresentationSituationIsNotValid
IntersectionalRelationshipRepresentationIsNotValid
IntersectionalRelationshipTypeWithSamePairAlreadyExists
IntersectionalRelationshipTypeCannotHavePairsWithAnyLeadOrMember
RelacionamentoTipoHasNoPairs
DuplicateRelationshipTypeInModellingSolution
DocumentManagementSystemRecuperado
ObjectTypeCreated
SoluçãoCriada
SoluçãoEliminada
WebhookSaved
WebhookDeleted
MappedImportWorksheetSettingsCreated
MappedImportWorksheetSettingsUpdated
ModeloCopiado
ModelItemsCopiado
ModelItemLocked
ModelItemUnlocked
ModelItemApprovalRequested
ModelItemApprovalRequestCompleted
ModelItemsNotApprovable
ModelCreated
ModeloAtualizado
NotificationCreated
NotificationDataHasIncorrectType
NotificationEndDatePrecedesStartDate
BothNotificationProgressCountsAndPercentAreSet
NotificaçõesEliminado
NotificaçõesPurgado
NotificaçõesLeia
NotificaçõesReadAll
NotificaçõesAtualizado
RelationshipTypeUpdated
RelationshipTypeCreated
RelationshipTypesCreated
RelationshipTypePairUpdated
RelationshipTypePairsCreated
DocumentoCriado
DocumentoAtualizado
DocumentCounterpartAssigned
DocumentoContraparteNão atribuído
DocumentoContrapartesExcluído
DocumentoContrapartesCriado
DocumentoContrapartidasAtualizado
DocumentoContrapartesReatribuído
DocumentFilePathIsInvalid
DocumentModelRootPathIsNotValid
DocumentFilePathIsTooLong
DocumentFilenameRequiresFileExtension
DocumentFilenameContainsInvalidCharacters
DocumentFileExtensionNotSupportedForCategory
DocumentFileExtensionNotSupportedForCustomCategory
DocumentFileExtensionNotSupportedForFileTypeFilter
DocumentoJá existe
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
EntidadesProteçãoEstadoAplicado
MetamodelItemApprovalInformationHasChanged
DocumentHasDifferentDocumentType
ExternalDocumentDoesNotHaveExternalDocumentId
LeadRelationshipTypeDoesNotExist
IntersectionalRelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageIsNotValid
MetamodelItemDesativada
MetamodelItemsDesativada
DescriçãoÉInválido
RelationshipTypePairActivated
RelationshipTypePairsActivated
RelationshipTypePairDeactivated
RelationshipTypePairsDesativada
MetamodelItemActivated
MetamodelItemsActivated
FailedToSaveRelationshipTypeConnectedToDetails
MemberModelItemIsNotObject
LeadModelItemIsNotObject
LeadModelItemIsNotRelationship
Espaço de trabalhocriado
Espaços de trabalhoCriado
WorkspaceCapacityIsExceeded
WorkspaceNameIsNotUnique
Espaço de trabalhoAtualizado
Espaços de trabalhoAtualizado
WorkspaceDoesNotExist
ComandosValidados
Espaço de trabalhoExcluído
Espaços de trabalhoExcluído
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculado
PreçosTierIsNotValid
PermissãoNegada
Erro Interno do Servidor
Pedido Inválido
Não Encontrado
Proibido
PedidoAceito
SubstituirTodos

Message

Propriedades

Nome Tipo Obrigatório Restrições Description
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.WebhookSaved

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition WebhookSaved false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.ObjectCreated

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition ObjectCreated false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.ObjectDeleted

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition ObjectDeleted false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.ObjectUpdated

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition ObjectUpdated false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.RelationshipCreated

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition RelacionamentoCriado false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.RelationshipDeleted

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition RelacionamentoExcluído false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

OperationMessage.RelationshipUpdated

Propriedades

Nome Tipo Obrigatório Restrições Description
messageDefinition RelacionamentoAtualizado false nenhuma nenhuma
messageCategory MensagemCategoria false nenhuma Indica o tipo de mensagem.
Código da mensagem Código da mensagem false nenhuma nenhuma
mensagem cadeia (de caracteres) false só de leitura Conteúdo da mensagem.

CreateWebhookRequest

Propriedades

Nome Tipo Obrigatório Restrições Description
segredo cadeia (de caracteres) false nenhuma Segredo do recetor.
eventType cadeia (de caracteres) true nenhuma Tipo de evento de assinatura.
URL cadeia (de caracteres) true nenhuma URL do recetor.
Data de expiração string(data-hora) false nenhuma 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 Restrições Description
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

SaveWebhookResponse

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.WebhookSaved false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

CreateObjectRequestValue

Propriedades

Nome Tipo Obrigatório Restrições Description
objectTypeId string(uuid) true nenhuma ID do tipo de objeto.
attributeValuesFlat objecto false nenhuma Pares de valores-chave de valores de Atributo.
additionalProperties any false nenhuma nenhuma
modelId string(uuid) true nenhuma ID do modelo.

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

UpdateObjectRequestValue

Propriedades

Nome Tipo Obrigatório Restrições Description
attributeValuesFlat objecto false nenhuma Pares de valores-chave de valores de atributos.

CreateObjectResponse

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.ObjectCreated false nenhuma nenhuma
operationType Tipo de operação false nenhuma nenhuma
entityTypes Tipo de entidade false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

DeleteObjectResponse

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

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.ObjectDeleted false nenhuma nenhuma
operationType Tipo de operação false nenhuma nenhuma
entityTypes Tipo de entidade false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

UpdateObjectResponse

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

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.ObjectUpdated false nenhuma nenhuma
operationType Tipo de operação false nenhuma nenhuma
entityTypes Tipo de entidade false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

CreateRelationshipRequestValue

Propriedades

Nome Tipo Obrigatório Restrições Description
relationshipTypeId string(uuid) true nenhuma ID do tipo de relação.
relationshipTypePairId string(uuid) false nenhuma Se do tipo de relação par.
leadModelItemId string(uuid) true nenhuma Id do item do modelo de lead do relacionamento.
memberModelItemId string(uuid) true nenhuma Id do item de modelo de membro do relacionamento.
attributeValuesFlat objecto false nenhuma nenhuma
modelId string(uuid) true nenhuma ID do modelo.

UpdateRelationshipRequestValue

Propriedades

Nome Tipo Obrigatório Restrições Description
attributeValuesFlat objecto false nenhuma nenhuma

CreateRelationshipResponse

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.RelationshipCreated false nenhuma nenhuma
operationType Tipo de operação false nenhuma nenhuma
entityTypes Tipo de entidade false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

DeleteRelationshipResponse

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.RelationshipDeleted false nenhuma nenhuma
operationType Tipo de operação false nenhuma nenhuma
entityTypes Tipo de entidade false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

UpdateRelationshipResponse

Propriedades

Nome Tipo Obrigatório Restrições Description
sucessoMensagem OperationMessage.RelationshipUpdated false nenhuma nenhuma
operationType Tipo de operação false nenhuma nenhuma
entityTypes Tipo de entidade false nenhuma nenhuma
sucesso Booleano false nenhuma Indica o sucesso da operação.
messages Message false só de leitura Mensagens de resposta.

Tipo de entidade

Valor
Nenhum
Solução
Tipo de objeto
Tipo de Relacionamento
RelationshipTypePair
Attribute
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Modelo
Objeto
Relacionamento
Documento
DocumentComponent
Espaço de trabalho
Funções

OperationType

Valor
Criar
Atualização
Suprimir

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) URL da API OrbusInfinity. Por exemplo: https://example-api.orbusinfinity.com Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de 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 um Relacionamento 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 ID do Tipo de Objeto, ID do Modelo e Atributo(s) de Identificação 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 Relacionamento, ID do Modelo, ID do Par do Tipo de Relacionamento, ID do Objeto Principal, ID do Objeto Membro e Atributo(s) de Identificação para o novo Relacionamento. 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 um relacionamento

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 OData opcionais para expandir propriedades adicionais e selecionar apenas propriedades especificadas.

Obter detalhes de um relacionamento

A resposta padrão inclui apenas propriedades de nível superior. Use parâmetros OData opcionais para expandir propriedades adicionais e selecionar apenas 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 propriedades especificadas na saída.

Obter relacionamentos 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 propriedades especificadas na saída.

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âmetros

Name Chave Necessá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-chave de valores de atributos.

Devoluções

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

Atualizar valores de Atributo de um Relacionamento existente

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

Parâmetros

Name Chave Necessário Tipo Description
chave
key True uuid

ID de um relacionamento no formato GUID, por exemplo 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Devoluções

Criar um novo objeto

Você deve especificar ID do Tipo de Objeto, ID do Modelo e Atributo(s) de Identificação para o novo Objeto. Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor.

Parâmetros

Name Chave Necessário Tipo Description
objectTypeId
objectTypeId True uuid

ID do tipo de objeto.

attributeValuesFlat
attributeValuesFlat object

Pares de valores-chave de valores de Atributo.

modelId
modelId True uuid

ID do modelo.

Devoluções

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

Criar uma nova relação

Você deve especificar ID do Tipo de Relacionamento, ID do Modelo, ID do Par do Tipo de Relacionamento, ID do Objeto Principal, ID do Objeto Membro e Atributo(s) de Identificação para o novo Relacionamento. Use AttributeValuesFlat a propriedade para especificar valores de atributo no formato chave-valor.

Parâmetros

Name Chave Necessário Tipo Description
relationshipTypeId
relationshipTypeId True uuid

ID do tipo de relação.

relationshipTypePairId
relationshipTypePairId uuid

Se do tipo de relação par.

leadModelItemId
leadModelItemId True uuid

Id do item do modelo de lead do relacionamento.

memberModelItemId
memberModelItemId True uuid

Id do item de modelo de membro do relacionamento.

attributeValuesFlat
attributeValuesFlat object
modelId
modelId True uuid

ID do modelo.

Devoluções

Excluir um objeto

O objeto excluído é movido para a Lixeira.

Parâmetros

Name Chave Necessário Tipo Description
chave
key True uuid

ID de um objeto no formato GUID, por exemplo 00000000-0000-0000-0000-000000000000.

Devoluções

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

Excluir um relacionamento

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

Parâmetros

Name Chave Necessário Tipo Description
chave
key True uuid

ID de um relacionamento no formato GUID, por exemplo 00000000-0000-0000-0000-000000000000.

Devoluções

Obter detalhes de um objeto

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

Parâmetros

Name Chave Necessá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 deixadas 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 Object na resposta.
Além disso, você pode solicitar as seguintes propriedades: Model, ObjectType, RelatedObjects, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, ApprovalDetailsDetail.

Devoluções

Entidade de objeto OData.

Obter detalhes de um relacionamento

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

Parâmetros

Name Chave Necessário Tipo Description
chave
key True uuid

ID de um relacionamento no formato GUID, por exemplo 00000000-0000-0000-0000-000000000000.

$select
$select string

Um subconjunto de propriedades a serem incluídas para o Relacionamento na resposta. Se deixadas 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 Relacionamento na resposta.
Além disso, você pode solicitar as seguintes propriedades: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, ApprovalDetailsDetail.

Devoluções

Relacionamento.

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 propriedades especificadas na saída.

Parâmetros

Name Chave Necessário Tipo Description
$select
$select string

Um subconjunto de propriedades a serem incluídas para cada Objeto na resposta. Se deixadas 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, IsApprovedModelIdDateCreatedCreatedByIdLockedById, . LastModifiedDateLastModifiedByIdDetailAttributeValuesObjectTypeModelCreatedByLastModifiedByLockedBy
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, digite 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, digite 20 para ignorar 20 objetos que foram criados mais recentemente no OrbusInfinity e retornar os próximos 50.

$count
$count boolean

Se verdadeiro, a contagem total de objetos é especificada na resposta. Por padrão, o parâmetro é definido como false, o que significa que a contagem total não é retornada.

Devoluções

Representa informações adicionais suportadas pelos formatos OData. É apenas para fins de documentação swagger.

Obter relacionamentos 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 propriedades especificadas na saída.

Parâmetros

Name Chave Necessário Tipo Description
incluemInterseccional
includeIntersectional boolean

Se verdadeiro, inclua Relações Interseccionais na saída. As Relações Interseccionais têm um valor para LeadRelationshipId a propriedade, e as Relações regulares têm um valor para LeadObjectId a propriedade.

$select
$select string

Um subconjunto de propriedades a serem incluídas para cada Relacionamento na resposta. Se deixadas 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 Relacionamento 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: , , , , , ModelLeadObjectId, , LeadRelationshipIdMemberObjectId, . DetailRelationshipTypeModelIdRelationshipTypeIdRelationshipId
O número mínimo e padrão de expressões é 0; o máximo — 100.

$orderby
$orderby string

A ordem em que Relationships é classificado 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 dos Relacionamentos, que foram criados mais recentemente em OrbusInfinity, para incluir na resposta. O valor mínimo é 0; o máximo — 50.
Por exemplo, digite 20 para retornar 20 Relações que foram criadas mais recentemente no OrbusInfinity.

$skip
$skip integer

A contagem dos Relacionamentos, que foram criados mais recentemente em OrbusInfinity, para excluir da resposta. O valor mínimo e padrão é 0; o máximo — 50.
Por exemplo, entre 20 para ignorar 20 Relações que foram criadas mais recentemente no OrbusInfinity e retorne as próximas 50.

$count
$count boolean

Se verdadeiro, a contagem total de Relações é especificada na resposta. Por padrão, o parâmetro é definido como false, o que significa que a contagem total não é retornada.

Devoluções

Representa informações adicionais suportadas pelos formatos OData. É apenas para fins de documentação swagger.

Acionadores

Quando ocorre um evento

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

Quando ocorre um evento

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

Parâmetros

Name Chave Necessário Tipo Description
segredo
secret string

Segredo do recetor.

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 expiração for fornecida, um valor por padrão será usado (normalmente 6 meses após a data de criação).

Devoluções

Definições

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Name Caminho Tipo Description
object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Name 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

Name 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

Name Caminho Tipo Description
objectId
objectId uuid

id de um objeto.

nome
name string

Nome de um objeto.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Name Caminho Tipo Description
relationshipId
relationshipId uuid

Id da relação.

leadObjectId
leadObjectId uuid

Id do objeto principal do relacionamento.

leadRelationshipId
leadRelationshipId uuid

Id do Lead Relationship do relacionamento. Usado para relações interseccionais.

memberObjectId
memberObjectId uuid

Id do objeto membro do relacionamento.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Name Caminho Tipo Description
deletedRelationshipId
deletedRelationshipId uuid

Id da relação excluída.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Name Caminho Tipo Description
relationshipId
relationshipId uuid

Id da relação.

OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Indica o tipo de mensagem.

OfficeArchitect.Contracts.Message.MessageCode

OfficeArchitect.Contracts.Message.Message_Level1

Name Caminho Tipo Description
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
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

Name Caminho Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
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

Name Caminho Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
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

Name Caminho Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
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

Name Caminho Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
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

Name Caminho Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
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

Name Caminho Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica o tipo de mensagem.

Código da mensagem
messageCode OfficeArchitect.Contracts.Message.MessageCode
mensagem
message string

Conteúdo da mensagem.

OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation

OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage

OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors

OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

O status do item de modelo.

O status do item de modelo.

OfficeArchitect.Contracts.Notification.WebhookPayload

Name Caminho Tipo Description
identificadores
ids array of
eventType
eventType string
segredo
secret string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Name 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 atributos.

posição
position integer

Representa a posição do Grupo de Atribuição de Atributos.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Atribuição de Atributos.

Name Caminho Tipo Description
attributeAssignmentId
attributeAssignmentId uuid

ID de 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.

isHerdado
isInherited boolean

bool IsInherited.

isDisplay
isDisplay boolean

bool IsDisplay.

isImportant
isImportant boolean

bool éImportante.

groupName
groupName string

cadeia de caracteres GroupName.

posição
position integer

int Posição.

estado ativo
activeState boolean

bool ActiveState.

stringDefaultValue
stringDefaultValue string

string 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

Name 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.

nome_da-pessoa
personName string

Obtém ou define o nome da pessoa.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

Solução MetamodelItem.

Name 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 Object Type.

Name Caminho Tipo Description
criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

parentObjectType
parentObjectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa a entidade Object Type.

objectTypeId
objectTypeId uuid

Representa a id do tipo de objeto.

parentObjectTypeId
parentObjectTypeId uuid

Representa a referência a Parent Object Type Id.

dateCriado
dateCreated date-time

Representa DateTime quando o tipo de objeto foi criado.

createdById
createdById uuid

Representa o UserId pelo qual o tipo de objeto foi criado.

dateLastModified
dateLastModified date-time

Representa DateTime quando o tipo de objeto foi modificado.

lastModifiedById
lastModifiedById uuid

Representa o UserId pelo qual o tipo de objeto foi modificado.

estado ativo
activeState boolean

Representa se o Tipo de Objeto está no estado ativo.

isAprovável
isApprovable boolean

Representa se o Tipo de objeto é aprová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 navigation para a coleção de soluções.

atributoAtribuições
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 Atributos.

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.

defaultAprovadores
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 de metamodelo.

nome
name string

Obtém ou define o nome do item de metamodelo.

descrição
description string

Obtém ou define a descrição do item de metamodelo.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa a entidade Object Type.

Name Caminho Tipo Description
objectTypeId
objectTypeId uuid

Representa a id do tipo de objeto.

parentObjectTypeId
parentObjectTypeId uuid

Representa a referência a Parent Object Type Id.

dateCriado
dateCreated date-time

Representa DateTime quando o tipo de objeto foi criado.

createdById
createdById uuid

Representa o UserId pelo qual o tipo de objeto foi criado.

dateLastModified
dateLastModified date-time

Representa DateTime quando o tipo de objeto foi modificado.

lastModifiedById
lastModifiedById uuid

Representa o UserId pelo qual o tipo de objeto foi modificado.

estado ativo
activeState boolean

Representa se o Tipo de Objeto está no estado ativo.

isAprovável
isApprovable boolean

Representa se o Tipo de objeto é aprovável.

alias
alias string

Obtém ou define o alias do item de metamodelo.

nome
name string

Obtém ou define o nome do item de metamodelo.

descrição
description string

Obtém ou define a descrição do item de metamodelo.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

Par RelationshipType.

Name 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 do tipo de relação de lead.

estado ativo
activeState boolean

bool ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

Name Caminho Tipo Description
criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

dateCriado
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.

isAprovável
isApprovable boolean

Representa se o RelationshipType é aprovável.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

membroToLeadDirection
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.

atributoAtribuições
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 Atributos.

defaultAprovadores
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 de metamodelo.

nome
name string

Obtém ou define o nome do item de metamodelo.

descrição
description string

Obtém ou define a descrição do item de metamodelo.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

Name Caminho Tipo Description
relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

dateCriado
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.

isAprovável
isApprovable boolean

Representa se o RelationshipType é aprovável.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

membroToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

alias
alias string

Obtém ou define o alias do item de metamodelo.

nome
name string

Obtém ou define o nome do item de metamodelo.

descrição
description string

Obtém ou define a descrição do item de metamodelo.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Name Caminho Tipo Description
valor
value double

Valor decimal.

stringValue
stringValue string

string StringValue.

attributeValueId
attributeValueId integer

longo 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 Caminho Tipo Description
object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Name Caminho Tipo Description
isAprovável
isApprovable boolean
isPendingReview
isPendingReview boolean
solicitadoPor
requestedBy uuid
solicitadoEm
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
concluídoPor
completedBy uuid
concluídoEm
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
comentário
comment string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Name Caminho Tipo Description
isAprovável
isApprovable boolean
isPendingReview
isPendingReview boolean
solicitadoPor
requestedBy uuid
solicitadoEm
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
concluídoPor
completedBy uuid
concluídoEm
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
comentário
comment string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Name 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.

Name Caminho Tipo Description
criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

descrição
description string

Representa a Descrição do modelo.

dateCriado
dateCreated date-time

Representa DateTime quando o modelo foi criado.

createdById
createdById uuid

Representa o UserId pelo qual o modelo foi criado.

dateLastModified
dateLastModified date-time

Representa DateTime quando o modelo foi modificado.

lastModifiedById
lastModifiedById uuid

Representa o UserId pelo 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 navigation 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.

Name Caminho Tipo Description
descrição
description string

Representa a Descrição do modelo.

dateCriado
dateCreated date-time

Representa DateTime quando o modelo foi criado.

createdById
createdById uuid

Representa o UserId pelo qual o modelo foi criado.

dateLastModified
dateLastModified date-time

Representa DateTime quando o modelo foi modificado.

lastModifiedById
lastModifiedById uuid

Representa o UserId pelo 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

Name Caminho Tipo Description
originalObjectId
originalObjectId uuid

A id do objeto original.

currentVersionNumber
currentVersionNumber integer

O número da versão atual do ModelItem.

estado
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

O status do item de modelo.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Name 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 de objeto OData.

Name Caminho Tipo Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Representa a entidade Object Type.

bloqueado por
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Usuário de auditoria.

detail
detail OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1
aprovaçãoDetalhes
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
modelo
model OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Usuário de auditoria.

objectId
objectId uuid

Guid ObjectId.

nome
name string

Nome da cadeia de caracteres.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

bloqueado
lockedOn date-time

Data de bloqueio.

lockedById
lockedById uuid

Bloqueado por ID de usuário.

isAprovado
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.

dateCriado
dateCreated date-time

DateTime? DataCriada.

createdById
createdById uuid

Guid CreatedById.

dataÚltimaModificaçã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 de objeto OData.

Name Caminho Tipo Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa a entidade Object Type.

bloqueado por
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

detail
detail OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2
aprovaçãoDetalhes
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
modelo
model OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

objectId
objectId uuid

Guid ObjectId.

nome
name string

Nome da cadeia de caracteres.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

bloqueado
lockedOn date-time

Data de bloqueio.

lockedById
lockedById uuid

Bloqueado por ID de usuário.

isAprovado
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.

dateCriado
dateCreated date-time

DateTime? DataCriada.

createdById
createdById uuid

Guid CreatedById.

dataÚltimaModificaçã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 de objeto OData.

Name Caminho Tipo Description
objectId
objectId uuid

Guid ObjectId.

nome
name string

Nome da cadeia de caracteres.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

bloqueado
lockedOn date-time

Data de bloqueio.

lockedById
lockedById uuid

Bloqueado por ID de usuário.

isAprovado
isApproved boolean

é aprovado.

modelId
modelId uuid

Guid ModelId.

dateCriado
dateCreated date-time

DateTime? DataCriada.

createdById
createdById uuid

Guid CreatedById.

dataÚltimaModificação
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

Objeto relacionado.

Name Caminho Tipo Description
relationshipId
relationshipId uuid

Guid RelationshipId.

objectId
objectId uuid

Guid ObjectId.

isChumbo
isLead boolean

bool IsLead.

relatedObjectId
relatedObjectId uuid

Guid RelatedObjectId.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1

Name Caminho Tipo Description
originalRelationshipId
originalRelationshipId uuid

O id de relacionamento original.

currentVersionNumber
currentVersionNumber integer

O número da versão atual do ModelItem.

estado
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

O status do item de modelo.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Name Caminho Tipo Description
originalRelationshipId
originalRelationshipId uuid

O id de relacionamento original.

currentVersionNumber
currentVersionNumber integer

O número da versão atual do ModelItem.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Relacionamento.

Name Caminho Tipo Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Entidade de objeto OData.

leadRelacionamento
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relacionamento.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Entidade de objeto OData.

relationshipType
relationshipType OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

detail
detail OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1
aprovaçãoDetalhes
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1
modelo
model OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Usuário de auditoria.

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 do tipo de relacionamento.

isAprovado
isApproved boolean

é aprovado.

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

Guid ModelId.

dateCriado
dateCreated date-time

DateTime? DataCriada.

createdById
createdById uuid

Guid CreatedById.

dataÚltimaModificaçã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

Relacionamento.

Name Caminho Tipo Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Entidade de objeto OData.

leadRelacionamento
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relacionamento.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Entidade de objeto OData.

relationshipType
relationshipType OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

detail
detail OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2
aprovaçãoDetalhes
approvalDetails OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2
modelo
model OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

criado por
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

última modificação por
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

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 do tipo de relacionamento.

isAprovado
isApproved boolean

é aprovado.

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

Guid ModelId.

dateCriado
dateCreated date-time

DateTime? DataCriada.

createdById
createdById uuid

Guid CreatedById.

dataÚltimaModificaçã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

Relacionamento.

Name 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 do tipo de relacionamento.

isAprovado
isApproved boolean

é aprovado.

modelId
modelId uuid

Guid ModelId.

dateCriado
dateCreated date-time

DateTime? DataCriada.

createdById
createdById uuid

Guid CreatedById.

dataÚltimaModificação
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Usuário de auditoria.

Name Caminho Tipo Description
userId
userId uuid

Guid UserId.

nome
name string

Nome da cadeia de caracteres.

endereço de e-mail
emailAddress string

string EmailAddress.

isInativo
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Usuário de auditoria.

Name Caminho Tipo Description
userId
userId uuid

Guid UserId.

nome
name string

Nome da cadeia de caracteres.

endereço de e-mail
emailAddress string

string EmailAddress.

isInativo
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

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

Name Caminho Tipo Description
sucessoMensagem
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 sucesso 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 do objeto.

Name Caminho Tipo Description
sucessoMensagem
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 sucesso 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 do objeto de atualização.

Name Caminho Tipo Description
sucessoMensagem
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 sucesso da operação.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensagens de resposta.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Name Caminho Tipo Description
sucessoMensagem
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 sucesso da operação.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensagens de resposta.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Name Caminho Tipo Description
sucessoMensagem
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 sucesso da operação.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensagens de resposta.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Name Caminho Tipo Description
sucessoMensagem
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 sucesso da operação.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensagens de resposta.

OfficeArchitect.Contracts.Response.EntityType

OfficeArchitect.Contracts.Response.OperationType

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

Representa informações adicionais suportadas pelos formatos OData. É apenas para fins de documentação swagger.

Name Caminho Tipo Description
@odata.CONTEXTO
@odata.context string

O link para Odata Context.

valor
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 suportadas pelos formatos OData. É apenas para fins de documentação swagger.

Name Caminho Tipo Description
@odata.CONTEXTO
@odata.context string

O link para Odata Context.

valor
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.