Udostępnij przez


OrbusInfinity

OrbusInfinity umożliwia zespołom architektury generowanie cyfrowej strategii przedsiębiorstwa i podejmowanie świadomych decyzji w oparciu o ujednolicony widok działalności biznesowej i w przyszłości. Twórz niestandardowe automatyzacje, aby tworzyć, odczytywać i aktualizować obiekty i relacje w repozytorium danych.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Orbus Software
adres URL https://support.orbussoftware.com
Email support@orbussoftware.com
Metadane łącznika
Publisher Orbus Software
Witryna internetowa https://www.orbussoftware.com
Zasady ochrony prywatności https://www.orbussoftware.com/privacy-policy
Kategorie Witryna internetowa; Dane

Łącznik OrbusInfinity

OrbusInfinity to prawdziwe rozwiązanie wielodostępne SaaS, które zapewnia ostateczną platformę umożliwiającą transformację cyfrową.

Rozwiązanie OrbusInfinity integruje się bezpośrednio z pakietem Microsoft Office, aby umożliwić łatwe łączenie, wymianę, wizualizowanie i synchronizowanie danych z repozytorium OrbusInfinity.

Łącznik OrbusInfinity jest oparty na interfejsie API OrbusInfinity i zapewnia operacje umożliwiające wygodną interakcję z platformą.

Wydawca: Orbus Software

Wymagania wstępne

Do korzystania z łącznika potrzebne są następujące elementy:

  • Plan usługi Power Automate z dostępem do łączników w warstwie Premium
  • Subskrypcja OrbusInfinity obejmująca dostęp do interfejsu API
  • Konto OrbusInfinity

Authentication

  • Uwierzytelnianie oAuth2 za pomocą przepływu niejawnego
  • Aby wykonać dowolną operację wymienioną poniżej, musisz się uwierzytelnić

Obsługiwane operacje

Operation Description
Uzyskiwanie obiektów Pobieranie obiektów i ich szczegółów
Post obiektów Tworzenie nowego obiektu
Obiekty — pobieranie pojedynczego Uzyskiwanie szczegółów obiektu
Usuwanie obiektów Usuwanie obiektu
Poprawka obiektów Aktualizowanie wartości atrybutów istniejącego obiektu
Uzyskiwanie relacji Pobieranie relacji i ich szczegółów
Wpis relacji Tworzenie nowej relacji
Relacje — uzyskiwanie pojedynczego Uzyskiwanie szczegółów relacji
Usuwanie relacji Usuwanie relacji
Poprawka relacji Aktualizowanie wartości atrybutów istniejącej relacji
Publikowanie elementów webhook Tworzy wyzwalacz z żądanym zdarzeniem
Usuwanie elementów webhook Usuwanie istniejącego elementu webhook

Objects

Operacje konfigurowania obiektów modelu i zarządzania nimi.

Uzyskiwanie obiektów

GET /odata/Objects

Pobieranie obiektów i ich szczegółów

Odpowiedź domyślna zawiera listę 50 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity i ich właściwości najwyższego poziomu. Użyj poniższych parametrów OData, aby filtrować, porządkować, rozwijać dodatkowe właściwości i wybierać tylko określone właściwości w danych wyjściowych.

Parametry

Name In Typ Wymagane Description
$select kwerenda ciąg false Podzestaw właściwości do uwzględnienia dla każdego obiektu w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.
$expand kwerenda ciąg false Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla każdego obiektu w odpowiedzi.
Ponadto można zażądać następujących właściwości: Model, , ObjectType, CreatedByAttributeValuesFlatLastModifiedByAttributeValues, . DetailLockedBy
$filter kwerenda ciąg false Wyrażenie, według którego filtrujesz obiekty w wyniku. Obiekty można filtrować według wartości następujących właściwości: ObjectId, Name, LastModifiedByAttributeValuesLockedByCreatedByModelObjectTypeDetailLastModifiedByIdLastModifiedDateCreatedByIdModelIdLockedByIdDateCreatedObjectTypeIdLockedOnIsApproved.
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 100.
$orderby kwerenda ciąg false Kolejność sortowania obiektów w odpowiedzi według wybranej właściwości. Na przykład wprowadź , Name desc aby zażądać obiektów w kolejności malejącej według właściwości Name.
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 5.
$top kwerenda liczba całkowita (int32) false Liczba obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity, do uwzględnienia w odpowiedzi. Wartość minimalna to 0; wartość maksymalna — 50.
Na przykład wprowadź polecenie 20 , aby zwrócić 20 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity.
$skip kwerenda liczba całkowita (int32) false Liczba obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity, do wykluczenia z odpowiedzi. Wartość minimalna i domyślna to 0; wartość maksymalna — 50.
Na przykład wprowadź wartość 20 , aby pominąć 20 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity i zwrócić następne 50.
$count kwerenda typ logiczny (boolowski) false Jeśli wartość true, łączna liczba obiektów jest określona w odpowiedzi. Domyślnie parametr ma wartość false, co oznacza, że łączna liczba nie jest zwracana.

Responses

Zwraca odpowiedź dynamiczną.

Post obiektów

POST /odata/Objects

Tworzenie nowego obiektu

Należy określić identyfikator typu obiektu, identyfikator modelu i atrybuty identyfikujące dla nowego obiektu. Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość.

Parametr treści

Parametry

Name In Typ Wymagane Description
body body CreateObjectRequestValue true Wartości właściwości dla nowego obiektu. Określ ObjectTypeId, aby NameModelIdutworzyć obiekt.

Szczegółowe opisy

body: wartości właściwości dla nowego obiektu. Określ ObjectTypeId, aby NameModelIdutworzyć obiekt. Opcjonalnie określ dodatkowe właściwości, postępując zgodnie ze strukturą w przykładzie.

Responses

Utworzono nowy obiekt. CreateObjectResponse

Obiekty — pobieranie pojedynczego

GET /odata/Objects({key})

Uzyskiwanie szczegółów obiektu

Odpowiedź domyślna zawiera tylko właściwości najwyższego poziomu. Użyj opcjonalnych parametrów OData, aby rozwinąć dodatkowe właściwości i wybrać tylko określone właściwości.

Parametry

Name In Typ Wymagane Description
klucz ścieżka string(uuid) true Identyfikator obiektu w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.
$select kwerenda ciąg false Podzestaw właściwości do uwzględnienia dla obiektu w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.
$expand kwerenda ciąg false Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla obiektu w odpowiedzi.
Ponadto można zażądać następujących właściwości: Model, , ObjectType, CreatedByAttributeValuesRelatedObjectsLastModifiedByLockedByAttributeValuesFlat, . ApprovalDetailsDetail

Responses

Zwraca odpowiedź dynamiczną.

Usuwanie obiektów

DELETE /odata/Objects({key})

Usuwanie obiektu

Usunięty obiekt jest przenoszony do Kosza.

Parametry

Name In Typ Wymagane Description
klucz ścieżka string(uuid) true Identyfikator obiektu w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

Responses

Usunięto obiekt. DeleteObjectResponse

Poprawka obiektów

PATCH /odata/Objects({key})

Aktualizowanie wartości atrybutów istniejącego obiektu

Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość. Zostaną zaktualizowane tylko określone wartości atrybutu.

Parametr treści

Parametry

Name In Typ Wymagane Description
klucz ścieżka string(uuid) true Identyfikator obiektu w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.
body body UpdateObjectRequestValue true Wartości atrybutu do aktualizacji dla określonego obiektu. Dla każdego atrybutu określ

Responses

Zaktualizowano obiekt. UpdateObjectResponse

Relacje

Operacje konfigurowania relacji modelu i zarządzania nimi.

Uzyskiwanie relacji

GET /odata/Relationships

Pobieranie relacji i ich szczegółów

Odpowiedź domyślna zawiera listę 50 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity i ich właściwości najwyższego poziomu. Użyj poniższych parametrów OData, aby filtrować, porządkować, rozwijać dodatkowe właściwości i wybierać tylko określone właściwości w danych wyjściowych.

Parametry

