Compartir a través de


OrbusInfinity

OrbusInfinity permite a los equipos de arquitectura generar un plano técnico digital de la empresa y tomar decisiones fundamentadas basadas en una visión unificada de la empresa y en el futuro. Cree automatizaciones personalizadas para crear, leer y actualizar objetos y relaciones en el repositorio de datos.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Orbus Software
URL https://support.orbussoftware.com
Correo Electrónico support@orbussoftware.com
Metadatos del conector
Publicador Orbus Software
Sitio web https://www.orbussoftware.com
Directiva de privacidad https://www.orbussoftware.com/privacy-policy
Categorías Sitio web; Datos

Conector orbusInfinity

OrbusInfinity es una verdadera solución multiinquilino de SaaS que ofrece la plataforma definitiva para habilitar la transformación digital.

OrbusInfinity se integra directamente con Microsoft Office para permitirle vincular, intercambiar, visualizar y sincronizar datos fácilmente con el repositorio orbusInfinity.

El conector OrbusInfinity se basa en la API orbusInfinity y proporciona operaciones para interactuar cómodamente con la plataforma.

Publisher: Orbus Software

Prerrequisitos

Para usar el conector, necesita lo siguiente:

  • Plan de Power Automate con acceso a conectores Premium
  • Suscripción a OrbusInfinity que incluye el acceso a la API
  • Cuenta de OrbusInfinity

Autenticación

  • Autenticación de oAuth2 con flujo implícito
  • Debe autenticarse para realizar cualquier operación que aparezca a continuación.

Operaciones admitidas

Operation Description
Obtención de objetos Obtener objetos y sus detalles
Post de objetos Crear un nuevo objeto
Obtención de objetos únicos Obtener detalles de un objeto
Eliminación de objetos Eliminar un objeto
Revisión de objetos Actualizar valores de atributo de un objeto existente
Obtención de relaciones Obtener relaciones y sus detalles
Publicación de relaciones Crear una nueva relación
Obtención de relaciones únicas Obtener detalles de una relación
Eliminar relaciones Eliminar una relación
Revisión de relaciones Actualizar valores de atributo de una relación existente
Publicación de webhooks Crea un desencadenador con el evento solicitado.
Eliminación de webhooks Eliminación de un webhook existente

Objetos

Operaciones para configurar y administrar objetos de modelo.

Obtención de objetos

GET /odata/Objects

Obtener objetos y sus detalles

La respuesta predeterminada incluye la lista de 50 objetos, que se crearon más recientemente en OrbusInfinity y sus propiedades de nivel superior. Use los parámetros de OData siguientes para filtrar, ordenar, expandir propiedades adicionales y seleccionar solo las propiedades especificadas en la salida.

Parámetros

Nombre In Tipo Obligatorio Description
$select query cuerda / cadena false Subconjunto de propiedades que se van a incluir para cada objeto en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.
$expand query cuerda / cadena false Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para cada objeto en la respuesta.
Además, puede solicitar las siguientes propiedades: Model, , AttributeValuesObjectTypeAttributeValuesFlat, CreatedBy, LastModifiedBy, , LockedByDetail.
$filtro query cuerda / cadena false Expresión por la que se filtran los objetos en el resultado. Puede filtrar Objetos por un valor para las siguientes propiedades: ObjectId, , NameObjectTypeId, IsApprovedLockedByLastModifiedByCreatedByModelObjectTypeAttributeValuesDetailLastModifiedByIdCreatedByIdModelIdLastModifiedDateLockedOnLockedByIdDateCreated.
El número mínimo y predeterminado de expresiones es 0; máximo: 100.
$orderby query cuerda / cadena false Orden en el que los objetos se ordenan en la respuesta, mediante una propiedad seleccionada. Por ejemplo, escriba Name desc para solicitar objetos en orden descendente por propiedad Name.
El número mínimo y predeterminado de expresiones es 0; el máximo: 5.
$top query integer(int32) false Recuento de los objetos, que se crearon más recientemente en OrbusInfinity, para incluir en la respuesta. El valor mínimo es 0; máximo: 50.
Por ejemplo, escriba 20 para devolver 20 Objetos creados más recientemente en OrbusInfinity.
$skip query integer(int32) false Recuento de los objetos, que se crearon más recientemente en OrbusInfinity, para excluir de la respuesta. El valor mínimo y predeterminado es 0; máximo: 50.
Por ejemplo, escriba 20 para omitir 20 objetos creados más recientemente en OrbusInfinity y devolver los 50 siguientes.
$count query boolean false Si es true, el recuento total de objetos se especifica en la respuesta. De forma predeterminada, el parámetro se establece en false, lo que significa que no se devuelve el recuento total.

Responses

Devuelve la respuesta dinámica.

Post de objetos

POST /odata/Objects

Crear un nuevo objeto

Debe especificar el identificador de tipo de objeto, el identificador de modelo y los atributos de identificación para el nuevo objeto. Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor.

Parámetro body

Parámetros

Nombre In Tipo Obligatorio Description
body body CreateObjectRequestValue true Valores de propiedad para un nuevo objeto. Especifique ObjectTypeId, ModelIdpara Name crear un objeto .

Descripciones detalladas

body: valores de propiedad para un nuevo objeto. Especifique ObjectTypeId, ModelIdpara Name crear un objeto . Opcionalmente, especifique propiedades adicionales, siguiendo la estructura del ejemplo.

Responses

Ha creado un nuevo objeto. CreateObjectResponse

Obtención de objetos únicos

GET /odata/Objects({key})

Obtener detalles de un objeto

La respuesta predeterminada solo incluye propiedades de nivel superior. Use parámetros opcionales de OData para expandir propiedades adicionales y seleccionar solo las propiedades especificadas.

Parámetros

Nombre In Tipo Obligatorio Description
key camino string(uuid) true Identificador de un objeto en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.
$select query cuerda / cadena false Subconjunto de propiedades que se van a incluir para el objeto en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.
$expand query cuerda / cadena false Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para el objeto en la respuesta.
Además, puede solicitar las siguientes propiedades: Model, , RelatedObjectsAttributeValuesFlatLastModifiedByCreatedByObjectTypeAttributeValues, LockedBy, . DetailApprovalDetails

Responses

Devuelve la respuesta dinámica.

Eliminación de objetos

DELETE /odata/Objects({key})

Eliminar un objeto

El objeto eliminado se mueve a la papelera de reciclaje.

Parámetros

Nombre In Tipo Obligatorio Description
key camino string(uuid) true Identificador de un objeto en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

Responses

Se eliminó un objeto . DeleteObjectResponse

Revisión de objetos

PATCH /odata/Objects({key})

Actualizar valores de atributo de un objeto existente

Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor. Solo se actualizarán los valores de atributo especificados.

Parámetro body

Parámetros

Nombre In Tipo Obligatorio Description
key camino string(uuid) true Identificador de un objeto en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.
body body UpdateObjectRequestValue true Valores de atributo que se van a actualizar para el objeto especificado. Para cada atributo, especifique

