Partager via


OrbusInfinity

OrbusInfinity permet aux équipes d’architecture de générer un blueprint numérique de l’entreprise et de prendre des décisions éclairées en fonction d’une vue unifiée de l’entreprise maintenant et à l’avenir. Créez des automatisations personnalisées pour créer, lire et mettre à jour des objets et des relations au sein de votre référentiel de données.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Orbus Software
URL https://support.orbussoftware.com
Messagerie électronique support@orbussoftware.com
Métadonnées du connecteur
Éditeur Orbus Software
Site internet https://www.orbussoftware.com
Politique de confidentialité https://www.orbussoftware.com/privacy-policy
Catégories Site internet; Données

Connecteur OrbusInfinity

OrbusInfinity est une véritable solution multilocataire SaaS qui fournit la plateforme ultime pour permettre votre transformation numérique.

OrbusInfinity s’intègre directement à Microsoft Office pour vous permettre de lier, d’échanger, de visualiser et de synchroniser facilement des données avec le référentiel OrbusInfinity.

Le connecteur OrbusInfinity est basé sur l’API OrbusInfinity et fournit des opérations permettant d’interagir facilement avec la plateforme.

Éditeur : Orbus Software

Prerequisites

Pour utiliser le connecteur, vous avez besoin des éléments suivants :

  • Plan Power Automate avec accès aux connecteurs Premium
  • Abonnement OrbusInfinity qui inclut l’accès à l’API
  • Compte OrbusInfinity

Authentication

  • Authentification oAuth2 avec flux implicite
  • Vous devez être authentifié pour effectuer une opération répertoriée ci-dessous

Opérations prises en charge

Opération Descriptif
Objets Get Obtenir des objets et leurs détails
Publication d’objets Créer un objet
Objets Get Single Obtenir les détails d’un objet
Suppression d’objets Supprimer un objet
Correctif d’objets Mettre à jour les valeurs d’attribut d’un objet existant
Obtention des relations Obtenir les relations et leurs détails
Publication des relations Créer une relation
Relations get single Obtenir les détails d’une relation
Relations supprimer Supprimer une relation
Correctif de relations Mettre à jour les valeurs d’attribut d’une relation existante
Post Webhooks Crée un déclencheur avec l’événement demandé
Supprimer des webhooks Supprimer un webhook existant

Objets

Opérations de configuration et de gestion des objets de modèle.

Objets Get

GET /odata/Objects

Obtenir des objets et leurs détails

La réponse par défaut inclut la liste de 50 objets, qui ont été récemment créés dans OrbusInfinity et leurs propriétés de niveau supérieur. Utilisez les paramètres OData ci-dessous pour filtrer, classer, développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées dans la sortie.

Paramètres

Nom In Type Obligatoire Descriptif
$select query ficelle false Sous-ensemble de propriétés à inclure pour chaque objet dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.
$expand query ficelle false Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour chaque objet dans la réponse.
Vous pouvez également demander les propriétés suivantes : Model, , ObjectTypeAttributeValuesAttributeValuesFlat, CreatedBy, LastModifiedBy, , . LockedByDetail
$filtre query ficelle false Expression par laquelle vous filtrez les objets dans le résultat. Vous pouvez filtrer les objets par une valeur pour les propriétés suivantes : ObjectId, , ObjectTypeIdName, LockedOn, LockedById, , DateCreatedIsApprovedLastModifiedDateModelIdCreatedById, LastModifiedById, , DetailAttributeValues, ObjectType, . ModelCreatedByLastModifiedByLockedBy
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 100.
$orderby query ficelle false Ordre dans lequel les objets sont triés dans la réponse, par une propriété sélectionnée. Par exemple, entrez Name desc pour demander des objets dans l’ordre décroissant par propriété Name.
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 5.
$top query integer(int32) false Nombre d’objets, récemment créés dans OrbusInfinity, à inclure dans la réponse. La valeur minimale est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour renvoyer 20 objets qui ont été récemment créés dans OrbusInfinity.
$skip query integer(int32) false Nombre d’objets, qui ont été créés récemment dans OrbusInfinity, à exclure de la réponse. La valeur minimale et par défaut est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour ignorer 20 objets qui ont été récemment créés dans OrbusInfinity et renvoyer les 50 suivants.
$count query boolean false Si la valeur est true, le nombre total d’objets est spécifié dans la réponse. Par défaut, le paramètre est défini sur false, ce qui signifie que le nombre total n’est pas retourné.

Responses

Retourne une réponse dynamique.

Publication d’objets

POST /odata/Objects

Créer un objet

Vous devez spécifier l’ID de type d’objet, l’ID de modèle et les attributs d’identification pour le nouvel objet. Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur.

Paramètre body

Paramètres

Nom In Type Obligatoire Descriptif
body body CreateObjectRequestValue true Valeurs de propriété d’un nouvel objet. Spécifiez ObjectTypeId, NameModelIdpour créer un objet.

Descriptions détaillées

body : Valeurs de propriété d’un nouvel objet. Spécifiez ObjectTypeId, NameModelIdpour créer un objet. Spécifiez éventuellement des propriétés supplémentaires, en suivant la structure de l’exemple.

Responses

Création d’un objet. CreateObjectResponse

Objets Get Single

GET /odata/Objects({key})

Obtenir les détails d’un objet

La réponse par défaut inclut uniquement les propriétés de niveau supérieur. Utilisez des paramètres OData facultatifs pour développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées.

Paramètres

Nom In Type Obligatoire Descriptif
key path string(uuid) true ID d’un objet au format GUID, par exemple 00000000-0000-0000-0000-000000000000.
$select query ficelle false Sous-ensemble de propriétés à inclure pour l’objet dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.
$expand query ficelle false Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour l’objet dans la réponse.
Vous pouvez également demander les propriétés suivantes : Model, AttributeValuesFlatAttributeValuesObjectTypeRelatedObjectsCreatedBy, LastModifiedBy, LockedBy, . ApprovalDetailsDetail

Responses

Retourne une réponse dynamique.

Suppression d’objets

DELETE /odata/Objects({key})

Supprimer un objet

L’objet supprimé est déplacé vers la Corbeille.

Paramètres

Nom In Type Obligatoire Descriptif
key path string(uuid) true ID d’un objet au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

Responses

Suppression d’un objet. DeleteObjectResponse

Correctif d’objets

PATCH /odata/Objects({key})

Mettre à jour les valeurs d’attribut d’un objet existant

Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur. Seules les valeurs d’attribut spécifiées sont mises à jour.

Paramètre body

Paramètres

