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.
Security: Manager or Designer of the process space, or an owner of the affected architecture element(s).
PUT
/v1/warehouses/{warehouseId}/architectureElements/{instanceId}Authorization
AuthorizationBearer token (JWT) · headerrequiredBpmLicenseAPI key · headerrequiredPath parameters
warehouseIdstringrequiredWarehouse-Id
instanceIdstringrequiredinstance id of the ArchitectureElement (its id, not its elementId)
Request body
requiredapplication/jsonUpdateArchitectureElement
conceptualClassArchitectureElementTypeAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackageownersEntityId[]Show propertiesHide properties
Array of
EntityIdtypeEntityIdTyperequiredAllowed:
GroupIdOrgRoleIdOrgUnitIdUserIdvaluestringrequiredpropertiesCreateArchitectureProperty[]Show propertiesHide properties
Array of
CreateArchitecturePropertykeystringrequiredvalueArchitecturePropertyValueShow propertiesHide properties
typestringrequiredpropertyUpdateModePropertyUpdateModeAllowed:
MergeOverwriterepresentationRefIdShow propertiesHide properties
typestringrequiredspecializationstringResponses
200
Updated ArchitectureElement
conceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredelementIdstringrequiredgroupsArchitectureGroup[]requiredShow propertiesHide properties
Array of
ArchitectureGroupcorebooleanrequireddescriptionTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredShow propertiesHide properties
Array of
TranslationlanguagestringrequiredvaluestringrequiredkeystringrequiredlabelTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredhasPredecessorbooleanrequiredidstringrequiredlastValidationHistoryShow propertiesHide properties
atstringrequiredbystringrequiredlayerArchitectureElementLayerrequiredAllowed:
ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayermodifiedHistoryShow propertiesHide properties
atstringrequiredbystringrequiredownersEntityId[]requiredShow propertiesHide properties
Array of
EntityIdtypeEntityIdTyperequiredAllowed:
GroupIdOrgRoleIdOrgUnitIdUserIdvaluestringrequiredprincipalIsOwnerbooleanrequiredpropertiesArchitectureProperty[]requiredShow propertiesHide properties
Array of
ArchitecturePropertymetaArchitectureMetaPropertyrequiredShow propertiesHide properties
corebooleanrequireddescriptionTranslatedStringgroupstringkeystringrequiredlabelTranslatedStringtypeArchitecturePropertyTyperequiredAllowed:
BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTimevalidationArchitecturePropertyValidationShow propertiesHide properties
literalsTranslatedString[]lowerBoundstringmandatorybooleanrequiredupperBoundstringvalueTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredpublishedHistoryShow propertiesHide properties
atstringrequiredbystringrequiredreferencesArchitectureReference[]requiredShow propertiesHide properties
Array of
ArchitectureReferencemetaArchitectureMetaReferencerequiredShow propertiesHide properties
corebooleanrequireddescriptionTranslatedStringgroupstringkeystringrequiredlabelTranslatedStringmultiplicityArchitectureReferenceMultiplicityrequiredAllowed:
ExactlyOneOneOrMoreZeroOrMoreZeroOrOnetargetClassesstring[]requiredtargetReferenceShow propertiesHide properties
assignedArchitectureElementRefsArchitectureElementRef[]requiredShow propertiesHide properties
Array of
ArchitectureElementRefconceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackageelementIdstringrequiredreferenceDirectionReferenceDirectionrequiredAllowed:
BidirectionalNoneSourceTargetreferenceKindReferenceKindrequiredAllowed:
AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggeringspecializationstringcreatedHistoryrequiredlinkedElementsRefId[]requiredmodifiedHistorypropertiesArchitectureProperty[]requiredrelationshipIdstringrequiredrepresentationRefIdShow propertiesHide properties
typestringrequiredspecializationstringvalidityStateArchitectureValidityStaterequiredAllowed:
DraftInvalidNextUpcomingValidvisibilityVisibilityrequiredShow propertiesHide properties
lastChangeHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredvisiblebooleanrequired403
Forbidden: insufficient permissions
string404
Warehouse or ArchitectureElement not found
string