Responses

Se ha actualizado el objeto . UpdateObjectResponse

Relationships

Operaciones para configurar y administrar relaciones de modelo.

Obtención de relaciones

GET /odata/Relationships

Obtener relaciones y sus detalles

La respuesta predeterminada incluye la lista de 50 relaciones, que se crearon más recientemente en OrbusInfinity y sus propiedades de nivel superior. Use los parámetros de OData siguientes para filtrar, ordenar, expandir propiedades adicionales y seleccionar solo las propiedades especificadas en la salida.

Parámetros

Nombre In Tipo Obligatorio Description
includeIntersectional query boolean false Si es true, incluya Relaciones interseccionales en la salida.
$select query cuerda / cadena false Subconjunto de propiedades que se van a incluir para cada relación en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.
$expand query cuerda / cadena false Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para cada relación en la respuesta.
Además, puede solicitar las siguientes propiedades: LeadObject, , MemberObjectLeadRelationshipRelationshipType, Model, AttributeValues, , AttributeValuesFlatDetail.
$filtro query cuerda / cadena false Expresión por la que se filtran las relaciones en el resultado. Puede filtrar las relaciones por un valor para las siguientes propiedades: RelationshipId, RelationshipTypeId, ModelIdRelationshipType, ModelLeadRelationshipIdLeadObjectId, . DetailMemberObjectId
El número mínimo y predeterminado de expresiones es 0; máximo: 100.
$orderby query cuerda / cadena false El orden en el que las relaciones se ordenan en la respuesta, mediante una propiedad seleccionada. Por ejemplo, escriba DateCreated desc para solicitar relaciones en orden descendente por propiedad DateCreated.
El número mínimo y predeterminado de expresiones es 0; el máximo: 5.
$top query integer(int32) false Recuento de las relaciones, que se crearon más recientemente en OrbusInfinity, para incluir en la respuesta. El valor mínimo es 0; máximo: 50.
Por ejemplo, escriba 20 para devolver 20 relaciones que se crearon más recientemente en OrbusInfinity.
$skip query integer(int32) false Recuento de las relaciones, que se crearon más recientemente en OrbusInfinity, para excluir de la respuesta. El valor mínimo y predeterminado es 0; máximo: 50.
Por ejemplo, escriba 20 para omitir 20 relaciones que se crearon más recientemente en OrbusInfinity y devolver los 50 siguientes.
$count query boolean false Si es true, el recuento total de relaciones se especifica en la respuesta. De forma predeterminada, el parámetro se establece en false, lo que significa que no se devuelve el recuento total.

Descripciones detalladas

includeIntersectional: si es true, incluya Las relaciones interseccionales en la salida. Las relaciones interseccionales tienen un valor para la LeadRelationshipId propiedad y las relaciones normales tienen un valor para la LeadObjectId propiedad .

Responses

Devuelve la respuesta dinámica.

Publicación de relaciones

POST /odata/Relationships

Crear una nueva relación

Debe especificar id. de tipo de relación, id. de modelo, id. de par de tipo de relación, id. de objeto de cliente potencial, id. de objeto miembro e identificación de atributos para la nueva relación. Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor.

Parámetro body

Parámetros

Nombre In Tipo Obligatorio Description
body body CreateRelationshipRequestValue true Valores de propiedad para una nueva relación. Especifique RelationshipTypeId, ModelId, RelationshipTypePairId, LeadModelItemId, para MemberModelItemId crear una relación.

Responses

Ha creado una nueva relación. CreateRelationshipResponse

Obtención de relaciones únicas

GET /odata/Relationships({key})

Obtener detalles de una relación

La respuesta predeterminada solo incluye propiedades de nivel superior. Use parámetros opcionales de OData para expandir propiedades adicionales y seleccionar solo las propiedades especificadas.

Parámetros

Nombre In Tipo Obligatorio Description
key camino string(uuid) true Identificador de una relación en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.
$select query cuerda / cadena false Subconjunto de propiedades que se van a incluir para la relación en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.
$expand query cuerda / cadena false Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para la relación en la respuesta.
Además, puede solicitar las siguientes propiedades: LeadObject, LeadRelationship, MemberObjectRelationshipType, Model, AttributeValues, AttributeValuesFlat, , Detail. ApprovalDetails

Responses

Devuelve la respuesta dinámica.

Eliminar relaciones

DELETE /odata/Relationships({key})

Eliminar una relación

La relación eliminada se mueve a la papelera de reciclaje.

Parámetros

Nombre In Tipo Obligatorio Description
key camino string(uuid) true Identificador de una relación en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

Responses

Eliminó la relación. DeleteRelationshipResponse

Revisión de relaciones

PATCH /odata/Relationships({key})

Actualizar valores de atributo de una relación existente

Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor. Solo se actualizarán los valores de atributo especificados.

Parámetro body

Parámetros

Nombre In Tipo Obligatorio Description
key camino string(uuid) true Identificador de una relación en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.
body body UpdateRelationshipRequestValue true Valores de atributo que se van a actualizar para la relación especificada. Para cada atributo, especifique

Responses

Se ha actualizado la relación. UpdateRelationshipResponse

Webhooks

Operaciones para administrar webhooks.

Publicación de webhooks

POST /odata/Webhooks

Cuando se produce un evento

Crea un desencadenador con el evento solicitado, por lo que cuando se produce ese evento en OrbusInfinity, se notificará a la aplicación ubicada en la dirección URL proporcionada.

Parámetro body

Parámetros

Nombre In Tipo Obligatorio Description
body body CreateWebhookRequest true Solicitud que contiene la información del webhook.

Responses

SaveWebhookResponse

Eliminación de webhooks

DELETE /odata/Webhooks({key})

Eliminación de un webhook existente

Elimina un webhook existente proporcionando el identificador de webhook.

Parámetros

Nombre In Tipo Obligatorio Description
key camino integer(int32) true Identificador de webhook.

Responses

DeleteWebhookResponse

Schemas

WebhookSaved

Propiedades

Nombre Tipo Obligatorio Restrictions Description
webhookId integer(int32) false none Id. de Webhook.

ObjectCreated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
nombre cuerda / cadena false none Nombre del objeto creado.
objectId string(uuid) false none Identificador del objeto creado.
modelId string(uuid) false none Id. de modelo del objeto creado.
objectTypeId string(uuid) false none Identificador de tipo de objeto del objeto creado.

ObjectDeleted

Propiedades

Nombre Tipo Obligatorio Restrictions Description
objectId string(uuid) false none Identificador del objeto eliminado.
objectName cuerda / cadena false none Nombre del objeto eliminado.

ObjectUpdated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
objectId string(uuid) false none Identificador de un objeto.
nombre cuerda / cadena false none Nombre de un objeto.

RelationshipCreated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
relationshipId string(uuid) false none Id. de relación.
leadObjectId string(uuid) false none Identificador del objeto lead de la relación.
leadRelationshipId string(uuid) false none Id. de relación de cliente potencial. Se usa para las relaciones interseccionales.
memberObjectId string(uuid) false none Identificador del objeto miembro de la relación.