Name In Typ Wymagane Description
includeIntersectional kwerenda typ logiczny (boolowski) false Jeśli wartość true, uwzględnij relacje częściowe w danych wyjściowych.
$select kwerenda ciąg false Podzestaw właściwości do uwzględnienia dla każdej relacji w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.
$expand kwerenda ciąg false Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla każdej relacji w odpowiedzi.
Ponadto można zażądać następujących właściwości: LeadObject, , LeadRelationship, ModelRelationshipTypeAttributeValuesMemberObject, . DetailAttributeValuesFlat
$filter kwerenda ciąg false Wyrażenie, według którego filtrujesz relacje w wyniku. Relacje można filtrować według wartości następujących właściwości: RelationshipId, , ModelIdRelationshipTypeId, ModelLeadObjectIdLeadRelationshipIdRelationshipType, , . DetailMemberObjectId
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 100.
$orderby kwerenda ciąg false Kolejność sortowania relacji w odpowiedzi według wybranej właściwości. Na przykład wprowadź wartość DateCreated desc , aby zażądać relacji w kolejności malejącej według właściwości DateCreated.
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 5.
$top kwerenda liczba całkowita (int32) false Liczba relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity, do uwzględnienia w odpowiedzi. Wartość minimalna to 0; wartość maksymalna — 50.
Na przykład wprowadź polecenie 20 , aby zwrócić 20 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity.
$skip kwerenda liczba całkowita (int32) false Liczba relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity, aby wykluczyć z odpowiedzi. Wartość minimalna i domyślna to 0; wartość maksymalna — 50.
Na przykład wprowadź wartość 20 , aby pominąć 20 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity i zwrócić następne 50.
$count kwerenda typ logiczny (boolowski) false Jeśli wartość true, łączna liczba relacji jest określona w odpowiedzi. Domyślnie parametr ma wartość false, co oznacza, że łączna liczba nie jest zwracana.

Szczegółowe opisy

includeIntersectional: jeśli wartość true, dołącz relacje częściowe w danych wyjściowych. Relacje częściowe mają wartość właściwości LeadRelationshipId , a zwykłe relacje mają wartość właściwości LeadObjectId .

Responses

Zwraca odpowiedź dynamiczną.

Wpis relacji

POST /odata/Relationships

Tworzenie nowej relacji

Należy określić identyfikator typu relacji, identyfikator modelu, identyfikator pary typu relacji, identyfikator obiektu potencjalnego klienta, identyfikator obiektu członkowskiego i identyfikatory identyfikujące atrybuty dla nowej relacji. Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość.

Parametr treści

Parametry

Name In Typ Wymagane Description
body body CreateRelationshipRequestValue true Wartości właściwości dla nowej relacji. Określ RelationshipTypeId, , RelationshipTypePairIdModelId, , MemberModelItemIdLeadModelItemIdaby utworzyć relację.

Responses

Utworzono nową relację. CreateRelationshipResponse

Relacje — uzyskiwanie pojedynczego

GET /odata/Relationships({key})

Uzyskiwanie szczegółów relacji

Odpowiedź domyślna zawiera tylko właściwości najwyższego poziomu. Użyj opcjonalnych parametrów OData, aby rozwinąć dodatkowe właściwości i wybrać tylko określone właściwości.

Parametry

Name In Typ Wymagane Description
klucz ścieżka string(uuid) true Identyfikator relacji w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.
$select kwerenda ciąg false Podzestaw właściwości do uwzględnienia dla relacji w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.
$expand kwerenda ciąg false Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla relacji w odpowiedzi.
Ponadto można zażądać następujących właściwości: LeadObject, , ModelMemberObjectLeadRelationshipAttributeValuesAttributeValuesFlatRelationshipType, . ApprovalDetailsDetail

Responses

Zwraca odpowiedź dynamiczną.

Usuwanie relacji

DELETE /odata/Relationships({key})

Usuwanie relacji

Usunięta relacja zostanie przeniesiona do Kosza.

Parametry

Name In Typ Wymagane Description
klucz ścieżka string(uuid) true Identyfikator relacji w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

Responses

Usunięto relację. DeleteRelationshipResponse

Poprawka relacji

PATCH /odata/Relationships({key})

Aktualizowanie wartości atrybutów istniejącej relacji

Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość. Zostaną zaktualizowane tylko określone wartości atrybutu.

Parametr treści

Parametry

Name In Typ Wymagane Description
klucz ścieżka string(uuid) true Identyfikator relacji w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.
body body UpdateRelationshipRequestValue true Wartości atrybutów do aktualizacji dla określonej relacji. Dla każdego atrybutu określ

Responses

Zaktualizowano relację. UpdateRelationshipResponse

Webhooks

Operacje zarządzania elementami webhook.

Publikowanie elementów webhook

POST /odata/Webhooks

Gdy wystąpi zdarzenie

Tworzy wyzwalacz z żądanym zdarzeniem, więc po wystąpieniu tego zdarzenia w aplikacji OrbusInfinity aplikacja znajdująca się pod podanym adresem URL zostanie powiadomiona.

Parametr treści

Parametry

Name In Typ Wymagane Description
body body Tworzenie elementuWebhookRequest true Żądanie zawierające informacje o elementach webhook.

Responses

SaveWebhookResponse

Usuwanie elementów webhook

DELETE /odata/Webhooks({key})

Usuwanie istniejącego elementu webhook

Usuwa istniejący element webhook, podając identyfikator elementu webhook.

Parametry

Name In Typ Wymagane Description
klucz ścieżka liczba całkowita (int32) true Identyfikator elementu webhook.

Responses

Usuń elementWebhookResponse

Schemas

Element webhookSaved

Właściwości

Name Typ Wymagane Restrictions Description
webhookId liczba całkowita (int32) false none Identyfikator elementu webhook.

ObjectCreated

Właściwości

Name Typ Wymagane Restrictions Description
nazwa ciąg false none Nazwa utworzonego obiektu.
objectId string(uuid) false none Identyfikator utworzonego obiektu.
modelId string(uuid) false none Identyfikator modelu utworzonego obiektu.
objectTypeId string(uuid) false none Identyfikator typu obiektu utworzonego obiektu.

ObjectDeleted

Właściwości

Name Typ Wymagane Restrictions Description
objectId string(uuid) false none Identyfikator usuniętego obiektu.
objectName ciąg false none Nazwa usuniętego obiektu.

ObjectUpdated

Właściwości

Name Typ Wymagane Restrictions Description
objectId string(uuid) false none Identyfikator obiektu.
nazwa ciąg false none Nazwa obiektu.

RelacjaTworzenie

Właściwości

Name Typ Wymagane Restrictions Description
relationshipId string(uuid) false none Identyfikator relacji.
leadObjectId string(uuid) false none Identyfikator obiektu potencjalnego klienta relacji.
leadRelationshipId string(uuid) false none Identyfikator relacji potencjalnej relacji. Służy do relacji międzycięciowych.
memberObjectId string(uuid) false none Identyfikator obiektu członkowskiego relacji.

RelacjaDeleted

Właściwości

Name Typ Wymagane Restrictions Description
deletedRelationshipId string(uuid) false none Identyfikator usuniętej relacji.

RelationshipUpdated

Właściwości

Name Typ Wymagane Restrictions Description
relationshipId string(uuid) false none Identyfikator relacji.

MessageCategory

Wartość
Error
Ostrzeżenie
Informacja

Kod komunikatu