Nom In Type Obligatoire Descriptif
key path string(uuid) true ID d’un objet au format GUID, par exemple 00000000-0000-0000-0000-000000000000.
body body UpdateObjectRequestValue true Valeur(s) d’attribut à mettre à jour pour l’objet spécifié. Pour chaque attribut, spécifiez

Responses

Mise à jour de l’objet. UpdateObjectResponse

Relations interpersonnelles

Opérations de configuration et de gestion des relations de modèle.

Obtention des relations

GET /odata/Relationships

Obtenir les relations et leurs détails

La réponse par défaut inclut la liste de 50 relations, qui ont été récemment créées dans OrbusInfinity et leurs propriétés de niveau supérieur. Utilisez les paramètres OData ci-dessous pour filtrer, classer, développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées dans la sortie.

Paramètres

Nom In Type Obligatoire Descriptif
includeIntersectional query boolean false Si la valeur est true, incluez les relations intersectionnelles dans la sortie.
$select query ficelle false Sous-ensemble de propriétés à inclure pour chaque relation dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.
$expand query ficelle false Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour chaque relation dans la réponse.
Vous pouvez également demander les propriétés suivantes : LeadObject, , LeadRelationshipMemberObjectRelationshipType, Model, AttributeValues, , . AttributeValuesFlatDetail
$filtre query ficelle false Expression par laquelle vous filtrez les relations dans le résultat. Vous pouvez filtrer les relations en fonction d’une valeur pour les propriétés suivantes : RelationshipId, , RelationshipTypeIdModelIdRelationshipType, Model, , LeadObjectId, , LeadRelationshipId, , . MemberObjectIdDetail
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 100.
$orderby query ficelle false Ordre dans lequel les relations sont triées dans la réponse, par une propriété sélectionnée. Par exemple, entrez DateCreated desc pour demander des relations dans l’ordre décroissant par propriété DateCreated.
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 5.
$top query integer(int32) false Nombre de relations, qui ont été créées récemment dans OrbusInfinity, à inclure dans la réponse. La valeur minimale est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour renvoyer 20 relations qui ont été créées récemment dans OrbusInfinity.
$skip query integer(int32) false Nombre de relations, qui ont été créées récemment dans OrbusInfinity, à exclure de la réponse. La valeur minimale et par défaut est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour ignorer 20 relations qui ont été créées récemment dans OrbusInfinity et retourner les 50 suivantes.
$count query boolean false Si la valeur est true, le nombre total de relations est spécifié dans la réponse. Par défaut, le paramètre est défini sur false, ce qui signifie que le nombre total n’est pas retourné.

Descriptions détaillées

includeIntersectional : si la valeur est true, incluez les relations intersectionnelles dans la sortie. Les relations intersectionnelles ont une valeur pour LeadRelationshipId la propriété et les relations régulières ont une valeur pour LeadObjectId la propriété.

Responses

Retourne une réponse dynamique.

Publication des relations

POST /odata/Relationships

Créer une relation

Vous devez spécifier l’ID de type de relation, l’ID de modèle, l’ID de paire de types de relation, l’ID d’objet principal, l’ID d’objet membre et les attributs d’identification pour la nouvelle relation. Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur.

Paramètre body

Paramètres

Nom In Type Obligatoire Descriptif
body body CreateRelationshipRequestValue true Valeurs de propriété pour une nouvelle relation. Spécifiez RelationshipTypeId, , ModelIdRelationshipTypePairId, LeadModelItemId, pour MemberModelItemId créer une relation.

Responses

Création d’une nouvelle relation. CreateRelationshipResponse

Relations get single

GET /odata/Relationships({key})

Obtenir les détails d’une relation

La réponse par défaut inclut uniquement les propriétés de niveau supérieur. Utilisez des paramètres OData facultatifs pour développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées.

Paramètres

Nom In Type Obligatoire Descriptif
key path string(uuid) true ID d’une relation au format GUID, par exemple 00000000-0000-0000-0000-000000000000.
$select query ficelle false Sous-ensemble de propriétés à inclure pour la relation dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.
$expand query ficelle false Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour la relation dans la réponse.
Vous pouvez également demander les propriétés suivantes : LeadObject, RelationshipTypeModelLeadRelationshipMemberObjectAttributeValues, AttributeValuesFlat, . ApprovalDetailsDetail

Responses

Retourne une réponse dynamique.

Relations supprimer

DELETE /odata/Relationships({key})

Supprimer une relation

La relation supprimée est déplacée vers la Corbeille.

Paramètres

Nom In Type Obligatoire Descriptif
key path string(uuid) true ID d’une relation au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

Responses

Suppression de la relation. DeleteRelationshipResponse

Correctif de relations

PATCH /odata/Relationships({key})

Mettre à jour les valeurs d’attribut d’une relation existante

Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur. Seules les valeurs d’attribut spécifiées sont mises à jour.

Paramètre body

Paramètres

Nom In Type Obligatoire Descriptif
key path string(uuid) true ID d’une relation au format GUID, par exemple 00000000-0000-0000-0000-000000000000.
body body UpdateRelationshipRequestValue true Valeur(s) d’attribut à mettre à jour pour la relation spécifiée. Pour chaque attribut, spécifiez

Responses

Mise à jour de la relation. UpdateRelationshipResponse

Webhooks

Opérations de gestion des Webhooks.

Post Webhooks

POST /odata/Webhooks

Lorsqu’un événement se produit

Crée un déclencheur avec l’événement demandé. Par conséquent, lorsque cet événement se produit dans OrbusInfinity, l’application située à l’URL fournie est avertie.

Paramètre body

Paramètres

Nom In Type Obligatoire Descriptif
body body CreateWebhookRequest true Demande contenant les informations du webhook.

Responses

SaveWebhookResponse

Supprimer des webhooks

DELETE /odata/Webhooks({key})

Supprimer un webhook existant

Supprime un webhook existant en fournissant l’ID de webhook.

Paramètres

Nom In Type Obligatoire Descriptif
key path integer(int32) true Identificateur du webhook.

Responses

DeleteWebhookResponse

Schemas

WebhookSaved

Propriétés

Nom Type Obligatoire Restrictions Descriptif
webhookId integer(int32) false Aucune ID du Webhook.

ObjectCreated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
nom ficelle false Aucune Nom de l’objet créé.
objectId string(uuid) false Aucune ID de l’objet créé.
modelId string(uuid) false Aucune ID de modèle de l’objet créé.
objectTypeId string(uuid) false Aucune ID de type d’objet de l’objet créé.

ObjectDeleted

Propriétés

Nom Type Obligatoire Restrictions Descriptif
objectId string(uuid) false Aucune ID de l’objet supprimé.
objectName ficelle false Aucune Nom de l’objet supprimé.