RelationshipDeleted

Propiedades

Nombre Tipo Obligatorio Restrictions Description
deletedRelationshipId string(uuid) false none Identificador de la relación eliminada.

RelationshipUpdated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
relationshipId string(uuid) false none Id. de relación.

MessageCategory

Importancia
Error
Advertencia
Información

MessageCode

Importancia
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryMismatch
CustomDocumentTypeNotSupported
CustomDocumentTypeMustHaveAtLeastOneFileExtension
DocumentTypeFileExtensionNotSupportedForCustomCategory
IdentificarAttributeAssignmentWithInstancesExists
DocumentTypeDoesNotExist
DocumentTypeNameIsInvalid
DocumentTypeFilenameInvalid
DocumentTypePrimaryTemplateAlreadyExists
DocumentTypeDoesNotSupportTemplateFiles
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
IdentificarAttributeAssignmentExists
InheritedAttributeAssignmentExists
MultipleDuplicateAttributes
AttributeCategoryMismatch
AttributeDateTimeDateOnly
AttributeDateTimeMaximumIsNotDateOnly
AttributeDateTimeMinimumIsNotDateOnly
AttributeValueHyperlinkNotUri
AttributeValuesCommitted
AttributeHyperlinkDisplayValueProvided
AttributeHyperlinkUriNotProvided
AttributeMultipleValuesProvided
AttributeHyperlinkValueTooLong
AttributeHyperlinkDisplayValueTooLong
AttributePersonOrGroupIsGroup
AttributeValuePersonOrGroupNotInGroup
AttributeNumberMaximumValueExceedsLimits
AttributeNumberMinimumValueExceedsLimits
AttributeMinimumNumberPrecisionIsNotEqualToPrecisionValue
AttributeMaximumNumberPrecisionIsNotEqualToPrecisionValue
AttributeCurrencyMaximumValueExceedsLimits
AttributeCurrencyMinimumValueExceedsLimits
AttributeCurrencyMaximumValueInvalidPrecision
AttributeCurrencyMinimumValueInvalidPrecision
AttributeTextMinimumValueExceedsLimits
AttributeTextMaximumValueExceedsLimits
AttributeDoesNotExists
AttributeWithNameAlreadyExists
InvalidIsoCurrencySymbol
AttributeNumberPrecisionIsOutOfRange
AttributeMinimumValueIsGreaterThanMaximumValue
AttributeCurrencyMinimumValueIsGreaterThanMaximumValue
AttributeDateTimeMinimumValueIsGreaterThanMaximumValue
AttributeNumberMinimumValueIsGreaterThanMaximumValue
AttributeTextMinimumLengthValueIsGreaterThanMaximumLengthValue
UnableToAssignReadOnlyAttributes
UnableToAssignHiddenAttributes
UnableToDeleteSystemAttributeAssignment
MappedImportWorksheetSettingsDoesNotExist
MappedImportWorksheetSettingsDoesNotBelongToUser
ModelDoesNotHaveSubsetOfModellingSolutions
ModelNameNotUnique
ModelNameValueNotProvided
ModelIsDeactivated
ModelIsActivated
ModelsDeactivated
ModelsActivated
ModellingSolutionsAreNotUnique
IdentificarAttributeCannotBeImportant
MultipleIdentifyingAttributeAssignments
AtributosAreAlreadyAssigned
MetamodelItemHasInstances
IdentificarAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
UnableToAssignSystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AttributeChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
IdentificarAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
ModellingSolutionDoesNotExist
ModelItemReuseDeletionRequired
ObjectIsReuse
ObjectIsVariant
ObjectIsReused
RelationshipDeletionRequired
FeedbackDeletionRequired
ViewModellingSolutionIdsNotAllowedOnCollectionView
ViewMustBelongToAModellingSolution
AdHocViewsCannotContainRuntimeParameters
ViewDimensionsRequired
TraceabilityViewFilterSetMustContainFilters
TraceabilityViewFilterCannotHaveMoreColumns
ViewDimensionRequireGroups
ViewFilterGroupRequireViewFilters
ViewFilterGroupHasIncorrectPositions
InvalidViewDimensionCategories
ViewFilterCategoryNotAllowedInCollectionView
ViewFilterHasTooManyIdentifyingParameters
ViewFilterIsMissingIdentifyingParameters
ViewFilterHasTooManyRuntimeParameters
ViewFilterIsMissingRuntimeParameter
ViewFilterParameterValuesNotProvided
ViewFilterParameterValuesProvidedForRuntimeParameter
ViewFilterParameterValuesProvidedForNullOperatorParameter
ViewFilterParameterOperatorNotSupported
ViewFilterParameterCategoryNotSupported
ViewFilterParameterValueTextIsTooLong
MetamodelItemCategoryNotSupported
ViewModelIdParameterMustBeRuntime
ViewGenerationStorageExpiredOrEmpty
ViewGenerationStorageNotAvailableForSavedParameters
ViewDimensionDoesNotExist
ViewFilterParameterRuntimeMissing
ViewFilterParameterRuntimeNotNeeded
ModelNotAvailableToAnyViewModellingSolutions
ModelNotAvailableToAllViewModellingSolutions
ImportantAttributeValueNotProvided
DisplayAttributeValueNotProvided
UniqueAttributeValueNotUnique
AttributeValueNumberOutOfRange
AttributeValueNumberOutOfRangeLowerOnly
AttributeValueNumberOutOfRangeUpperOnly
AttributeValueCurrencyOutOfRange
AttributeValueCurrencyOutOfRangeLowerOnly
AttributeValueCurrencyOutOfRangeUpperOnly
AttributeValueTextOutOfRange
AttributeValueTextOutOfRangeLowerOnly
AttributeValueTextOutOfRangeUpperOnly
AttributeValueDateTimeOutOfRange
AttributeValueDateTimeDateOnly
AttributeValueDateTimeOutOfRangeLowerOnly
AttributeValueDateTimeOutOfRangeUpperOnly
AttributeValueTextPlainTextMissing
AttributeValueCurrencyInvalidPrecision
AttributeValueNumberInvalidPrecision
AttributeValueChoiceDuplicateExistingChoice
AttributeValueNotChoice
AttributeValueChoiceInvalidParent
AttributeValueChoiceMultipleValuesProvided
AttributeValueHyperlinkMultipleValuesProvided
AttributeValuePersonOrGroupMultipleValuesProvided
AttributeValueBothPersonAndGroupHaveValue
MultipleDuplicateAttributeValues
AttributePersonOrGroupInvalid
UnableToDeleteGlobalAttribute
UnableToUpdateGlobalAttribute
UnableToDeleteSystemAttribute
UnableToUpdateSystemAttribute
UnableToUpdateNameOrSolutionForGlobalAttribute
UnableToUpdateConfigurationForGlobalAttribute
UnableToUpdateConfigurationForAssignedAttribute
ProtectedAttributeConfigurationHasChanged
ProtectedMetamodelItemHasChanged
ProtectedObjectTypeHasChanged
ProtectedRelationshipTypeHasChanged
ModelItemDoesNotExist
MetamodelItemDoesNotExist
ModelItemIsAlike
ModelItemIsLocked
ModelItemIsUnlocked
ModelItemIsNotObject
ModelItemIsNotRelationship
ModelItemIsNotApprovable
ModelItemIsNotPendingReview
ModelItemIsAlreadyPendingReview
ModelItemVersionIsNotLast
ModelItemsTypeNotEquals
ModelItemsEquals
ModelItemIsDeactivated
ModelItemsActivatedDeactivated
ModelItemsDeactivated
ModelItemsActivated
UserIsNotInApproversList
IdentificarAttributeValueNotProvided
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
Objetos copiados
ObjectDeleted
ObjectsDeleted
Objetos combinados
ObjectReclassified
ObjectsReclassified
ObjectsRelationshipsMerged
RelationshipCreated
RelacionesCreadas
Relaciones copiadas
RelationshipUpdated
RelacionesActualizar
RelationshipDeleted
RelationshipsDeleted
RelaciónSkipped
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
Relaciones combinadas
LeadToMemberDirectionEmpty
MemberToLeadDirectionEmpty
RepresentationSituationIsNotValid
IntersectionalRelationshipRepresentationIsNotValid
InterseccionalRelationshipTypeWithSamePairAlreadyExists
IntersectionalRelationshipTypeCannotHavePairsWithAnyLeadOrMember
RelationshipTypeHasNoPairs
DuplicateRelationshipTypeInModellingSolution
DocumentManagementSystemRetrieved
ObjectTypeCreated
SolutionCreated
SolutionDeleted
WebhookSaved
WebhookDeleted
MappedImportWorksheetSettingsCreated
MappedImportWorksheetSettingsUpdated
Modelo copiado
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
DescripciónIsInvalid
RelationshipTypePairActivated
RelationshipTypePairsActivated
RelationshipTypePairDeactivated
RelationshipTypePairsDeactivated
MetamodelItemActivated
MetamodelItemsActivated
FailedToSaveRelationshipTypeConnectedToDetails
MemberModelItemIsNotObject
LeadModelItemIsNotObject
LeadModelItemIsNotRelationship
Área de trabajoCreada
WorkspacesCreated
WorkspaceCapacityIsExceeded
WorkspaceNameIsNotUnique
WorkspaceUpdated
WorkspacesUpdated
WorkspaceDoesNotExist
ComandosValidated
WorkspaceDeleted
WorkspacesDeleted
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculated
PricingTierIsNotValid
PermissionDenied
Error Interno del Servidor
Solicitud incorrecta
No encontrado
Prohibido
RequestAccepted
OverrideAll