Wartość
AttributeAssignmentDoesNotExist
DocumentTypeMustBelongToAModellingSolution
DocumentTypeHasDocuments
CustomDocumentTypeHasDocuments
DuplicateDocumentTypeInModellingSolution
DuplicateObjectTypeInModellingSolution
InvalidDocumentTypeCategory
DocumentTypeCategoryMismatch
CustomDocumentTypeNotSupported
CustomDocumentTypeMustHaveAtLeastOneFileExtension
DocumentTypeFileExtensionNotSupportedForCustomCategory
IdentifyingAttributeAssignmentWithInstancesExists
DocumentTypeDoesNotExist
DocumentTypeNameIsInvalid
DocumentTypeFilenameInvalid
DocumentTypePrimaryTemplateAlreadyExists
DocumentTypeDoesNotSupportAncillaryTemplateFiles
MissingDocumentTypeTemplateFile
MissingDocumentTypePrimaryTemplateFile
MultipleDocumentTypePrimaryTemplateFiles
DocumentTypeFileExtensionNotSupportedForCategory
TemplateFilenamesMustBeUnique
ContentTypeSaveOperationFailed
InvalidDocumentTypeRelationshipType
MetamodelItemMustBelongToAModellingSolution
ParentObjectTypeDoesNotExist
ObjectTypeHasCircularReference
ObjectsTypeHasNotChanged
ModelDoesNotExist
MetamodelItemIsNotUniqueToModellingSolution
MetamodelItemNotInModel
MetamodelItemIsSystemLocked
MetamodelItemIsHidden
MetamodelItemIsAlreadyVisible
MetamodelItemIsNotApprovable
MetamodelItemHasNotRequiredCategory
MetamodelItemHasNotAttributeAssignment
MetamodelItemHasNotCommonSolutionsWithIdentifyingAttribute
AtrybutyDeletowane
ObjectTypesDeleted
RelationshipTypesDeleted
DependentModelItemsExist
ModelItemsDoesNotHaveComponents
ModelItemIsNotComponentOfDocumentType
RelationshipPairMembersAreNotComponentsOfDocument
MultipleDuplicateMetamodelItems
EntityIsAlreadyProtected
EntityIsAlreadyUnprotected
AttributeDoesNotExist
AttributeDoesNotExistByName
AttributeDoesNotExistByKey
AttributeNotAssignedToMetamodelItem
AttributeIsNotIdentifyingAttribute
AttributeNotInModelModellingSolution
AttributeAssignmentCannotBeEdited
IdentifyingAttributeAssignmentExists
Dziedziczone atrybutyAssignmentExists
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
ModeleZaaktywowane
ModeleAktywne
ModelkiSolutionsAreNotUnique
Identyfikowanie atrybutuCannotBeImportant
MultipleIdentifyingAttributeAssignments
AttributesAreAlreadyAssigned
MetamodelItemHasInstances
Identyfikowanie elementuAttributeModellingSolutionsAreNotValid
ObjectTypeIsParentOrChild
UnableToAssignSystemAttributes
AttributeIsNotAssignedToMetamodelItem
ExternalDocumentDoesNotExist
DocumentDoesNotExist
AtrybutChoiceDuplicates
AttributeChoiceDoesNotExists
AttributeChoiceIsNotPresent
AttributeChoiceValueIsNotPresent
AttributeChoiceValueIsNotUnique
IdentifyingAttributeDoesNotShareAllMetamodelItemsSolutions
AttributeIsIdentifyingAttribute
ModelItemIsSoftDeleted
ModelItemIsNotSoftDeleted
ModelkiDoesNotExist
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
Identyfikowanie elementuValueNotProvided
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
Element webhookDoesNotExist
Element webhookWithSameDataAlreadyExists
WebhookEventTypeIsNotValid
Element webhookUrlIsNotValid
WebhookExpirationDateIsNotValid
Element 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
DokumentyDeletowane
SharePointSiteSet
DokumentyZarejestrowane
DocumentTypeCreated
DocumentTypeDeleted
DocumentTypeUpdated
DocumentTypeTemplateFilesSaved
DocumentTypeMetamodelItemsSaved
AtrybutAssigmentsSaved
AtrybutTworzeny
AttributeUpdated
ModelItemsReused
ModelItemsDeleted
ObjectCreated
ObjectUpdated
ObiektyTworzenie
ObjectsUpdated
ObjectSkipped
Skopiowane obiekty
ObjectDeleted
ObjectsDeleted
ObjectsMerged
ObjectReclassified
ObjectsReclassified
ObjectsRelationshipsMerged
RelacjaTworzenie
RelacjeTworzenie
Relacje skopiowane
RelationshipUpdated
RelacjeAktualizowane
RelacjaDeleted
RelacjeDeletowane
RelacjaZmapowane
RelationshipTypeDoesNotExist
RelationshipTypePairsDeleted
RelacjeMerged
LeadToMemberDirectionEmpty
MemberToLeadDirectionEmpty
RepresentationSituationIsNotValid
IntersectionalRelationshipRepresentationIsNotValid
IntersectionalRelationshipTypeWithSamePairAlreadyExists
IntersectionalRelationshipTypeCannotHavePairsWithAnyLeadOrMember
RelationshipTypeHasNoPairs
DuplicateRelationshipTypeInModellingSolution
DocumentManagementSystemRetrieved
ObjectTypeCreated
SolutionCreated (Tworzenie rozwiązania)
SolutionDeleted
Element webhookSaved
Element webhookDeleted
MappedImportWorksheetSettingsCreated
MappedImportWorksheetSettingsUpdated
Skopiowany model
ModelItems Skopiowane
ModelItemLocked
ModelItemUnlocked
ModelItemApprovalRequested
ModelItemApprovalRequestCompleted
ModelItemsNotApprovable
ModelTworzenie
ModelUpdated
PowiadomienieTworzenie
NotificationDataHasIncorrectType
NotificationEndDatePrecedesStartDate
BothNotificationProgressCountsAndPercentAreSet
NotificationsDeleted
PowiadomieniaPurged
NotificationsRead
NotificationsReadAll
NotificationsUpdated
RelationshipTypeUpdated
Typ relacjiTworzenie
RelationshipTypesCreated
RelationshipTypePairUpdated
RelationshipTypePairsCreated
DocumentCreated (Tworzenie dokumentu)
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
DocumentTypeLinksTworzenie
ObjectTypeUpdated
RequestCannotBeProcessed
LeadObjectTypeDoesNotExist
MemberObjectTypeDoesNotExist
DocumentComponentUpdated
DocumentComponentsUpdated
DocumentComponentDeleted
DocumentComponentCreated
DocumentComponentsCreated
DocumentTypeComponentsUpdated
DocumentTypeComponentAlreadyExists
DocumentTypeComponentDoesNotExist
MetamodelItemHasDocumentComponents
DocumentTypeCategoryIsNotVisioType
DocumentTypeCategoryIsVisioType
DocumentTypeComponentsTworzenie
DocumentTypeComponentsDeleted
DocumentTypeRelationshipTypeEndpointsDoNotExist
DocumentTypeTemplateUpdated
MetamodelEntitiesLocked
MetamodelEntityIsLocked
MetamodelEntitiesUnlocked
KoszBinPurged
EntitiesProtectionStateApplied
MetamodelItemApprovalInformationHasChanged
DocumentHasDifferentDocumentType
ExternalDocumentDoesNotHaveExternalDocumentId
LeadRelationshipTypeDoesNotExist
IntersectionalRelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageCannotBeUpdated
RelationshipTypeUsageIsNotValid
MetamodelItemDeactivated
MetamodelItemsDeactivated
DescriptionIsInvalid
RelationshipTypePairActivated
RelationshipTypePairsActivated
RelationshipTypePairDeactivated
RelationshipTypePairsDeactivated
MetamodelItemActivated
MetamodelItemsActivated
FailedToSaveRelationshipTypeConnectedToDetails
MemberModelItemIsNotObject
LeadModelItemIsNotObject
LeadModelItemIsNotRelationship
Obszar roboczyTworzenie
Obszary roboczeTworzenie
WorkspaceCapacityIsExceeded
WorkspaceNameIsNotUnique
WorkspaceUpdated
Obszary roboczeAktualizowane
WorkspaceDoesNotExist
PoleceniaValidated
Obszar roboczyDeleted
Obszary roboczeDeletowane
MetamodelItemNotInWorkspace
WorkspaceObjectCreated
ObjectIsNotAvailableInWorkspace
PermissionDeniedDeleteWorkspace
LicenseTypesRecalculated
PricingTierIsNotValid
PermissionDenied
Błąd Wewnętrzny Serwera
NieprawidłoweŻądanie
Nie znaleziono
Zakazany
RequestAccepted
Zastępowaniewszystkie

Message

Właściwości

Name Typ Wymagane Restrictions Description
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.WebhookSaved

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition Element webhookSaved false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.ObjectCreated

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition ObjectCreated false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.ObjectDeleted

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition ObjectDeleted false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.ObjectUpdated

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition ObjectUpdated false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.RelationshipCreated

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition RelacjaTworzenie false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.RelationshipDeleted

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition RelacjaDeleted false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

OperationMessage.RelationshipUpdated

Właściwości