ObjectUpdated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
objectId string(uuid) false Aucune ID d’un objet.
nom ficelle false Aucune Nom d’un objet.

RelationshipCreated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
relationshipId string(uuid) false Aucune ID de relation.
leadObjectId string(uuid) false Aucune ID de l’objet lead de la relation.
leadRelationshipId string(uuid) false Aucune ID de la relation de prospect. Utilisé pour les relations intersectionnelles.
memberObjectId string(uuid) false Aucune ID de l’objet membre de la relation.

RelationshipDeleted

Propriétés

Nom Type Obligatoire Restrictions Descriptif
deletedRelationshipId string(uuid) false Aucune ID de la relation supprimée.

RelationshipUpdated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
relationshipId string(uuid) false Aucune ID de relation.

MessageCategory

Valeur
Erreur
Avertissement
Informations

MessageCode

Valeur
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryMismatch
CustomDocumentTypeNotSupported
CustomDocumentTypeMustHaveAtLeastOneFileExtension
DocumentTypeFileExtensionNotSupportedForCustomCategory
IdentificationAttributeAssignmentWithInstancesExists
DocumentTypeDoesNotExist
DocumentTypeNameIsInvalid
DocumentTypeFilenameInvalid
DocumentTypePrimaryTemplateAlreadyExists
DocumentTypeDoesNotSupportAncillaryTemplateFiles
MissingDocumentTypeTemplateFile
MissingDocumentTypePrimaryTemplateFile
MultipleDocumentTypePrimaryTemplateFiles
DocumentTypeFileExtensionNotSupportedForCategory
TemplateFilenamesMustBeUnique
ContentTypeSaveOperationFailed
InvalidDocumentTypeRelationshipType
MetamodelItemMustBelongToAModellingSolution
ParentObjectTypeDoesNotExist
ObjectTypeHasCircularReference
ObjectsTypeHasNotChanged
ModelDoesNotExist
MetamodelItemIsNotUniqueToModellingSolution
MetamodelItemNotInModel
MetamodelItemIsSystemLocked
MetamodelItemIsHidden
MetamodelItemIsAlreadyVisible
MetamodelItemIsNotApprovable
MetamodelItemHasNotRequiredCategory
MetamodelItemHasNotAttributeAssignment
MetamodelItemHasNotCommonSolutionsWithIdentifyingAttribute
AttributesDeleted
ObjectTypesDeleted
RelationshipTypesDeleted
DependentModelItemsExist
ModelItemsDoesNotHaveComponents
ModelItemIsNotComponentOfDocumentType
RelationshipPairMembersAreNotComponentsOfDocument
MultipleDuplicateMetamodelItems
EntityIsAlreadyProtected
EntityIsAlreadyUnprotected
AttributeDoesNotExist
AttributeDoesNotExistByName
AttributeDoesNotExistByKey
AttributeNotAssignedToMetamodelItem
AttributeIsNotIdentifyingAttribute
AttributeNotInModelModellingSolution
AttributeAssignmentCannotBeEdited
IdentificationAttributeAssignmentExists
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
MapImportWorksheetSettingsDoesNotExist
MapImportWorksheetSettingsDoesNotBelongToUser
ModelDoesNotHaveSubsetOfModellingSolutions
ModelNameNotUnique
ModelNameValueNotProvided
ModelIsDeactivated
ModelIsActivated
ModelsDeactivated
ModelsActivated
ModelingSolutionsAreNotUnique
IdentificationAttributeCannotBeImportant
MultipleIdentifyingAttributeAssignments
AttributesAreAlreadyAssigned
MetamodelItemHasInstances
IdentificationAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
UnableToAssignSystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AttributeChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
IdentificationAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
ModelingSolutionDoesNotExist
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
IdentificationAttributeValueNotProvided
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
Objets Copiés
ObjectDeleted
ObjectsDeleted
Objets fusionnés
ObjectReclassified
ObjectsReclassified
ObjectsRelationshipsMerged
RelationshipCreated
RelationsCreated
Relations copiées
RelationshipUpdated
RelationsUpdated
RelationshipDeleted
RelationsDeleted
RelationSkipped
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
Relations fusionnées
LeadToMemberDirectionEmpty
MemberToLeadDirectionEmpty
RepresentationSituationIsNotValid
IntersectionalRelationshipRepresentationIsNotValid
IntersectionalRelationshipTypeWithSamePairAlreadyExists
IntersectionalRelationshipTypeCannotHavePairsWithAnyLeadOrMember
RelationshipTypeHasNoPairs
DuplicateRelationshipTypeInModellingSolution
DocumentManagementSystemRetrieved
ObjectTypeCreated
SolutionCreated
SolutionDeleted
WebhookSaved
WebhookDeleted
MapImportWorksheetSettingsCreated
MapImportWorksheetSettingsUpdated
ModelCopied
ModelItemsCopied
ModelItemLocked
ModelItemUnlocked
ModelItemApprovalRequested
ModelItemApprovalRequestCompleted
ModelItemsNotApprovable
ModelCreated
ModelUpdated
NotificationCreated
NotificationDataHasIncorrectType
NotificationEndDatePrecedesStartDate
BothNotificationProgressCountsAndPercentAreSet
NotificationsDeleted
NotificationsPurged
NotificationsRead
NotificationsReadAll
NotificationsUpdated
RelationshipTypeUpdated
RelationshipTypeCreated
RelationshipTypesCreated
RelationshipTypePairUpdated
RelationshipTypePairsCreated
DocumentCreated
DocumentUpdated
DocumentCounterpartAssigned
DocumentCounterpartUnassigned
DocumentCounterpartsDeleted
DocumentCounterpartsCreated
DocumentCounterpartsUpdated
DocumentCounterpartsReassigned
DocumentFilePathIsInvalid
DocumentModelRootPathIsNotValid
DocumentFilePathIsTooLong
DocumentFilenameRequiresFileExtension
DocumentFilenameContainsInvalidCharacters
DocumentFileExtensionNotSupportedForCategory
DocumentFileExtensionNotSupportedForCustomCategory
DocumentFileExtensionNotSupportedForFileTypeFilter
DocumentAlreadyExists
DocumentHasCounterparts
DocumentTypeLinksDeleted
DocumentTypeLinkDoesNotExist
DocumentTypeLinkIsInherited
InheritedDocumentLinkAlreadyExists
DocumentTypeLinkAlreadyExists
MetamodelItemIsNotAnObjectType
MetamodelItemIsNotARelationshipType
DocumentTypeLinkCreated
DocumentTypeLinksCreated
ObjectTypeUpdated
RequestCannotBeProcessed
LeadObjectTypeDoesNotExist
MemberObjectTypeDoesNotExist
DocumentComponentUpdated
DocumentComponentsUpdated
DocumentComponentDeleted
DocumentComponentCreated
DocumentComponentsCreated
DocumentTypeComponentsUpdated
DocumentTypeComponentAlreadyExists
DocumentTypeComponentDoesNotExist
MetamodelItemHasDocumentComponents
DocumentTypeCategoryIsNotVisioType
DocumentTypeCategoryIsVisioType
DocumentTypeComponentsCreated
DocumentTypeComponentsDeleted
DocumentTypeRelationshipTypeEndpointsDoNotExist
DocumentTypeTemplateUpdated
MetamodelEntitiesLocked
MetamodelEntityIsLocked
MetamodelEntitiesUnlocked
RecycleBinPurged
EntitiesProtectionStateApplied
MetamodelItemApprovalInformationHasChanged
DocumentHasDifferentDocumentType
ExternalDocumentDoesNotHaveExternalDocumentId
LeadRelationshipTypeDoesNotExist
IntersectionalRelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageIsNotValid
MetamodelItemDeactivated
MetamodelItemsDeactivated
DescriptionIsInvalid
RelationshipTypePairActivated
RelationshipTypePairsActivated
RelationshipTypePairDeactivated
RelationshipTypePairsDeactivated
MetamodelItemActivated
MetamodelItemsActivated
FailedToSaveRelationshipTypeConnectedToDetails
MemberModelItemIsNotObject
LeadModelItemIsNotObject
LeadModelItemIsNotRelationship
Espace de travailcréé
WorkspacesCreated
WorkspaceCapacityIsExceedededed
WorkspaceNameIsNotUnique
WorkspaceUpdated
WorkspacesUpdated
WorkspaceDoesNotExist
CommandsValidated
Espace de travail supprimé
WorkspacesDeleted
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculated
PricingTierIsNotValid
PermissionDenied
Erreur Interne du Serveur
Requête incorrecte
Non trouvé
Interdit
RequestAccepted
OverrideAll