Message

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.WebhookSaved

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition WebhookSaved false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.ObjectCreated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition ObjectCreated false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.ObjectDeleted

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition ObjectDeleted false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.ObjectUpdated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition ObjectUpdated false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.RelationshipCreated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition RelationshipCreated false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.RelationshipDeleted

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition RelationshipDeleted false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

OperationMessage.RelationshipUpdated

Propiedades

Nombre Tipo Obligatorio Restrictions Description
messageDefinition RelationshipUpdated false none none
messageCategory MessageCategory false none Indica el tipo de Mensaje.
messageCode MessageCode false none none
Mensaje cuerda / cadena false solo lectura Contenido del mensaje.

CreateWebhookRequest

Propiedades

Nombre Tipo Obligatorio Restrictions Description
secret cuerda / cadena false none Secreto del receptor.
eventType cuerda / cadena true none Tipo de evento de suscripción.
URL cuerda / cadena true none Dirección URL del receptor.
fecha de vencimiento string(fecha y hora) false none Obtiene o establece la fecha de expiración. Si no se proporciona ninguna fecha de expiración, un valor
De forma predeterminada, se usará (normalmente 6 meses después de la fecha de creación).

DeleteWebhookResponse

Propiedades

Nombre Tipo Obligatorio Restrictions Description
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

SaveWebhookResponse

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.WebhookSaved false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

CreateObjectRequestValue

Propiedades

Nombre Tipo Obligatorio Restrictions Description
objectTypeId string(uuid) true none Identificador del tipo de objeto.
attributeValuesFlat objeto false none Pares clave-valor de los valores de atributo.
additionalProperties cualquier false none none
modelId string(uuid) true none Id. del modelo.

Modelo que representa la respuesta de la operación de creación de objetos.

UpdateObjectRequestValue

Propiedades

Nombre Tipo Obligatorio Restrictions Description
attributeValuesFlat objeto false none Pares clave-valor de los valores de atributo.

CreateObjectResponse

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.ObjectCreated false none none
operationType OperationType false none none
entityTypes Tipo de entidad false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

DeleteObjectResponse

Modelo que representa la respuesta de la operación de eliminación de objetos.

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.ObjectDeleted false none none
operationType OperationType false none none
entityTypes Tipo de entidad false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

UpdateObjectResponse

Modelo que representa la respuesta de la operación del objeto de actualización.

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.ObjectUpdated false none none
operationType OperationType false none none
entityTypes Tipo de entidad false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

CreateRelationshipRequestValue

Propiedades

Nombre Tipo Obligatorio Restrictions Description
relationshipTypeId string(uuid) true none Identificador del tipo de relación.
relationshipTypePairId string(uuid) false none Si es el par de tipo de relación.
leadModelItemId string(uuid) true none Identificador del elemento de modelo principal de la relación.
memberModelItemId string(uuid) true none Identificador del elemento de modelo de miembro de la relación.
attributeValuesFlat objeto false none none
modelId string(uuid) true none Id. del modelo.

UpdateRelationshipRequestValue

Propiedades

Nombre Tipo Obligatorio Restrictions Description
attributeValuesFlat objeto false none none

CreateRelationshipResponse

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.RelationshipCreated false none none
operationType OperationType false none none
entityTypes Tipo de entidad false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

DeleteRelationshipResponse

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.RelationshipDeleted false none none
operationType OperationType false none none
entityTypes Tipo de entidad false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

UpdateRelationshipResponse

Propiedades

Nombre Tipo Obligatorio Restrictions Description
successMessage OperationMessage.RelationshipUpdated false none none
operationType OperationType false none none
entityTypes Tipo de entidad false none none
correcto boolean false none Indica que la operación se ha realizado correctamente.
messages Mensaje false solo lectura Mensajes de respuesta.

EntityType

Importancia
Ninguno
Solución
ObjectType
RelationshipType
RelationshipTypePair
Atributo
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Modelo
Objeto
Relación
Documento
DocumentComponent
Workspace
Rol

OperationType

Importancia
Create
Update
Delete

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
OrbusInfinity API URL cuerda / cadena Dirección URL de la API de OrbusInfinity. Por ejemplo https://example-api.orbusinfinity.com Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualizar valores de atributo de un objeto existente

Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor. Solo se actualizarán los valores de atributo especificados.