Name Typ Wymagane Restrictions Description
messageDefinition RelationshipUpdated false none none
messageCategory MessageCategory false none Wskazuje typ komunikatu.
messageCode Kod komunikatu false none none
komunikat ciąg false tylko do odczytu Zawartość komunikatu.

Tworzenie elementuWebhookRequest

Właściwości

Name Typ Wymagane Restrictions Description
klucz tajny ciąg false none Wpis tajny odbiorcy.
eventType ciąg true none Typ zdarzenia subskrypcji.
URL ciąg true none Adres URL odbiorcy.
data wygaśnięcia string(data-godzina) false none Pobiera lub ustawia datę wygaśnięcia. Jeśli nie podano daty wygaśnięcia, jedna wartość
domyślnie będzie używany (zazwyczaj 6 miesięcy po dacie utworzenia).

Usuń elementWebhookResponse

Właściwości

Name Typ Wymagane Restrictions Description
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

SaveWebhookResponse

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.WebhookSaved false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

CreateObjectRequestValue

Właściwości

Name Typ Wymagane Restrictions Description
objectTypeId string(uuid) true none Identyfikator typu obiektu.
attributeValuesFlat obiekt false none Pary klucz-wartość wartości atrybutu.
additionalProperties any false none none
modelId string(uuid) true none Identyfikator modelu.

Model reprezentujący odpowiedź operacji tworzenia obiektu.

UpdateObjectRequestValue

Właściwości

Name Typ Wymagane Restrictions Description
attributeValuesFlat obiekt false none Pary klucz-wartość wartości atrybutu.

CreateObjectResponse

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.ObjectCreated false none none
typ operacji Typ operacji false none none
entityTypes EntityType (Typ jednostki) false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

DeleteObjectResponse

Model reprezentujący odpowiedź operacji usuwania obiektu.

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.ObjectDeleted false none none
typ operacji Typ operacji false none none
entityTypes EntityType (Typ jednostki) false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

UpdateObjectResponse

Model reprezentujący odpowiedź operacji obiektu aktualizacji.

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.ObjectUpdated false none none
typ operacji Typ operacji false none none
entityTypes EntityType (Typ jednostki) false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

CreateRelationshipRequestValue

Właściwości

Name Typ Wymagane Restrictions Description
relationshipTypeId string(uuid) true none Identyfikator typu relacji.
relationshipTypePairId string(uuid) false none Jeśli para typu relacji.
leadModelItemId string(uuid) true none Identyfikator elementu modelu potencjalnego klienta relacji.
memberModelItemId string(uuid) true none Identyfikator elementu modelu członkowskiego relacji.
attributeValuesFlat obiekt false none none
modelId string(uuid) true none Identyfikator modelu.

UpdateRelationshipRequestValue

Właściwości

Name Typ Wymagane Restrictions Description
attributeValuesFlat obiekt false none none

CreateRelationshipResponse

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.RelationshipCreated false none none
typ operacji Typ operacji false none none
entityTypes EntityType (Typ jednostki) false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

DeleteRelationshipResponse

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.RelationshipDeleted false none none
typ operacji Typ operacji false none none
entityTypes EntityType (Typ jednostki) false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

UpdateRelationshipResponse

Właściwości

Name Typ Wymagane Restrictions Description
successMessage OperationMessage.RelationshipUpdated false none none
typ operacji Typ operacji false none none
entityTypes EntityType (Typ jednostki) false none none
sukces typ logiczny (boolowski) false none Wskazuje powodzenie operacji.
messages Message false tylko do odczytu Komunikaty odpowiedzi.

Typ jednostki

Wartość
Żaden
Rozwiązanie
ObjectType
Typ relacji
RelationshipTypePair
Attribute
AttributeAssignment
DocumentType
DocumentTypeLink
DocumentTypeComponent
Model
Object
Relacja
Dokument
DocumentComponent
Workspace
Role

OperationType

Wartość
Create
Update
Usuń

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
OrbusInfinity API URL ciąg Adres URL interfejsu API OrbusInfinity. Np. https://example-api.orbusinfinity.com Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie wartości atrybutów istniejącego obiektu

Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość. Zostaną zaktualizowane tylko określone wartości atrybutu.

Aktualizowanie wartości atrybutów istniejącej relacji

Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość. Zostaną zaktualizowane tylko określone wartości atrybutu.

Pobieranie obiektów i ich szczegółów

Odpowiedź domyślna zawiera listę 50 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity i ich właściwości najwyższego poziomu. Użyj poniższych parametrów OData, aby filtrować, porządkować, rozwijać dodatkowe właściwości i wybierać tylko określone właściwości w danych wyjściowych.

Pobieranie relacji i ich szczegółów

Odpowiedź domyślna zawiera listę 50 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity i ich właściwości najwyższego poziomu. Użyj poniższych parametrów OData, aby filtrować, porządkować, rozwijać dodatkowe właściwości i wybierać tylko określone właściwości w danych wyjściowych.

Tworzenie nowego obiektu

Należy określić identyfikator typu obiektu, identyfikator modelu i atrybuty identyfikujące dla nowego obiektu. Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość.

Tworzenie nowej relacji

Należy określić identyfikator typu relacji, identyfikator modelu, identyfikator pary typu relacji, identyfikator obiektu potencjalnego klienta, identyfikator obiektu członkowskiego i identyfikatory identyfikujące atrybuty dla nowej relacji. Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość.

Usuwanie obiektu

Usunięty obiekt jest przenoszony do Kosza.

Usuwanie relacji

Usunięta relacja zostanie przeniesiona do Kosza.

Uzyskiwanie szczegółów obiektu

Odpowiedź domyślna zawiera tylko właściwości najwyższego poziomu. Użyj opcjonalnych parametrów OData, aby rozwinąć dodatkowe właściwości i wybrać tylko określone właściwości.

Uzyskiwanie szczegółów relacji

Odpowiedź domyślna zawiera tylko właściwości najwyższego poziomu. Użyj opcjonalnych parametrów OData, aby rozwinąć dodatkowe właściwości i wybrać tylko określone właściwości.

Aktualizowanie wartości atrybutów istniejącego obiektu

Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość. Zostaną zaktualizowane tylko określone wartości atrybutu.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz
key True uuid

Identyfikator obiektu w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Pary klucz-wartość wartości atrybutu.

Zwraca

Model reprezentujący odpowiedź operacji obiektu aktualizacji.

Aktualizowanie wartości atrybutów istniejącej relacji

Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość. Zostaną zaktualizowane tylko określone wartości atrybutu.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz
key True uuid

Identyfikator relacji w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

attributeValuesFlat
attributeValuesFlat object

Zwraca

Pobieranie obiektów i ich szczegółów

Odpowiedź domyślna zawiera listę 50 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity i ich właściwości najwyższego poziomu. Użyj poniższych parametrów OData, aby filtrować, porządkować, rozwijać dodatkowe właściwości i wybierać tylko określone właściwości w danych wyjściowych.

Parametry

Nazwa Klucz Wymagane Typ Opis
$select
$select string

Podzestaw właściwości do uwzględnienia dla każdego obiektu w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.

$expand
$expand string

Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla każdego obiektu w odpowiedzi.
Ponadto można zażądać następujących właściwości: Model, , ObjectType, CreatedByAttributeValuesFlatLastModifiedByAttributeValues, . DetailLockedBy

$filter
$filter string

Wyrażenie, według którego filtrujesz obiekty w wyniku. Obiekty można filtrować według wartości następujących właściwości: ObjectId, Name, LastModifiedByAttributeValuesLockedByCreatedByModelObjectTypeDetailLastModifiedByIdLastModifiedDateCreatedByIdModelIdLockedByIdDateCreatedObjectTypeIdLockedOnIsApproved.
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 100.

$orderby
$orderby string

Kolejność sortowania obiektów w odpowiedzi według wybranej właściwości. Na przykład wprowadź , Name desc aby zażądać obiektów w kolejności malejącej według właściwości Name.
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 5.

$top
$top integer

Liczba obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity, do uwzględnienia w odpowiedzi. Wartość minimalna to 0; wartość maksymalna — 50.
Na przykład wprowadź polecenie 20 , aby zwrócić 20 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity.

$skip
$skip integer