Message

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.WebhookSaved

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition WebhookSaved false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.ObjectCreated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition ObjectCreated false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.ObjectDeleted

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition ObjectDeleted false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.ObjectUpdated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition ObjectUpdated false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.RelationshipCreated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition RelationshipCreated false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.RelationshipDeleted

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition RelationshipDeleted false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

OperationMessage.RelationshipUpdated

Propriétés

Nom Type Obligatoire Restrictions Descriptif
messageDefinition RelationshipUpdated false Aucune Aucune
messageCategory MessageCategory false Aucune Indique le type de message.
messageCode MessageCode false Aucune Aucune
Message ficelle false lecture seule Contenu du message.

CreateWebhookRequest

Propriétés

Nom Type Obligatoire Restrictions Descriptif
secret ficelle false Aucune Secret du récepteur.
eventType ficelle true Aucune Type d’événement d’abonnement.
URL ficelle true Aucune URL du récepteur.
date d'expiration string(date-time) false Aucune Obtient ou définit la date d’expiration. Si aucune date d’expiration n’est fournie, une valeur
par défaut, sera utilisé (généralement 6 mois après la date de création).

DeleteWebhookResponse

Propriétés

Nom Type Obligatoire Restrictions Descriptif
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

SaveWebhookResponse

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.WebhookSaved false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

CreateObjectRequestValue

Propriétés

Nom Type Obligatoire Restrictions Descriptif
objectTypeId string(uuid) true Aucune ID du type d’objet.
attributeValuesFlat objet false Aucune Paires clé-valeur de valeurs d’attribut.
additionalProperties quelconque false Aucune Aucune
modelId string(uuid) true Aucune ID du modèle.

Modèle qui représente la réponse de l’opération de création d’objet.

UpdateObjectRequestValue

Propriétés

Nom Type Obligatoire Restrictions Descriptif
attributeValuesFlat objet false Aucune Paires clé-valeur de valeurs d’attribut.

CreateObjectResponse

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.ObjectCreated false Aucune Aucune
type d’opération OperationType false Aucune Aucune
entityTypes Type d’entité false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

DeleteObjectResponse

Modèle qui représente la réponse de l’opération de suppression d’objet.

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.ObjectDeleted false Aucune Aucune
type d’opération OperationType false Aucune Aucune
entityTypes Type d’entité false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

UpdateObjectResponse

Modèle qui représente la réponse de l’opération de mise à jour de l’objet.

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.ObjectUpdated false Aucune Aucune
type d’opération OperationType false Aucune Aucune
entityTypes Type d’entité false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

CreateRelationshipRequestValue

Propriétés

Nom Type Obligatoire Restrictions Descriptif
relationshipTypeId string(uuid) true Aucune ID du type de relation.
relationshipTypePairId string(uuid) false Aucune Si la paire de types de relation est associée.
leadModelItemId string(uuid) true Aucune ID de l’élément de modèle de prospect de la relation.
memberModelItemId string(uuid) true Aucune ID de l’élément de modèle membre de la relation.
attributeValuesFlat objet false Aucune Aucune
modelId string(uuid) true Aucune ID du modèle.

UpdateRelationshipRequestValue

Propriétés

Nom Type Obligatoire Restrictions Descriptif
attributeValuesFlat objet false Aucune Aucune

CreateRelationshipResponse

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.RelationshipCreated false Aucune Aucune
type d’opération OperationType false Aucune Aucune
entityTypes Type d’entité false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

DeleteRelationshipResponse

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.RelationshipDeleted false Aucune Aucune
type d’opération OperationType false Aucune Aucune
entityTypes Type d’entité false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

UpdateRelationshipResponse

Propriétés

Nom Type Obligatoire Restrictions Descriptif
successMessage OperationMessage.RelationshipUpdated false Aucune Aucune
type d’opération OperationType false Aucune Aucune
entityTypes Type d’entité false Aucune Aucune
success boolean false Aucune Indique la réussite de l’opération.
messages Message false lecture seule Messages de réponse.

EntityType

Valeur
Aucun
Solution
ObjectType
RelationshipType
RelationshipTypePair
Caractéristique
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Model
Objet
Relation
Document
DocumentComponent
Workspace
Role

OperationType

Valeur
Créer
Update
Supprimer

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
URL de l’API OrbusInfinity ficelle URL de l’API OrbusInfinity. Par exemple, https://example-api.orbusinfinity.com Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Créer un objet

Vous devez spécifier l’ID de type d’objet, l’ID de modèle et les attributs d’identification pour le nouvel objet. Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur.

Créer une relation

Vous devez spécifier l’ID de type de relation, l’ID de modèle, l’ID de paire de types de relation, l’ID d’objet principal, l’ID d’objet membre et les attributs d’identification pour la nouvelle relation. Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur.