Actualizar valores de atributo de una relación existente

Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor. Solo se actualizarán los valores de atributo especificados.

Crear un nuevo objeto

Debe especificar el identificador de tipo de objeto, el identificador de modelo y los atributos de identificación para el nuevo objeto. Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor.

Crear una nueva relación

Debe especificar id. de tipo de relación, id. de modelo, id. de par de tipo de relación, id. de objeto de cliente potencial, id. de objeto miembro e identificación de atributos para la nueva relación. Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor.

Eliminar un objeto

El objeto eliminado se mueve a la papelera de reciclaje.

Eliminar una relación

La relación eliminada se mueve a la papelera de reciclaje.

Obtener detalles de un objeto

La respuesta predeterminada solo incluye propiedades de nivel superior. Use parámetros opcionales de OData para expandir propiedades adicionales y seleccionar solo las propiedades especificadas.

Obtener detalles de una relación

La respuesta predeterminada solo incluye propiedades de nivel superior. Use parámetros opcionales de OData para expandir propiedades adicionales y seleccionar solo las propiedades especificadas.

Obtener objetos y sus detalles

La respuesta predeterminada incluye la lista de 50 objetos, que se crearon más recientemente en OrbusInfinity y sus propiedades de nivel superior. Use los parámetros de OData siguientes para filtrar, ordenar, expandir propiedades adicionales y seleccionar solo las propiedades especificadas en la salida.

Obtener relaciones y sus detalles

La respuesta predeterminada incluye la lista de 50 relaciones, que se crearon más recientemente en OrbusInfinity y sus propiedades de nivel superior. Use los parámetros de OData siguientes para filtrar, ordenar, expandir propiedades adicionales y seleccionar solo las propiedades especificadas en la salida.

Actualizar valores de atributo de un objeto existente

Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor. Solo se actualizarán los valores de atributo especificados.

Parámetros

Nombre Clave Requerido Tipo Description
key
key True uuid

Identificador de un objeto en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Pares clave-valor de los valores de atributo.

Devoluciones

Modelo que representa la respuesta de la operación del objeto de actualización.

Actualizar valores de atributo de una relación existente

Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor. Solo se actualizarán los valores de atributo especificados.

Parámetros

Nombre Clave Requerido Tipo Description
key
key True uuid

Identificador de una relación en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Devoluciones

Crear un nuevo objeto

Debe especificar el identificador de tipo de objeto, el identificador de modelo y los atributos de identificación para el nuevo objeto. Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor.

Parámetros

Nombre Clave Requerido Tipo Description
objectTypeId
objectTypeId True uuid

Identificador del tipo de objeto.

attributeValuesFlat
attributeValuesFlat object

Pares clave-valor de los valores de atributo.

modelId
modelId True uuid

Id. del modelo.

Devoluciones

Modelo que representa la respuesta de la operación de creación de objetos.

Crear una nueva relación

Debe especificar id. de tipo de relación, id. de modelo, id. de par de tipo de relación, id. de objeto de cliente potencial, id. de objeto miembro e identificación de atributos para la nueva relación. Use AttributeValuesFlat la propiedad para especificar valores de atributo en el formato clave-valor.

Parámetros

Nombre Clave Requerido Tipo Description
relationshipTypeId
relationshipTypeId True uuid

Identificador del tipo de relación.

relationshipTypePairId
relationshipTypePairId uuid

Si es el par de tipo de relación.

leadModelItemId
leadModelItemId True uuid

Identificador del elemento de modelo principal de la relación.

memberModelItemId
memberModelItemId True uuid

Identificador del elemento de modelo de miembro de la relación.

attributeValuesFlat
attributeValuesFlat object
modelId
modelId True uuid

Id. del modelo.

Devoluciones

Eliminar un objeto

El objeto eliminado se mueve a la papelera de reciclaje.

Parámetros

Nombre Clave Requerido Tipo Description
key
key True uuid

Identificador de un objeto en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

Devoluciones

Modelo que representa la respuesta de la operación de eliminación de objetos.

Eliminar una relación

La relación eliminada se mueve a la papelera de reciclaje.

Parámetros

Nombre Clave Requerido Tipo Description
key
key True uuid

Identificador de una relación en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

Devoluciones

Obtener detalles de un objeto

La respuesta predeterminada solo incluye propiedades de nivel superior. Use parámetros opcionales de OData para expandir propiedades adicionales y seleccionar solo las propiedades especificadas.

Parámetros

Nombre Clave Requerido Tipo Description
key
key True uuid

Identificador de un objeto en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

$select
$select string

Subconjunto de propiedades que se van a incluir para el objeto en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.

$expand
$expand string

Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para el objeto en la respuesta.
Además, puede solicitar las siguientes propiedades: Model, , RelatedObjectsAttributeValuesFlatLastModifiedByCreatedByObjectTypeAttributeValues, LockedBy, . DetailApprovalDetails

Devoluciones

Entidad de objeto OData.

Obtener detalles de una relación

La respuesta predeterminada solo incluye propiedades de nivel superior. Use parámetros opcionales de OData para expandir propiedades adicionales y seleccionar solo las propiedades especificadas.

Parámetros

Nombre Clave Requerido Tipo Description
key
key True uuid

Identificador de una relación en formato GUID, por ejemplo 00000000-0000-0000-0000-000000000000.

$select
$select string

Subconjunto de propiedades que se van a incluir para la relación en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.

$expand
$expand string

Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para la relación en la respuesta.
Además, puede solicitar las siguientes propiedades: LeadObject, LeadRelationship, MemberObjectRelationshipType, Model, AttributeValues, AttributeValuesFlat, , Detail. ApprovalDetails

Devoluciones

Relación.

Obtener objetos y sus detalles

La respuesta predeterminada incluye la lista de 50 objetos, que se crearon más recientemente en OrbusInfinity y sus propiedades de nivel superior. Use los parámetros de OData siguientes para filtrar, ordenar, expandir propiedades adicionales y seleccionar solo las propiedades especificadas en la salida.

Parámetros

Nombre Clave Requerido Tipo Description
$select
$select string

Subconjunto de propiedades que se van a incluir para cada objeto en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.

$expand
$expand string

Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para cada objeto en la respuesta.
Además, puede solicitar las siguientes propiedades: Model, , AttributeValuesObjectTypeAttributeValuesFlat, CreatedBy, LastModifiedBy, , LockedByDetail.

$filtro
$filter string

Expresión por la que se filtran los objetos en el resultado. Puede filtrar Objetos por un valor para las siguientes propiedades: ObjectId, , NameObjectTypeId, IsApprovedLockedByLastModifiedByCreatedByModelObjectTypeAttributeValuesDetailLastModifiedByIdCreatedByIdModelIdLastModifiedDateLockedOnLockedByIdDateCreated.
El número mínimo y predeterminado de expresiones es 0; máximo: 100.

$orderby
$orderby string