Liczba obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity, do wykluczenia z odpowiedzi. Wartość minimalna i domyślna to 0; wartość maksymalna — 50.
Na przykład wprowadź wartość 20 , aby pominąć 20 obiektów, które zostały ostatnio utworzone w usłudze OrbusInfinity i zwrócić następne 50.

$count
$count boolean

Jeśli wartość true, łączna liczba obiektów jest określona w odpowiedzi. Domyślnie parametr ma wartość false, co oznacza, że łączna liczba nie jest zwracana.

Zwraca

Reprezentuje dodatkowe informacje obsługiwane przez formaty OData. Jest to przeznaczone tylko dla celów dokumentacji struktury Swagger.

Pobieranie relacji i ich szczegółów

Odpowiedź domyślna zawiera listę 50 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity i ich właściwości najwyższego poziomu. Użyj poniższych parametrów OData, aby filtrować, porządkować, rozwijać dodatkowe właściwości i wybierać tylko określone właściwości w danych wyjściowych.

Parametry

Nazwa Klucz Wymagane Typ Opis
includeIntersectional
includeIntersectional boolean

Jeśli wartość true, uwzględnij relacje częściowe w danych wyjściowych. Relacje częściowe mają wartość właściwości LeadRelationshipId , a zwykłe relacje mają wartość właściwości LeadObjectId .

$select
$select string

Podzestaw właściwości do uwzględnienia dla każdej relacji w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.

$expand
$expand string

Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla każdej relacji w odpowiedzi.
Ponadto można zażądać następujących właściwości: LeadObject, , LeadRelationship, ModelRelationshipTypeAttributeValuesMemberObject, . DetailAttributeValuesFlat

$filter
$filter string

Wyrażenie, według którego filtrujesz relacje w wyniku. Relacje można filtrować według wartości następujących właściwości: RelationshipId, , ModelIdRelationshipTypeId, ModelLeadObjectIdLeadRelationshipIdRelationshipType, , . DetailMemberObjectId
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 100.

$orderby
$orderby string

Kolejność sortowania relacji w odpowiedzi według wybranej właściwości. Na przykład wprowadź wartość DateCreated desc , aby zażądać relacji w kolejności malejącej według właściwości DateCreated.
Minimalna i domyślna liczba wyrażeń to 0; wartość maksymalna — 5.

$top
$top integer

Liczba relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity, do uwzględnienia w odpowiedzi. Wartość minimalna to 0; wartość maksymalna — 50.
Na przykład wprowadź polecenie 20 , aby zwrócić 20 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity.

$skip
$skip integer

Liczba relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity, aby wykluczyć z odpowiedzi. Wartość minimalna i domyślna to 0; wartość maksymalna — 50.
Na przykład wprowadź wartość 20 , aby pominąć 20 relacji, które zostały ostatnio utworzone w usłudze OrbusInfinity i zwrócić następne 50.

$count
$count boolean

Jeśli wartość true, łączna liczba relacji jest określona w odpowiedzi. Domyślnie parametr ma wartość false, co oznacza, że łączna liczba nie jest zwracana.

Zwraca

Reprezentuje dodatkowe informacje obsługiwane przez formaty OData. Jest to przeznaczone tylko dla celów dokumentacji struktury Swagger.

Tworzenie nowego obiektu

Należy określić identyfikator typu obiektu, identyfikator modelu i atrybuty identyfikujące dla nowego obiektu. Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość.

Parametry

Nazwa Klucz Wymagane Typ Opis
objectTypeId
objectTypeId True uuid

Identyfikator typu obiektu.

attributeValuesFlat
attributeValuesFlat object

Pary klucz-wartość wartości atrybutu.

modelId
modelId True uuid

Identyfikator modelu.

Zwraca

Model reprezentujący odpowiedź operacji tworzenia obiektu.

Tworzenie nowej relacji

Należy określić identyfikator typu relacji, identyfikator modelu, identyfikator pary typu relacji, identyfikator obiektu potencjalnego klienta, identyfikator obiektu członkowskiego i identyfikatory identyfikujące atrybuty dla nowej relacji. Użyj AttributeValuesFlat właściwości, aby określić wartości atrybutów w formacie klucz-wartość.

Parametry

Nazwa Klucz Wymagane Typ Opis
relationshipTypeId
relationshipTypeId True uuid

Identyfikator typu relacji.

relationshipTypePairId
relationshipTypePairId uuid

Jeśli para typu relacji.

leadModelItemId
leadModelItemId True uuid

Identyfikator elementu modelu potencjalnego klienta relacji.

memberModelItemId
memberModelItemId True uuid

Identyfikator elementu modelu członkowskiego relacji.

attributeValuesFlat
attributeValuesFlat object
modelId
modelId True uuid

Identyfikator modelu.

Zwraca

Usuwanie obiektu

Usunięty obiekt jest przenoszony do Kosza.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz
key True uuid

Identyfikator obiektu w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

Zwraca

Model reprezentujący odpowiedź operacji usuwania obiektu.

Usuwanie relacji

Usunięta relacja zostanie przeniesiona do Kosza.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz
key True uuid

Identyfikator relacji w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

Zwraca

Uzyskiwanie szczegółów obiektu

Odpowiedź domyślna zawiera tylko właściwości najwyższego poziomu. Użyj opcjonalnych parametrów OData, aby rozwinąć dodatkowe właściwości i wybrać tylko określone właściwości.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz
key True uuid

Identyfikator obiektu w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

$select
$select string

Podzestaw właściwości do uwzględnienia dla obiektu w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.

$expand
$expand string

Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla obiektu w odpowiedzi.
Ponadto można zażądać następujących właściwości: Model, , ObjectType, CreatedByAttributeValuesRelatedObjectsLastModifiedByLockedByAttributeValuesFlat, . ApprovalDetailsDetail

Zwraca

Jednostka obiektu OData.

Uzyskiwanie szczegółów relacji

Odpowiedź domyślna zawiera tylko właściwości najwyższego poziomu. Użyj opcjonalnych parametrów OData, aby rozwinąć dodatkowe właściwości i wybrać tylko określone właściwości.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz
key True uuid

Identyfikator relacji w formacie GUID, na przykład 00000000-0000-0000-0000-000000000000.

$select
$select string

Podzestaw właściwości do uwzględnienia dla relacji w odpowiedzi. Jeśli pole pozostanie puste, zostaną zwrócone właściwości domyślne.

$expand
$expand string

Dodatkowe właściwości (wraz z domyślnymi) do uwzględnienia dla relacji w odpowiedzi.
Ponadto można zażądać następujących właściwości: LeadObject, , ModelMemberObjectLeadRelationshipAttributeValuesAttributeValuesFlatRelationshipType, . ApprovalDetailsDetail

Zwraca

Związek.

Wyzwalacze

Gdy wystąpi zdarzenie

Tworzy wyzwalacz z żądanym zdarzeniem, więc po wystąpieniu tego zdarzenia w aplikacji OrbusInfinity aplikacja znajdująca się pod podanym adresem URL zostanie powiadomiona.

Gdy wystąpi zdarzenie

Tworzy wyzwalacz z żądanym zdarzeniem, więc po wystąpieniu tego zdarzenia w aplikacji OrbusInfinity aplikacja znajdująca się pod podanym adresem URL zostanie powiadomiona.

Parametry

Nazwa Klucz Wymagane Typ Opis
klucz tajny
secret string

Wpis tajny odbiorcy.

eventType
eventType True string

Typ zdarzenia subskrypcji.

data wygaśnięcia
expirationDate date-time

Pobiera lub ustawia datę wygaśnięcia. Jeśli data wygaśnięcia nie zostanie podana, domyślnie zostanie użyta jedna wartość (zazwyczaj 6 miesięcy po dacie utworzenia).

Zwraca

Definicje

OfficeArchitect.Contracts.Message.Definition.MessageDefinition

Nazwa Ścieżka Typ Opis
object

OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa utworzonego obiektu.

objectId
objectId uuid

Identyfikator utworzonego obiektu.

modelId
modelId uuid

Identyfikator modelu utworzonego obiektu.

objectTypeId
objectTypeId uuid

Identyfikator typu obiektu utworzonego obiektu.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2

Nazwa Ścieżka Typ Opis
objectId
objectId uuid

Identyfikator usuniętego obiektu.

objectName
objectName string

Nazwa usuniętego obiektu.

OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2