Mettre à jour les valeurs d’attribut d’un objet existant

Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur. Seules les valeurs d’attribut spécifiées sont mises à jour.

Mettre à jour les valeurs d’attribut d’une relation existante

Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur. Seules les valeurs d’attribut spécifiées sont mises à jour.

Obtenir des objets et leurs détails

La réponse par défaut inclut la liste de 50 objets, qui ont été récemment créés dans OrbusInfinity et leurs propriétés de niveau supérieur. Utilisez les paramètres OData ci-dessous pour filtrer, classer, développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées dans la sortie.

Obtenir les détails d’un objet

La réponse par défaut inclut uniquement les propriétés de niveau supérieur. Utilisez des paramètres OData facultatifs pour développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées.

Obtenir les détails d’une relation

La réponse par défaut inclut uniquement les propriétés de niveau supérieur. Utilisez des paramètres OData facultatifs pour développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées.

Obtenir les relations et leurs détails

La réponse par défaut inclut la liste de 50 relations, qui ont été récemment créées dans OrbusInfinity et leurs propriétés de niveau supérieur. Utilisez les paramètres OData ci-dessous pour filtrer, classer, développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées dans la sortie.

Supprimer un objet

L’objet supprimé est déplacé vers la Corbeille.

Supprimer une relation

La relation supprimée est déplacée vers la Corbeille.

Créer un objet

Vous devez spécifier l’ID de type d’objet, l’ID de modèle et les attributs d’identification pour le nouvel objet. Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur.

Paramètres

Nom Clé Obligatoire Type Description
objectTypeId
objectTypeId True uuid

ID du type d’objet.

attributeValuesFlat
attributeValuesFlat object

Paires clé-valeur de valeurs d’attribut.

modelId
modelId True uuid

ID du modèle.

Retours

Modèle qui représente la réponse de l’opération de création d’objet.

Créer une relation

Vous devez spécifier l’ID de type de relation, l’ID de modèle, l’ID de paire de types de relation, l’ID d’objet principal, l’ID d’objet membre et les attributs d’identification pour la nouvelle relation. Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur.

Paramètres

Nom Clé Obligatoire Type Description
relationshipTypeId
relationshipTypeId True uuid

ID du type de relation.

relationshipTypePairId
relationshipTypePairId uuid

Si la paire de types de relation est associée.

leadModelItemId
leadModelItemId True uuid

ID de l’élément de modèle de prospect de la relation.

memberModelItemId
memberModelItemId True uuid

ID de l’élément de modèle membre de la relation.

attributeValuesFlat
attributeValuesFlat object
modelId
modelId True uuid

ID du modèle.

Retours

Mettre à jour les valeurs d’attribut d’un objet existant

Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur. Seules les valeurs d’attribut spécifiées sont mises à jour.

Paramètres

Nom Clé Obligatoire Type Description
key
key True uuid

ID d’un objet au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Paires clé-valeur de valeurs d’attribut.

Retours

Modèle qui représente la réponse de l’opération de mise à jour de l’objet.

Mettre à jour les valeurs d’attribut d’une relation existante

Utilisez AttributeValuesFlat la propriété pour spécifier les valeurs d’attribut au format clé-valeur. Seules les valeurs d’attribut spécifiées sont mises à jour.

Paramètres

Nom Clé Obligatoire Type Description
key
key True uuid

ID d’une relation au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Retours

Obtenir des objets et leurs détails

La réponse par défaut inclut la liste de 50 objets, qui ont été récemment créés dans OrbusInfinity et leurs propriétés de niveau supérieur. Utilisez les paramètres OData ci-dessous pour filtrer, classer, développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées dans la sortie.

Paramètres

Nom Clé Obligatoire Type Description
$select
$select string

Sous-ensemble de propriétés à inclure pour chaque objet dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.

$expand
$expand string

Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour chaque objet dans la réponse.
Vous pouvez également demander les propriétés suivantes : Model, , ObjectTypeAttributeValuesAttributeValuesFlat, CreatedBy, LastModifiedBy, , . LockedByDetail

$filtre
$filter string

Expression par laquelle vous filtrez les objets dans le résultat. Vous pouvez filtrer les objets par une valeur pour les propriétés suivantes : ObjectId, , ObjectTypeIdName, LockedOn, LockedById, , DateCreatedIsApprovedLastModifiedDateModelIdCreatedById, LastModifiedById, , DetailAttributeValues, ObjectType, . ModelCreatedByLastModifiedByLockedBy
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 100.

$orderby
$orderby string

Ordre dans lequel les objets sont triés dans la réponse, par une propriété sélectionnée. Par exemple, entrez Name desc pour demander des objets dans l’ordre décroissant par propriété Name.
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 5.

$top
$top integer

Nombre d’objets, récemment créés dans OrbusInfinity, à inclure dans la réponse. La valeur minimale est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour renvoyer 20 objets qui ont été récemment créés dans OrbusInfinity.

$skip
$skip integer

Nombre d’objets, qui ont été créés récemment dans OrbusInfinity, à exclure de la réponse. La valeur minimale et par défaut est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour ignorer 20 objets qui ont été récemment créés dans OrbusInfinity et renvoyer les 50 suivants.

$count
$count boolean

Si la valeur est true, le nombre total d’objets est spécifié dans la réponse. Par défaut, le paramètre est défini sur false, ce qui signifie que le nombre total n’est pas retourné.

Retours

Représente des informations supplémentaires que les formats OData prennent en charge. Il s’agit uniquement d’une documentation swagger.

Obtenir les détails d’un objet

La réponse par défaut inclut uniquement les propriétés de niveau supérieur. Utilisez des paramètres OData facultatifs pour développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées.

Paramètres

Nom Clé Obligatoire Type Description
key
key True uuid

ID d’un objet au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

$select
$select string

Sous-ensemble de propriétés à inclure pour l’objet dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.

$expand
$expand string

Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour l’objet dans la réponse.
Vous pouvez également demander les propriétés suivantes : Model, AttributeValuesFlatAttributeValuesObjectTypeRelatedObjectsCreatedBy, LastModifiedBy, LockedBy, . ApprovalDetailsDetail

Retours

Entité d’objet OData.

Obtenir les détails d’une relation

La réponse par défaut inclut uniquement les propriétés de niveau supérieur. Utilisez des paramètres OData facultatifs pour développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées.

Paramètres

Nom Clé Obligatoire Type Description
key
key True uuid

ID d’une relation au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

$select
$select string

Sous-ensemble de propriétés à inclure pour la relation dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.

$expand
$expand string

Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour la relation dans la réponse.
Vous pouvez également demander les propriétés suivantes : LeadObject, RelationshipTypeModelLeadRelationshipMemberObjectAttributeValues, AttributeValuesFlat, . ApprovalDetailsDetail