Orden en el que los objetos se ordenan en la respuesta, mediante una propiedad seleccionada. Por ejemplo, escriba Name desc para solicitar objetos en orden descendente por propiedad Name.
El número mínimo y predeterminado de expresiones es 0; el máximo: 5.

$top
$top integer

Recuento de los objetos, que se crearon más recientemente en OrbusInfinity, para incluir en la respuesta. El valor mínimo es 0; máximo: 50.
Por ejemplo, escriba 20 para devolver 20 Objetos creados más recientemente en OrbusInfinity.

$skip
$skip integer

Recuento de los objetos, que se crearon más recientemente en OrbusInfinity, para excluir de la respuesta. El valor mínimo y predeterminado es 0; máximo: 50.
Por ejemplo, escriba 20 para omitir 20 objetos creados más recientemente en OrbusInfinity y devolver los 50 siguientes.

$count
$count boolean

Si es true, el recuento total de objetos se especifica en la respuesta. De forma predeterminada, el parámetro se establece en false, lo que significa que no se devuelve el recuento total.

Devoluciones

Representa información adicional que admiten los formatos OData. Solo es para fines de documentación de Swagger.

Obtener relaciones y sus detalles

La respuesta predeterminada incluye la lista de 50 relaciones, que se crearon más recientemente en OrbusInfinity y sus propiedades de nivel superior. Use los parámetros de OData siguientes para filtrar, ordenar, expandir propiedades adicionales y seleccionar solo las propiedades especificadas en la salida.

Parámetros

Nombre Clave Requerido Tipo Description
includeIntersectional
includeIntersectional boolean

Si es true, incluya Relaciones interseccionales en la salida. Las relaciones interseccionales tienen un valor para la LeadRelationshipId propiedad y las relaciones normales tienen un valor para la LeadObjectId propiedad .

$select
$select string

Subconjunto de propiedades que se van a incluir para cada relación en la respuesta. Si se deja en blanco, se devuelven las propiedades predeterminadas.

$expand
$expand string

Las propiedades adicionales (junto con las predeterminadas) que se van a incluir para cada relación en la respuesta.
Además, puede solicitar las siguientes propiedades: LeadObject, , MemberObjectLeadRelationshipRelationshipType, Model, AttributeValues, , AttributeValuesFlatDetail.

$filtro
$filter string

Expresión por la que se filtran las relaciones en el resultado. Puede filtrar las relaciones por un valor para las siguientes propiedades: RelationshipId, RelationshipTypeId, ModelIdRelationshipType, ModelLeadRelationshipIdLeadObjectId, . DetailMemberObjectId
El número mínimo y predeterminado de expresiones es 0; máximo: 100.

$orderby
$orderby string

El orden en el que las relaciones se ordenan en la respuesta, mediante una propiedad seleccionada. Por ejemplo, escriba DateCreated desc para solicitar relaciones en orden descendente por propiedad DateCreated.
El número mínimo y predeterminado de expresiones es 0; el máximo: 5.

$top
$top integer

Recuento de las relaciones, que se crearon más recientemente en OrbusInfinity, para incluir en la respuesta. El valor mínimo es 0; máximo: 50.
Por ejemplo, escriba 20 para devolver 20 relaciones que se crearon más recientemente en OrbusInfinity.

$skip
$skip integer

Recuento de las relaciones, que se crearon más recientemente en OrbusInfinity, para excluir de la respuesta. El valor mínimo y predeterminado es 0; máximo: 50.
Por ejemplo, escriba 20 para omitir 20 relaciones que se crearon más recientemente en OrbusInfinity y devolver los 50 siguientes.

$count
$count boolean

Si es true, el recuento total de relaciones se especifica en la respuesta. De forma predeterminada, el parámetro se establece en false, lo que significa que no se devuelve el recuento total.

Devoluciones

Representa información adicional que admiten los formatos OData. Solo es para fines de documentación de Swagger.

Desencadenadores

Cuando se produce un evento

Crea un desencadenador con el evento solicitado, por lo que cuando se produce ese evento en OrbusInfinity, se notificará a la aplicación ubicada en la dirección URL proporcionada.

Cuando se produce un evento

Crea un desencadenador con el evento solicitado, por lo que cuando se produce ese evento en OrbusInfinity, se notificará a la aplicación ubicada en la dirección URL proporcionada.

Parámetros

Nombre Clave Requerido Tipo Description
secret
secret string

Secreto del receptor.

eventType
eventType True string

Tipo de evento de suscripción.

fecha de vencimiento
expirationDate date-time

Obtiene o establece la fecha de expiración. Si no se proporciona ninguna fecha de expiración, se usará un valor de forma predeterminada (normalmente 6 meses después de la fecha de creación).

Devoluciones

Definiciones

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Nombre Ruta de acceso Tipo Description
object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Nombre Ruta de acceso Tipo Description
nombre
name string

Nombre del objeto creado.

objectId
objectId uuid

Identificador del objeto creado.

modelId
modelId uuid

Id. de modelo del objeto creado.

objectTypeId
objectTypeId uuid

Identificador de tipo de objeto del objeto creado.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2

Nombre Ruta de acceso Tipo Description
objectId
objectId uuid

Identificador del objeto eliminado.

objectName
objectName string

Nombre del objeto eliminado.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2

Nombre Ruta de acceso Tipo Description
objectId
objectId uuid

Identificador de un objeto.

nombre
name string

Nombre de un objeto.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Nombre Ruta de acceso Tipo Description
relationshipId
relationshipId uuid

Id. de relación.

leadObjectId
leadObjectId uuid

Identificador del objeto lead de la relación.

leadRelationshipId
leadRelationshipId uuid

Id. de relación de cliente potencial. Se usa para las relaciones interseccionales.

memberObjectId
memberObjectId uuid

Identificador del objeto miembro de la relación.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Nombre Ruta de acceso Tipo Description
deletedRelationshipId
deletedRelationshipId uuid

Identificador de la relación eliminada.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Nombre Ruta de acceso Tipo Description
relationshipId
relationshipId uuid

Id. de relación.

OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

Indica el tipo de Mensaje.

OfficeArchitect.Contracts.Message.MessageCode

OfficeArchitect.Contracts.Message.Message_Level1

Nombre Ruta de acceso Tipo Description
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

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

Nombre Ruta de acceso Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

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

Nombre Ruta de acceso Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

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

Nombre Ruta de acceso Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

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

Nombre Ruta de acceso Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

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

Nombre Ruta de acceso Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

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

Nombre Ruta de acceso Tipo Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indica el tipo de Mensaje.

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

Contenido del mensaje.

OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation

OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage

OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors

OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Estado del elemento de modelo.

Estado del elemento de modelo.

OfficeArchitect.Contracts.Notification.WebhookPayload

Nombre Ruta de acceso Tipo Description
ids
ids array of
eventType
eventType string
secret
secret string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Nombre Ruta de acceso Tipo Description
attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Representa el identificador del grupo de asignación de atributos.

nombre
name string

Representa el nombre del grupo de asignación de atributos.