Nazwa Ścieżka Typ Opis
objectId
objectId uuid

Identyfikator obiektu.

nazwa
name string

Nazwa obiektu.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2

Nazwa Ścieżka Typ Opis
relationshipId
relationshipId uuid

Identyfikator relacji.

leadObjectId
leadObjectId uuid

Identyfikator obiektu potencjalnego klienta relacji.

leadRelationshipId
leadRelationshipId uuid

Identyfikator relacji potencjalnej relacji. Służy do relacji międzycięciowych.

memberObjectId
memberObjectId uuid

Identyfikator obiektu członkowskiego relacji.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2

Nazwa Ścieżka Typ Opis
deletedRelationshipId
deletedRelationshipId uuid

Identyfikator usuniętej relacji.

OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2

Nazwa Ścieżka Typ Opis
relationshipId
relationshipId uuid

Identyfikator relacji.

OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

Wskazuje typ komunikatu.

OfficeArchitect.Contracts.Message.MessageCode

OfficeArchitect.Contracts.Message.Message_Level1

Nazwa Ścieżka Typ Opis
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

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

Nazwa Ścieżka Typ Opis
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

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

Nazwa Ścieżka Typ Opis
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

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

Nazwa Ścieżka Typ Opis
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

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

Nazwa Ścieżka Typ Opis
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

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

Nazwa Ścieżka Typ Opis
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

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

Nazwa Ścieżka Typ Opis
messageDefinition
messageDefinition OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level2
messageCategory
messageCategory OfficeArchitect.Contracts.Message.MessageCategory

Wskazuje typ komunikatu.

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

Zawartość komunikatu.

OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation

OfficeArchitect.Contracts.Metamodel.MetamodelItem.RelationshipTypeUsage

OfficeArchitect.Contracts.Metamodel.MetamodelItem.SystemColors

OfficeArchitect.Contracts.Metamodel.MetamodelItem.TitleIcons

OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Stan elementu modelu.

Stan elementu modelu.

OfficeArchitect.Contracts.Notification.WebhookPayload

Nazwa Ścieżka Typ Opis
Numery identyfikacyjne
ids array of
eventType
eventType string
klucz tajny
secret string

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignmentGroup_Level2

Nazwa Ścieżka Typ Opis
attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Reprezentuje identyfikator grupy przypisań atrybutów.

nazwa
name string

Reprezentuje nazwę grupy przypisań atrybutów.

pozycja
position integer

Reprezentuje położenie grupy przypisania atrybutu.

OfficeArchitect.Contracts.OData.Metamodel.Attribute.AttributeAssignment_Level2

Przypisanie atrybutu.

Nazwa Ścieżka Typ Opis
attributeAssignmentId
attributeAssignmentId uuid

Identyfikator przypisania atrybutu.

attributeId
attributeId uuid

Guid AttributeId.

attributeCategoryId
attributeCategoryId integer

int AttributeCategoryId.

metamodelItemId
metamodelItemId uuid

Guid MetamodelItemId.

attributeAssignmentGroupId
attributeAssignmentGroupId uuid

Pobiera lub ustawia identyfikator grupy przypisań atrybutów.

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.

pozycja
position integer

położenie int.

activeState (stan aktywny)
activeState boolean

wartość logiczna ActiveState.

stringDefaultValue
stringDefaultValue string

ciąg abstrakcyjny StringDefaultValue.

isProtected
isProtected boolean

Pobiera lub ustawia wartość wskazującą, czy przypisanie atrybutu jest chronione.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemDefaultApprover_Level2

Nazwa Ścieżka Typ Opis
metamodelItemDefaultApproverId
metamodelItemDefaultApproverId uuid

Pobiera lub ustawia klucz jednostki.

personId
personId uuid

Pobiera lub ustawia identyfikator osoby.

personName
personName string

Pobiera lub ustawia nazwisko osoby.

OfficeArchitect.Contracts.OData.Metamodel.MetamodelItemSolution_Level2

Rozwiązanie MetamodelItem.

Nazwa Ścieżka Typ Opis
solutionId
solutionId uuid

Reprezentuje identyfikator rozwiązania.

nazwa
name string

Reprezentuje nazwę rozwiązania.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Reprezentuje jednostkę Typ obiektu.

Nazwa Ścieżka Typ Opis
utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

parentObjectType
parentObjectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Reprezentuje jednostkę Typ obiektu.

objectTypeId
objectTypeId uuid

Reprezentuje identyfikator typu obiektu.

parentObjectTypeId
parentObjectTypeId uuid

Reprezentuje odwołanie do identyfikatora typu obiektu nadrzędnego.

dateCreated
dateCreated date-time

Reprezentuje datę/godzinę utworzenia typu obiektu.

createdById
createdById uuid

Reprezentuje identyfikator UserId, za pomocą którego utworzono typ obiektu.

dateLastModified
dateLastModified date-time

Reprezentuje datę/godzinę modyfikacji typu obiektu.

lastModifiedById
lastModifiedById uuid

Reprezentuje identyfikator UserId, za pomocą którego zmodyfikowano typ obiektu.

activeState (stan aktywny)
activeState boolean

Określa, czy typ obiektu jest w stanie aktywnym.

isApprovable
isApprovable boolean

Określa, czy typ obiektu jest możliwy do zatwierdzeniu.

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

Reprezentuje właściwość nawigacji do kolekcji rozwiązań.

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

Reprezentuje właściwość nawigacji do kolekcji przypisanych atrybutów.

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

Reprezentuje właściwość nawigacji do kolekcji grup przypisań atrybutów.

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

Reprezentuje właściwość nawigacji do kolekcji przywołynych typów obiektów podrzędnych.

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

Reprezentuje właściwość nawigacji do kolekcji domyślnych osób zatwierdzających.

alias
alias string

Pobiera lub ustawia alias elementu metamodel.

nazwa
name string

Pobiera lub ustawia nazwę elementu metamodel.

opis
description string

Pobiera lub ustawia opis elementu metamodel.

OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Reprezentuje jednostkę Typ obiektu.

Nazwa Ścieżka Typ Opis
objectTypeId
objectTypeId uuid

Reprezentuje identyfikator typu obiektu.

parentObjectTypeId
parentObjectTypeId uuid

Reprezentuje odwołanie do identyfikatora typu obiektu nadrzędnego.

dateCreated
dateCreated date-time

Reprezentuje datę/godzinę utworzenia typu obiektu.

createdById
createdById uuid

Reprezentuje identyfikator UserId, za pomocą którego utworzono typ obiektu.

dateLastModified
dateLastModified date-time

Reprezentuje datę/godzinę modyfikacji typu obiektu.

lastModifiedById
lastModifiedById uuid

Reprezentuje identyfikator UserId, za pomocą którego zmodyfikowano typ obiektu.

activeState (stan aktywny)
activeState boolean

Określa, czy typ obiektu jest w stanie aktywnym.

isApprovable
isApprovable boolean

Określa, czy typ obiektu jest możliwy do zatwierdzeniu.

alias
alias string

Pobiera lub ustawia alias elementu metamodel.

nazwa
name string

Pobiera lub ustawia nazwę elementu metamodel.

opis
description string

Pobiera lub ustawia opis elementu metamodel.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipTypePair_Level2

RelacjaTyp pary.

Nazwa Ścieżka Typ Opis
relationshipTypePairId
relationshipTypePairId uuid

Guid RelationshipTypePairId.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadObjectTypeId
leadObjectTypeId uuid

Guid LeadObjectTypeId.

memberObjectTypeId
memberObjectTypeId uuid

Guid MemberObjectTypeId.

leadRelationshipTypeId
leadRelationshipTypeId uuid

Identyfikator typu relacji potencjalnych klientów.

activeState (stan aktywny)
activeState boolean

wartość logiczna ActiveState.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

Typ relacji.

Nazwa Ścieżka Typ Opis
utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

dateCreated
dateCreated date-time

Data/godzina utworzenia.

createdById
createdById uuid

Guid CreatedById.

dateLastModified
dateLastModified date-time

DateTime DateLastModified.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

activeState (stan aktywny)
activeState boolean

wartość logiczna ActiveState.

isApprovable
isApprovable boolean

Określa, czy typ relacji jest możliwy do zatwierdzeniu.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

