Edit a single element.
Edit a single element. Edits an existing ArchitectureElement. The path names it by its instance id (the id of one version of the element), not by its logical ElementId. The edit lands in the element’s draft, derived from the published version if it has none yet, and that version is what it is read against: the properties taken are the ones its conceptual class declares, and a change of the conceptual class is measured against the one it carries - not against the version the path names.
Security: Manager or Designer of the process space, or an owner of the affected architecture element(s).
/v1/warehouses/{warehouseId}/architectureElements/{instanceId}AuthorizationBearer-Token (JWT) · headererforderlichBpmLicenseAPI-Schlüssel · headererforderlichwarehouseIdstringerforderlichWarehouse-Id
instanceIdstringerforderlichInstance id of the ArchitectureElement (its id, not its elementId)
application/jsonUpdateArchitectureElement
conceptualClassArchitectureElementTypeApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackageownersEntityId[]Eigenschaften anzeigenEigenschaften ausblenden
EntityIdtypeEntityIdTypeerforderlichGroupIdOrgRoleIdOrgUnitIdUserIdvaluestringerforderlichpropertiesCreateArchitectureProperty[]Eigenschaften anzeigenEigenschaften ausblenden
CreateArchitecturePropertykeystringerforderlichvalueArchitecturePropertyValueEigenschaften anzeigenEigenschaften ausblenden
typestringerforderlichpropertyUpdateModePropertyUpdateModeMergeOverwriterepresentationRefIdEigenschaften anzeigenEigenschaften ausblenden
typestringerforderlichspecializationstringUpdated ArchitectureElement
conceptualClassArchitectureElementTypeerforderlichApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryerforderlichEigenschaften anzeigenEigenschaften ausblenden
atstringerforderlichbystringerforderlichelementIdstringerforderlichexternalIdstringgroupsArchitectureGroup[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
ArchitectureGroupcorebooleanerforderlichdescriptionTranslatedStringEigenschaften anzeigenEigenschaften ausblenden
defaultLanguagestringerforderlichtranslationsTranslation[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
TranslationlanguagestringerforderlichvaluestringerforderlichkeystringerforderlichlabelTranslatedStringEigenschaften anzeigenEigenschaften ausblenden
defaultLanguagestringerforderlichtranslationsTranslation[]erforderlichhasPredecessorbooleanerforderlichidstringerforderlichlastValidationHistoryEigenschaften anzeigenEigenschaften ausblenden
atstringerforderlichbystringerforderlichlayerArchitectureElementLayererforderlichApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayermodifiedHistoryEigenschaften anzeigenEigenschaften ausblenden
atstringerforderlichbystringerforderlichownersEntityId[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
EntityIdtypeEntityIdTypeerforderlichGroupIdOrgRoleIdOrgUnitIdUserIdvaluestringerforderlichprincipalIsOwnerbooleanerforderlichpropertiesArchitectureProperty[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
ArchitecturePropertyenumKeystringmetaArchitectureMetaPropertyerforderlichEigenschaften anzeigenEigenschaften ausblenden
corebooleanerforderlichdescriptionTranslatedStringgroupstringkeystringerforderlichlabelTranslatedStringtypeArchitecturePropertyTypeerforderlichBBCodeBooleanDateDateTimeDecimalEnumIntegerStringTimevalidationArchitecturePropertyValidationEigenschaften anzeigenEigenschaften ausblenden
enumLiteralsArchitectureEnumLiteral[]Eigenschaften anzeigenEigenschaften ausblenden
ArchitectureEnumLiteraldeprecatedbooleanerforderlichkeystringerforderlichlabelTranslatedStringerforderlichliteralsTranslatedString[]lowerBoundstringmandatorybooleanerforderlichupperBoundstringvalueTranslatedStringEigenschaften anzeigenEigenschaften ausblenden
defaultLanguagestringerforderlichtranslationsTranslation[]erforderlichpublishedHistoryEigenschaften anzeigenEigenschaften ausblenden
atstringerforderlichbystringerforderlichreferencesArchitectureReference[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
ArchitectureReferencemetaArchitectureMetaReferenceerforderlichEigenschaften anzeigenEigenschaften ausblenden
corebooleanerforderlichdescriptionTranslatedStringgroupstringkeystringerforderlichlabelTranslatedStringmultiplicityArchitectureReferenceMultiplicityerforderlichExactlyOneOneOrMoreZeroOrMoreZeroOrOnetargetClassesstring[]erforderlichtargetReferenceEigenschaften anzeigenEigenschaften ausblenden
assignedArchitectureElementRefsArchitectureElementRef[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
ArchitectureElementRefconceptualClassArchitectureElementTypeerforderlichApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackageelementIdstringerforderlichreferenceDirectionReferenceDirectionerforderlichBidirectionalNoneSourceTargetreferenceKindReferenceKinderforderlichAccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggeringspecializationstringcreatedHistoryerforderlichlinkedElementsRefId[]erforderlichmodifiedHistorypropertiesArchitectureProperty[]erforderlichrelationshipIdstringerforderlichrepresentationRefIdEigenschaften anzeigenEigenschaften ausblenden
typestringerforderlichspecializationstringvalidityStateArchitectureValidityStateerforderlichDraftInvalidNextUpcomingValidvisibilityVisibilityerforderlichEigenschaften anzeigenEigenschaften ausblenden
lastChangeHistoryerforderlichEigenschaften anzeigenEigenschaften ausblenden
atstringerforderlichbystringerforderlichvisiblebooleanerforderlichThe element would be left without a name, a property value is invalid or its key is not declared by the conceptual class the edit is read against, or the representation belongs to another element
stringForbidden: insufficient permissions
stringWarehouse or ArchitectureElement not found
stringAnother change is still working on the draft of the element or on the representation given, the draft was published or discarded meanwhile, or the version this edit was prepared for is no longer the one it would be written to; repeat the request. Or the element documents a version of a process with an open BPMN draft; change the process in that draft instead
string