Retours

Relation.

Obtenir les relations et leurs détails

La réponse par défaut inclut la liste de 50 relations, qui ont été récemment créées dans OrbusInfinity et leurs propriétés de niveau supérieur. Utilisez les paramètres OData ci-dessous pour filtrer, classer, développer des propriétés supplémentaires et sélectionner uniquement les propriétés spécifiées dans la sortie.

Paramètres

Nom Clé Obligatoire Type Description
includeIntersectional
includeIntersectional boolean

Si la valeur est true, incluez les relations intersectionnelles dans la sortie. Les relations intersectionnelles ont une valeur pour LeadRelationshipId la propriété et les relations régulières ont une valeur pour LeadObjectId la propriété.

$select
$select string

Sous-ensemble de propriétés à inclure pour chaque relation dans la réponse. Si elle est vide, les propriétés par défaut sont retournées.

$expand
$expand string

Propriétés supplémentaires (ainsi que les propriétés par défaut) à inclure pour chaque relation dans la réponse.
Vous pouvez également demander les propriétés suivantes : LeadObject, , LeadRelationshipMemberObjectRelationshipType, Model, AttributeValues, , . AttributeValuesFlatDetail

$filtre
$filter string

Expression par laquelle vous filtrez les relations dans le résultat. Vous pouvez filtrer les relations en fonction d’une valeur pour les propriétés suivantes : RelationshipId, , RelationshipTypeIdModelIdRelationshipType, Model, , LeadObjectId, , LeadRelationshipId, , . MemberObjectIdDetail
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 100.

$orderby
$orderby string

Ordre dans lequel les relations sont triées dans la réponse, par une propriété sélectionnée. Par exemple, entrez DateCreated desc pour demander des relations dans l’ordre décroissant par propriété DateCreated.
Le nombre minimal et par défaut d’expressions est 0 ; la valeur maximale : 5.

$top
$top integer

Nombre de relations, qui ont été créées récemment dans OrbusInfinity, à inclure dans la réponse. La valeur minimale est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour renvoyer 20 relations qui ont été créées récemment dans OrbusInfinity.

$skip
$skip integer

Nombre de relations, qui ont été créées récemment dans OrbusInfinity, à exclure de la réponse. La valeur minimale et par défaut est 0 ; la valeur maximale : 50.
Par exemple, entrez 20 pour ignorer 20 relations qui ont été créées récemment dans OrbusInfinity et retourner les 50 suivantes.

$count
$count boolean

Si la valeur est true, le nombre total de relations est spécifié dans la réponse. Par défaut, le paramètre est défini sur false, ce qui signifie que le nombre total n’est pas retourné.

Retours

Représente des informations supplémentaires que les formats OData prennent en charge. Il s’agit uniquement d’une documentation swagger.

Supprimer un objet

L’objet supprimé est déplacé vers la Corbeille.

Paramètres

Nom Clé Obligatoire Type Description
key
key True uuid

ID d’un objet au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

Retours

Modèle qui représente la réponse de l’opération de suppression d’objet.

Supprimer une relation

La relation supprimée est déplacée vers la Corbeille.

Paramètres

Nom Clé Obligatoire Type Description
key
key True uuid

ID d’une relation au format GUID, par exemple 00000000-0000-0000-0000-000000000000.

Retours

Déclencheurs

Lorsqu’un événement se produit

Crée un déclencheur avec l’événement demandé. Par conséquent, lorsque cet événement se produit dans OrbusInfinity, l’application située à l’URL fournie est avertie.

Lorsqu’un événement se produit

Crée un déclencheur avec l’événement demandé. Par conséquent, lorsque cet événement se produit dans OrbusInfinity, l’application située à l’URL fournie est avertie.

Paramètres

Nom Clé Obligatoire Type Description
secret
secret string

Secret du récepteur.

eventType
eventType True string

Type d’événement d’abonnement.

date d'expiration
expirationDate date-time

Obtient ou définit la date d’expiration. Si aucune date d’expiration n’est fournie, une valeur par défaut est utilisée (généralement 6 mois après la date de création).

Retours

Définitions

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Nom Chemin d’accès Type Description
object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Nom Chemin d’accès Type Description
nom
name string

Nom de l’objet créé.

objectId
objectId uuid

ID de l’objet créé.

modelId
modelId uuid

ID de modèle de l’objet créé.

objectTypeId
objectTypeId uuid

ID de type d’objet de l’objet créé.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2

Nom Chemin d’accès Type Description
objectId
objectId uuid

ID de l’objet supprimé.

objectName
objectName string

Nom de l’objet supprimé.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2

Nom Chemin d’accès Type Description
objectId
objectId uuid

ID d’un objet.

nom
name string

Nom d’un objet.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Nom Chemin d’accès Type Description
relationshipId
relationshipId uuid

ID de relation.

leadObjectId
leadObjectId uuid

ID de l’objet lead de la relation.

leadRelationshipId
leadRelationshipId uuid

ID de la relation de prospect. Utilisé pour les relations intersectionnelles.

memberObjectId
memberObjectId uuid

ID de l’objet membre de la relation.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Nom Chemin d’accès Type Description
deletedRelationshipId
deletedRelationshipId uuid

ID de la relation supprimée.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Nom Chemin d’accès Type Description
relationshipId
relationshipId uuid

ID de relation.

OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

Indique le type de message.

OfficeArchitect.Contracts.Message.MessageCode

OfficeArchitect.Contracts.Message.Message_Level1

Nom Chemin d’accès Type Description
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

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

Nom Chemin d’accès Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

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

Nom Chemin d’accès Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

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

Nom Chemin d’accès Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

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

Nom Chemin d’accès Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

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

Nom Chemin d’accès Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

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

Nom Chemin d’accès Type Description
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Indique le type de message.

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

Contenu du message.

OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation

OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage

OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors

OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

État de l’élément de modèle.

État de l’élément de modèle.

OfficeArchitect.Contracts.Notification.WebhookPayload

Nom Chemin d’accès Type Description
ids
ids array of
eventType
eventType string
secret
secret string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Nom Chemin d’accès Type Description
attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Représente l’ID du groupe d’affectations d’attributs.

nom
name string

Représente le nom du groupe d’affectations d’attributs.

position
position integer

Représente la position du groupe d’affectations d’attributs.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Affectation d’attributs.

Nom Chemin d’accès Type Description
attributeAssignmentId
attributeAssignmentId uuid

ID d’attribution d’attribut.

attributeId
attributeId uuid

Guid AttributeId.

attributeCategoryId
attributeCategoryId integer

int AttributeCategoryId.