position
position integer

Representa la posición del grupo de asignación de atributos.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Asignación de atributos.

Nombre Ruta de acceso Tipo Description
attributeAssignmentId
attributeAssignmentId uuid

Id. de asignación de atributos.

attributeId
attributeId uuid

Guid AttributeId.

attributeCategoryId
attributeCategoryId integer

int AttributeCategoryId.

metamodelItemId
metamodelItemId uuid

MetamodelItemId guid.

attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Obtiene o establece el identificador del grupo de asignación 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

string GroupName.

position
position integer

int Position.

activeState
activeState boolean

bool ActiveState.

stringDefaultValue
stringDefaultValue string

cadena abstract string StringDefaultValue.

isProtected
isProtected boolean

Obtiene o establece un valor que indica si la asignación de atributos está protegida.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Nombre Ruta de acceso Tipo Description
metamodelItemDefaultApproverId
metamodelItemDefaultApproverId uuid

Obtiene o establece la clave de entidad.

personId
personId uuid

Obtiene o establece el identificador de persona.

personName
personName string

Obtiene o establece el nombre de la persona.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

MetamodelItem Solution.

Nombre Ruta de acceso Tipo Description
solutionId
solutionId uuid

Representa el identificador de la solución.

nombre
name string

Representa el nombre de la solución.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Representa la entidad Tipo de objeto.

Nombre Ruta de acceso Tipo Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

parentObjectType
parentObjectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa la entidad Tipo de objeto.

objectTypeId
objectTypeId uuid

Representa el identificador del tipo de objeto.

parentObjectTypeId
parentObjectTypeId uuid

Representa la referencia al identificador de tipo de objeto primario.

dateCreated
dateCreated date-time

Representa DateTime cuando se creó el tipo de objeto.

createdById
createdById uuid

Representa el UserId por el que se creó el tipo de objeto.

dateLastModified
dateLastModified date-time

Representa DateTime cuando se modificó el tipo de objeto.

lastModifiedById
lastModifiedById uuid

Representa el UserId por el que se modificó el tipo de objeto.

activeState
activeState boolean

Representa si el tipo de objeto está en estado activo.

isApprovable
isApprovable boolean

Representa si el tipo de objeto es accesible.

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

Representa la propiedad de navegación a la colección de soluciones.

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

Representa la propiedad de navegación a la colección de atributos asignados.

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

Representa la propiedad de navegación a la colección de grupos de asignaciones de atributos.

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

Representa la propiedad de navegación a la colección de tipos de objetos secundarios a los que se hace referencia.

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

Representa la propiedad de navegación a la colección de aprobadores predeterminados.

alias
alias string

Obtiene o establece el alias del elemento de metamodelo.

nombre
name string

Obtiene o establece el nombre del elemento de metamodelo.

descripción
description string

Obtiene o establece la descripción del elemento de metamodelo.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa la entidad Tipo de objeto.

Nombre Ruta de acceso Tipo Description
objectTypeId
objectTypeId uuid

Representa el identificador del tipo de objeto.

parentObjectTypeId
parentObjectTypeId uuid

Representa la referencia al identificador de tipo de objeto primario.

dateCreated
dateCreated date-time

Representa DateTime cuando se creó el tipo de objeto.

createdById
createdById uuid

Representa el UserId por el que se creó el tipo de objeto.

dateLastModified
dateLastModified date-time

Representa DateTime cuando se modificó el tipo de objeto.

lastModifiedById
lastModifiedById uuid

Representa el UserId por el que se modificó el tipo de objeto.

activeState
activeState boolean

Representa si el tipo de objeto está en estado activo.

isApprovable
isApprovable boolean

Representa si el tipo de objeto es accesible.

alias
alias string

Obtiene o establece el alias del elemento de metamodelo.

nombre
name string

Obtiene o establece el nombre del elemento de metamodelo.

descripción
description string

Obtiene o establece la descripción del elemento de metamodelo.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

RelationshipType Pair.

Nombre Ruta de acceso 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 del tipo de relación de cliente potencial.

activeState
activeState boolean

bool ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

Nombre Ruta de acceso Tipo Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

dateCreated
dateCreated date-time

DateTime DateCreated.

createdById
createdById uuid

Guid CreatedById.

dateLastModified
dateLastModified date-time

DateTime DateLastModified.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

activeState
activeState boolean

bool ActiveState.

isApprovable
isApprovable boolean

Representa si relationshipType es accesible.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

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

List RelationshipTypePairs RelationshipTypePairs.

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

Enumerar metamodelItemSolution Solutions.

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

List AttributeAssignment AttributeAssignments.

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

Representa la propiedad de navegación a la colección de grupos de asignaciones de atributos.

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

Representa la propiedad de navegación a la colección de aprobadores predeterminados.

alias
alias string

Obtiene o establece el alias del elemento de metamodelo.

nombre
name string

Obtiene o establece el nombre del elemento de metamodelo.

descripción
description string

Obtiene o establece la descripción del elemento de metamodelo.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

Nombre Ruta de acceso 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.

activeState
activeState boolean

bool ActiveState.

isApprovable
isApprovable boolean

Representa si relationshipType es accesible.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

alias
alias string

Obtiene o establece el alias del elemento de metamodelo.

nombre
name string

Obtiene o establece el nombre del elemento de metamodelo.

descripción
description string

Obtiene o establece la descripción del elemento de metamodelo.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Nombre Ruta de acceso Tipo Description
value
value double

decimal Value.

stringValue
stringValue string

string StringValue.

attributeValueId
attributeValueId integer

long AttributeValueId.

attributeCategoryId
attributeCategoryId integer

int AttributeCategoryId.

attributeId
attributeId uuid

Guid AttributeId.

modelItemId
modelItemId uuid

Guid ModelItemId.

attributeName
attributeName string

string AttributeName.

attributeAlias
attributeAlias string

string AttributeAlias.

OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat

Nombre Ruta de acceso Tipo Description
object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Nombre Ruta de acceso Tipo Description
isApprovable
isApprovable boolean
isPendingReview
isPendingReview boolean
requestedBy
requestedBy uuid
requestedOn
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
completedBy
completedBy uuid
completedOn
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
comentario
comment string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Nombre Ruta de acceso Tipo Description
isApprovable
isApprovable boolean
isPendingReview
isPendingReview boolean
requestedBy
requestedBy uuid
requestedOn
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
completedBy
completedBy uuid
completedOn
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
comentario
comment string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Nombre Ruta de acceso Tipo Description
solutionId
solutionId uuid

Representa el identificador de la solución.

nombre
name string

Representa el nombre de la solución.

OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

Nombre Ruta de acceso Tipo Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

descripción
description string

Representa la descripción del modelo.

dateCreated
dateCreated date-time

Representa DateTime cuando se creó el modelo.

createdById
createdById uuid

Representa el UserId por el que se creó el modelo.

dateLastModified
dateLastModified date-time

Representa DateTime cuando se modificó el modelo.