reprezentacja
representation OfficeArchitect.Contracts.Metamodel.DocumentType.RepresentationSituation
kierunek
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

Lista rozwiązań metamodelItemSolution.

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

Reprezentuje właściwość nawigacji do kolekcji grup przypisań atrybutów.

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

Reprezentuje właściwość nawigacji do kolekcji domyślnych osób zatwierdzających.

alias
alias string

Pobiera lub ustawia alias elementu metamodel.

nazwa
name string

Pobiera lub ustawia nazwę elementu metamodel.

opis
description string

Pobiera lub ustawia opis elementu metamodel.

OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

Typ relacji.

Nazwa Ścieżka Typ Opis
relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

dateCreated
dateCreated date-time

Data/godzina utworzenia.

createdById
createdById uuid

Guid CreatedById.

dateLastModified
dateLastModified date-time

DateTime DateLastModified.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

activeState (stan aktywny)
activeState boolean

wartość logiczna ActiveState.

isApprovable
isApprovable boolean

Określa, czy typ relacji jest możliwy do zatwierdzeniu.

leadToMemberDirection
leadToMemberDirection string

string LeadToMemberDirection.

memberToLeadDirection
memberToLeadDirection string

string MemberToLeadDirection.

alias
alias string

Pobiera lub ustawia alias elementu metamodel.

nazwa
name string

Pobiera lub ustawia nazwę elementu metamodel.

opis
description string

Pobiera lub ustawia opis elementu metamodel.

OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

AttributeValue.

Nazwa Ścieżka Typ Opis
value
value double

wartość dziesiętna.

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 (nazwa_atrybutu)
attributeName string

string AttributeName.

attributeAlias
attributeAlias string

string AttributeAlias.

OfficeArchitect.Contracts.OData.Model.AttributeValuesFlat

Nazwa Ścieżka Typ Opis
object

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level1

Nazwa Ścieżka Typ Opis
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
komentarz
comment string

OfficeArchitect.Contracts.OData.Model.ModelItemApprovalDetails_Level2

Nazwa Ścieżka Typ Opis
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
komentarz
comment string

OfficeArchitect.Contracts.OData.Model.ModelSolution_Level2

Nazwa Ścieżka Typ Opis
solutionId
solutionId uuid

Reprezentuje identyfikator rozwiązania.

nazwa
name string

Reprezentuje nazwę rozwiązania.

OfficeArchitect.Contracts.OData.Model.Model_Level1

Model.

Nazwa Ścieżka Typ Opis
utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

opis
description string

Reprezentuje opis modelu.

dateCreated
dateCreated date-time

Reprezentuje datę/godzinę utworzenia modelu.

createdById
createdById uuid

Reprezentuje identyfikator UserId, za pomocą którego utworzono model.

dateLastModified
dateLastModified date-time

Reprezentuje datę/godzinę modyfikacji modelu.

lastModifiedById
lastModifiedById uuid

Reprezentuje identyfikator UserId, za pomocą którego zmodyfikowano model.

startDate
startDate date-time

Reprezentuje datę/godzinę rozpoczęcia modelu.

data zakończenia
endDate date-time

Reprezentuje wartość DateTime, gdy model był nieaktualny.

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

Reprezentuje model jest dezaktywowany.

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

Reprezentuje właściwość nawigacji do kolekcji rozwiązań.

modelId
modelId uuid

Reprezentuje identyfikator modelu.

nazwa
name string

Reprezentuje nazwę modelu.

OfficeArchitect.Contracts.OData.Model.Model_Level2

Model.

Nazwa Ścieżka Typ Opis
opis
description string

Reprezentuje opis modelu.

dateCreated
dateCreated date-time

Reprezentuje datę/godzinę utworzenia modelu.

createdById
createdById uuid

Reprezentuje identyfikator UserId, za pomocą którego utworzono model.

dateLastModified
dateLastModified date-time

Reprezentuje datę/godzinę modyfikacji modelu.

lastModifiedById
lastModifiedById uuid

Reprezentuje identyfikator UserId, za pomocą którego zmodyfikowano model.

startDate
startDate date-time

Reprezentuje datę/godzinę rozpoczęcia modelu.

data zakończenia
endDate date-time

Reprezentuje wartość DateTime, gdy model był nieaktualny.

isHidden
isHidden boolean

Reprezentuje model jest dezaktywowany.

modelId
modelId uuid

Reprezentuje identyfikator modelu.

nazwa
name string

Reprezentuje nazwę modelu.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level1

Nazwa Ścieżka Typ Opis
originalObjectId
originalObjectId uuid

Oryginalny identyfikator obiektu.

currentVersionNumber
currentVersionNumber integer

Numer bieżącej wersji elementu ModelItem.

stan
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Stan elementu modelu.

OfficeArchitect.Contracts.OData.Model.ObjectDetail_Level2

Nazwa Ścieżka Typ Opis
originalObjectId
originalObjectId uuid

Oryginalny identyfikator obiektu.

currentVersionNumber
currentVersionNumber integer

Numer bieżącej wersji elementu ModelItem.

OfficeArchitect.Contracts.OData.Model.Object_Level0

Jednostka obiektu OData.

Nazwa Ścieżka Typ Opis
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level1

Reprezentuje jednostkę Typ obiektu.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Przeprowadź inspekcję użytkownika.

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.

utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Przeprowadź inspekcję użytkownika.

objectId
objectId uuid

Identyfikator ObjectId identyfikatora GUID.

nazwa
name string

nazwa ciągu.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Zablokowana data.

lockedById
lockedById uuid

Zablokowaneby identyfikator użytkownika.

isApproved
isApproved boolean

Jest zatwierdzony.

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

virtual List RelatedObject RelatedObjects.

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

Identyfikator modelu Guid.

dateCreated
dateCreated date-time

Data/godzina? DateCreated.

createdById
createdById uuid

Guid CreatedById.

dataOstatniejModyfikacji
lastModifiedDate date-time

Data/godzina? Data ostatniej modyfikacji.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues (Wartości atrybutów)
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level1

Jednostka obiektu OData.

Nazwa Ścieżka Typ Opis
objectType
objectType OfficeArchitect.Contracts.OData.Metamodel.ObjectType_Level2

Reprezentuje jednostkę Typ obiektu.

lockedBy
lockedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

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.

utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

objectId
objectId uuid

Identyfikator ObjectId identyfikatora GUID.

nazwa
name string

nazwa ciągu.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Zablokowana data.

lockedById
lockedById uuid

Zablokowaneby identyfikator użytkownika.

isApproved
isApproved boolean

Jest zatwierdzony.

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

virtual List RelatedObject RelatedObjects.

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

Identyfikator modelu Guid.

dateCreated
dateCreated date-time

Data/godzina? DateCreated.

createdById
createdById uuid

Guid CreatedById.

dataOstatniejModyfikacji
lastModifiedDate date-time

Data/godzina? Data ostatniej modyfikacji.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues (Wartości atrybutów)
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Object_Level2

Jednostka obiektu OData.

Nazwa Ścieżka Typ Opis
objectId
objectId uuid

Identyfikator ObjectId identyfikatora GUID.

nazwa
name string

nazwa ciągu.

objectTypeId
objectTypeId uuid

Guid ObjectTypeId.

lockedOn
lockedOn date-time

Zablokowana data.

lockedById
lockedById uuid

Zablokowaneby identyfikator użytkownika.

isApproved
isApproved boolean

Jest zatwierdzony.

modelId
modelId uuid

Identyfikator modelu Guid.

dateCreated
dateCreated date-time

Data/godzina? DateCreated.

createdById
createdById uuid

Guid CreatedById.

dataOstatniejModyfikacji
lastModifiedDate date-time

Data/godzina? Data ostatniej modyfikacji.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Model.RelatedObject_Level2

Obiekt pokrewny.

Nazwa Ścieżka Typ Opis
relationshipId
relationshipId uuid

Identyfikator relacji Guid.

objectId
objectId uuid

Identyfikator ObjectId identyfikatora GUID.

isLead
isLead boolean

bool IsLead.

relatedObjectId
relatedObjectId uuid

Guid RelatedObjectId.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level1

Nazwa Ścieżka Typ Opis
originalRelationshipId
originalRelationshipId uuid

Oryginalny identyfikator relacji.