metamodelItemId
metamodelItemId uuid

Guid MetamodelItemId.

attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Obtient ou définit l’identificateur de groupe d’affectation d’attributs.

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

string string StringDefaultValue abstrait.

isProtected
isProtected boolean

Obtient ou définit une valeur indiquant si l’attribution d’attribut est protégée.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Nom Chemin d’accès Type Description
metamodelItemDefaultApproverId
metamodelItemDefaultApproverId uuid

Obtient ou définit la clé d’entité.

personId
personId uuid

Obtient ou définit l’ID de la personne.

personName
personName string

Obtient ou définit le nom de la personne.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

MetamodelItem Solution.

Nom Chemin d’accès Type Description
solutionId
solutionId uuid

Représente l’ID de solution.

nom
name string

Représente le nom de la solution.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Représente l’entité Type d’objet.

Nom Chemin d’accès Type Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

parentObjectType
parentObjectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Représente l’entité Type d’objet.

objectTypeId
objectTypeId uuid

Représente l’ID du type d’objet.

parentObjectTypeId
parentObjectTypeId uuid

Représente la référence à l’ID de type d’objet parent.

dateCreated
dateCreated date-time

Représente DateTime lorsque le type d’objet a été créé.

createdById
createdById uuid

Représente l’UserId par lequel le type d’objet a été créé.

dateLastModified
dateLastModified date-time

Représente DateTime lorsque le type d’objet a été modifié.

lastModifiedById
lastModifiedById uuid

Représente l’UserId par lequel le type d’objet a été modifié.

activeState
activeState boolean

Représente si le type d’objet est dans un état actif.

isApprovable
isApprovable boolean

Représente si le type d’objet est approvable.

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

Représente la propriété de navigation vers la collection de solutions.

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

Représente la propriété de navigation vers la collection d’attributs attribués.

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

Représente la propriété de navigation vers la collection de groupes d’affectations d’attributs.

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

Représente la propriété de navigation vers la collection de types d’objets enfants référencés.

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

Représente la propriété de navigation vers la collection d’approbateurs par défaut.

alias
alias string

Obtient ou définit l’alias de l’élément metamodel.

nom
name string

Obtient ou définit le nom de l’élément métamodel.

descriptif
description string

Obtient ou définit la description de l’élément métamodel.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Représente l’entité Type d’objet.

Nom Chemin d’accès Type Description
objectTypeId
objectTypeId uuid

Représente l’ID du type d’objet.

parentObjectTypeId
parentObjectTypeId uuid

Représente la référence à l’ID de type d’objet parent.

dateCreated
dateCreated date-time

Représente DateTime lorsque le type d’objet a été créé.

createdById
createdById uuid

Représente l’UserId par lequel le type d’objet a été créé.

dateLastModified
dateLastModified date-time

Représente DateTime lorsque le type d’objet a été modifié.

lastModifiedById
lastModifiedById uuid

Représente l’UserId par lequel le type d’objet a été modifié.

activeState
activeState boolean

Représente si le type d’objet est dans un état actif.

isApprovable
isApprovable boolean

Représente si le type d’objet est approvable.

alias
alias string

Obtient ou définit l’alias de l’élément metamodel.

nom
name string

Obtient ou définit le nom de l’élément métamodel.

descriptif
description string

Obtient ou définit la description de l’élément métamodel.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

Paire RelationshipType.

Nom Chemin d’accès Type Description
relationshipTypePairId
relationshipTypePairId uuid

Guid RelationshipTypePairId.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadObjectTypeId
leadObjectTypeId uuid

Guid LeadObjectTypeId.

memberObjectTypeId
memberObjectTypeId uuid

Guid MemberObjectTypeId.

leadRelationshipTypeId
leadRelationshipTypeId uuid

Identificateur de type de relation de prospect.

activeState
activeState boolean

bool ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

RelationshipType.

Nom Chemin d’accès Type Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

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

Représente si RelationshipType est approvable.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

représentation
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

Répertorier les solutions MetamodelItemSolution.

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

Répertorier AttributeAssignment AttributeAssignments.

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

Représente la propriété de navigation vers la collection de groupes d’affectations d’attributs.

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

Représente la propriété de navigation vers la collection d’approbateurs par défaut.

alias
alias string

Obtient ou définit l’alias de l’élément metamodel.

nom
name string

Obtient ou définit le nom de l’élément métamodel.

descriptif
description string

Obtient ou définit la description de l’élément métamodel.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

RelationshipType.

Nom Chemin d’accès Type Description
relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

dateCreated
dateCreated date-time

DateTime DateCreated.

createdById
createdById uuid

Guid CreatedById.

dateLastModified
dateLastModified date-time

DateTime DateLastModified.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

activeState
activeState boolean

bool ActiveState.

isApprovable
isApprovable boolean

Représente si RelationshipType est approvable.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

alias
alias string

Obtient ou définit l’alias de l’élément metamodel.

nom
name string

Obtient ou définit le nom de l’élément métamodel.

descriptif
description string

Obtient ou définit la description de l’élément métamodel.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Nom Chemin d’accès Type Description
value
value double

Valeur décimale.

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

Nom Chemin d’accès Type Description
object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Nom Chemin d’accès Type Description
isApprovable
isApprovable boolean
isPendingReview
isPendingReview boolean
requestedBy
requestedBy uuid
requestedOn
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
completedBy
completedBy uuid
completedOn
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
commentaire
comment string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Nom Chemin d’accès Type Description
isApprovable
isApprovable boolean
isPendingReview
isPendingReview boolean
requestedBy
requestedBy uuid
requestedOn
requestedOn date-time
requestedOnVersionNumber
requestedOnVersionNumber integer
completedBy
completedBy uuid
completedOn
completedOn date-time
completedOnVersionNumber
completedOnVersionNumber integer
commentaire
comment string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Nom Chemin d’accès Type Description
solutionId
solutionId uuid

Représente l’ID de solution.

nom
name string

Représente le nom de la solution.

OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

Nom Chemin d’accès Type Description
createdBy
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

descriptif
description string

Représente la description du modèle.

dateCreated
dateCreated date-time

Représente DateTime lors de la création du modèle.

createdById
createdById uuid

Représente l’Id utilisateur par lequel le modèle a été créé.

dateLastModified
dateLastModified date-time

Représente DateTime lorsque le modèle a été modifié.

lastModifiedById
lastModifiedById uuid

Représente l’Id utilisateur par lequel le modèle a été modifié.

date de début
startDate date-time

Représente DateTime au démarrage du modèle.

date de fin
endDate date-time

Représente DateTime lorsque le modèle était obsolète.

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

Représente le modèle désactivé.

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

Représente la propriété de navigation vers la collection de solutions.

