Add a relationship starting at an element.
Add a relationship starting at an element. Creates a relationship starting at the architecture element named in the path. Both the path and the body name the elements by their logical ElementId (the elementId an element keeps across all its versions), not by the instance id of one version. The conceptual class of both elements is resolved from the stored elements, so besides the two element ids only the reference kind and the direction are required; properties and linked elements may be omitted. A relationship with a BusinessProcess carries a BPMN reference for each BusinessProcess it connects (its process, or an element or lane of it): a missing one is added from the BusinessProcess’s representation. A relationship without a BusinessProcess carries no linked elements. If a relationship of the same kind and direction already exists between the two elements, that relationship is returned instead of a second one being created, and properties and linked elements sent along are merged into it as long as both elements are active and valid. Relationships between the same two elements are created one at a time; if another one is still being created after a short wait, the request is answered with 409. A Composition replaces the other Compositions of its part, since a part belongs to at most one whole. If the part has a draft, only that draft changes until it is published; otherwise the change takes effect at once. A Composition that would close a cycle is rejected. Compositions of one process space are written one at a time; if another one is still being written after a short wait, the request is answered with 409 and can be repeated. Writing a relationship requires the edition of this process space to cover every element the relationship connects: for each of them, the type of every stored version counts, not only the current one.
Security: Manager or Designer of the process space, or an owner of the affected architecture element(s).
/v1/warehouses/{warehouseId}/architectureElements/{elementId}/relationsAuthorizationBearer-Token (JWT) · headererforderlichBpmLicenseAPI-Schlüssel · headererforderlichwarehouseIdstringerforderlichWarehouse-Id
elementIdstringerforderlichLogical ElementId of the source element
application/jsonRelationship to create
directionRelationshipDirectionerforderlichBidirectionalDirectionalNoneelementIdstringerforderlichlinkedElementsRefId[]Eigenschaften anzeigenEigenschaften ausblenden
RefIdtypestringerforderlichpropertiesCreateArchitectureProperty[]Eigenschaften anzeigenEigenschaften ausblenden
CreateArchitecturePropertykeystringerforderlichvalueArchitecturePropertyValueEigenschaften anzeigenEigenschaften ausblenden
typestringerforderlichreferenceKindReferenceKinderforderlichAccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggeringCreated or merged ArchitectureRelationship
architectureElementRefsArchitectureElementRef[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
ArchitectureElementRefconceptualClassArchitectureElementTypeerforderlichApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackageelementIdstringerforderlichreferenceDirectionReferenceDirectionerforderlichBidirectionalNoneSourceTargetreferenceKindReferenceKinderforderlichAccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggeringspecializationstringconceptualClassArchitectureRelationshipTypeAccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggeringidstringerforderlichlinkedElementsRefId[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
RefIdtypestringerforderlichpropertiesArchitectureProperty[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
ArchitecturePropertyenumKeystringmetaArchitectureMetaPropertyerforderlichEigenschaften anzeigenEigenschaften ausblenden
corebooleanerforderlichdescriptionTranslatedStringgroupstringkeystringerforderlichlabelTranslatedStringtypeArchitecturePropertyTypeerforderlichBBCodeBooleanDateDateTimeDecimalEnumIntegerStringTimevalidationArchitecturePropertyValidationEigenschaften anzeigenEigenschaften ausblenden
enumLiteralsArchitectureEnumLiteral[]Eigenschaften anzeigenEigenschaften ausblenden
ArchitectureEnumLiteraldeprecatedbooleanerforderlichkeystringerforderlichlabelTranslatedStringerforderlichliteralsTranslatedString[]lowerBoundstringmandatorybooleanerforderlichupperBoundstringvalueTranslatedStringEigenschaften anzeigenEigenschaften ausblenden
defaultLanguagestringerforderlichtranslationsTranslation[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
TranslationlanguagestringerforderlichvaluestringerforderlichrelationshipDirectionRelationshipDirectionerforderlichBidirectionalDirectionalNonespecializationArchitectureRelationshipSpecializationTypeNotSpecializedInvalid reference kind, direction or property (every kind but Association and ArchitectureReference must be Directional), a Composition cycle, or linkedElements against the BusinessProcess rule (any on a relationship without BusinessProcess, one belonging to no BusinessProcess of it, a BusinessProcess without a process)
stringForbidden: insufficient permissions, or the edition of this process space does not cover an element the relationship connects
stringWarehouse or ArchitectureElement not found
stringAnother Composition of the process space, or another relationship between the two elements, is being written, or a draft of one of them is being published; repeat the request
string