currentVersionNumber
currentVersionNumber integer

Numer bieżącej wersji elementu ModelItem.

stan
status OfficeArchitect.Contracts.ModelItem.ModelItemStatus

Stan elementu modelu.

OfficeArchitect.Contracts.OData.Model.RelationshipDetail_Level2

Nazwa Ścieżka Typ Opis
originalRelationshipId
originalRelationshipId uuid

Oryginalny identyfikator relacji.

currentVersionNumber
currentVersionNumber integer

Numer bieżącej wersji elementu ModelItem.

OfficeArchitect.Contracts.OData.Model.Relationship_Level0

Związek.

Nazwa Ścieżka Typ Opis
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Jednostka obiektu OData.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Związek.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level1

Jednostka obiektu OData.

Typ relacji
relationshipType OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level1

Typ relacji.

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.

utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Przeprowadź inspekcję użytkownika.

relationshipId
relationshipId uuid

Identyfikator relacji Guid.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadRelationshipId
leadRelationshipId uuid

Guid LeadObjectId.

leadObjectId
leadObjectId uuid

Guid LeadObjectId.

memberObjectId
memberObjectId uuid

Guid MemberObjectId.

relationshipTypePairId
relationshipTypePairId uuid

Identyfikator pary typu relacji.

isApproved
isApproved boolean

Jest zatwierdzony.

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

Identyfikator modelu Guid.

dateCreated
dateCreated date-time

Data/godzina? DateCreated.

createdById
createdById uuid

Guid CreatedById.

dataOstatniejModyfikacji
lastModifiedDate date-time

Data/godzina? Data ostatniej modyfikacji.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues (Wartości atrybutów)
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level1

Związek.

Nazwa Ścieżka Typ Opis
leadObject
leadObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Jednostka obiektu OData.

leadRelationship
leadRelationship OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Związek.

memberObject
memberObject OfficeArchitect.Contracts.OData.Model.Object_Level2

Jednostka obiektu OData.

Typ relacji
relationshipType OfficeArchitect.Contracts.OData.Metamodel.RelationshipType_Level2

Typ relacji.

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.

utworzone przez
createdBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

Ostatni, zmodyfikowany, przez
lastModifiedBy OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

relationshipId
relationshipId uuid

Identyfikator relacji Guid.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadRelationshipId
leadRelationshipId uuid

Guid LeadObjectId.

leadObjectId
leadObjectId uuid

Guid LeadObjectId.

memberObjectId
memberObjectId uuid

Guid MemberObjectId.

relationshipTypePairId
relationshipTypePairId uuid

Identyfikator pary typu relacji.

isApproved
isApproved boolean

Jest zatwierdzony.

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

Identyfikator modelu Guid.

dateCreated
dateCreated date-time

Data/godzina? DateCreated.

createdById
createdById uuid

Guid CreatedById.

dataOstatniejModyfikacji
lastModifiedDate date-time

Data/godzina? Data ostatniej modyfikacji.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

attributeValues (Wartości atrybutów)
attributeValues array of OfficeArchitect.Contracts.OData.Model.AttributeValue.AttributeValue_Level2

List AttributeValue AttributeValues.

OfficeArchitect.Contracts.OData.Model.Relationship_Level2

Związek.

Nazwa Ścieżka Typ Opis
relationshipId
relationshipId uuid

Identyfikator relacji Guid.

relationshipTypeId
relationshipTypeId uuid

Guid RelationshipTypeId.

leadRelationshipId
leadRelationshipId uuid

Guid LeadObjectId.

leadObjectId
leadObjectId uuid

Guid LeadObjectId.

memberObjectId
memberObjectId uuid

Guid MemberObjectId.

relationshipTypePairId
relationshipTypePairId uuid

Identyfikator pary typu relacji.

isApproved
isApproved boolean

Jest zatwierdzony.

modelId
modelId uuid

Identyfikator modelu Guid.

dateCreated
dateCreated date-time

Data/godzina? DateCreated.

createdById
createdById uuid

Guid CreatedById.

dataOstatniejModyfikacji
lastModifiedDate date-time

Data/godzina? Data ostatniej modyfikacji.

lastModifiedById
lastModifiedById uuid

Guid LastModifiedById.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level1

Przeprowadź inspekcję użytkownika.

Nazwa Ścieżka Typ Opis
userId
userId uuid

Guid UserId.

nazwa
name string

nazwa ciągu.

adres e-mail
emailAddress string

ciąg EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.OData.Permission.AuditUser_Level2

Przeprowadź inspekcję użytkownika.

Nazwa Ścieżka Typ Opis
userId
userId uuid

Guid UserId.

nazwa
name string

nazwa ciągu.

adres e-mail
emailAddress string

ciąg EmailAddress.

isInactive
isInactive boolean

bool IsInactive.

OfficeArchitect.Contracts.Object.Response.CreateObjectResponse_Level0

Model reprezentujący odpowiedź operacji tworzenia obiektu.

Nazwa Ścieżka Typ Opis
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectCreated_Level1
typ operacji
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
sukces
success boolean

Wskazuje powodzenie operacji.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Komunikaty odpowiedzi.

OfficeArchitect.Contracts.Object.Response.DeleteObjectResponse_Level0

Model reprezentujący odpowiedź operacji usuwania obiektu.

Nazwa Ścieżka Typ Opis
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectDeleted_Level1
typ operacji
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
sukces
success boolean

Wskazuje powodzenie operacji.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Komunikaty odpowiedzi.

OfficeArchitect.Contracts.Object.Response.UpdateObjectResponse_Level0

Model reprezentujący odpowiedź operacji obiektu aktualizacji.

Nazwa Ścieżka Typ Opis
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Object.ObjectUpdated_Level1
typ operacji
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
sukces
success boolean

Wskazuje powodzenie operacji.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Komunikaty odpowiedzi.

OfficeArchitect.Contracts.Relationship.Response.CreateRelationshipResponse_Level0

Nazwa Ścieżka Typ Opis
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipCreated_Level1
typ operacji
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
sukces
success boolean

Wskazuje powodzenie operacji.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Komunikaty odpowiedzi.

OfficeArchitect.Contracts.Relationship.Response.DeleteRelationshipResponse_Level0

Nazwa Ścieżka Typ Opis
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipDeleted_Level1
typ operacji
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
sukces
success boolean

Wskazuje powodzenie operacji.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Komunikaty odpowiedzi.

OfficeArchitect.Contracts.Relationship.Response.UpdateRelationshipResponse_Level0

Nazwa Ścieżka Typ Opis
successMessage
successMessage OfficeArchitect.Contracts.Message.Operation.OperationMessage-Of-OfficeArchitect.Contracts.Message.Definition.Relationship.RelationshipUpdated_Level1
typ operacji
operationType OfficeArchitect.Contracts.Response.OperationType
entityTypes
entityTypes OfficeArchitect.Contracts.Response.EntityType
sukces
success boolean

Wskazuje powodzenie operacji.

messages
messages array of OfficeArchitect.Contracts.Message.Message_Level1

Komunikaty odpowiedzi.

OfficeArchitect.Contracts.Response.EntityType

OfficeArchitect.Contracts.Response.OperationType

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

Reprezentuje dodatkowe informacje obsługiwane przez formaty OData. Jest to przeznaczone tylko dla celów dokumentacji struktury Swagger.

Nazwa Ścieżka Typ Opis
@odata.context
@odata.context string

Link do kontekstu Odata.

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

Pobiera kolekcję jednostek dla tego kanału informacyjnego.

@odata.nextLink
@odata.nextLink uri

Pobiera link do następnej strony wartości w kanale informacyjnym.

@odata.count
@odata.count integer

Pobiera łączną liczbę wartości w kanale informacyjnym.

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

Reprezentuje dodatkowe informacje obsługiwane przez formaty OData. Jest to przeznaczone tylko dla celów dokumentacji struktury Swagger.

Nazwa Ścieżka Typ Opis
@odata.context
@odata.context string

Link do kontekstu Odata.

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

Pobiera kolekcję jednostek dla tego kanału informacyjnego.

@odata.nextLink
@odata.nextLink uri

Pobiera link do następnej strony wartości w kanale informacyjnym.

@odata.count
@odata.count integer

Pobiera łączną liczbę wartości w kanale informacyjnym.