modelId
modelId uuid

Représente l’ID de modèle.

nom
name string

Représente le nom du modèle.

OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

Nom Chemin d’accès Type Description
descriptif
description string

Représente la description du modèle.

dateCreated
dateCreated date-time

Représente DateTime lors de la création du modèle.

createdById
createdById uuid

Représente l’Id utilisateur par lequel le modèle a été créé.

dateLastModified
dateLastModified date-time

Représente DateTime lorsque le modèle a été modifié.

lastModifiedById
lastModifiedById uuid

Représente l’Id utilisateur par lequel le modèle a été modifié.

date de début
startDate date-time

Représente DateTime au démarrage du modèle.

date de fin
endDate date-time

Représente DateTime lorsque le modèle était obsolète.

isHidden
isHidden boolean

Représente le modèle désactivé.

modelId
modelId uuid

Représente l’ID de modèle.

nom
name string

Représente le nom du modèle.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1

Nom Chemin d’accès Type Description
originalObjectId
originalObjectId uuid

ID d’objet d’origine.

currentVersionNumber
currentVersionNumber integer

Numéro de version actuel de ModelItem.

status
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

État de l’élément de modèle.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Nom Chemin d’accès Type Description
originalObjectId
originalObjectId uuid

ID d’objet d’origine.

currentVersionNumber
currentVersionNumber integer

Numéro de version actuel de ModelItem.

OfficeArchitect.Contracts.OData.Model.Object_Level0

Entité d’objet OData.

Nom Chemin d’accès Type Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Représente l’entité Type d’objet.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Utilisateur d’audit.

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

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Utilisateur d’audit.

objectId
objectId uuid

Guid ObjectId.

nom
name string

nom de chaîne.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Date verrouillée.

lockedById
lockedById uuid

Id d’utilisateur LockedBy.

isApproved
isApproved boolean

Est approuvé.

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

virtual List 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

Répertorier AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level1

Entité d’objet OData.

Nom Chemin d’accès Type Description
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Représente l’entité Type d’objet.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

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

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

objectId
objectId uuid

Guid ObjectId.

nom
name string

nom de chaîne.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Date verrouillée.

lockedById
lockedById uuid

Id d’utilisateur LockedBy.

isApproved
isApproved boolean

Est approuvé.

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

virtual List 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

Répertorier AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level2

Entité d’objet OData.

Nom Chemin d’accès Type Description
objectId
objectId uuid

Guid ObjectId.

nom
name string

nom de chaîne.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Date verrouillée.

lockedById
lockedById uuid

Id d’utilisateur LockedBy.

isApproved
isApproved boolean

Est approuvé.

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

Objet connexe.

Nom Chemin d’accès Type Description
relationshipId
relationshipId uuid

Guid RelationshipId.

objectId
objectId uuid

Guid ObjectId.

isLead
isLead boolean

bool IsLead.

relatedObjectId
relatedObjectId uuid

Guid RelatedObjectId.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1

Nom Chemin d’accès Type Description
originalRelationshipId
originalRelationshipId uuid

ID de relation d’origine.

currentVersionNumber
currentVersionNumber integer

Numéro de version actuel de ModelItem.

status
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

État de l’élément de modèle.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Nom Chemin d’accès Type Description
originalRelationshipId
originalRelationshipId uuid

ID de relation d’origine.

currentVersionNumber
currentVersionNumber integer

Numéro de version actuel de ModelItem.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Relation.

Nom Chemin d’accès Type Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Entité d’objet OData.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relation.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Entité d’objet 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

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Utilisateur d’audit.

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 paire de type de relation.

isApproved
isApproved boolean

Est approuvé.

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

Répertorier AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Relation.

Nom Chemin d’accès Type Description
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Entité d’objet OData.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relation.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Entité d’objet 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

Utilisateur d’audit.

lastModifiedBy
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

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 paire de type de relation.

isApproved
isApproved boolean

Est approuvé.

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

Répertorier AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Relation.

Nom Chemin d’accès Type Description
relationshipId
relationshipId uuid

Guid RelationshipId.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadRelationshipId
leadRelationshipId uuid

Guid LeadObjectId.

leadObjectId
leadObjectId uuid

Guid LeadObjectId.

memberObjectId
memberObjectId uuid

Guid MemberObjectId.

relationshipTypePairId
relationshipTypePairId uuid

ID de paire de type de relation.

isApproved
isApproved boolean

Est approuvé.

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

Utilisateur d’audit.

Nom Chemin d’accès Type Description
userId
userId uuid

Guid UserId.

nom
name string

nom de chaîne.

adresse e-mail
emailAddress string

string EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Utilisateur d’audit.

Nom Chemin d’accès Type Description
userId
userId uuid

Guid UserId.

nom
name string

nom de chaîne.

adresse e-mail
emailAddress string

string EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Modèle qui représente la réponse de l’opération de création d’objet.

Nom Chemin d’accès Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level1
type d’opération
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indique la réussite de l’opération.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Messages de réponse.

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Modèle qui représente la réponse de l’opération de suppression d’objet.

Nom Chemin d’accès Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level1
type d’opération
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indique la réussite de l’opération.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Messages de réponse.

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Modèle qui représente la réponse de l’opération de mise à jour de l’objet.

Nom Chemin d’accès Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level1
type d’opération
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indique la réussite de l’opération.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Messages de réponse.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Nom Chemin d’accès Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level1
type d’opération
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indique la réussite de l’opération.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Messages de réponse.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Nom Chemin d’accès Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level1
type d’opération
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indique la réussite de l’opération.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Messages de réponse.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Nom Chemin d’accès Type Description
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level1
type d’opération
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
success
success boolean

Indique la réussite de l’opération.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Messages de réponse.

OfficeArchitect.Contracts.Response.EntityType

OfficeArchitect.Contracts.Response.OperationType

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

Représente des informations supplémentaires que les formats OData prennent en charge. Il s’agit uniquement d’une documentation swagger.

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

Lien vers le contexte Odata.

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

Obtient la collection d’entités pour ce flux.

@odata.nextLink
@odata.nextLink uri

Obtient le lien de la page suivante de valeurs dans le flux.

@odata.count
@odata.count integer

Obtient le nombre total de valeurs dans le flux.

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

Représente des informations supplémentaires que les formats OData prennent en charge. Il s’agit uniquement d’une documentation swagger.

Nom Chemin d’accès Type Description
@odata.context
@odata.context string

Lien vers le contexte Odata.

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

Obtient la collection d’entités pour ce flux.

@odata.nextLink
@odata.nextLink uri

Obtient le lien de la page suivante de valeurs dans le flux.

@odata.count
@odata.count integer

Obtient le nombre total de valeurs dans le flux.