lastModifiedById
lastModifiedById uuid

Representa el UserId por el que se modificó el modelo.

startDate
startDate date-time

Representa DateTime cuando se inició el modelo.

fecha de finalización
endDate date-time

Representa DateTime cuando el modelo estaba obsoleto.

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

Representa el modelo desactivado.

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

Representa la propiedad de navegación a la colección de soluciones.

modelId
modelId uuid

Representa el identificador del modelo.

nombre
name string

Representa el nombre del modelo.

OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

Nombre Ruta de acceso Tipo Description
descripción
description string

Representa la descripción del modelo.

dateCreated
dateCreated date-time

Representa DateTime cuando se creó el modelo.

createdById
createdById uuid

Representa el UserId por el que se creó el modelo.

dateLastModified
dateLastModified date-time

Representa DateTime cuando se modificó el modelo.

lastModifiedById
lastModifiedById uuid

Representa el UserId por el que se modificó el modelo.

startDate
startDate date-time

Representa DateTime cuando se inició el modelo.

fecha de finalización
endDate date-time

Representa DateTime cuando el modelo estaba obsoleto.

isHidden
isHidden boolean

Representa el modelo desactivado.

modelId
modelId uuid

Representa el identificador del modelo.

nombre
name string

Representa el nombre del modelo.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1

Nombre Ruta de acceso Tipo Description
originalObjectId
originalObjectId uuid

Identificador del objeto original.

currentVersionNumber
currentVersionNumber integer

Número de versión actual de ModelItem.

estado
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Estado del elemento de modelo.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Nombre Ruta de acceso Tipo Description
originalObjectId
originalObjectId uuid

Identificador del objeto original.

currentVersionNumber
currentVersionNumber integer

Número de versión actual de ModelItem.

OfficeArchitect.Contracts.OData.Model.Object_Level0

Entidad de objeto OData.

Nombre Ruta de acceso Tipo Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Representa la entidad Tipo de objeto.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar usuario.

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

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar usuario.

objectId
objectId uuid

Guid ObjectId.

nombre
name string

string Name.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Fecha bloqueada.

lockedById
lockedById uuid

LockedBy User Id.

isApproved
isApproved boolean

Se aprueba.

relatedObjects
relatedObjects array of OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

virtual List RelatedObject RelatedObjects.

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

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

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

Enumerar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level1

Entidad de objeto OData.

Nombre Ruta de acceso Tipo Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Representa la entidad Tipo de objeto.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

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

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

objectId
objectId uuid

Guid ObjectId.

nombre
name string

string Name.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Fecha bloqueada.

lockedById
lockedById uuid

LockedBy User Id.

isApproved
isApproved boolean

Se aprueba.

relatedObjects
relatedObjects array of OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

virtual List RelatedObject RelatedObjects.

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

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

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

Enumerar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level2

Entidad de objeto OData.

Nombre Ruta de acceso Tipo Description
objectId
objectId uuid

Guid ObjectId.

nombre
name string

string Name.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Fecha bloqueada.

lockedById
lockedById uuid

LockedBy User Id.

isApproved
isApproved boolean

Se aprueba.

modelId
modelId uuid

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

Objeto relacionado.

Nombre Ruta de acceso 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

Nombre Ruta de acceso Tipo Description
originalRelationshipId
originalRelationshipId uuid

Identificador de relación original.

currentVersionNumber
currentVersionNumber integer

Número de versión actual de ModelItem.

estado
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Estado del elemento de modelo.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Nombre Ruta de acceso Tipo Description
originalRelationshipId
originalRelationshipId uuid

Identificador de relación original.

currentVersionNumber
currentVersionNumber integer

Número de versión actual de ModelItem.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Relación.

Nombre Ruta de acceso Tipo Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Entidad de objeto OData.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relación.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Entidad de 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
model
model OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar usuario.

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. de par de tipo de relación.

isApproved
isApproved boolean

Se aprueba.

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

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

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

Enumerar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relación.

Nombre Ruta de acceso Tipo Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Entidad de objeto OData.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relación.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Entidad de 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
model
model OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

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. de par de tipo de relación.

isApproved
isApproved boolean

Se aprueba.

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

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

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

Enumerar AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relación.

Nombre Ruta de acceso 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. de par de tipo de relación.

isApproved
isApproved boolean

Se aprueba.

modelId
modelId uuid

Guid ModelId.

dateCreated
dateCreated date-time

DateTime? DateCreated.

createdById
createdById uuid

Guid CreatedById.

lastModifiedDate
lastModifiedDate date-time

DateTime? LastModifiedDate.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Auditar usuario.

Nombre Ruta de acceso Tipo Description
userId
userId uuid

Identificador de usuario guid.

nombre
name string

string Name.

dirección de correo electrónico
emailAddress string

string EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Auditar usuario.

Nombre Ruta de acceso Tipo Description
userId
userId uuid

Identificador de usuario guid.

nombre
name string

string Name.

dirección de correo electrónico
emailAddress string

string EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Modelo que representa la respuesta de la operación de creación de objetos.

Nombre Ruta de acceso 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
correcto
success boolean

Indica que la operación se ha realizado correctamente.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensajes de respuesta.

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Modelo que representa la respuesta de la operación de eliminación de objetos.

Nombre Ruta de acceso 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
correcto
success boolean

Indica que la operación se ha realizado correctamente.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensajes de respuesta.

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Modelo que representa la respuesta de la operación del objeto de actualización.

Nombre Ruta de acceso 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
correcto
success boolean

Indica que la operación se ha realizado correctamente.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensajes de respuesta.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Nombre Ruta de acceso 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
correcto
success boolean

Indica que la operación se ha realizado correctamente.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensajes de respuesta.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Nombre Ruta de acceso 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
correcto
success boolean

Indica que la operación se ha realizado correctamente.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensajes de respuesta.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Nombre Ruta de acceso 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
correcto
success boolean

Indica que la operación se ha realizado correctamente.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Mensajes de respuesta.

OfficeArchitect.Contracts.Response.EntityType

OfficeArchitect.Contracts.Response.OperationType

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

Representa información adicional que admiten los formatos OData. Solo es para fines de documentación de Swagger.

Nombre Ruta de acceso Tipo Description
@odata.context
@odata.context string

Vínculo al contexto de Odata.

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

Obtiene la colección de entidades para esta fuente.

@odata.nextLink
@odata.nextLink uri

Obtiene el vínculo de la página siguiente de valores de la fuente.

@odata.count
@odata.count integer

Obtiene el recuento total de valores de la fuente.

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

Representa información adicional que admiten los formatos OData. Solo es para fines de documentación de Swagger.

Nombre Ruta de acceso Tipo Description
@odata.context
@odata.context string

Vínculo al contexto de Odata.

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

Obtiene la colección de entidades para esta fuente.

@odata.nextLink
@odata.nextLink uri

Obtiene el vínculo de la página siguiente de valores de la fuente.

@odata.count
@odata.count integer

Obtiene el recuento total de valores de la fuente.